华为云用户手册

批量启动或停止任务 批量启动或停止任务。 输入参数 用户配置批量启动或停止任务执行动作，相关参数说明如表16所示。 表16 批量启动或停止任务输入参数说明 参数 必填 说明 实例ID 是 实例ID。 操作类型 否 操作类型：- start (启动)，- stop (停止)。 任务ID列表 否 需要启动或者停止的任务ID列表。 任务ID 否 任务ID，可为空。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表17。 表17 批量启动或停止任务输出参数说明 参数 说明 成功个数 成功的个数。 失败个数 失败的个数。 失败详情 失败的详情。 任务ID 任务ID。 任务名称 任务名称。 失败错误码 失败的错误码。 错误详情 错误详情。 成功的任务信息 成功的任务信息。 任务ID 任务ID。 任务名称 任务名称。 失败的错误码 失败的错误码。 错误详情 错误详情。

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

创建调度计划 创建调度计划。 输入参数 用户配置查询事件通道列表执行动作，相关参数说明如表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表达式。

任务监控日志查询 查询单个任务的所有日志信息。 输入参数 用户配置任务监控日志查询执行动作，相关参数说明如表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-执行中，SUCCESS-执行成功，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 发送邮件输入参数说明 参数 必填 说明 示例值/默认值 收件人 是 收件人邮箱，如果有多个收件人使用逗号隔开。 example@163.com 抄送 否 邮件需要抄送人邮箱。 example1@163.com 密送 否 邮件需要密送人邮箱。 example2@163.com 邮件主题 是 邮件主题。 作业 邮件内容 是 邮件内容。 题目1..... 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参考表3。 表3 发送邮件输出参数说明 参数 说明 示例值/默认值 操作结果 操作结果描述。 success 操作失败描述 如果发送失败显示。 false

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

操作指引 图1 模型中心操作指引 表1 模型中心操作指引详解 序号 流程环节 说明 1 创建数据集 创建微调数据集 用户根据需要创建微调数据集，用于模型微调。 标注数据 用户可以将数据集中的某些元素进行标记或分类，以便模型可以更好地理解和使用这些数据。 2 创建提示语 选择平台预置提示语或自定义提示语 用户根据需要选择平台预置的提示语模板或自定义提示语模板，可在创建应用、调测模型中快速引用。 优化提示语 针对提示语进行结构、排版、内容等维度进行优化和改进，将大模型的输入限定在了一个特定的范围之中，进而更好地控制模型的输出。 3 调优大模型 创建模型微调流水线 通过选择合适的数据集，调整参数，训练平台预置的模型以调优模型效果，可通过训练过程/结果指标初步判断调优效果。 创建模型服务 模型需要部署成功后才可正式提供模型推理服务，平台支持将微调后的模型、系统预置的模型以及通过自建模型服务接入的模型发布为模型服务。调测模型、应用调用均需先部署模型（即部署模型服务）。 调测模型 通过调测模型，检验模型的准确性、可靠性及反应效果，发现模型中存在的问题和局限性。

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

