1、业务流程介绍

1、用户系统向云信使系统提交语音通知请求;
2、云信使系统将用户提交的文字内容合成为语音流(如果语音通知内容是预先录制的语音文件,则无需合成),然后开始拨打被叫电话;
3、被叫接听,云信使系统播放语音通知内容;
4、播放结束,如果用户在提交语音通知任务时指定了接续流程,则系统执行接续流程,否则电话挂断;
5、电话挂断后,云信使系统将本次通话的记录详情推送到用户系统;

2、接口地址与交互方式

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

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

3.1、接口功能:创建语音通知任务 ( CreateTask )


功能说明:
该接口用于创建语音通知任务。

发送的XML数据包:
<xml>
   <ActionType>CreateTask</ActionType>
   <UserName></UserName>
   <Token></Token>
   <Phone></Phone>
   <ivrType></ivrType>
   <CommonTTS></CommonTTS>
   <DigitMode></DigitMode>
   <EnglishMode></EnglishMode>
   <CommonIVR></CommonIVR>
   <Caller></Caller>
   <CallRepeatedly></CallRepeatedly>
   <PlayTimes></PlayTimes>
   <ProceedPolicy></ProceedPolicy>
   <TransferTo></TransferTo>
   <Record></Record>
   <CustomData></CustomData>
   <KeyAction0>
     <Policy></Policy>
     <ivrType></ivrType>
     <TransferTo></TransferTo>
     <TTS></TTS>
     <IVR></IVR>
   </KeyAction0>
     .
     .
     .
   <KeyAction9>
     <Policy></Policy>
     <ivrType></ivrType>
     <TransferTo></TransferTo>
     <TTS></TTS>
     <IVR></IVR>
   </KeyAction9>
</xml>
  


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

参数必要性含义
ActionType必填
UserName必填
Token必填
Phone必填
ivrType必填
CommonTTS可选
DigitMode可选
EnglishMode可选
CommonIVR可选
Caller可选
CallRepeatedly可选
PlayTimes可选
ProceedPolicy可选
TransferTo可选
Record可选
CustomData可选
KeyAction(x)可选
KeyAction(x)/Policy可选
KeyAction(x)/ivrType可选
KeyAction(x)/TransferTo可选
KeyAction(x)/TTS可选
KeyAction(x)/IVR可选

返回值:
<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>
   <ivrType></ivrType>
   <CommonTTS></CommonTTS>
   <CommonIVR></CommonIVR>
   <PlayTimes></PlayTimes>
   <ProceedPolicy></ProceedPolicy>
   <TransferTo></TransferTo>
   <Record></Record>
   <RecordFiles></RecordFiles>
   <CustomData></CustomData>
   <Key></Key>
   <SubmitTime></SubmitTime>
   <CallPhoneTime></CallPhoneTime>
   <ConnectPhoneTime></ConnectPhoneTime>
   <CallPhoneTimes></CallPhoneTimes>
   <CallTransferToTime></CallTransferToTime>
   <ConnectTransferToTime></ConnectTransferToTime>
   <EndTime></EndTime>
</xml>


返回值参数说明:

参数含义
errorcode
errmsg
TaskSN
Caller
Phone
ivrType
CommonTTS
CommonIVR
PlayTimes
ProceedPolicy
TransferTo
Record
RecordFiles
CustomData
Key
SubmitTime
CallPhoneTime
ConnectPhoneTime
CallPhoneTimes
CallTransferToTime
ConnectTransferToTime
EndTime

3.3、接口功能:查询当前可用的并发数 ( QueryAvailableCoCurrent )


功能说明:
该接口用于查询当前账号可用的语音通知并发数,出于对资源的合理利用考虑,每个账户的语音通知都有并发数限制,当可用并发数为0时,用户无法提交新的语音通知任务,只有等待执行中的语音通知任务释放后才能追加新的任务。并发数可以根据业务需求进行调整,如果需要调整,请联系客服。

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


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

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

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


返回值参数说明:

参数含义
errorcode
errmsg
AvailableCoCurrent

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


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

用户亦可在每次提交语音通知任务时动态变更回调消息的接收地址,如需实现该动态变更功能,请咨询技术客服。

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

