1、业务流程介绍

1、用户系统向云信使系统提交语音验证请求;
2、云信使系统将用户提交的文字形式的验证码合成为语音流,然后开始拨打被叫电话;
3、被叫接听,云信使系统播放验证码;
4、播放结束,电话挂断,云信使系统将本次通话的记录详情推送到用户系统;

2、接口地址与交互方式

接口地址:https://api.yunxinshi.com:8081/VoiceCode.do

交互方式:用户系统以HTTPS POST的方式向服务器(上述接口地址)发送XML数据包,服务器接收并通过验证后开始执行业务流程。服务器将在执行过程中的必要节点向用户系统以HTTP方式回调消息以告知流程进度和其他相关数据;

3.1、接口功能:创建语音验证码任务(CreateTask)


功能说明:
该接口用于创建语音验证码任务。

发送的XML数据包:
<xml>
   <ActionType>CreateTask</ActionType>
   <UserName></UserName>
   <Token></Token>
   <Phone></Phone>
   <VerifyCode></VerifyCode>
   <Caller></Caller>
   <PlayTimes></PlayTimes>
   <IVR></IVR>
   <CodeLanguage></CodeLanguage>
   <CustomData></CustomData>
</xml>


发送的XML数据包参数说明:

参数必要性含义
ActionType必填
UserName必填
Token必填
Phone必填
VerifyCode必填
Caller可选
PlayTimes可选
IVR可选
CodeLanguage可选
CustomData可选

返回值:
<xml>
   <errcode></errcode>
   <errmsg></errmsg>
   <TaskSN></TaskSN>
</xml>


返回值参数说明:

参数含义
errorcode
errmsg
TaskSN

3.2、接口功能:查询语音验证码历史记录(QueryTaskHistory)


功能说明:
该接口用于查询已经处理完毕的语音验证码的历史记录。

发送的XML数据包:
<xml>
   <ActionType>QueryTaskHistory</ActionType>
   <UserName></UserName>
   <Token></Token>
   <TaskSN></TaskSN>
</xml>


发送的XML数据包参数说明:

参数必要性含义
ActionType必填
UserName必填
Token必填
TaskSN必填

返回值:
<xml>
   <errcode></errcode>
   <errmsg></errmsg>
   <TaskSN></TaskSN>
   <Caller></Caller>
   <Phone></Phone>
   <VerifyCode></VerifyCode>
   <SubmitTime></SubmitTime>
   <ConnectTime></ConnectTime>
   <EndTime></EndTime>
   <CalledTimes></CalledTimes>
   <PlayedTimes></PlayedTimes>
   <IVR></IVR>
   <CodeLanguage></CodeLanguage>
   <CustomData></CustomData>
</xml>


返回值参数说明:

参数含义
errcode
errmsg
TaskSN
Caller
Phone
VerifyCode
SubmitTime
ConnectTime
EndTime
CalledTimes
PlayedTimes
IVR
CodeLanguage
CustomData

4.1、回调消息:回调消息的推送地址和接收响应


回调消息推送地址的配置:
如果用户在管理平台的“业务管理”-“回调消息地址配置”中,配置了“语音验证码回调消息”的回调消息地址,则当有这类消息触发时,云信使系统会将消息的详情推送到用户所配置的地址。该地址的配置如下图所示:

用户亦可在每次发送语音验证码时动态变更回调消息的接收地址,如需实现该动态变更功能,请咨询技术客服。

用户系统接收后的响应:
用户系统成功接收消息后,返回字符串0。云信使系统如果未收到字符串0,则认为推送失败,会再次推送该消息(最多三次)。

4.2、回调消息:推送CDR日志(ReportCDR)


消息说明:
该消息在被叫电话挂断时触发,表明该验证码任务已经执行结束,无论是被叫电话主动挂断,还是服务器将被叫电话挂断,都将触发同样的消息。

用户系统接收的XML数据包:
<xml>
   <PushSN></PushSN>
   <UserName></UserName>
   <Business>VoiceCode</Business>
   <Event>ReportCDR</Event>
   <TaskSN></TaskSN>
   <Caller></Caller>
   <Phone></Phone>
   <VerifyCode></VerifyCode>
   <SubmitTime></SubmitTime>
   <ConnectTime></ConnectTime>
   <EndTime></EndTime>
   <CalledTimes></CalledTimes>
   <PlayedTimes></PlayedTimes>
   <IVR></IVR>
   <CodeLanguage></CodeLanguage>
   <CustomData></CustomData>
   <Time></Time>
</xml>


接收的XML数据包参数说明:

参数含义
PushSN
UserName
Business
Event
TaskSN
Caller
Phone
VerifyCode
SubmitTime
ConnectTime
EndTime
CalledTimes
PlayedTimes
IVR
CodeLanguage
CustomData
Time
用户系统响应:
用户系统接收到该消息后,需要返回字符串0,云信使系统如果未接收到正确的返回,将在三秒内重发该消息(最多三次)。

5、使用在线调试工具快速测试

用户可以登录帮客云信使业务管理系统(https://www.yunxinshi.com/user/),通过“接口调试工具”--“语音验证码”模块,快速测试与调试本功能。调试工具如下图所示:

>