本文导读

场景描述
使用说明
接口方法
接口URI
请求说明
响应说明
触发事件
结果码
报文样例

展开导读

文档首页/ 云客服/ API参考/ 电销外呼/ 外呼结果回调/ 外呼结果回调接口

外呼结果回调接口

更新时间：2023-09-27 GMT+08:00

查看PDF

场景描述

该接口会将外呼结果推送至指定URL。

使用说明

前提条件
- 已经申请了开发者账号。
- 外呼活动已经创建，并已添加外呼数据。
注意事项
- 接收请求后，需服务端返回200的响应，其他响应均认为推送失败。
- 接收到非200响应后，会立即再次推送。如果仍为非200响应，则认为本次推送失败。
使用限制
- 每条呼叫数据最大推送次数为 6 次。
- 推送失败后 10 分钟再次推送。

接口方法

该接口仅支持POST方法。

接口URI

创建外呼活动时，通过callBackUrl指定。

请求说明

无请求头消息。

表1 请求消息体参数说明
序号	参数名	参数类型	说明
1	callResultList	List	外呼结果列表，此处仅做说明，实际无此实体对象，response直接返回List。具体参考表2。

表2 callDataList参数说明
序号	参数名	参数类型	说明
1	campaignId	String	外呼活动的id
2	sessionId	String	标识用户的ID。
3	called	String	被叫号码。
4	callTimeStr	String	呼叫时间，格式为：yyyy-mm-dd hh:mm:ss。
5	callStatus	int	呼叫结果（5: 呼叫失败，6: 呼叫成功）。
6	failCode	String	失败的原因码，请参见表4。
7	vdnId	int	外呼号码所属VDN ID。
8	callId	String	通话记录ID，用于与CTI平台的话单等通话数据关联。
9	customField	String	用户自定义字段。
10	recordPath	String	通话录音文件的存储路径。说明：该字段仅在使用接续时（SAAS组网），才返回值，其他情况返回为空。

响应说明

响应码：200

表3 响应消息说明
序号	名称	参数类型	是否必选	说明
1	retCode	string	True	0，成功，其他为失败。
2	retMsg	string	True	失败原因的描述。

触发事件

无

结果码

表4 外呼结果错误原因码说明
分类	错误原因码	错误原因描述
外呼成功	00000	外呼成功。
用户侧拆线	00531	外呼用户挂机。
	00537	外呼号码被叫忙。
	00538	外呼号码为空号或错号。
	00548	外呼手机号码关机。
	00549	外呼手机号码不在服务区。
	00551	用户挂机。
	00601	应答前用户挂机。
	00603	外呼号码无应答后拆线。
	00604	呼叫拒绝。
	00701	外呼用户转队列，排队中用户主动挂机。
平台正常拆线	00702	外呼用户转队列，排队超时，平台释放呼叫（若配置为排队超时释放）。
	01040	振铃超时，平台释放呼叫。（即在设置的振铃时间内，用户一直没有摘机）
	01043	平台内部等待外呼结果超时。
	01046	占用座席失败（转IVR外呼不涉及）。
	01049	外呼检测超时。
	34601	外呼任务不存在。
	34605	电话号码为空，即外呼获取的被叫号码为空字符串。
	34606	试呼失败，即调用呼出接口失败(比较常见的一种情况：当前的并发外呼数达到了最大外呼数；)，没有呼出到用户。
	34608	呼出后，没有得到呼出结果信息，超时后将该呼叫数据回写。
系统资源不足，平台侧拆线	00602	系统资源不足，请联系管理员检查资源配置。
	00605
	01048
	34606
系统异常	00606	请联系管理员排查。
	34611
	其他

报文样例

该接口的请求消息体举例如下：

[
    {
        "campaignId": "3",
        "sessionId": "1202_test013",
        "called": "60584",
        "callTimeStr": "2020-08-30 20:00:00",
        "callStatus": 6,
        "failCode": "0",
        "vdnId": 11,
        "callId": "0023-134864174",
        "recordPath": "Y:/1/11/20200830/3408/0949218.V3"
    }
]

该接口的响应消息体举例如下：

{ 
    "retCode": "0",
    "retMsg": "success"
}

父主题： 外呼结果回调

上一篇：外呼结果回调

下一篇：业务结果回写

意见反馈

文档内容是否对您有帮助？

有帮助没帮助

提供反馈

提交成功！非常感谢您的反馈，我们会继续努力做到更好！

系统繁忙，请稍后重试

在使用文档中是否遇到以下问题

内容与产品页面不一致

内容不易理解

缺失示例代码

步骤不可操作

搜不到想要的内容

缺少最佳实践

意见反馈（选填）

0/500

请至少选择一项反馈信息并填写问题反馈

字符长度不能超过500

直接提交取消