接口描述
描述:
会议创建者、主持人、联席主持人可以批量外呼电话入会。
在拨打后,立刻返回,无需等待,客户通过查询接口和 Webhook 获得外呼状态。
支持在会议未开始、会中外呼。
每次调用支持批量外呼30路。
支持境外电话号及分机号的外呼。
支持在 Webinar 准备模式下外呼嘉宾,在 Webinar 会中外呼观众。
此功能依赖电话会议服务包,更多电话会议服务包信息请参见 计费概述。
请求方式:POST
鉴权方式:AK/SK 鉴权
接口请求域名:
https://api.meeting.qq.com/v1/meeting/{meeting_id}/phone/callout
输入参数
参数名称 | 必选 | 参数类型 | 参数描述 |
operator_id | 是 | String | 操作者 ID。 会议创建者、主持人、联席主持人可以调用该接口。 operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。 |
operator_id_type | 是 | Number | 操作者 ID 的类型: 1:企业内用户 userid |
phone_numbers | 是 | 外呼的电话号码对象数组。 |
PhoneNumbers 对象
参数名称 | 必选 | 参数类型 | 参数描述 |
area | 是 | Number | 电话区号。(例如:中国内地默认86) 当前仅支持呼叫中国内地、中国香港、美国的号码。 |
phone | 是 | String | 电话号码或固定电话总机号。 |
extension_number | 否 | String | 固定电话分机号。 |
nick_name | 否 | String | 入会昵称。 |
输出参数
参数名称 | 参数类型 | 参数描述 |
meeting_id | String | 会议的唯一 ID。 |
phone_numbers | 成功外呼的电话号码对象数组。 | |
invalid_phone_numbers | 不合法的外呼电话号码对象数组。 |
PhoneNumbers 对象数组
参数名称 | 参数类型 | 参数描述 |
area | Number | 电话区号。 目前支持的外呼国家:中国内地(86)、中国香港(852)、美国(1) |
phone | String | 电话号码或固定电话总机号。 |
extension_number | String | 固定电话分机号。 |
status | String | 外呼状态。 |
InvalidPhoneNumbers 对象数组
参数名称 | 参数类型 | 参数描述 |
area | Number | 电话区号。(例如:中国内地默认86) |
phone | String | 电话号码或固定电话总机号。 |
extension_number | String | 固定电话分机号。 |
error_msg | String | 错误信息。 |
错误码列表
状态码 | 错误码 | 错误描述 |
400 | 190457 | 会议不存在,请核对 meeting_id。 |
400 | 190004 | 参数非法,请对照接口文档检查您的参数。 |
400 | 9042 | 权限受限或鉴权失败。 |
500 | 9006 | 会议已结束。 |
500 | 14203 | 输入号码有误,请重新输入。 |
500 | 14220 | 邀请成员入会失败,请稍后重试。 |
500 | 190001 | 存在未注册的用户。 |
500 | 14225 | PSTN 资源不足。 |
500 | 9007 | 会议已取消。 |
示例
输入示例
{"operator_id":"songe","operator_id_type":2,"phone_numbers":[{"area":86,"phone":"13888888888"}]}
输出示例
{"meeting_id":"1111111111111","phone_numbers":[{"area":86,"phone":"13888888888","status":""}],"invalid_phone_numbers":[{"area":86,"phone":"13888888888","error_msg":"xxxxxxxxx"}]}