淘宝开放平台 - 文档中心

请求地址：

环境	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。

名称	类型	是否必须	示例值	更多限制	描述
task_content	UTouchDeliverTaskContent	必须			任务内容
└ deliver_targets String [] 可选 ["xxxx","xxxx"] 列表格式，传入ouid └ out_node_inst_id Number 可选 4001 节点实例ID └ crowd_mode Boolean 可选 false 人群模式 └ plh_val String 可选 {\"store_name\": \"青鸥测试店铺\", \"category\":\"3c\", \"solution\":\"优惠券方案\", \"reason":"不想要了\"} 外呼模板的变量，key为占位符，value是替换值 └ mobile_acquisition_rule String [] 可选 [3,1,2] 自定义手机号获取规则 └ task_code String 可选 top-utouch-1 服务场景code

名称	类型	示例值	描述
result	NodeExecuteReportDto		非人群模式的发送报告
└ coupon_un_use_count Number 1000 couponUnUseCount └ coupon_used_count Number 200 couponUsedCount └ coupon_using_count Number 800 couponUsingCount └ fail_bill_count Number 40 failBillCount └ fail_count Number 20 failCount └ fail_statistics String {} failStatistics └ limited_count Number 5 limitedCount └ node_inst_id Number 4001 nodeInstId └ short_link_click_pv Number 1000 shortLinkClickPv └ short_link_click_uv Number 500 shortLinkClickUv └ success_bill_count Number 200 successBillCount └ success_count Number 100 successCount └ total_count Number 1000 totalCount └ unknown_status_bill_count Number 20 unknownStatusBillCount └ unknown_status_count Number 10 unknownStatusCount

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
OpencrmUtouchListSendRequest req = new OpencrmUtouchListSendRequest();
OpencrmUtouchListSendRequest.UTouchDeliverTaskContent obj1 = new OpencrmUtouchListSendRequest.UTouchDeliverTaskContent();
obj1.setDeliverTargets(""xxxx","xxxx"");
obj1.setOutNodeInstId(4001L);
obj1.setCrowdMode(false);
obj1.setPlhVal("{\\"store_name\\": \\"青鸥测试店铺\\",       \\"category\\":\\"3c\\",       \\"solution\\":\\"优惠券方案\\",       \\"reason\":\"不想要了\\"}");
obj1.setMobileAcquisitionRule("3,1,2");
obj1.setTaskCode("top-utouch-1");
req.setTaskContent(obj1);
OpencrmUtouchListSendResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
OpencrmUtouchListSendRequest req = new OpencrmUtouchListSendRequest();
OpencrmUtouchListSendRequest.UTouchDeliverTaskContentDomain obj1 = new OpencrmUtouchListSendRequest.UTouchDeliverTaskContentDomain();
obj1.DeliverTargets = ""xxxx","xxxx"";
obj1.OutNodeInstId = 4001L;
obj1.CrowdMode = false;
obj1.PlhVal = "{\\"store_name\\": \\"青鸥测试店铺\\",       \\"category\\":\\"3c\\",       \\"solution\\":\\"优惠券方案\\",       \\"reason\":\"不想要了\\"}";
obj1.MobileAcquisitionRule = "3,1,2";
obj1.TaskCode = "top-utouch-1";
req.TaskContent_ = obj1;
OpencrmUtouchListSendResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new OpencrmUtouchListSendRequest;
$task_content = new UTouchDeliverTaskContent;
$task_content->deliver_targets="[\"xxxx\",\"xxxx\"]";
$task_content->out_node_inst_id="4001";
$task_content->crowd_mode="false";
$task_content->plh_val="{\\"store_name\\": \\"青鸥测试店铺\\",       \\"category\\":\\"3c\\",       \\"solution\\":\\"优惠券方案\\",       \\"reason\":\"不想要了\\"}";
$task_content->mobile_acquisition_rule="[3,1,2]";
$task_content->task_code="top-utouch-1";
$req->setTaskContent(json_encode($task_content));
$resp = $c->execute($req, $sessionKey);

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=taobao.opencrm.utouch.list.send' \
-d 'partner_id=apidoc' \
-d 'session=bb5bc848-512d-4122-9b44-5078327c6191' \
-d 'sign=67454257C61A5DBA1887ACCBEF6CF507' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-18+16%3A27%3A10' \
-d 'v=2.0' \
-d 'task_content=%7B%7D'

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

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

req.task_content="{}"
try:
	resp= req.getResponse(sessionkey)
	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,"taobao.opencrm.utouch.list.send");
add_param(pRequest,"task_content","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
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('taobao.opencrm.utouch.list.send', {
	'task_content':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<opencrm_utouch_list_send_response>
    <result>
        <coupon_un_use_count>1000</coupon_un_use_count>
        <coupon_used_count>200</coupon_used_count>
        <coupon_using_count>800</coupon_using_count>
        <fail_bill_count>40</fail_bill_count>
        <fail_count>20</fail_count>
        <fail_statistics>{}</fail_statistics>
        <limited_count>5</limited_count>
        <node_inst_id>4001</node_inst_id>
        <short_link_click_pv>1000</short_link_click_pv>
        <short_link_click_uv>500</short_link_click_uv>
        <success_bill_count>200</success_bill_count>
        <success_count>100</success_count>
        <total_count>1000</total_count>
        <unknown_status_bill_count>20</unknown_status_bill_count>
        <unknown_status_count>10</unknown_status_count>
    </result>
</opencrm_utouch_list_send_response>

{
    "opencrm_utouch_list_send_response":{
        "result":{
            "coupon_un_use_count":1000,
            "coupon_used_count":200,
            "coupon_using_count":800,
            "fail_bill_count":40,
            "fail_count":20,
            "fail_statistics":"{}",
            "limited_count":5,
            "node_inst_id":4001,
            "short_link_click_pv":1000,
            "short_link_click_uv":500,
            "success_bill_count":200,
            "success_count":100,
            "total_count":1000,
            "unknown_status_bill_count":20,
            "unknown_status_count":10
        }
    }
}

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"
	}
}

错误码	错误描述	解决方案
10002	参数校验异常	参考文档检测入参

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

开放平台

客户运营平台API

taobao.opencrm.utouch.list.send (指定列表发送外呼)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