修改自动外呼号码

1. 接口描述

接口名称:

/eventopenapi/event/call/update

发送方式:

POST

参数格式:

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

2. 输入参数

参数 类型 必须 说明
token String 统一鉴权token
eventId Long 直播会议ID
callId String 外呼ID
beforeMinutes Int 提前入会时间(0-60)单位分钟,默认值30
name String 姓名
company String 公司
countryCode String 国家码
mobile String 手机(手机和座机二选一,如果选择手机mobile必须传递)
areaCode String 区号
phone String 座机电话(如果选择座机,phone必须传递)

注意

  • 支持设置全局beforeMinutes,详见示例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 返回数据

4. 示例

示例1: 修改外呼记录

输入示例

{
    "token":"5d41c4ac806c6440eb6aa8e071115f2b",
    "eventId": 542818,
    "callId": "62061d9ed978d00007dd456f",
    "areaCode": "22",
    "company": "quanshi.com",
    "countryCode": "86",
    "mobile": "181000000022",
    "name": "user12",
    "phone": "22"
}

输出示例

{
    "timeStamp": 1646816404440,
    "code": 200,
    "msg": "Successfully to update the event call!",
    "data": null,
    "requestId": "10.255.0.106_20220309_170004_1646816404228"
}

示例2: 设置全局提前入会时间

输入示例

{
    "token":"5d41c4ac806c6440eb6aa8e071115f2b",
    "eventId": 542818,
    "beforeMinutes": 20
}

输出示例

{
    "timeStamp": 1646815515985,
    "code": 200,
    "msg": "Successfully to update the event call!",
    "data": null,
    "requestId": "10.255.0.106_20220309_164515_1646815515717"
}