使用流程 按照不同的使用场景，运营中心使用流程如图1所示。 图1 使用流程 使用场景一：数据工程师/分析师支撑或配合业务提出的数据相关需求，完成一些相对复杂的数据接入、数据建模以及数据指标开发的工作。 新建数据接入：运营中心提供通用数据接入能力，通过与数据源连接，可以建立数据源中数据表的迁移任务，将源端数据迁移到运营中心，为后续业务做数据准备。 新建数据模型：运营中心提供数据建模能力，运营人员可以自定义数据模型，也可以通过逆向数据库生成数据模型。通过提供多表关联建模整合表能力，一个数据模型可以映射多个数据表数据。 新建指标：运营中心提供指标自定义灵活配置能力，可以配置普通指标和复合指标，基于数据模型，通过计算方式、计算时间单位、统计维度、筛选条件组合配置指标。 自定义运营看板：通过自定义运营看板，可以把产品运营中的关键数据统一呈现出来，可按人员权限和业务类型展示不同的数据看板，可视化展现产品运营现状。 看板：运营中心提供看板功能，产品运营人员能直观查看关键数据，分析产品运营过程中取得的成效和潜在问题。 使用场景二：业务分析者/执行者（如产品经理、运营人员等）根据业务诉求快速生成、查看各类数据报表。 新建数据接入：运营中心提供通用数据接入能力，通过与数据源连接，可以建立数据源中数据表的迁移任务，将源端数据迁移到运营中心，为后续业务做数据准备。 应用指标模板：运营中心提供指标模板应用能力，模板中内置数据模型、指标定义、图表卡片等经验内容。运营中心通过提供多场景模板，以场景驱动一键应用，赋能用户低门槛、高效率地构建指标体系。 自定义运营看板：通过自定义运营看板，可以把产品运营中的关键数据统一呈现出来，可按人员权限和业务类型展示不同的数据看板，可视化展现产品运营现状。 看板：运营中心提供看板功能，产品运营人员能直观查看关键数据，分析产品运营过程中取得的成效和潜在问题。 使用场景三：业务决策者（如领导、业务负责人等）基于全场景看板随时随地直观查看关键数据，分析产品运营过程中取得的成效和潜在问题。 父主题： 运营中心简介

获取成员信息 在通讯录同步助手中此接口可以读取企业通讯录的所有成员的信息，而自建应用可以读取该应用设置的可见范围内的成员信息。 输入参数 输入参数说明如表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来展示。代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。 成员对外属性 成员对外属性，字段详情见对外属性；代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。

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

获取打卡记录数据 获取打卡的记录数据。 输入参数 输入参数说明如表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。

获取子部门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]。

创建成员 创建成员信息。 输入参数 输入参数说明如表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 创建成员输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。

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

获取指定日程 该接口用于获取指定的日程详情。 输入参数 输入参数说明如表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：已取消

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

获取指定日历 该接口用于获取应用在企业内创建的日历信息。 输入参数 输入参数说明如表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：是

获取部门成员列表详情 该接口用于获取部门成员列表详情信息。 输入参数 输入参数说明如表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 成员对外属性，字段详情见对外属性；代开发自建应用需要管理员授权才返回；第三方仅通讯录应用可获取；对于非第三方创建的成员，第三方通讯录应用也不可获取；上游企业不可获取下游企业成员该字段。

更新日程 该接口用于在日历中更新指定的日程。 输入参数 输入参数说明如表17所示。 表17 更新日程输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。 organizer 否 组织者不多于64字节。 schedule_id 是 日程ID。创建日程时返回的ID。 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个字符。 skip_attendees 否 忽略掉attendees参数，只更新其他参数，默认值是false。 attendees 否 日程参与者列表。最多支持2000人。 repeat_day_of_week 否 每周周几重复仅当指定为自定义重复且重复类型为每周时有效取值范围：1~7，分别表示周一至周日。 repeat_day_of_month 否 每月哪几天重复仅当指定为自定义重复且重复类型为每月时有效取值范围：1~31，分别表示1~31号。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表18。 表18 更新日程输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。

删除指定日历 该接口用于删除指定日历。 输入参数 输入参数说明如表11所示。 表11 删除指定日历输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。 body 否 删除指定日历的参数body体。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表12。 表12 删除指定日历输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。

更新日历 该接口用于修改指定日历的信息。 输入参数 输入参数说明如表9所示。 表9 更新日历输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。 cal_id 是 日历ID。 readonly 否 日历组织者对日历对否只读权限。即不可编辑日历，不可在日历上添加日程，仅可作为组织者删除日历。 0：否 1：是 默认为1，只有只读权限。 summary 是 日历标题。标题长度为1~128 字符。 color 是 日历颜色，用RGB颜色编码16进制表示。 例如：#0000FF表示纯蓝色。 description 否 日历描述信息。 shares 是 日历共享成员的ID。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表10。 表10 更新日历输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。

创建日程 该接口用于在日历中创建一个日程。 输入参数 输入参数说明如表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。

