华为云用户手册

任务监控日志查询 查询单个任务的所有日志信息。 输入参数 用户配置任务监控日志查询执行动作，相关参数说明如表11所示。 表11 任务监控日志查询输入参数说明 参数 必填 说明 实例ID 是 实例ID。 任务ID 是 任务ID。 偏移量 否 偏移量，表示从此偏移量开始查询，offset大于等于1。 每页显示条目数量 否 每页显示条目数量，最大数量999，超过999后只返回999。 日志查询的起始时间 否 日志查询的起始时间，格式timestamp(ms)，使用UTC时区。 日志查询的结束时间 否 日志查询的结束时间，格式timestamp(ms)，使用UTC时区。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表12。 表12 任务监控日志查询输出参数说明 参数 说明 总数 总数。 当前页日志数量 当前页日志数量。 任务监控日志当前页元素 任务监控日志当前页元素。 单次任务执行的跟踪ID 单次任务执行的跟踪ID。 本次执行启动时间 本次执行启动时间，格式timestamp(ms)，使用UTC时区。 任务本次执行状态 任务本次执行状态，允许如下值：UNSTARTED-未启动，WAITING-等待调度中，RUNNING-执行中，SUC CES S-执行成功，CANCELLED-任务取消，ERROR-执行异常。 标识本次任务执行到哪一个阶段 标识本次任务执行到哪一个阶段，允许如下值：ADAPTER-任务处于初始化阶段，READER-任务正在执行Reader读操作，WRITER-任务正在执行Writer写操作。 任务本次执行当前阶段的状态 任务本次执行当前阶段的状态，允许如下值：NORMAL-正在运行，NODE_END-本节点正常结束，RUNTIME_CANCEL-任务被取消，TASK_END-本任务正常结束，RUNTIME_ERR-运行时异常，INTERNAL_ERR-内部程序异常。 本次任务执行详细状态 本次任务执行详细状态，使用状态码的形式。 异常数据条数 异常数据条数。 成功数据条数 成功数据条数。 成功数据大小 成功数据大小，浮点数类型。 成功数据大小的计量单位 成功数据大小的计量单位。 执行时长 执行时长，单位：ms。 本次执行详细轨迹信息 本次执行详细轨迹信息。 任务每次执行步骤产生的唯一ID 任务每次执行步骤产生的唯一ID。 当前步骤执行详细状态 当前步骤执行详细状态，使用状态码的形式。 标识当前步骤属于哪一个阶段 标识当前步骤属于哪一个阶段，允许如下值：ADAPTER-任务处于初始化阶段，READER-任务正在执行Reader读操作，WRITER-任务正在执行Writer写操作。 任务当前步骤的状态 任务当前步骤的状态，允许如下值：NORMAL-正在运行，NODE_END-本节点正常结束，RUNTIME_CANCEL-任务被取消，TASK_END-本任务正常结束，RUNTIME_ERR-运行时异常，INTERNAL_ERR-内部程序异常。 标识当前步骤属于哪一个FDI插件 标识当前步骤属于哪一个FDI插件，如adapter，apireader，rdbwriter等。 异常数据条数 异常数据条数。 成功数据条数 成功数据条数。 成功数据大小 成功数据大小，浮点数类型。 成功数据大小的计量单位 成功数据大小的计量单位。 执行时长 执行时长，单位：ms。 执行详细信息 执行详细信息。 本次步骤启动时间 本次步骤启动时间，格式timestamp(ms)，使用UTC时区。 本次步骤结束时间 本次步骤结束时间，格式timestamp(ms)，使用UTC时区。

创建调度计划 创建调度计划。 输入参数 用户配置查询事件通道列表执行动作，相关参数说明如表2所示。 表2 创建调度计划输入参数说明 参数 必填 说明 实例ID 是 实例ID。 任务ID 是 任务ID。 调度计划的执行开始时间 否 调度计划的执行开始时间。 调度计划执行周期的时间单位 否 调度计划执行周期的时间单位，当使用cron表达式时为空。- MIN (分钟) - HOUR (小时) - DAY (日) - WEEK (周) - MON (月)。 调度计划的执行间隔时间周期 否 调度计划的执行间隔时间周期。 调度计划的备注信息 否 调度计划的备注信息。 调度计划是否使用cron表达式 否 调度计划是否使用cron表达式，允许如下值：- true (使用cron表达式)，- false (不使用cron表达式)。 调度计划的cron表达式 否 调度计划的cron表达式。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表3。 表3 创建调度计划输出参数说明 参数 说明 调度计划ID 调度计划ID。 调度计划关联的任务ID 调度计划关联的任务ID。 调度计划的执行开始时间 调度计划的执行开始时间。 调度计划执行周期的时间单位 调度计划执行周期的时间单位，当使用cron表达式时为空。- MIN (分钟) - HOUR (小时) - DAY (日) - WEEK (周) - MON (月)。 调度计划的执行间隔时间周期 调度计划的执行间隔时间周期。 调度计划的创建时间 调度计划的创建时间。 调度计划最近一次的修改时间 调度计划最近一次的修改时间。 调度计划的备注信息 调度计划的备注信息。 调度计划是否使用cron表达式 调度计划是否使用cron表达式，允许如下值：- true (使用cron表达式)，- false (不使用cron表达式)。 调度计划的cron表达式 调度计划的cron表达式。

