添加自动外呼号码
1. 接口描述
添加新的外呼号码, 不会影响已有数据
接口名称:
/eventopenapi/event/call/create
发送方式:
POST
参数格式:
accept: application/json;content-type: application/json
2. 输入参数
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
token | String | 是 | 统一鉴权token |
eventId | Long | 是 | 直播会议ID |
beforeMinutes | Int | 否 | 提前入会时间(0-60)单位分钟,默认值30 |
callList | Array | 是 | 外呼人员列表 |
callList 参数说明
参数 | 类型 | 必须 | 说明 |
---|---|---|---|
name | String | 否 | 姓名 |
company | String | 否 | 公司 |
countryCode | String | 是 | 国家码 |
mobile | String | 否 | 手机(手机和座机二选一,如果选择手机mobile必须传递) |
areaCode | String | 否 | 区号 |
phone | String | 否 | 座机电话(如果选择座机,phone必须传递) |
说明
参数 | 说明 |
---|---|
countryCode | 即国际电话区号,以小括号包含在内,不包含+号,00等其他字符,例如:美国(1)、中国(86)、香港(852)、台湾(886);所有国家码参考:https://www.itu.int/dms_pub/itu-t/opb/sp/T-SP-E.164D-2016-PDF-C.pdf |
areaCode | 国内区号,只包括中国大陆内省份的区号,区号不包含首位0,只有国内座机会有区号,例如:北京 10、西安 29; |
phone | 本地号码,即号码本地的号码(不包含国家码、区号、分机号的公网号码)例如:58512042 |
3. 输出参数
参数 | 类型 | 说明 |
---|---|---|
timeStamp | Long | 返回时间(时间戳,单位毫秒) |
requestId | String | 请求ID(在接口异常时, 需提供请求ID) |
code | Int | 返回的状态码 |
msg | String | 当返回结果的状态码不为200时,包含的错误信息 |
data | Json | 返回数据 |
data 参数说明
参数 | 类型 | 说明 |
---|---|---|
total_count | Int | 返回总记录数 |
success_count | Int | 成功记录数 |
success_data | Array | 成功记录 |
fail_count | Int | 失败记录数 |
fail_data | Array | 失败记录 |
success_data 参数说明
参数 | 类型 | 说明 |
---|---|---|
id | String | 外呼ID |
name | String | 姓名 |
company | String | 公司 |
countryCode | String | 国家码 |
mobile | String | 手机(手机和座机二选一,如果选择手机mobile必须传递) |
areaCode | String | 区号 |
phone | String | 座机电话(如果选择座机,phone必须传递) |
fail_data 参数说明 (同success_data)
4. 示例
输入示例
{
"token":"5d41c4ac806c6440eb6aa8e071115f2b",
"eventId": 542818,
"callList": [
{
"company": "quanshi.com",
"countryCode": "86",
"mobile": "18100000030",
"name": "user1",
"areaCode": "",
"phone": ""
}
]
}
输出示例 1 - 执行成功,成功添加
{
"timeStamp": 1646816678200,
"code": 200,
"msg": "Successfully to create the event call!",
"data": {
"total_count": 1,
"success_count": 1,
"fail_count": 0,
"requestId": null,
"fail_data": [],
"success_data": [
{
"id": "62286da5388f66000643106c",
"areaCode": "",
"company": "quanshi.com",
"countryCode": "86",
"mobile": "18100000030",
"name": "user1",
"phone": ""
}
]
},
"requestId": "10.255.0.106_20220309_170437_1646816677951"
}
输出示例2 - 执行成功,有失败记录、
{
"timeStamp": 1646816644656,
"code": 200,
"msg": "Successfully to create the event call!",
"data": {
"total_count": 1,
"success_count": 0,
"fail_count": 1,
"requestId": null,
"fail_data": [
{
"id": "62286d82388f66000643106b",
"areaCode": "",
"company": "quanshi.com",
"countryCode": "86",
"mobile": "18100000030",
"name": "user1",
"phone": ""
}
],
"success_data": []
},
"requestId": "10.255.0.106_20220309_170404_1646816644456"
}