访问路径
POST /openapi/call/api/v1/callout
请求参数
字段名称 | 字段类型 | 是否必填 | 字段描述 |
agentNumber | String | 是 | 坐席工号 |
customerNumber | String | 是 | 被叫号码,固话请输入完整区号。 |
calloutType | String | 是 | 外呼方式:PSTN(坐席绑定手机号),SIP(sip话机)、WEBRTC(软电话)。 |
agentTimeout | String | 否 | 呼叫座席侧超时时间,默认60秒。 |
customerTimeout | String | 否 | 呼叫客户侧超时时间,默认60秒。 |
agentDisNumber | string | 否 | 指定呼叫座席侧外显号码,优先级最高。 |
customerDisNumber | string | 否 | 指定呼叫客户侧外显号码,此号码应为企业账户外显号码中的已存在的。 |
numberGroupName | string | 否 | 号码组名称,传该值,会查找对应名称的号码组,并根据策略选择外显号。未找到号码组按照没传处理 |
numberGroupId | string | 否 | 号码组编号,传该值,会查找对应Id的号码组,并根据策略选择外显号。未找到号码组按照没传处理,号码组名称和id同时存在时,优先根据编号查找号码组 |
extras | jsonString | 否 | 自定义参数,通话中通过事件推送,通话后通话记录中可以查询搜索和定位 限制字节数为255个,并且使用json格式进行传输,超出或者格式不正确则报错。同时可在此参数里传extraNumber分机号,实现分机号自动拨号。 |
请求示例
{
"agentNumber": "2000",
"customerNumber": "1861111111",
"calloutType": "PSTN",
"agentTimeout": "60",
"customerTimeout": "120",
"agentDisNumber": "01011111111",
"customerDisNumber": "0101111111",
"extras": {
"extraNumber":"8000",
"test": "自定义传参"
}
}
返回示例
{
"success": true,
"message": "200 ok!",
"code": "200",
"data": null
}