连接参数 ROMA数据集成连接器使用 IAM 认证，连接参数说明如表1所示。 表1 连接参数说明 名称 必填 说明 示例值/默认值 连接名称 是 设置连接名称。 ROMA数据集成的连接 描述 否 对于连接的信息描述说明。 description 租户名 是 IAM用户所属账号信息。了解账号与IAM用户的关系。 domain 用户名 是 IAM用户名。 name 密码 是 IAM用户的登录密码。 - 区域 是 服务所属区域。 cn-north-4

发送邮件 将邮件发送到指定邮箱。 输入参数 用户配置发送邮件执行动作，相关参数说明如表2所示。 表2 发送邮件输入参数说明 参数 必填 说明 示例值/默认值 收件人 是 收件人邮箱，如果有多个收件人使用逗号隔开。 example@163.com 抄送 否 邮件需要抄送人邮箱。 example1@163.com 密送 否 邮件需要密送人邮箱。 example2@163.com 邮件主题 是 邮件主题。 作业 邮件内容 是 邮件内容。 题目1..... 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表3。 表3 发送邮件输出参数说明 参数 说明 示例值/默认值 操作结果 操作结果描述。 success 操作失败描述 如果发送失败显示。 false

查询云服务器详情列表 根据用户请求条件从数据库筛选，查询所有的弹性云服务器，并关联相关表获取到弹性云服务器的详细信息。支持查询弹性云服务器计费方式，以及是否被冻结。 输入参数 用户配置查询云服务器详情列表执行动作，相关参数说明如表7所示。 表7 查询云服务器详情列表输入参数说明 参数 必填 说明 项目id 是 路径参数，project_id。 企业项目id 否 查询绑定某个企业项目的弹性云服务器。 如果需要查询当前用户所有企业项目绑定的弹性云服务，请传参all_granted_eps。 云服务器规格ID 否 已上线的规格请参见《弹性云服务器用户指南》的“实例和应用场景”章节。 IPv4地址(模糊匹配) 否 IPv4地址过滤结果，匹配规则为模糊匹配。 查询返回云服务器当前页面的大小 否 查询返回云服务器当前页面的大小。每页默认值是25，最多返回1000台云服务器的信息。 云服务器名称 否 云服务器名称，匹配规则为模糊匹配。 查询tag字段中不包含该值的云服务器 否 查询tag字段中不包含该值的云服务器。 页码 否 当前页面数，默认为1。取值大于等于0，取值为0时返回第1页。 批量创建弹性云服务器时，指定返回的ID 否 批量创建弹性云服务器时，指定返回的ID，用于查询本次批量创建的弹性云服务器。 云服务器状态 否 只有管理员可以使用“deleted”状态过滤查询已经删除的弹性云服务器。 查询tag字段中包含该值的云服务器 否 查询tag字段中包含该值的云服务器。 IPv4地址(精确匹配) 否 IPv4地址过滤结果，匹配规则为精确匹配。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表8。 表8 查询云服务器详情列表输出参数说明 参数 说明 列表总数 弹性云服务器的列表总数。 弹性云服务器详情列表 弹性云服务器详情列表，查询级别不同，返回的详情不同。

获取VNC远程登录地址 获取弹性云服务器VNC远程登录地址。 输入参数 用户配置获取VNC远程登录地址执行动作，相关参数说明如表9所示。 表9 获取VNC远程登录地址输入参数说明 参数 必填 说明 项目id 是 路径参数，project_id。 云服务id 是 路径参数，server_id。 远程登录的类型 是 远程登录的类型，请将type配置为“novnc”。 远程登录协议 是 远程登录协议，请将protocol配置为“vnc”。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表10。 表10 获取VNC远程登录地址输出参数说明 参数 说明 弹性云服务器获取远程登录地址 弹性云服务器获取远程登录地址。 远程登录的类型 远程登录的类型。 远程登录的协议 远程登录的协议。 远程登录的url 远程登录的url。

气象预警查询 根据城市名和日期查询相关气象预警信息。 输入参数 用户配置气象预警查询执行动作，相关参数说明如表2所示。 表2 气象预警查询输入参数说明 参数 必填 说明 城市名 是 城市名称(含市)。 查询日期 否 查询日期(yyyy-MM-dd)。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表3。 表3 气象预警查询输出参数说明 参数 说明 返回结果集 返回结果集，无预警信息时返回空。 预警消息标题 预警消息标题。 预警等级 预警等级，橙色/红色/蓝色/黄色/未知。 预警类型 预警类型。 预警发布时间 预警发布时间。 省份 省份，可能为空。 城市 城市，可能为空。 区域 区域，可能为空。 预警详细内容 预警详细内容。

