会中批量外呼参会人
1. 接口描述
接口名称:
/eventopenapi/event/dialout/running
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
token | String | 是 | 统一鉴权token |
eventId | Long | 是 | 直播会议ID |
partyList | Array | 是 | 外呼参会人列表 |
callbackUrl | String | 否 | 回调地址,参会人状态变化时主动调用的回调地址 |
partyList 参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
role | Int | 是 | 入会角色 1: 主持人 0: 参与人 |
phone | String | 是 | 电话号码,格式:国际码+区号+电话,比如(86)1059933636, (86)1059933636-3636, (86)138xxxxxxxx |
3. 输出参数
参数 | 类型 | 说明 |
---|---|---|
timeStamp | Long | 返回时间(时间戳,单位毫秒) |
requestId | String | 请求ID(在接口异常时, 需提供请求ID) |
code | Int | 返回的状态码 |
msg | String | 当返回结果的状态码不为200时,包含的错误信息 |
data | Json | 返回数据 |
data 参数说明
参数 | 类型 | 说明 |
---|---|---|
status | String | 执行状态 0:成功,非0失败 |
callSeq | String | 外呼序列号 |
result | Array | 外呼返回结果 |
result 参数说明
参数 | 类型 | 说明 |
---|---|---|
partyId | String | 外呼参会人ID |
role | Int | 入会角色 1: 主持人 0: 参与人 |
phone | String | 电话号码 |
status | Int | 外呼状态 0:成功,非0失败 |
4. 示例
输入示例
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"eventId": 542818,
"partyList": [{
"role": 0,
"phone": 18100000001
}
]
}
输出示例
{
"timeStamp": 1644994155373,
"code": 200,
"msg": "Successfully to dialout the party list!",
"data": {
"status": "0",
"callSeq": "95379102-1644994149585",
"result": [
{
"phone": "18100000001",
"role": 0,
"partyId": "1644994154376YY10000",
"status": 0
}
]
},
"requestId": "172.10.240.238_20220216_144912_1644994152398"
}