删除参会人
1. 接口描述
接口名称:
/eventopenapi/event/telmonitor/participant/remove
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
token | String | 是 | 统一鉴权token |
eventId | Long | 是 | 直播会议ID |
participants | Array | 是 | 外呼参会人列表 |
participants 参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
countryCode | String | 否 | 国家码(默认值86) |
areaCode | String | 否 | 区号(默认为空) |
number | String | 是 | 电话号码或者手机号 |
- 如果参会人此时处于电话连线状态,删除操作会失败
3. 输出参数
参数 | 类型 | 说明 |
---|---|---|
timeStamp | Long | 返回时间(时间戳,单位毫秒) |
requestId | String | 请求ID(在接口异常时, 需提供请求ID) |
code | Int | 返回的状态码 |
msg | String | 当返回结果的状态码不为200时,包含的错误信息 |
data | Json | 返回数据 |
4. 示例
输入示例
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"eventId": 581274,
"participants": [
{
"countryCode": "86",
"number": "18100000001"
}
]
}
输出示例
{
"timeStamp": 1660807364357,
"code": 200,
"msg": "Successfully to remove the telphone conference participants!",
"data": {
"failedList": []
},
"requestId": "10.255.0.106_20220818_152241_1660807361972"
}