推送状态报告
功能说明:开通此接口后,我们将为您实时推送最新的状态报告。您需要提供一个callback url地址,接受http post请求。 为不影响推送速度,建议先接受数据后再做异步处理。
备注:#
- 本功能默认不开启,如需开启在每次发送请求中携带callback url 地址。我们会优先向发送请求中携带的callback url 地址推送。
- 接收到数据后,数据处理成功请返回字符串"SUCCESS",其他返回值将被认为是失败。该接口失败重试次数为3次,每次间隔5分钟。
- 获取数据后,建议根据sid做去重。
HTTP头信息:#
Content-Type:application/json;charset=utf-8;请求#
URL:http://your_receive_url_address 访问方式:POST 访问参数: 已JSON 格式推送请求参数#
| 参数名 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
| mobile | string | 是 | 手机号 |
| sid | long(64 位) | 是 | sid 发送接口返回的参数 |
| busId | string | 否 | 您上送的业务系统内的 ID |
| batchId | string | 是 | 批次号 |
| userLabels | list | 否 | 标签 |
| callTime | string | 否 | 呼叫时间 格式 yyyy-MM-dd HH:mm:ss |
| connectTime | string | 否 | 接通时间 格式 yyyy-MM-dd HH:mm:ss |
| callStatus | string | 是 | 呼叫状态 描述: SUCCESS 成功;FAIL 失败 |
| level | string | 否 | 意向等级 |
| resultCode | string | 否 | 呼叫结果码 |
| hangupTime | string | 否 | 挂机时间 格式 yyyy-MM-dd HH:mm:ss |
| callDuration | int | 否 | 计费时长(秒) |
| interactiveCount | int | 否 | 对话统计 |
| audioPath | string | 否 | 录音文件 |
| interactiveRecords | list | 否 | 对话流程 |
| callDetails | list | 否 | 呼叫详情 |
interactiveRecords 对象#
| 名称 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
| role | string | 是 | 角色 CUSTOMER: 用户 ROBOT: 机器人 |
| content | string | 是 | 对话内容 |
callDetails 对象#
| 名称 | 类型 | 是否必传 | 描述 |
|---|---|---|---|
| sequence | int | 是 | 序列 |
| callTime | string | 是 | 呼叫时间 格式 yyyy-MM-dd HH:mm:ss |
| endTime | string | 是 | 结束时间 格式 yyyy-MM-dd HH:mm:ss |
| callStatus | string | 是 | 呼叫状态 描述: SUCCESS 成功;FAIL 失败 |
| resultCode | string | 是 | 呼叫结果码 |
重要说明#
请按照如下顺序使用参数
- 请妥善保存推送信息;
- 如果您的系统接收推送信息失败,请及时联系我们。
Json响应示例#
{ "busId": "1234567", "sid": 9527, "batchId": "S1625800477312819200", "callStatus": "SUCCESS", "mobile": "18105201314", "callTime": "2023-06-09 00:58:36", "connectTime": "2023-06-09 00:58:40", "resultCode": "OK", "level": "A", "hangupTime": "2023-06-09 00:59:10", "callDuration": 30, "interactiveCount": 2, "audioPath": "001a9a99-56a6-40b8-beb2-a584ef50a0e0.wav", "userLabels": ["标签1","标签2"], "interactiveRecords": [{ "role": "ROBOT", "content": "你好,这里是ai外呼平台" },{ "role": "CUSTOMER", "content": "你好" }], "callDetails": [{ "sequence": 1, "callTime": "2023-06-09 00:58:36", "endTime": "2023-06-09 00:59:10", "callStatus": "SUCCESS", "resultCode": "OK", }], }