阿里大于 -

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	更多限制	描述
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	Json	可选	{"code":"1234"}		当use_tts=tts时，该字段可填写tts模板变量参数
play_times	Number	可选	3	默认值：1	播放次数
params	Json	可选	{ "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());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaAliqinFcIvrNumCallRequest req = new AlibabaAliqinFcIvrNumCallRequest();
req.CalledNumber = "13800000000";
req.CalledShowNumber = "057188773344";
req.UseTts = "tts";
req.MenuCode = "a.wav";
req.SessionTimeOut = "120";
req.Extend = "12345";
req.ByeCode = "a.wav";
req.MenuArgs = "{\"code\":\"1234\"}";
req.PlayTimes = 3L;
req.Params = "{    \"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.ServiceNumber = "95***";
AlibabaAliqinFcIvrNumCallResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$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->setMenuArgs("{\"code\":\"1234\"}");
$req->setPlayTimes("3");
$req->setParams("{    \"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***");
$resp = $c->execute($req);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=alibaba.aliqin.fc.ivr.num.call' \
-d 'partner_id=apidoc' \
-d 'sign=894AD3C00256323C6F1F75C8B08C0743' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-11-21+18%3A36%3A37' \
-d 'v=2.0' \
-d 'bye_code=a.wav' \
-d 'called_number=13800000000' \
-d 'called_show_number=057188773344' \
-d 'extend=12345' \
-d 'menu_args=%7B%5C%22code%5C%22%3A%5C%221234%5C%22%7D' \
-d 'menu_code=a.wav' \
-d 'params=%7B++++%5C%22menuKeyMap%5C%22%3A+%5B+++++++++%7B+++++++++++++%5C%22key%5C%22%3A+%5C%221%5C%22%2C++++++++++++++%5C%22action%5C%22%3A+%5C%22voice%5C%22%2C++++++++++++++%5C%22code%5C%22%3A+%5C%221.wav%5C%22+++++++++%7D%2C++++++++++%7B+++++++++++++%5C%22key%5C%22%3A+%5C%222%5C%22%2C++++++++++++++%5C%22action%5C%22%3A+%5C%22voice%5C%22%2C++++++++++++++%5C%22code%5C%22%3A+%5C%222.wav%5C%22+++++++++%7D%2C++++++++++%7B+++++++++++++%5C%22key%5C%22%3A+%5C%22-1%5C%22%2C+%28%E6%8C%89%E9%94%AE%E8%BE%93%E5%85%A5%E9%94%99%E8%AF%AF%29+++++++++++++%5C%22action%5C%22%3A+%5C%22voice%5C%22%2C++++++++++++++%5C%22code%5C%22%3A+%5C%22error.wav%5C%22%2C%28%E6%8C%89%E9%94%AE%E8%BE%93%E5%85%A5%E9%94%99%E8%AF%AF%E6%8F%90%E7%A4%BA%E9%9F%B3%29+++++++%5C%22max%5C%22%3A%5C%223%5C%22%2C%EF%BC%88%E6%8C%89%E9%94%AE%E8%BE%93%E5%85%A5%E9%94%99%E8%AF%AF%E6%9C%80%E5%A4%A7%E6%AC%A1%E6%95%B0%29+++++++%5C%22maxNotice%5C%22%3A%5C%22maxNotice.wav%5C%22%28%E6%8C%89%E9%94%AE%E8%BE%93%E5%85%A5%E8%AF%AF%E8%B6%85%E8%BF%87%E6%9C%80%E5%A4%A7%E8%BE%93%E5%85%A5%E6%AC%A1%E6%95%B0%E7%9A%84%E9%94%99%E6%8F%90%E7%A4%BA%E9%9F%B3%29+++++++++%7D+++++%5D%7D' \
-d 'play_times=3' \
-d 'service_number=95***' \
-d 'session_time_out=120' \
-d 'use_tts=tts'

# -*- coding: utf-8 -*-
import top.api

req=top.api.AlibabaAliqinFcIvrNumCallRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.called_number="13800000000"
req.called_show_number="057188773344"
req.use_tts="tts"
req.menu_code="a.wav"
req.session_time_out="120"
req.extend="12345"
req.bye_code="a.wav"
req.menu_args="{\"code\":\"1234\"}"
req.play_times=3
req.params="{    \"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.service_number="95***"
try:
	resp= req.getResponse()
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"alibaba.aliqin.fc.ivr.num.call");
add_param(pRequest,"called_number","13800000000");
add_param(pRequest,"called_show_number","057188773344");
add_param(pRequest,"use_tts","tts");
add_param(pRequest,"menu_code","a.wav");
add_param(pRequest,"session_time_out","120");
add_param(pRequest,"extend","12345");
add_param(pRequest,"bye_code","a.wav");
add_param(pRequest,"menu_args","{\"code\":\"1234\"}");
add_param(pRequest,"play_times","3");
add_param(pRequest,"params","{    \"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\"(按键输入误超过最大输入次数的错提示音)         }     ]}");
add_param(pRequest,"service_number","95***");
pResponse = top_execute(pClient,pRequest,NULL);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('alibaba.aliqin.fc.ivr.num.call', {
	'called_number':'13800000000',
	'called_show_number':'057188773344',
	'use_tts':'tts',
	'menu_code':'a.wav',
	'session_time_out':'120',
	'extend':'12345',
	'bye_code':'a.wav',
	'menu_args':'{\"code\":\"1234\"}',
	'play_times':'3',
	'params':'{    \"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':'95***'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

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>

{
    "alibaba_aliqin_fc_ivr_num_call_response":{
        "result":{
            "model":"134523^4351232",
            "err_code":"0",
            "success":true,
            "msg":"成功"
        }
    }
}

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>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

阿里大于API

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

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