外呼接口

此接口可以供三方平台在自己的系统中实现外呼功能。

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分机号，实现分机号自动拨号。
encrypt	string	否	被叫号码是否加密，可传值1/0， 0为不加密，不传则默认为0。加密方式为aes加密，可参考AES加密示例

{
    "agentNumber": "2000",
    "customerNumber": "1861111111",
    "calloutType": "PSTN",
    "agentTimeout": "60",
    "customerTimeout": "120",
    "agentDisNumber": "01011111111",
    "customerDisNumber": "0101111111",
    "extras": {
        "extraNumber":"8000",
        "test": "自定义传参"
    }
}

字段名称	字段类型	字段描述
success	boolean	请求是否成功
message	String	响应结果
code	String	响应码
data	String	响应文本

{
    "success": true,
    "message": "200 ok!",
    "code": "200",
    "data": null
}

错误码	错误信息
01030061	返回下面提示信息之一：该号码呼叫次数今日已达上限，请勿重复呼叫。该号码呼叫次数本周已达上限，请勿重复呼叫。该号码呼叫次数本月已达上限，请勿重复呼叫。该号码呼叫次数本季度已达上限，请勿重复呼叫。该号码呼叫次数今年已达上限，请勿重复呼叫。
01030080	该时间段属于风控阶段，已限制呼叫
01030063	由于网络原因，当前坐席已掉线，请刷新后重试
01030064	外呼失败
01030065	extras格式错误
01030003	座席忙
01030019	agent_not_find
01030020	agent_disable
01030021	agent_locked
01030044	座席没有绑定手机号，不可手机方式签入
01030045	未找到外显号
01030046	座席没有绑定sip号，不可SIP话机方式签入
01030047	话机掉注册，请重新注册后再试
01030086	账户余额不足，请联系管理员
01030059	该号码属于黑名单号码，已限制呼叫
01030088	线路呼叫限制
01030035	current display number is not belong current account
01030089	当前外显组未找到空闲号码
01030090	座席呼叫锁定中,请稍后重试

场景描述：期望在自有系统中通过WebRTC 形式，使用外呼接口实现“点呼”功能，同时搭配对应接口完成通话时长查看、挂机等操作。

实现方式：调用电话条对接-易用版+本外呼接口

demo示例：

ue-soft-demo.zip

36.5 KB

demo说明：通过外呼接口发起呼叫后，WebRTC 对应的电话条会自动启动，同时可借助简易电话条接口完成通话时长查看、挂机等操作，等同于整合 “外呼 + 电话条” 两个接口的功能。

注：demo中鉴权为示意，需根据实际环境进行替换

2025-12-10

外呼接口

访问路径

请求参数

请求示例

返回参数

返回示例

外呼接口错误码

电话条+点呼功能

本页目录