注意:以下文档只适用于TOP接口,请谨慎使用!

文档中心 > API类目 > 阿里大于API

alibaba.aliqin.fc.ivr.num.call (ivr呼叫)

ivr呼叫

公共参数

请求参数

名称 类型 是否必须 示例值 更多限制 描述
called_number String 必须 13800000000 被叫号码,支持国内手机号与固话号码,格式如下057188773344,13911112222,4001112222,95500
called_show_number String 必须 057188773344 被叫号码侧的号码显示,传入的显示号码可以是阿里大鱼“管理中心-号码管理”中申请通过的号码。显示号码格式如下057188773344,4001112222,95500。显示号码也可以为主叫号码。
use_tts String 必须 tts 可选值:tts或voice。
menu_code String 必须 a.wav 当值为tts时,menu_codet填写tts模板;当值为voice时,menu_code填写语音模板编码
session_time_out String 可选 120 通话超时时长,如接通后到达120秒时,通话会因为超时自动挂断。若无需设置超时时长,可不传。
extend String 可选 12345 公共回传参数,在消息中带回
bye_code String 可选 a.wav 结束语编码,当use_tts=voice时,该字段填写语音文件编码,当use_tts=tts时,该字段填写tts模板编码
menu_args String 可选 {"code":"1234"} 当use_tts=tts时,该字段可填写tts模板变量参数
play_times Number 可选 3
  • 默认值:1
  • 播放次数
    params String 可选 { "menuKeyMap": [ { "key": "1", "action": "voice", "code": "1.wav" }, { "key": "2", "action": "voice", "code": "2.wav" }, { "key": "-1", (按键输入错误) "action": "voice", "code": "error.wav",(按键输入错误提示音) "max":"3",(按键输入错误最大次数) "maxNotice":"maxNotice.wav"(按键输入误超过最大输入次数的错提示音) } ]} 按键映射事件
    service_number String 可选 95*** 人工服务号码

    响应参数

    名称 类型 示例值 描述
    result Result result
    • └ model
    • String
    • 134523^4351232
    • model
    • └ err_code
    • String
    • 0
    • code
    • └ success
    • Boolean
    • true
    • success
    • └ msg
    • String
    • 成功
    • msg

    请求示例

    • JAVA
    • .NET
    • PHP
    • CURL
    • Python
    • C/C++
    • NodeJS
    TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
    AlibabaAliqinFcIvrNumCallRequest req = new AlibabaAliqinFcIvrNumCallRequest();
    req.setCalledNumber("13800000000");
    req.setCalledShowNumber("057188773344");
    req.setUseTts("tts");
    req.setMenuCode("a.wav");
    req.setSessionTimeOut("120");
    req.setExtend("12345");
    req.setByeCode("a.wav");
    req.setMenuArgsString("{\"code\":\"1234\"}");
    req.setPlayTimes(3L);
    req.setParamsString("{    \"menuKeyMap\": [         {             \"key\": \"1\",              \"action\": \"voice\",              \"code\": \"1.wav\"         },          {             \"key\": \"2\",              \"action\": \"voice\",              \"code\": \"2.wav\"         },          {             \"key\": \"-1\", (按键输入错误)             \"action\": \"voice\",              \"code\": \"error.wav\",(按键输入错误提示音)       \"max\":\"3\",(按键输入错误最大次数)       \"maxNotice\":\"maxNotice.wav\"(按键输入误超过最大输入次数的错提示音)         }     ]}");
    req.setServiceNumber("95***");
    AlibabaAliqinFcIvrNumCallResponse rsp = client.execute(req);
    System.out.println(rsp.getBody());

    响应示例

    • XML示例
    • JSON示例
    <alibaba_aliqin_fc_ivr_num_call_response>
        <result>
            <model>134523^4351232</model>
            <err_code>0</err_code>
            <success>true</success>
            <msg>成功</msg>
        </result>
    </alibaba_aliqin_fc_ivr_num_call_response>

    异常示例

    • XML示例
    • JSON示例
    <error_response>
        <code>50</code>
        <msg>Remote service error</msg>
        <sub_code>isv.invalid-parameter</sub_code>
        <sub_msg>非法参数</sub_msg>
    </error_response>

    错误码解释

    错误码 错误描述 解决方案

    API工具

    如何获得此API

    FAQ

    返回
    顶部