创建日历 该接口用于通过应用在企业内创建一个日历。 输入参数 输入参数说明如表7所示。 表7 创建日历输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。 organizer 是 指定的组织者userID。注意该字段指定后不可更新。 readonly 否 日历组织者对日历对否只读权限。即不可编辑日历，不可在日历上添加日程，仅可作为组织者删除日历。 0：否 1：是 默认为1，只有只读权限。 set_as_default 否 是否将该日历设置为组织者的默认日历。 0：否 1：是。 默认为0，即不设为默认日历第三方应用不支持使用该参数。 summary 否 日历标题。标题长度为1~128 字符。 color 否 日历颜色，用RGB颜色编码16进制表示。 例如：#0000FF表示纯蓝色。 description 否 日历描述信息。 安装的应用agentid 否 授权方安装的应用agentid。仅旧的第三方多应用套件需要填此参数。 shares 否 日历共享成员列表。最多2000人。系统支持数组和输入框两种模式。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表8。 表8 创建日历输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。

删除成员 删除企业微信成员，仅通讯录同步助手或第三方通讯录应用可调用。如果是绑定了腾讯企业邮，则会同时删除邮箱账号。 输入参数 输入参数说明如表1所示。 表1 删除成员输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。 成员UserID 是 成员UserID。对应管理端的账号，企业内必须唯一。不区分大小写，长度为1~64个字节。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表2。 表2 删除成员输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。

批量删除成员 批量删除成员的信息。 输入参数 输入参数说明如表3所示。 表3 批量删除成员输入参数说明 参数 必填 说明 调用接口凭证 是 调用接口凭证。 body 否 请选择数组类型的节点输出。系统支持数组和输入框两种格式。 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表4。 表4 批量删除成员输出参数说明 参数 说明 返回码 返回码。 对返回码的文本描述内容 对返回码的文本描述内容。

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

近期赛程查询 根据联赛类型，查询近期赛程赛果。 输入参数 输入参数说明如表2所示。 表2 近期赛程查询输入参数说明 参数 必填 说明 足球联赛类型 是 足球联赛类型，支持输入框和下拉列表两种模式。 西甲 德甲 英超 意甲 法甲 中超 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表3。 表3 近期赛程查询输出参数说明 参数 说明 返回码 返回码。 返回说明 返回说明。 返回结果集 返回结果集。 -足球联赛名称 足球联赛的名称。 -联赛赛季 足球联赛的赛季。 -赛事清单 足球联赛的赛事清单。 --比赛日期 足球联赛的比赛日期。 --星期 足球联赛的星期。 --赛事场次 足球联赛的赛事场次。 ---比赛开始时间 足球联赛每场赛事的比赛开始时间。 ---比赛状态 足球联赛每场赛事的比赛状态。 ---比赛状态描述 足球联赛每场赛事的比赛状态描述 ---队伍1 足球联赛每场赛事的队伍1 ---队伍2 足球联赛每场赛事的队伍2 ---队伍1比分 足球联赛每场赛事的队伍1比分 ---队伍2比分 足球联赛每场赛事的队伍2比分

联赛积分榜 根据联赛类型，查询积分榜排名。 输入参数 输入参数说明如表4所示。 表4 联赛积分榜输入参数说明 参数 必填 说明 足球联赛类型 是 足球联赛类型，支持输入框和下拉列表两种模式。 西甲 德甲 英超 意甲 法甲 中超 输出参数 用户可以在之后的执行动作中调用该输出参数，输出参数说明请参见表5。 表5 联赛积分榜输出参数说明 参数 说明 返回码 返回码。 返回说明 返回说明。 返回结果集 返回结果集。 -足球联赛名称 足球联赛的名称。 -联赛赛季 足球联赛的赛季。 -联赛积分排名情况 足球联赛的积分排名情况。 --排名 足球联赛的排名。 --球队名称 足球联赛的球队名称。 --胜场 足球联赛的比赛胜场。 --败场 足球联赛的比赛败场。 --平局 足球联赛的比赛平局。 --进球数 足球联赛的每场比赛的进球数 --失球数 足球联赛的每场比赛的失球数 --净胜球 足球联赛的每场比赛的净胜球 --积分 足球联赛的比赛积分