司法拍卖 输入参数 用户配置司法拍卖执行动作，相关参数说明如表20所示。 表20 司法拍卖输入参数说明 参数 必填 说明 关键字 是 关键字（公司名称、公司ID、注册号或社会统一信用代码）。 当前页数 是 当前页数（默认第1页）。 每页条数 是 每页条数（默认20条，最大20条）。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表21。 表21 司法拍卖输出参数说明 参数 说明 结果 结果。 -总数 总数。 -详情 详情。 --图片链接集合 图片链接集合 --拍卖标的 拍卖标的 --公告日期 公告日期 --标的物位置 标的物位置 --起拍价 起拍价（元） --执行法院 执行法院 --公告标题 公告标题 --竞买公告 竞买公告 --评估价 评估价（元） --标的物介绍链接 标的物介绍链接 --附件链接集合 附件链接集合 --拍卖起止时间 拍卖起止时间 --拍卖阶段 拍卖阶段 --竞买须知链接 竞买须知链接 错误信息 错误信息 状态码 状态码

严重违法 输入参数 用户配置严重违法执行动作，相关参数说明如表18所示。 表18 严重违法输入参数说明 参数 必填 说明 关键字 是 关键字（公司名称、公司ID、注册号或社会统一信用代码）。 当前页数 是 当前页数（默认第1页）。 每页条数 是 每页条数（默认20条，最大20条）。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表19。 表19 严重违法输出参数说明 参数 说明 结果 结果。 -总数 总数。 -详情 详情。 --列入原因 列入原因。 --列入决定机关 列入决定机关。 --移除决定机关 移除决定机关。 --移除原因 移除原因。 --id ID。 --列入时间 列入时间。 错误信息 错误信息。 状态码 状态码。

动产抵押 输入参数 用户配置动产抵押执行动作，相关参数说明如表16所示。 表16 动产抵押输入参数说明 参数 必填 说明 关键字 是 关键字（公司名称、公司ID、注册号或社会统一信用代码）。 当前页数 是 当前页数（默认第1页）。 每页条数 是 每页条数（默认20条，最大20条）。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表17。 表17 动产抵押输出参数说明 参数 说明 结果 结果。 -总数 总数。 -详情 详情。 --基本信息 基本信息。 ---被担保债权数额 被担保债权数额。 ---公示日期 公示日期。 ---登记日期 登记日期。 ---备注 备注。 ---被担保债权种类 被担保债权种类。 ---登记机关 登记机关。 ---登记编号 登记编号。 ---担保范围 担保范围。 ---债务人履行债务的期限 债务人履行债务的期限。 ---id ID。 ---注销原因 注销原因。 ---状态 状态。 ---省份 省份。 --抵押权人信息 抵押权人信息。 ---抵押权人证照/证件类型 抵押权人证照/证件类型。 ---抵押权人名称 抵押权人名称。 ---证照/证件号码 证照/证件号码。 --抵押物信息 抵押物信息。 ---名称 名称。 ---所有权归属 所有权归属。 ---备注 备注。 ---数量、质量、状况、所在地等情况 数量、质量、状况、所在地等情况。 --变更信息 变更信息。 ---变更内容 变更内容。 ---变更日期 变更日期。 错误原因 错误原因。 状态码 状态码。

历史股权出质 输入参数 用户配置历史股权出质执行动作，相关参数说明如表12所示。 表12 历史股权出质输入参数说明 参数 必填 说明 关键字 是 关键字（公司名称、公司ID、注册号或社会统一信用代码）。 当前页数 是 当前页数（默认第1页）。 每页条数 是 每页条数（默认20条，最大20条）。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表13。 表13 历史股权出质输出参数说明 参数 说明 结果 结果。 -总数 总数。 -详情 详情。 --质权人列表 质权人列表。 ---公司名 公司名。 ---id ID。 --股权出质设立登记日期 股权出质设立登记日期。 --出质人 出质人。 --质权人证照/证件号码 质权人证照/证件号码。 --质权人 质权人。 --登记编号 登记编号。 --出质人证照/证件号码 出质人证照/证件号码。 --公司列表 公司列表。 ---公司名 公司名。 ---公司id 公司ID。 --出质股权标的企业 出质股权标的企业。 ---公司名 公司名。 ---公司id 公司ID。 --出质人列表 出质人列表。 ---名称 名称。 ---id ID。 --出质股权数额 出质股权数额。 --股权出质id 股权出质ID。 --状态 状态。 --股权出质设立发布日期 股权出质设立发布日期。 错误信息 错误信息。 状态码 状态码。