4.2、回调消息:开始呼叫被叫电话(StartDialPhone)


消息说明:
该消息在本次语音通知任务就绪,并开始呼叫被叫电话时触发。

用户系统接收的XML数据包:
<xml>
   <PushSN></PushSN>
   <UserName></UserName>
   <Business>VoiceNotice</Business>
   <Event>StartDialPhone</Event>
   <TaskSN></TaskSN>
   <CustomData></CustomData>
   <Time></Time>
</xml>


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

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

4.3、回调消息:被叫电话接通(PhoneConnected)


消息说明:
该消息在被叫电话接通时触发。

用户系统接收的XML数据包:
<xml>
   <PushSN></PushSN>
   <UserName></UserName>
   <Business>VoiceNotice</Business>
   <Event>PhoneConnected</Event>
   <TaskSN></TaskSN>
   <CustomData></CustomData>
   <Time></Time>
</xml>


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

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

4.4、回调消息:开始呼叫客服电话(StartDialTransferTo)


消息说明:
该消息在需要呼叫客服电话的接续流程中,开始呼叫客服电话时触发,此时用户系统可以根据业务逻辑,给客服人员弹屏。

用户系统接收的XML数据包:
<xml>
   <PushSN></PushSN>
   <UserName></UserName>
   <Business>VoiceNotice</Business>
   <Event>StartDialTransferTo</Event>
   <TaskSN></TaskSN>
   <Key></Key>
   <TransferTo></TransferTo>
   <CustomData></CustomData>
   <Time></Time>
</xml>


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

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

4.5、回调消息:客服电话接通(TransferToConnected)


消息说明:
该消息在需要呼叫客服电话的接续流程中,客服电话接通时触发,此时用户系统可以根据业务逻辑,给客服人员弹屏。

用户系统接收的XML数据包:
<xml>
   <PushSN></PushSN>
   <UserName></UserName>
   <Business>VoiceNotice</Business>
   <Event>TransferToConnected</Event>
   <TaskSN></TaskSN>
   <Key></Key>
   <TransferTo></TransferTo>
   <CustomData></CustomData>
   <Time></Time>
</xml>


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

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

4.6、回调消息:通话结束(HangUP)


消息说明:
该消息在被叫电话挂断时触发。

用户系统接收的XML数据包:
<xml>
   <PushSN></PushSN>
   <UserName></UserName>
   <Business>VoiceNotice</Business>
   <Event>HangUP</Event>
   <TaskSN></TaskSN>
   <CustomData></CustomData>
   <Time></Time>
</xml>


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

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

4.7、回调消息:推送本次呼叫日志(ReportCDR)


消息说明:
该消息在语音通知任务执行完毕后触发,向用户系统推送本次语音通知任务执行的详情。

用户系统接收的XML数据包:
<xml>
   <PushSN></PushSN>
   <UserName></UserName>
   <Business>VoiceNotice</Business>
   <Event>ReportCDR</Event>
   <TaskSN></TaskSN>
   <Caller></Caller>
   <Phone></Phone>
   <TransferTo></TransferTo>
   <RecordFiles></RecordFiles>
   <Key></Key>
   <AvailableCoCurrent></AvailableCoCurrent>
   <SubmitTime></SubmitTime>
   <CallPhoneTime></CallPhoneTime>
   <ConnectPhoneTime></ConnectPhoneTime>
   <CallPhoneTimes></CallPhoneTimes>
   <CallTransferToTime></CallTransferToTime>
   <ConnectTransferToTime></ConnectTransferToTime>
   <EndTime></EndTime>
   <CustomData></CustomData>
   <Time></Time>
</xml>


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

参数含义
PushSN
UserName
Business
Event
TaskSN
Caller
Phone
TransferTo
RecordFiles
Key
AvailableCoCurrent
SubmitTime
CallPhoneTime
ConnectPhoneTime
CallPhoneTimes
CallTransferToTime
ConnectTransferToTime
EndTime
CustomData
Time
用户系统响应:
用户系统接收到该消息后,需要返回字符串0,服务器如果未接收到正确的返回,将在三秒内重发该消息(最多三次)。

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

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