保存自动外呼列表

1. 接口描述

保存外呼号码, 先删除原有的外呼数据, 再保存新数据, 如果调用接口时, 超过了会议开始时间, 直接进行外呼.

接口名称:

/eventopenapi/event/call/save

发送方式:

POST

参数格式:

accept: application/json;content-type: application/json

2. 输入参数

参数 类型 必须 说明
token String 统一鉴权token
eventId Long 直播会议ID
beforeMinutes Int 提前入会时间(0-60)单位分钟,默认值5
callList Array 外呼人员列表

callList 参数说明

参数 类型 必须 说明
name String 姓名
company String 公司
countryCode String 国家码
mobile String 手机(手机和座机二选一,如果选择手机mobile必须传递)
areaCode String 区号
phone String 座机电话(如果选择座机,phone必须传递)
role int 外呼角色, 0:参会人 1:主讲人 2:主持人 3:嘉宾(默认), 角色1,2只对电话会议生效

说明

参数 说明
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 参数说明

参数 类型 说明
eventId Long 直播会议ID
beforeMinutes Int 提前入会时间,单位分钟
callList Array 外呼人员列表
realTimeCallFailedList Array 实时外呼失败列表,没有失败数据时返回null
callType Int 外呼类型 1: 定时外呼 2:实时外呼

callList 参数说明

参数 类型 说明
id String 会前定时外呼数据主键, 修改数据时需要使用此参数, 当callType=2, 为实时外呼时, id为null
name String 姓名
company String 公司
countryCode String 国家码
mobile String 手机
areaCode String 区号
phone String 座机电话
role int 外呼角色, 0:参会人 3:嘉宾

realTimeCallFailedList 参数说明

参数 类型 说明
name String 姓名
company String 公司
countryCode String 国家码
areaCode String 区号
number String 电话号码或者手机号

4. 示例

输入示例

{
    "token":"5d41c4ac806c6440eb6aa8e071115f2b",
    "eventId": 544992,
    "beforeMinutes": 5,
    "callList": [
        {
            "company": "quanshi.com",
            "countryCode": "86",
            "mobile": "18100000001",
            "name": "user1",
            "areaCode": "",
            "phone": "",
            "role":3
        }
    ]

}

输出示例

{
    "timeStamp": 1640922674313,
    "code": 200,
    "msg": "Successfully to set the event call!",
    "data": {
        "eventId": 544992,
        "beforeMinutes": 30,
        "callList": [
            {
                "id": "620f6c321ada820006fcc096",
                "areaCode": "",
                "company": "quanshi.com",
                "countryCode": "86",
                "mobile": "18100000001",
                "name": "user1",
                "phone": "",
                "role":0
            }
        ],
        "realTimeCallFailedList":null,
        "callType":1
    },
    "requestId": "10.255.0.106_20211231_115114_1640922674019"
}