全部产品
云市场

交互式语音应答

更新时间:2018-10-10 20:45:53

交互式语音应答(ivrCall)

步骤 1 创建阿里云账号

为了访问语音服务,您需要有一个阿里云账号。如果没有,可首先按照如下步骤创建阿里云账号:

  1. 访问阿里云 官方网站,单击页面上的 免费注册 按钮。
  2. 按照屏幕提示完成注册流程并进行企业实名认证语音服务只支持企业实名认证用户使用。为了更好地使用阿里云服务,建议尽快完成实名认证,否则部分阿里云服务将无法使用。具体实名认证流程,请参考 这里

步骤 2 获取阿里云访问密钥

为了使用交互式语音应答API-PHP SDK,您必须申请阿里云的访问密钥。

阿里云访问秘钥是阿里云为用户使用 API(非控制台)来访问其云资源设计的“安全口令”。您可以用它来签名 API 请求内容以通过服务端的安全验证。

该访问秘钥成对(AccessKeyId 与 AccessKeySecret)生成和使用。每个阿里云用户可以创建多对访问秘钥,且可随时启用(Active)、禁用(Inactive)或者删除已经生成的访问秘钥对。

您可以通过阿里云控制台的 秘钥管理页面 创建、管理所有的访问秘钥对,且保证它处于“启用”状态。由于访问秘钥是阿里云对 API 请求进行安全验证的关键因子,请妥善保管你的访问秘钥。如果某些秘钥对出现泄漏风险,建议及时删除该秘钥对并生成新的替代秘钥对。

步骤 3 在控制台完成号码与模板的申请,获得调用接口必备的参数

在“语音号码”页面完成资质的申请,号码的购买

在“文本转语音模板”页面完成模板申请,或,在“语音通知文件”页面完成文件上传

入参列表

参数名称 参数类型 必填与否 样例取值 参数说明
CalledShowNumber String 必须 4001112222 被叫显号
CalledNumber String 必须 13700000000 被叫号码
StartCode String 必须 2d4c-4e78-8d2a-afbb06cf6216.wav或者TTS_1234 呼叫开始时播放的提示音-语音文件Code名称或者Tts模板Code,类型选择必须与ByeCode保持一致
StartTtsParams String 可选 {“name”:”xxx”,”code”:”123”} Tts模板变量替换JSON,当startCode为Tts时且Tts模板中带变量的情况下此参数必填
MenuKeyMapList List 必须 详见SDK中的MenuKeyMap结构体 按键和播放对应提示音的Map关系
ByeCode String 可选 2d4c-4e78-8d2a-afbb06cf6216.wav或者TTS_1234 播放结束时播放的结束提示音,支持语音文件和Tts2种方式,但是要求Tts中不支持变量,类型选择必须与StartCode保持一致
PlayTimes Long 可选 3 重复播放次数(最多3次)
OutId String 可选 abcdefgh 预留给调用方使用的ID, 最终会通过在回执消息中将此ID带回给调用方

出参列表

出参名称 出参类型 样例取值 参数说明
RequestId String 8906582E-6722 请求ID
Code String OK 状态码-返回OK代表请求成功,其他错误码详见错误码列表
Message String 请求成功 状态码的描述
CallId String 134523^4351232 调用的回执ID

技术对接步骤

1:下载SDK工具包

SDK&DEMO[下载地址]

2: 编写样例程序
  1. // 代码节选,详见aliyun-dyvms-php-sdk/api_demo/VmsDemo.php
  2. ...
  3. class VmsDemo
  4. {
  5. ...
  6. /**
  7. * 交互式语音应答
  8. *
  9. * @return stdClass
  10. * @throws ClientException
  11. */
  12. public static function ivrCall() {
  13. //组装请求对象-具体描述见控制台-文档部分内容
  14. $request = new IvrCallRequest();
  15. //必填-被叫显号
  16. $request->setCalledShowNumber("05344757036");
  17. //必填-被叫号码
  18. $request->setCalledNumber("1500000000");
  19. //选填-外呼流水号
  20. $request->setPlayTimes(3);
  21. //必填-语音文件ID或者tts模板的模板号,有参数的模板需要设置模板变量的值
  22. //$request->setStartCode("ebe3a2b5-c287-42a4-8299-fc40ae79a89f.wav");
  23. $request->setStartCode("TTS_713900000");
  24. $request->setStartTtsParams("{\"product\":\"aliyun\",\"code\":\"123\"}");
  25. $menuKeyMaps = array();
  26. $menuKeyMap1 = new MenuKeyMap();
  27. $menuKeyMap1->setKey("1");
  28. $menuKeyMap1->setCode("9a9d7222-670f-40b0-a3af.wav");
  29. $menuKeyMaps[] = $menuKeyMap1;
  30. $menuKeyMap2 = new MenuKeyMap();
  31. $menuKeyMap2->setKey("2");
  32. $menuKeyMap2->setCode("44e3e577-3d3a-418f-932c.wav");
  33. $menuKeyMaps[] = $menuKeyMap2;
  34. $menuKeyMap3 = new MenuKeyMap();
  35. $menuKeyMap3->setKey("3");
  36. $menuKeyMap3->setCode("TTS_71390000");
  37. $menuKeyMap3->setTtsParams("{\"product\":\"aliyun\",\"code\":\"123\"}");
  38. $menuKeyMaps[] = $menuKeyMap3;
  39. $request->setMenuKeyMaps($menuKeyMaps);
  40. //结束语可以使一个无参模板或者一个语音文件ID
  41. $request->setByeCode("TTS_71400007");
  42. //选填-外呼流水号
  43. $request->setOutId("yourOutId");
  44. //hint 此处可能会抛出异常,注意catch
  45. $response = static::getAcsClient()->getAcsResponse($request);
  46. return $response;
  47. }
  48. }
  49. $response = VmsDemo::ivrCall();
  50. echo "交互式语音应答(ivrCall)接口返回的结果:\n";
  51. print_r($response);

错误码列表

Code 描述
OK 请求成功
isp.RAM_PERMISSION_DENY RAM权限DENY
isv.OUT_OF_SERVICE 业务停机
isv.PRODUCT_UN_SUBSCRIPT 未开通云通信产品的阿里云客户
isv.OUT_OF_SERVICE 业务停机
isv.PRODUCT_UNSUBSCRIBE 产品未开通
isv.ACCOUNT_NOT_EXISTS 账户不存在
isv.ACCOUNT_ABNORMAL 账户异常
isv.VOICE_FILE_ILLEGAL 语音文件不合法
isv.DISPLAY_NUMBER_ILLEGAL 号显不合法
isv.INVALID_PARAMETERS 参数异常
isp.SYSTEM_ERROR 系统错误
isv.MOBILE_NUMBER_ILLEGAL 号码格式非法
isv.BUSINESS_LIMIT_CONTROL 触发流控