语音通话 VoiceCall-语音验证码话单通知API

时间：2025-02-12 14:55:49

语音通话 VoiceCall

表2 请求Headers参数说明
参数名称	是否必选	参数类型	说明
Content-Type	是	String	固定填写为application/json;charset=UTF-8。
Authorization	是	String	固定填写为AKSK realm="SDP",profile="UsernameToken",type="Appkey"。
X-AKSK	是	String	取值为UsernameToken Username="APP_Key的值", PasswordDigest="PasswordDigest的值", Nonce="随机数", Created="随机数生成时间"。 PasswordDigest：根据PasswordDigest = Base64(HMAC(appSecret, url+安全随机数+时间戳))生成。其中，url使用客户设置的话单推送URL，随机数需使用安全随机数。 Nonce：客户发送请求时生成的一个随机数，长度为1~128位，可包含数字和大小写字母。例如：66C92B11FF8A425FB8D4CCFE0ED9ED1F。 Created：随机数生成时间。采用标准UTC格式，例如：2018-02-12T15:30:20Z。不同编程语言中将UTC时间戳转换为普通时间时使用的格式不同，部分语言可参考表3。

表3 不同编程语言的时间格式
编程语言	时间格式
Java	yyyy-MM-dd'T'HH:mm:ss'Z'
PHP	Y-m-d\TH:i:s\Z
Python	%Y-%m-%dT%H:%M:%SZ
C#	yyyy-MM-ddTHH:mm:ssZ
Node.js	toISOString().replace(/.[0-9]+\Z/, 'Z') 注：Node.js中，使用toISOString()转换后的时间格式去除毫秒后即为本接口要求的时间格式。

表4 请求Body参数说明
参数名称	是否必选	参数类型	说明
eventType	是	String(枚举)	该参数标识API事件通知的类型。取值范围如下： fee：话单事件
feeLst	否	FeeInfo[1-50]	呼叫话单事件的信息，参数取值为列表，最大50条。当eventType参数为fee时携带。

FeeInfo

表5 fee：话单事件
参数名称	是否必须	参数类型	默认值	描述
direction	是	Integer (0-1)	无	通话的呼叫方向，以语音通话平台为基准。 0表示呼出（外呼）
spId	是	String(1-32)	无	客户的云服务账号。
appKey	是	String(1-32)	无	应用的app_key。
icid	否	String(1-64)	无	呼叫记录的唯一标识。
bindNum	是	String(1-32)	无	发起此次呼叫的固话号码。号码仅支持全局号码格式（包含国家码），比如+8675528****02。
sessionId	是	String(1-256)	无	通话链路的唯一标识。
callerNum	是	String(1-32)	无	主叫号码，号码为全局号码格式（包含国家码），比如+86138****0021。注：callerNum为SP设置的来电显示号码（displayNbr）。
calleeNum	是	String(1-128)	无	被叫号码，号码为全局号码格式（包含国家码），比如+86138****0021。注：calleeNum为A号码。
callEndTime	否	String(1-128)	无	呼叫结束时间。该参数为UTC时间（+8小时为北京时间），时间格式为“yyyy-MM-dd HH:mm:ss”。
fwdUnaswRsn	否	Integer	无	转接呼叫操作失败的Q850原因值。详细说明参见附录1-Q850原因值说明。
failTime	否	String(1-128)	无	呼入、呼出的失败时间。该参数为UTC时间（+8小时为北京时间），时间格式为“yyyy-MM-dd HH:mm:ss”。
ulFailReason	否	Integer	无	通话失败的拆线点。详细说明参见附录2-呼叫拆线点说明。
sipStatusCode	否	Integer	无	呼入、呼出的失败SIP状态码。
callOutStartTime	否	String(1-128)	无	Initcall的呼出开始时间该参数为UTC时间（+8小时为北京时间），时间格式为“yyyy-MM-dd HH:mm:ss”。
callOutAlertingTime	否	String(1-128)	无	Initcall的呼出振铃时间该参数为UTC时间（+8小时为北京时间），时间格式为“yyyy-MM-dd HH:mm:ss”。
callOutAnswerTime	否	String(1-128)	无	Initcall的呼出应答时间该参数为UTC时间（+8小时为北京时间），时间格式为“yyyy-MM-dd HH:mm:ss”。
callOutUnaswRsn	否	Integer	NA	Initcall的呼出失败的Q850原因值。详细说明参见附录1-Q850原因值说明。
recordFlag	否	Integer (0-1)	无	该字段用于录音标识，参数值范围如： 0：表示未录音 1：表示有录音
ttsPlayTimes	否	integer	无	应用 TTS 功能时，使用TTS的总次数。
ttsTransDuration	否	integer	无	应用TTS功能时，TTS Server进行TTS转换的总时长。单位为秒。
serviceType	否	String(1-32)	无	携带呼叫的业务类型信息，取值范围： 001：语音播放
hostName	否	String(1-128)	无	该参数用于标识话单生成的服务器设备对应的主机名。
userData	否	String(0-256)	无	用户附属信息，此参数的值与“语音验证码场景API”中的"userData"参数值一致。

响应示例

POST /status HTTP/1.1Content-Length: xx {"eventType":"fee","feeLst":[{"direction":0,"spId":"CaaS_Test_01","appKey":"7VN6w60Pl3e1E5C8310517x32698","icid":"CAE-20190124105808-12009374","bindNum":"+8675528****02","sessionId":"1200_164_4294967295_20190124025808@callenabler245.huaweicaas.com","callerNum":"+86138****0021","calleeNum":"+86138****7021","callEndTime":"2019-01-24 02:58:36","fwdUnaswRsn":0,"ulFailReason":0,"sipStatusCode":0,"callOutStartTime":"2019-01-24 02:58:08","callOutAlertingTime":"2019-01-24 02:58:13","callOutAnswerTime":"2019-01-24 02:58:24","callOutUnaswRsn":0,"recordFlag":0,"ttsPlayTimes":0,"ttsTransDuration":0,"serviceType":"001","hostName":"callenabler245.huaweicaas.com"}]}

上一篇：语音通话 VoiceCall-语音验证码话单通知API:使用说明

下一篇：语音通话 VoiceCall-语音验证码话单通知API:使用说明