开发文档

一、 语音双向呼叫API

日期	版本	修订内容摘要
2023-08-24	v1.0.0	更新接口文档

名称	说明
接口名称	语音营销
URL	https://api.253.com/open/bidirectionalcall/out-call
协议	HTTPS POST
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

参数名	参数类型	是否必传	参数说明
appId	String	是	应用id ，详情请看,功能介绍->接口详情
appKey	String	是	应用key ，详情请看,功能介绍->接口详情
caller	String	是	主叫号码
called	String	是	被叫号码
billUrl	String	否	话单推送回调地址 （最大长度250）
transData	String	否	透传数据(话单推送回调时返回 最大长度50)

{
	"appId": "*****",
	"appKey": "*****,
	"caller": "176***5202",
	"called": "186***5203",
	"billUrl": "http://****/voice/test/test3",
	"transData": "3333"
}

参数名	数据类型	参数说明
code	string	响应code码。200000：成功，其他失败。详见code码
message	string	响应code码解释
data	Object	返回对象
callId	string	呼叫唯一标识Id

{
    "message": "请求成功",
    "data": {
        "callId": "YYTZ931512444176564224"
    },
    "code": "200000"
}

{
    "message": "系统异常",
    "code": "500000"
}

二、 消息状态报告推送

日期	版本	修订内容摘要
2023-08-24	v1.0.0	更新接口文档

名称	说明
接口名称	消息状态报告推送
协议	HTTPS POST
编码格式	UTF8
Content-Type	application/x-www-form-urlencoded
返回类型	application/json

参数名	参数类型	是否必传	参数说明
callId	String	是	本次通话的callId，与调用绑定接口返还的相同
fileName	String	是	录音文件地址
reason	String	是	挂机原因：现状是0为正常挂机 0：正常挂机 2: TTS转换失败 3: TTS处理超时 4: 会话处理超时 5: 呼叫失败 – 线路返回相关错误，结合呼叫状态判断
transData	String	是	透传数据
startTime	String	是	语音接听时间，毫秒级时间戳
callTime	String	是	通话时长(s)
callStatus	String	是	呼叫结果 0-成功 1-失败
callATime	String	是	主叫通话时间
callBTime	String	是	被叫通话时间

{
    "message": "请求成功",
    "code": "200000"，
    "success": true
}