欠税公告 输入参数 用户配置欠税公告执行动作，相关参数说明如表14所示。 表14 欠税公告输入参数说明 参数 必填 说明 关键字 是 关键字（公司名称、公司ID、注册号或社会统一信用代码） 当前页数 是 当前页数（默认第1页） 每页条数 是 每页条数（默认20条，最大20条） 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表15。 表15 欠税公告输出参数说明 参数 说明 结果 结果。 -总数 总数。 -详情 详情。 --纳税人识别号 纳税人识别号。 --当前新发生欠税余额 当前新发生欠税余额。 --欠税金额 欠税金额。 --发布时间 发布时间。 --欠税余额 欠税余额。 --税务类型 税务类型。 --证件号码 证件号码。 --欠税税种 欠税税种。 --纳税人类型 纳税人类型。 --法人证件名称 法人证件名称。 --纳税人名称 纳税人名称。 --经营地点 经营地点。 --税务机关 税务机关。 --注册类型 注册类型。 --法人或负责人名称 法人或负责人名称。 错误信息 错误信息。 状态码 状态码。

股权出质 输入参数 用户配置股权出质执行动作，相关参数说明如表10所示。 表10 股权出质输入参数说明 参数 必填 说明 关键字 是 关键字（公司名称、公司ID、注册号或社会统一信用代码）。 当前页数 是 当前页数（默认第1页）。 每页条数 是 每页条数（默认20条，最大20条）。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表11。 表11 股权出质输出参数说明 参数 说明 结果 结果。 -总数 总数。 -详情 详情。 --质权人列表 质权人列表。 ---公司名 公司名。 ---公司id 公司ID。 --股权出质设立登记日期 股权出质设立登记日期。 --出质人 出质人。 --质权人证照/证件号码 质权人证照/证件号码。 --质权人 质权人。 --登记编号 登记编号。 --出质人证照/证件号码 出质人证照/证件号码。 --公司列表 公司列表。 ---公司名 公司名。 ---公司id 公司ID。 --出质股权标的企业 出质股权标的企业。 ---公司名 公司名。 ---公司id 公司ID。 --出质人列表。 出质人列表。 ---名称 名称。 ---出质人id 出质人ID。 --出质股权数额 出质股权数额。 --股权出质id 股权出质ID。 --状态 状态。 --股权出质设立发布日期 股权出质设立发布日期。 错误信息 错误信息。 错误码 错误码。

历史经营异常 输入参数 用户配置经营异常执行动作，相关参数说明如表8所示。 表8 历史经营异常输入参数说明 参数 必填 说明 关键字 是 关键字（公司名称、公司ID、注册号或社会统一信用代码）。 当前页数 是 当前页数（默认第1页）。 每页条数 是 每页条数（默认20条，最大20条）。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表9。 表9 历史经营异常输出参数说明 参数 说明 结果 结果。 -总数 总数。 -详细 详细。 --移出日期 移出日期。 --列入异常名录原因 列入异常名录原因。 --创建时间 创建时间 --作出决定机关 作出决定机关 --决定移出部门 决定移出部门。 --移出经营异常名录原因 移出经营异常名录原因。 --异常id 异常ID。 --列入日期 列入日期。 错误信息 错误信息。 错误码 错误码。

经营异常 输入参数 用户配置经营异常执行动作，相关参数说明如表6所示。 表6 经营异常输入参数说明 参数 必填 说明 关键字 是 关键字（公司名称、公司ID、注册号或社会统一信用代码）。 当前页数 是 当前页数（默认第1页）。 每页条数 是 每页条数（默认20条，最大20条）。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表7。 表7 经营异常输出参数说明 参数 说明 结果 结果。 -总数 总数。 -详细 详细。 --移出日期 移出日期。 --列入异常名录原因 列入异常名录原因。 --决定列入异常名录部门 决定列入异常名录部门（作出决定机关）。 --移出部门 移出部门。 --移除异常名录原因 移除异常名录原因。 --列入日期 列入日期。 错误信息 错误信息。 错误码 错误码。

历史行政处罚 输入参数 用户配置历史行政处罚执行动作，相关参数说明如表4所示。 表4 历史行政处罚输入参数说明 参数 必填 说明 关键字 是 关键字（公司名称、公司ID、注册号或社会统一信用代码）。 当前页数 是 当前页数（默认第1页）。 每页条数 是 每页条数（默认20条，最大20条）。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表5。 表5 历史行政处罚输出参数说明 参数 说明 结果 结果。 -总数 总数。 -详细 详细。 --处罚单位 处罚单位。 --处罚事由/违法行为类型 处罚事由/违法行为类型。 --处罚依据 处罚依据。 --处罚状态 处罚状态。 --备注 备注。 --数据来源 数据来源。 --处罚类别 处罚类别。 --处罚结果/内容 处罚结果/内容。 --处罚日期 处罚日期。 --国家市场监督管理总局时返回数据 国家市场监督管理总局时返回数据。 --处罚名称 处罚名称。 --决定文书号 决定文书号。 --处罚类别2 处罚类别2。 错误信息 错误信息。 错误码 错误码。

