IVR 基础命令

1. 获取按键

• 获取用户按键信息，只能作为主命令使用。命令名称为<Get>。
• 
  
• 属性

• 嵌套规则
• 在<Get>中可以嵌套：<Play>、<PlayTTS>。
• 
  
• 示例

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Get action="handle-user-input.jsp" numdigits="1">
        <Play>menu.wav</Play>
    </Get>
    <Play>sorrybye.wav</Play>
    <Redirect>/welcome/voice</Redirect>
</Response>

• 示例解释
  • 获取用户按键，同时播放语音文件提示用户，若用户按键则云平台向应用侧action属性对应的URL发起请求，若用户按键超时则播放sorrybye.wav语音，语音播放完或按键打断后业务流程重定向到Redirect指向的URL。

2. 放音

• 播放语音文件，支持wav和mp3语音格式文件，可作为主、副命令使用，放音完成后跳转将执行后续副命令中的呼转命令。命令名称为<Play>。

• 属性

• 
  
• 嵌套规则
  • 此命令不支持嵌套。
• 
  
• 示例

<?xml version="1.0" encoding="UTF-8" ?>
<Response>
    <Play>cowbell.wav</Play>
    <Redirect>otherservice</Redirect>
</Response>

• 放音文件说明
  • 当isrecord=“true”的时候，放音文件名必需是云通讯返回的录音文件名，放音文件的格式样本如下：位速 128kbps，音频采样大小16位，频道 1(单声道)， 音频采样级别 8 kHz，音频格式 PCM。这样能保证放音的清晰度。

3. 播放混合音

• 播放语音文件，播放混合音，内容为数字或字母与文件名拼成的串，以分号分隔，字母不区分大小写。可作为主、副命令使用，放音完成后跳转将执行后续副命令中的呼转命令。命令名称为<PlayMix>。
• 
  
• 属性

• 嵌套规则
  • 此命令不支持嵌套。
• 
  
• 示例

    <?xml version="1.0" encoding="UTF-8" ?>
<Response>
    <PlayMix type="4140">hello.wav;2013-7-30;welcome.wav;1234</PlayMix>
    <Redirect>otherservice</Redirect>
</Response>

• 
  
• 示例解释
  • 用户听到的内容为：“尊敬的用户您好，今天是2013年7月30日欢迎光临云通讯平台1234”。

4. 录音

• 电话录音功能，只能作为主命令使用。命令名称为<Record>。
• 
  
• 属性

• 
  
• 嵌套规则
  • 可以嵌套Play命令，播放录音前提示音。
• 
  
• 示例

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Record>
       <Play>promt.wav</Play>
    </Record>
    <Play>test.wav</Play>
    <Redirect tag="9">dfaa</Redirect>
</Response>

• 
  
• 示例解释
  • 平台执行<Record>，呼叫者在听到”beep”声后开始录音。若呼叫者静默5秒钟后输入结束键，或者已到录音最长时间，平台将携带参数“RecUrl”将向“action”指定的URL发起指定方法请求。

5. 播放TTS

• 播放文本转语音，将用户的文本转换语音文件进行播放，文本中的汉字需要用utf8编码，可作为主、副命令使用，放音完成后跳转将执行后续副命令中的呼转命令。命令名称为<PlayTTS>。
• 
  
• 属性

• 
  
• 嵌套规则
  • 此命令不支持嵌套。
• 
  
• 示例

    <?xml version="1.0" encoding="UTF-8" ?>
<Response>
    <PlayTTS>您好，这里云通讯开放平台系统</PlayTTS>
    <Redirect>otherservice</Redirect>
</Response>

6. 咨询呼叫

• 为用户发起咨询呼叫，被咨询者接听后自动与用户进行话路桥接，只能作为主命令使用。命令名称<ConsultationCall>。
• 
  
• 属性

• 嵌套规则
  • 只能嵌套<Play>，为用户播放等待音。

• 示例

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <ConsultationCall number=”13800138000” record=”true”>
        <Play>waitmusic.wav</Play>
    </ConsultationCall>
    <Play>sorry.wav</Play>
    <Redirect>continue</Redirect>
</Response>

