接口描述
描述:为已开启等候室的会议配置等候室欢迎语。当有用户进入等候室时,会收到来自会议主办方的私聊消息引导。
请求方式: POST
鉴权方式:JWT 鉴权、OAuth 鉴权。
权限点:查看和管理会议
接口请求域名:
https://api.meeting.qq.com/v1/meeting/set-waiting-room-welcome-message
输入参数
参数名称 | 参数类型 | 是否必须 | 参数描述 |
meeting_id | String | 必须 | 会议 ID。 |
operator_id | String | 必须 | 操作者 ID,设置等候室欢迎语的用户。会议的创建者、主持人、联席主持人,企业管理平台有会控权限的用户可以设置。 operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。 |
operator_id_type | Number | 必须 | 操作者 ID 的类型: 1:企业内用户 userid 2:open_id |
enable_welcome | Boolean | 必须 | 是否开启等候室欢迎语能力。 |
welcome_text | String | 必须 | 欢迎语,文本类型,最大长度1000字符。欢迎语中如果传入占位符 %NICKNAME%(大小写敏感),则该占位符会被替换为被私聊用户的会中昵称。一条消息中支持多个占位符。 |
输出参数
参数名称 | 参数类型 | 参数描述 |
welcome_text | String | 欢迎语,文本类型,最大长度1000字符。欢迎语中如果传入占位符%NICKNAME%(大小写敏感),则该占位符会被替换为被私聊用户的会中昵称。一条消息中支持多个占位符。 |
enable_welcome | Boolean | 是否开启等候室欢迎语能力。 |
错误码列表
状态码 | 错误码 | 错误描述 |
500 | 190001 | 存在未注册的用户。 |
500 | 9042 | 无权限进行该操作,建议检查操作者身份或资源归属。 |
400 | 190457 | 会议不存在, 请核对 meeting_id。 |
400 | 9042 | 无权限进行该操作,建议检查操作者身份或资源归属。 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
示例
输入示例
POST https://api.meeting.qq.com/v1/meeting/set-waiting-room-welcome-message{"meeting_id": "100001","operator_id_type": 1,"welcome_text": "欢迎大家","operator_id": "user1","enable_welcome": true}
输出示例
{"welcome_text": "欢迎大家","enable_welcome": true}