周边停车场查询 周边停车场查询。 输入参数：包含“页码”、“页码”、“距离范围”必填参数。“纬度”、“经度”选填参数。 输出参数：包含“响应内容”、“总数”、“停车场详细信息”、“区域”、“地址”、“经度”、“停车场图片列表”、“范围”、“城市名”、“总数车位”、“收费描述”、“停车ID”、“停车场类型”、“剩余车位”、“是否预定”、“省份”、“价格”、“价格单位”、“停车场名称”、“纬度”参数。

收货地址解析 从文本中解析出收货人信息，如姓名、联系电话、具体地址、邮编号码等具体信息。 输入参数 用户配置收货地址解析执行动作，相关参数说明如表2所示。 表2 收货地址解析输入参数说明 参数 必填 说明 示例值/默认值 待解析文本 是 输入需要解析的文本内容。 马云13800138000杭州市滨江区网商路699号。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表3。 表3 收货地址解析输出参数说明 参数 说明 示例值/默认值 移动电话号码 收货人电话号码。 13800138000 收货人姓名 收货人姓名。 马云 省/特区/自治区/直辖市 该地址所在的省。 浙江省 城市 该地址所在的城市。 杭州市 县区 该地址所在位置的县区。 滨江区 邮编 邮编（文本中优先否则默认区县级）。 310052 完整地址 收货具体地址。 浙江省杭州市滨江区网商路699号

获取打卡记录数据 获取打卡的记录数据。 输入参数 输入参数说明如表43所示。 表43 获取打卡记录数据输入参数说明 参数 必填 说明 获取打卡记录的结束时间 是 获取打卡记录的结束时间，unix时间戳。 打卡类型 是 打卡类型。 上下班打卡 外出打卡 全部打卡 获取打卡记录的开始时间 是 获取打卡记录的开始时间，unix时间戳。 调用接口凭证 是 调用接口凭证。必须使用打卡应用的secret获取access_token。 需要获取打卡记录的用户列表 是 需要获取打卡记录的用户列表。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表44。 表44 获取打卡记录数据输出参数说明 参数 说明 errcode 返回码。 errmsg 返回码的描述内容。 checkindata 检查数据。 -userid 用户ID。 -groupname 打卡规则名称。 -checkin_type 打卡类型。目前包含以下几种： 上班打卡 下班打卡 外出打卡 -exception_type 异常类型。如果有多个异常，以分号间隔。 异常情况包含以下情形： 时间异常 地点异常 未打卡 wifi异常 非常用设备 -checkin_time 打卡时间，unix时间戳。 -location_title 打卡地点title。 -location_detail 打卡地点详情。 -wifiname 打卡wifi名称。 -notes 打卡备注。 -wifimac 打卡的MAC地址/bssid。 -mediaids 打卡的附件media_id，可使用media/get获取附件。 -sch_checkin_time 标准打卡时间，指此次打卡时间对应的标准上班时间或标准下班时间。 -groupid 规则ID，表示打卡记录所属规则的ID。 -schedule_id 班次ID，表示打卡记录所属规则中，所属班次的ID。 -timeline_id 时段ID，表示打卡记录所属规则中，某一班次中的某一时段的ID，如上下班时间为9:00-12:00、13:00-18:00的班次中，9:00-12:00为其中一组时段。 -lat 位置打卡地点维度，是实际维度的1000000倍，与腾讯地图一致采用GCJ-02坐标系统标准。 -lng 位置打卡地点经度，是实际经度的1000000倍，与腾讯地图一致采用GCJ-02坐标系统标准。 -deviceid 打卡设备ID。

删除部门 删除部门信息。 输入参数 输入参数说明如表37所示。 表37 删除部门输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。 部门id 是 部门ID。 说明： 不能删除根部门，不能删除含有子部门、成员的部门。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表38。 表38 删除部门输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。

