批量取消外呼

最近更新时间:2024-10-09 15:32:21

我的收藏

接口描述

描述
会议创建者、主持人、联席主持人可以批量取消外呼电话入会。
每次调用支持批量取消50路。
支持境外电话号及分机号的外呼。
取消呼叫为异步任务,具体结果需要通过 PSTN 外呼状态更新 获得。
请求方式:POST
鉴权方式:JWT 鉴权
接口请求域名
https://api.meeting.qq.com/v1/meeting/{meeting_id}/phone/cancelcall

输入参数

参数名称
必选
参数类型
参数描述
operator_id
String
操作者 ID。
会议创建者、主持人、联席主持人可以调用该接口。
operator_id 必须与 operator_id_type 配合使用。根据 operator_id_type 的值,operator_id 代表不同类型。
operator_id_type
Number
操作者 ID 的类型:
1:企业内用户 userid
phone_numbers
PhoneNumbers 对象数组
电话号码对象数组。

PhoneNumbers 对象

参数名称
必选
参数类型
参数描述
area
Number
国家/地区代码。(例如:中国是86)
当前仅支持呼叫中国大陆、中国香港、美国的号码。
phone
String
电话号码或固定电话总机号。
extension_number
String
固定电话分机号。

输出参数

参数名称
参数类型
参数描述
success_list
SuccessList 对象数组
取消呼叫成功的列表。
failed_list
FailedList 对象数组
取消呼叫失败的列表。

SuccessList 对象数组

参数名称
参数类型
参数描述
area
Number
国家/地区代码。
目前支持的外呼国家:中国大陆(86)、中国香港(852)、和美国(1)。
phone
String
电话号码或固定电话总机号。
extension_number
String
固定电话分机号。

FailedList 对象数组

参数名称
参数类型
参数描述
area
Number
国家/地区代码(例如:中国是86)。
phone
String
电话号码或固定电话总机号。
extension_number
String
固定电话分机号。
error_msg
String
错误信息

错误码列表

状态码
错误码
错误描述
400
190457
会议不存在,请核对 meeting_id。
400
190004
参数非法,请对照接口文档检查您的参数。
400
550000
请求超时,请稍后再试。
400
500122
操作者没有权限。
400
500135
取消用户呼叫失败。

示例

输入示例

{
"operator_id":"songe",
"operator_id_type":2,
"phone_numbers":[
{
"area":86,
"phone":"13888888888"
}
]
}

输出示例

{
"SuccessList":[
{
"area":86,
"phone":"13888888888"
}
],
"FailedList":[
{
"area":86,
"phone":"13888888888",
"error_msg":"xxxxxxxxx"
}
]
}