7. 咨询呼叫桥接

• 若咨询呼叫不是自动桥接，需要能过此命令进行桥接，用于主命令。命令名称<ConsultationBridge>。
• 
  
• 属性

• 
  
• 嵌套规则
  • 可嵌套<Play>、<PlayTTS>命令。
• 
  
• 示例

    <?xml version="1.0" encoding="UTF-8"?>
<Response>
    <ConsultationBridge>
        <Play>prompt.wav</Play>
    </ConsultationBridge>
    <Redirect>connectfail</Redirect>
</Response>

8. 呼叫转接

• 为用户发起呼叫转接，发起呼叫后主被叫会被立刻桥接，即主叫可以听到被叫的振铃音，只能作为主命令使用，如果被叫未接听、占线或拒接，将跳转到后续副命令中的呼转命令。命令名称<TransferCall>。
• 
  
• 属性

• 
  
• 嵌套规则
  • 不支持嵌套命令。
• 
  
• 示例

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <TransferCall number=”13800138000” record=”true”/>
    <Play>sorry.wav</Play>
    <Redirect>continue</Redirect>
</Response>

9. 发送DTMF

• 发送DTMF按键。可作为主命令使用。若action为空则执行跳转命令。命令名称为<SendDTMF>。
• 
  
• 属性

• 
  
• 嵌套规则
  • 此命令不支持嵌套。
• 
  
• 示例

    <?xml version="1.0" encoding="UTF-8"?>
    <Response>
      <SendDTMF action="senddtmfok" dtmf="123"/>
    <Redirect>otherservice</Redirect>
    </Response>

10. 业务跳转

• 业务跳转到另一个URL地址，不可作为主命令使用。命令名称<Redirect>。返回呼转请求通知
• 
  
• 属性

• 
  
• 嵌套规则
  • 不嵌套其它命令也不能被嵌套。
• 
  
• 示例

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Play>paly.wav</Play>
    <Redirect tag="0">mmstory</Redirect>
</Response>

11. 通话连接

• 将两用户进行连接通话，用户一方只能在做了Pause命令后才可执行此命令。命令名称<Connect>。
• 
  
• 属性

• 
  
• 嵌套规则
  • 不支持嵌套命令。
• 
  
• 示例

<?xml version="1.0" encoding="UTF-8"?>
<Response>
<Connect mcallid ="13421304281638380001000000000001" callsid="16421304281638380001000000000002"/>
    <Redirect>connectfail</Redirect>
</Response>

12. 应用侧挂机

• 应用侧挂机命令，可作为主、副命令使用，执行后会发起。命令名称<Hangup>。
• 
  
• 属性

• 
  
• 嵌套规则
  • 不能嵌套其它命令也不能被嵌套。
• 
  
• 示例

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Hangup callid ="13421304281638380001000000000009"/>
</Response>

13. 拒接

• 应用侧拒接，可作为主命令使用，只能在启动业务请求后回复，其它情况下不建议使用。命令名称<Refuse>。
• 
  
• 属性

• 
  
• 嵌套规则
  • 可嵌套<Play>。
• 
  
• 示例

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Refuse reason="busy">
        <Play>SaySorry.wav</Play>
    </Refuse>
</Response>

14. 暂停

• 命令说明：将用户的呼叫session暂停，并播放等待音，直AS侧再次发送命令来控制该用户。暂停时间到后会通<Redirect>命令反回给AS通知。命令名称<Pause>。
• 
  
• 属性

• 
  
• 嵌套规则
  • 可嵌套<Play>。
• 
  
• 示例

<?xml version="1.0" encoding="UTF-8"?>
<Response>
    <Pause callid="13421304281638380001000000000001">
        <Play>waitmusic.wav</Play>
    </Pause >
    <Redirect>pausefinish</Redirect>
</Response>

15. 空指令

• 应用侧只是对平台通知事件的响应，无需平台做任何事情。命令名称<CmdNone>。
• 
  
• 属性
• 无

• 嵌套规则
  • 不能嵌套也不能被嵌套。
• 
  
• 示例

<?xml version="1.0" encoding="UTF-8" ?>
<Response>
    <CmdNone/>
</Response>