获取成员信息 在通讯录同步助手中此接口可以读取企业通讯录的所有成员的信息，而自建应用可以读取该应用设置的可见范围内的成员信息。 输入参数 输入参数说明如表41所示。 表41 获取成员信息输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。 成员UserID 是 成员UserID。对应管理端的账号，企业内必须唯一。不区分大小写，长度为1~64个字节。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表42。 表42 获取成员信息输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。 成员UserID 成员UserID。对应管理端的账号，企业内必须唯一。不区分大小写，长度为1~64个字节。 成员名称 成员名称；第三方不可获取，调用时返回userid以代替name，代开发自建应用需要管理员授权才返回。对于非第三方创建的成员，第三方通讯录应用也不可获取。未返回name的情况需要通过通讯录展示组件来展示名字。 手机号码 手机号码，代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 成员所属部门id列表 成员所属部门ID列表，仅返回该应用有查看权限的部门ID；成员授权模式下，固定返回根部门ID，即固定为1。对授权了“组织架构信息”权限的第三方应用，返回成员所属的全部部门ID。 部门内的排序值 部门内的排序值，默认为0。数量必须和department一致，数值越大排序越前面。值范围是0, 2^32)。[成员授权模式下不返回该字段。 职务信息 职务信息。代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 性别 性别。0表示未定义，1表示男性，2表示女性。第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。不可获取指返回值0。 邮箱 邮箱，代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 企业邮箱 企业邮箱，代开发自建应用不返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 表示在所在的部门内是否为部门负责人 表示在所在的部门内是否为部门负责人，数量与department一致；第三方通讯录应用或者授权了“组织架构信息-应用可获取企业的部门组织架构信息-部门负责人”权限的第三方应用可获取；对于非第三方创建的成员，第三方通讯录应用不可获取；上游企业不可获取下游企业成员该字段。 直属上级UserID 直属上级UserID，返回在应用可见范围内的直属上级列表，最多有五个直属上级；第三方通讯录应用或者授权了“组织架构信息-应用可获取可见范围内成员组织架构信息-直属上级”权限的第三方应用可获取；对于非第三方创建的成员，第三方通讯录应用不可获取；上游企业不可获取下游企业成员该字段。 头像url 头像url。 第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 头像缩略图url 头像缩略图url。第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 座机 座机。代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 别名 别名；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 地址 地址。代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 全局唯一 全局唯一。对于同一个服务商，不同应用获取到企业内同一个成员的open_userid是相同的，最多64个字节。仅第三方应用可获取。 主部门 主部门，仅当应用对主部门有查看权限时返回。 扩展属性 扩展属性，代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 激活状态 激活状态。 1：已激活 2：已禁用 4：未激活 5：退出企业 已激活代表已激活企业微信或已关注微信插件（原企业号）。未激活代表既未激活企业微信又未关注微信插件（原企业号）。 员工个人二维码 员工个人二维码，扫描可添加为外部联系人(注意返回的是一个url，可在浏览器上打开该url以展示二维码)；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 对外职务 对外职务，如果设置了该值，则以此作为对外展示的职务，否则以position来展示。代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 成员对外属性 成员对外属性，字段详情见对外属性；代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。

创建成员 创建成员信息。 输入参数 输入参数说明如表33所示。 表33 创建成员输入参数说明 参数 必填 说明 属性名称 是 属性名称。 需要先确保在管理端有创建该属性，否则会忽略。 文本属性内容 是 文本属性内容，长度限制64个UTF8字符。 属性类型 是 属性类型。 0：文本 1：网页 2：小程序 网页的展示标题 是 网页的展示标题，长度限制12个UTF8字符。 网页的url 是 网页的url。必须包含http或者https头。 external_corp_name 否 external_corp_name。 成员名称 是 成员名称。长度为1~64个utf8字符。 成员UserID 是 成员UserID。对应管理端的账号，企业内必须唯一。 长度为1~64个字节。只能由数字、字母和“_-@.”四种字符组成，且第一个字符必须是数字或字母。系统进行唯一性检查时会忽略大小写。 调用接口凭证 是 调用接口凭证。 成员所属部门id列表 否 成员所属部门ID列表，不超过100个。 attrs 否 请选择数组类型的节点输出。 external_attr 否 请选择数组类型的节点输出。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表34。 表34 创建成员输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。

获取子部门ID列表 该接口用于获取子部门的ID列表。 输入参数 输入参数说明如表29所示。 表29 获取子部门ID列表输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。必须使用打卡应用的secret获取access_token。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表30。 表30 获取子部门ID列表输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。 部门列表数据 部门列表数据。 -id 创建的部门ID。 -parentid 父部门ID。根部门为1。 -order 在父部门中的次序值。order值大的排序靠前。值范围是[0, 2^32]。

获取单个部门详情 获取单个部门详情。 输入参数 输入参数说明如表31所示。 表31 获取单个部门详情输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。必须使用打卡应用的Secret获取access_token。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表32。 表32 获取单个部门详情输出参数说明 参数 说明 返回码 返回码。 返回码描述 对返回码的文本描述内容。 部门详情 部门详情。 -id 创建的部门ID。 -name 部门名称，代开发自建应用需要管理员授权才返回。 -name_en 英文名称。 -department_leader 部门负责人的UserID；第三方仅通讯录应用可获取。 -parentid 父部门ID。根部门为1。 -order 在父部门中的次序值。order值大的排序靠前。 值范围是[0, 2^32]。

获取部门列表 获取部门列表。 输入参数 输入参数说明如表27所示。 表27 获取部门列表输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。必须使用打卡应用的secret获取access_token。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表28。 表28 获取部门列表输出参数说明 参数 说明 返回码 返回码。 返回码描述 对返回码的文本描述内容。 部门详情 部门详情。 -id 创建的部门ID。 -name 部门名称，代开发自建应用需要管理员授权才返回。 -name_en 英文名称。 -department_leader 部门负责人的UserID；第三方仅通讯录应用可获取。 -parentid 父部门ID。根部门为1。 -order 在父部门中的次序值。order值大的排序靠前。 取值范围是[0, 2^32]。

获取指定日程 该接口用于获取指定的日程详情。 输入参数 输入参数说明如表25所示。 表25 获取指定日程输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。必须使用打卡应用的Secret获取access_token。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表26。 表26 获取指定日程输出参数说明 参数 说明 返回码 返回码。 返回码描述 对返回码的文本描述内容。 日程列表 日程列表。 -schedule_id 日程ID。 -organizer 组织者不多于64字节。 -attendees 日程参与者列表。最多支持2000人。 --userid 日程参与者ID。 --response_status 日程参与者的接受状态。 0：未处理 1：待定 2：全部接受 3：仅接受一次 4：拒绝 -summary 日程标题。 -description 日程描述。 -reminders 提醒相关信息。 --is_remind 是否需要提醒。 0：否 1：是 --is_repeat 是否重复日程。 0：否 1：是 --remind_before_event_secs 日程开始（start_time）前多少秒提醒。 当is_remind为1时有效。 --remind_time_diffs 日程开始（start_time）与提醒时间的差值。 当is_remind为1时有效。 --repeat_type 重复类型，当is_repeat为1时有效。 目前支持如下类型： 0：每日 1：每周 2：每月 5：每年 7：工作日 --repeat_until 重复结束时刻，Unix时间戳。 不填或填0表示一直重复。 --is_custom_repeat 是否自定义重复。 0：否 1：是 --repeat_interval 重复间隔仅当指定为自定义重复时有效该字段随repeat_type不同而含义不同。 --repeat_day_of_week 每周周几重复仅当指定为自定义重复且重复类型为每周时有效。 取值范围：1~7，分别表示周一至周日。 --repeat_day_of_month 每月哪几天重复仅当指定为自定义重复且重复类型为每月时有效。 取值范围：1~31，分别表示1~31号。 --timezone 时区。UTC偏移量表示(即偏离零时区的小时数)，东区为正数，西区为负数。 --exclude_time_list 重复日程不包含的日期列表。对重复日程修改/删除特定一天或多天，则原来的日程将会排除对应的日期。 ---start_time 不包含的日期时间戳。 -location 日程地址不多于128个字符。 -cal_id 日程所属日历ID。该日历必须是access_token所对应应用所创建的日历。 -start_time 日程开始时间，unix时间戳。 -end_time 日程结束时间，unix时间戳。 -status 日程状态。 0：正常 1：已取消

获取部门成员列表 该接口用于获取部门成员列表。 输入参数 输入参数说明如表23所示。 表23 获取部门成员列表输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。必须使用打卡应用的secret获取access_token。 获取的部门id 是 获取的部门ID。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表24。 表24 获取部门成员列表输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。 成员列表 成员列表。 -userid 成员UserID。对应管理端的账号。 -name 成员名称，代开发自建应用需要管理员授权才返回。 -department 成员所属部门列表。列表项为部门ID，32位整型。 -open_userid 全局唯一。对于同一个服务商，不同应用获取到企业内同一个成员的open_userid是相同的，最多64个字节。仅第三方应用可获取。

获取部门成员列表详情 该接口用于获取部门成员列表详情信息。 输入参数 输入参数说明如表21所示。 表21 获取部门成员列表详情输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。必须使用打卡应用的Secret获取access_token。 获取的部门id 是 获取的部门ID。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表22。 表22 获取部门成员列表详情输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。 成员详情列表 成员详情列表。 -userid 成员UserID。对应管理端的账号。 -name 成员名称，第三方不可获取，调用时返回userid以代替name；代开发自建应用需要管理员授权才返回；对于非第三方创建的成员，第三方通讯录应用也不可获取；未返回名称的情况需要通过通讯录展示组件来展示名字。 -department 成员所属部门列表。仅返回该应用有查看权限的部门ID。对授权了“组织架构信息”的第三方应用，返回成员所属的全部部门ID列表。 -order 部门内的排序值，默认为0。数量必须和department一致，数值越大排序越前面。值范围是[0, 2^32]。 -position 职务信息，代开发自建应用需要管理员授权才返回。 -mobile 手机号码，代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 -gender 性别。0表示未定义，1表示男性，2表示女性。第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。注：不可获取指返回值为0。 -email 邮箱，代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 -biz_mail 企业邮箱，代开发自建应用不返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 -is_leader_in_dept 表示在所在的部门内是否为部门负责人。0表示否；1表示是。是一个列表，数量必须与department一致。第三方通讯录应用或者授权了“组织架构信息-应用可获取企业的部门组织架构信息-部门负责人”权限的第三方应用可获取；对于非第三方创建的成员，第三方通讯录应用不可获取；上游企业不可获取下游企业成员该字段。 -direct_leader 直属上级UserID，返回在应用可见范围内的直属上级列表，最多有五个直属上级；第三方通讯录应用或者授权了“组织架构信息-应用可获取可见范围内成员组织架构信息-直属上级”权限的第三方应用可获取；对于非第三方创建的成员，第三方通讯录应用不可获取；上游企业不可获取下游企业成员该字段。 -avatar 头像url。 第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 -thumb_avatar 头像缩略图url。第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 -telephone 座机。代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 -alias 别名；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 -status 激活状态: 1=已激活，2=已禁用，4=未激活，5=退出企业。已激活代表已激活企业微信或已关注微信插件（原企业号）。未激活代表既未激活企业微信又未关注微信插件（原企业号）。 -address 地址。代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 -hide_mobile 隐藏手机。 -english_name 英文名字。 -open_userid 扩展属性，代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 -main_department 扩展属性，代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 -extattr 扩展属性，代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 -qr_code 员工个人二维码，扫描可添加为外部联系人(注意返回的是一个url，可在浏览器上打开该url以展示二维码)；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 -external_position 对外职务，如果设置了该值，则以此作为对外展示的职务，否则以position来展示。代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 -external_profile 成员对外属性，字段详情见对外属性；代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。

获取指定日历 该接口用于获取应用在企业内创建的日历信息。 输入参数 输入参数说明如表19所示。 表19 获取指定日历输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。必须使用打卡应用的Secret获取access_token。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表20。 表20 获取指定日历输出参数说明 参数 说明 错误码 错误码。 错误码说明 错误码说明。 日历列表 日历列表。 -cal_id 日历ID。 -organizer 指定的组织者userid。 -readonly 日历组织者对日历是否只读权限。 0：否 1：是 -summary 日历标题。标题长度为1~128 字符。 -color 日历颜色，用RGB颜色编码16进制表示。 例如：#0000FF表示纯蓝色。 -description 日历描述。长度为0~512 字符。 -shares 日历共享成员列表。共享成员最多2000人。 --userid 日历共享成员的ID。 --readonly 共享成员对日历是否只读权限。 0：否 1：是

创建日程 该接口用于在日历中创建一个日程。 输入参数 输入参数说明如表15所示。 表15 创建日程输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。 organizer 是 组织者，组织者不多于64字节。 start_time 是 日程开始时间，Unix时间戳。 end_time 是 日程结束时间，Unix时间戳。 summary 否 日程标题，0~128 字符。不填会默认显示为“新建事件”。 description 否 日程描述不多于512个字符。 is_remind 否 是否需要提醒。 0：否 1：是 remind_before_event_secs 否 日程开始（start_time）前多少秒提醒，当is_remind为1时有效。例如：300表示日程开始前5分钟提醒。目前仅支持以下数值： 0：事件开始时 300：事件开始前5分钟 900：事件开始前15分钟 3600：事件开始前1小时 86400：事件开始前1天 is_repeat 否 是否重复日程。 0：否 1：是 repeat_type 否 重复类型，当is_repeat为1时有效。目前支持如下类型： 0：每日 1：每周 2：每月 5：每年 7：工作日 repeat_until 否 重复结束时刻，Unix时间戳。不填或填0表示一直重复。 is_custom_repeat 否 是否自定义重复。 0：否 1：是 repeat_interval 否 重复间隔仅当指定为自定义重复时有效该字段随repeat_type不同而含义不同，例如： repeat_interval指定为3，repeat_type指定为每周重复，那么每3周重复一次repeat_interval指定为3，repeat_type指定为每月重复，那么每3个月重复一次 timezone 否 时区。UTC偏移量表示(即偏离零时区的小时数)，东区为正数，西区为负数。例如：+8 表示北京时间东八区默认为北京时间东八区。 取值范围：-12~+12 location 否 日程地址，不多于128个字符。 cal_id 否 日程所属日历ID。该日历必须是access_token所对应应用所创建的日历。注意，这个日历必须是属于组织者(organizer)的日历；如果不填，那么插入到组织者的默认日历上。第三方应用必须指定cal_id不多于64字节。 授权方安装的应用agentid 否 授权方安装的应用agentid。仅旧的第三方多应用套件需要填此参数。 attendees 是 日程参与者列表。最多支持2000人。 repeat_day_of_week 否 每周周几重复仅当指定为自定义重复且重复类型为每周时有效取值范围：1~7，分别表示周一至周日。 repeat_day_of_month 否 每月哪几天重复仅当指定为自定义重复且重复类型为每月时有效取值范围：1~31，分别表示1~31号。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表16。 表16 创建日程输出参数说明 参数 说明 返回码 返回码。 返回码描述 返回码描述。 日程ID 日程ID。