# 日程创建
# host: https://yach-oapi.zhiyinlou.com 正式环境
# host: https://yach-oapi-test.zhiyinlou.com 测试环境
# 概述
名称 | 值 |
---|---|
地址 | /v2/schedule/events/create?access_token=ACCESS_TOKEN |
请求方式 | POST |
参数 | 见【参数】 |
返回值 | 见【返回值】 |
# 参数
参数名 | 参数类型 | 是否必须 | 说明 |
---|---|---|---|
access_token | String | 是 | 调用接口凭证 |
biz_id | String | 是 | 业务方唯一ID,最长64个字符 |
title | String | 是 | 日程标题,最大长度100字符 |
start_time | Int | 是 | 开始时间戳,单位是毫秒,示例:1606709410791 |
end_time | Int | 是 | 结束时间戳,单位是毫秒,示例:1606709410791 |
participant | String | 是 | 日程参与用户的工号列表,半角逗号分隔 |
timestamp | Int | 是 | 当前时间戳,单位是毫秒,示例:1606709410791 |
workcode | String | 是 | 日程创建人用户工号 |
meeting_type | String | 否 | 会议类型(0:线下1:线上,默认1),当为线下模式时,会议相关参数不生效 |
meeting_client(server_type) | String | 否 | 会议客户端类型(zoom,tencent,默认tencent) |
schedule_type | String | 否 | 日程类型(0:普通日程,1:面试日程,3:moka 面试日程,默认0) |
meeting_param | String | 否 | 会议相关的参数,json字符串,只有meeting_client传tencent时该参数生效,比如 {"tencent":{"visible_list":"{"123445":"001,002"}","sdk_id":"2132323","auto_open_sdkid":"2132323","auto_record_type":1},"zoom":{}},目前仅支持tencet和zoom |
└ tencent | String | 否 | 腾讯会议相关参数,仅当meeting_client为tencent时该参数生效 |
└ └sdk_id | string | 否 | 腾讯自建应用ID,如果有自建应用需要绑定则必须传,多个用半角逗号分隔 |
└ └meeting_id | string | 否 | 腾讯会议id,moka 面试日程必传 |
└ └meeting_code | string | 否 | 腾讯会议code,moka 面试日程必传 |
└└auto_open_sdkid | string | 否 | 开启会议后自动打开的应用ID,如果不需要可以不传,一次只能打开一个,如果传了该字段,则sdk_id为必传 |
└└auto_record_type | int | 否 | 会议开始后是否自动开启会议录制,传1为开启,不传或这0为不开启,默认0 |
└ └visible_list | string | 否 | 仅腾讯会议生效,应用可见范围,json字符串,key为sdk_id,value为可见用户工号,多个工号用半角逗号分隔,比如{"123445":"001,002"},其中的sdk_id必须为参数sdk_id的子集 |
└ zoom | String | 否 | zoom会议相关参数,暂时没有可自定义参数 |
address | String | 否 | 日程地点,最大长度30字符 |
remind_time | String | 否 | 开始前多少秒提醒(-1:为不提醒 1:300秒 2:900秒 3:1800秒 4:86400秒,默认2),多个用英文逗号隔开,如 1,2 |
visibility | String | 否 | 隐私设置(1:公开 2:私密,默认1) |
icon_link | String | 否 | 点击Icon的跳转地址,半角逗号分割,最多2个 |
icon_link_extra | List | 否 | 点击Icon的自定义跳转地址,分为:pc、android、ios,示例:icon_link_extra[pc]、icon_link_extra[android]、icon_link_extra[ios] |
└ pc | String | 否 | 点击Icon的PC端自定义跳转地址 |
└ android | String | 否 | 点击Icon的Android端自定义跳转地址 |
└ ios | String | 否 | 点击Icon的IOS端自定义跳转地址 |
remark | String | 否 | 描述,最大长度1000字符 |
tpl_code | String | 否 | 日程模板。已接入的日程分配原有模板;新接入的日程不传该参数,分配默认模板;如需新的tpl_code的值,请联系yach获取 |
注意:通过新接口创建的日程后续操作只能用新版接口,旧版接口无法操作
返回值
{
"code": 200,
"msg": "",
"obj": {
"biz_id": {biz_id},
"yach_mid": 144090287952801830,
"meeting_url": "" // 只有同步模式才会返回该字段
}
}
```_