淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
initiative_batch_task_request	InitiativeBatchTaskRequest	可选			initiative_batch_task_request
└ task_unique_code String 必须 79326d4a-7fcd-4670-87e3-0b853d15dd6b taskUniqueCode └ batch_num String 可选 1 批次Num 作为批次之间执行的先后顺序依据 task_list InitiativeTaskRequest [] 必须 {} 任务列表 └ source_id Number 可选 123 对接CMS 的sourceId └ department_id Number 可选 30001 xp上开启cms的部门id └ outer_user_id String 可选 OUTER_USER_ID 外部会员id，eg:淘宝uid └ input_params String 必须 {} 入参变量 └ user_name String 可选 USER_NAME 会员名称 └ cms_member_type String 可选 CMS_MEMBER_TYPE 账号拆分后cms系统的新版客户类型，替代之前的sourceId └ appointment_time_id Number 可选 1710230712 预约的时间段id └ phone_number String 可选 18717866218 联系人手机号码 (触达方式为智能外呼、短信时必填) └ policy_id Number 可选 123 预约回拨的task，对应预约策略ID └ book_charge_biz_info String 可选 {} 记录实际消费时其他的业务信息 └ output_params String 必须 {} 出参变量-结果回收槽位 └ biz_id String 可选 BIZ_ID 自定义业务Id,如果需要进行接口查询，必传 └ book_user_id Number 可选 123 记录实际消费主体id. （注：需要做任务账本计费时填写，如不填，默认为持卡本人id） └ cms_user_id Number 可选 123 cms会员id └ email String 可选 1234@qq.com 邮件地址 (触达方式为邮件时必填) └ plan_execute_start_time Date 可选 2024-03-12 14:05:56 计划执行开始时间 └ plan_id Number 必须 123 计划id use_book_info UseBookInfo 可选账本计费信息 └ use_platform String 必须 PLATFORM_A 使用平台 └ book_code String 必须 BOOK_CODE 账本码 └ book_owner_id Number 必须 123 账本持有人id

名称	类型	示例值	描述
result	Result		返回结果
└ code String 400 失败code data InitiativeTaskResponse [] 消息内容 └ task_id Number 123 提交任务生成的任务id task_request InitiativeTaskRequest 提交任务时的请求对象 └ policy_id Number 123 预约回拨的task，对应预约策略ID └ biz_id String BIZ_ID 自定义业务Id └ phone_number String 18717866218 联系人手机号码 └ outer_user_id String OUTER_USER_ID 外部会员id，eg:淘宝uid └ cms_user_id Number 123 cms会员id └ user_name String USER_NANE 会员名称 └ source_id Number 123 对接CMS 的sourceId └ cms_member_type String CMS_MEMBER_TYPE 账号拆分后cms系统的新版客户类型，替代之前的sourceId └ department_id Number 4124 xp上开启cms的部门id └ email String qwer@qq.com 邮件地址 └ input_params String {} 入参变量 └ output_params String {} 出参变量-结果回收槽位 └ plan_execute_start_time Date Thu Mar 14 15:16:52 CST 2024 计划执行开始时间 └ appointment_time_id Number 80 预约的时间段id └ book_user_id Number 123 记录实际消费主体id └ book_charge_biz_info String {} 记录实际消费时其他的业务信息 └ success Boolean true 是否成功 └ message String 参数错误失败消息内容

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest req = new AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest();
AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest.InitiativeBatchTaskRequest obj1 = new AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest.InitiativeBatchTaskRequest();
obj1.setTaskUniqueCode("79326d4a-7fcd-4670-87e3-0b853d15dd6b");
obj1.setBatchNum("1");
List<AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest.InitiativeTaskRequest> list3 = new ArrayList<AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest.InitiativeTaskRequest>();
AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest.InitiativeTaskRequest obj4 = new AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest.InitiativeTaskRequest();
list3.add(obj4);
obj4.setSourceId(123L);
obj4.setDepartmentId(30001L);
obj4.setOuterUserId("OUTER_USER_ID");
obj4.setInputParams("{}");
obj4.setUserName("USER_NAME");
obj4.setCmsMemberType("CMS_MEMBER_TYPE");
obj4.setAppointmentTimeId(1710230712L);
obj4.setPhoneNumber("18717866218");
obj4.setPolicyId(123L);
obj4.setBookChargeBizInfo("{}");
obj4.setOutputParams("{}");
obj4.setBizId("BIZ_ID");
obj4.setBookUserId(123L);
obj4.setCmsUserId(123L);
obj4.setEmail("1234@qq.com");
obj4.setPlanExecuteStartTime(StringUtils.parseDateTime("2024-03-12 14:05:56"));
obj1.setTaskList(list3);
obj1.setPlanId(123L);
AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest.UseBookInfo obj5 = new AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest.UseBookInfo();
obj5.setUsePlatform("PLATFORM_A");
obj5.setBookCode("BOOK_CODE");
obj5.setBookOwnerId(123L);
obj1.setUseBookInfo(obj5);
req.setInitiativeBatchTaskRequest(obj1);
AlibabaLingyangUtouchSubmitInitiativeBatchTaskResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest req = new AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest();
AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest.InitiativeBatchTaskRequestDomain obj1 = new AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest.InitiativeBatchTaskRequestDomain();
obj1.TaskUniqueCode = "79326d4a-7fcd-4670-87e3-0b853d15dd6b";
obj1.BatchNum = "1";
List<AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest.InitiativeTaskRequestDomain> list3 = new List<AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest.InitiativeTaskRequestDomain>();
AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest.InitiativeTaskRequestDomain obj4 = new AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest.InitiativeTaskRequestDomain();
list3.Add(obj4);
obj4.SourceId = 123L;
obj4.DepartmentId = 30001L;
obj4.OuterUserId = "OUTER_USER_ID";
obj4.InputParams = "{}";
obj4.UserName = "USER_NAME";
obj4.CmsMemberType = "CMS_MEMBER_TYPE";
obj4.AppointmentTimeId = 1710230712L;
obj4.PhoneNumber = "18717866218";
obj4.PolicyId = 123L;
obj4.BookChargeBizInfo = "{}";
obj4.OutputParams = "{}";
obj4.BizId = "BIZ_ID";
obj4.BookUserId = 123L;
obj4.CmsUserId = 123L;
obj4.Email = "1234@qq.com";
obj4.PlanExecuteStartTime = DateTime.Parse(2024-03-12 14:05:56");
obj1.TaskList= list3;
obj1.PlanId = 123L;
AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest.UseBookInfoDomain obj5 = new AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest.UseBookInfoDomain();
obj5.UsePlatform = "PLATFORM_A";
obj5.BookCode = "BOOK_CODE";
obj5.BookOwnerId = 123L;
obj1.UseBookInfo= obj5;
req.InitiativeBatchTaskRequest_ = obj1;
AlibabaLingyangUtouchSubmitInitiativeBatchTaskResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaLingyangUtouchSubmitInitiativeBatchTaskRequest;
$initiative_batch_task_request = new InitiativeBatchTaskRequest;
$initiative_batch_task_request->task_unique_code="79326d4a-7fcd-4670-87e3-0b853d15dd6b";
$initiative_batch_task_request->batch_num="1";
$task_list = new InitiativeTaskRequest;
$task_list->source_id="123";
$task_list->department_id="30001";
$task_list->outer_user_id="OUTER_USER_ID";
$task_list->input_params="{}";
$task_list->user_name="USER_NAME";
$task_list->cms_member_type="CMS_MEMBER_TYPE";
$task_list->appointment_time_id="1710230712";
$task_list->phone_number="18717866218";
$task_list->policy_id="123";
$task_list->book_charge_biz_info="{}";
$task_list->output_params="{}";
$task_list->biz_id="BIZ_ID";
$task_list->book_user_id="123";
$task_list->cms_user_id="123";
$task_list->email="1234@qq.com";
$task_list->plan_execute_start_time="2024-03-12 14:05:56";
$initiative_batch_task_request->task_list = $task_list;
$initiative_batch_task_request->plan_id="123";
$use_book_info = new UseBookInfo;
$use_book_info->use_platform="PLATFORM_A";
$use_book_info->book_code="BOOK_CODE";
$use_book_info->book_owner_id="123";
$initiative_batch_task_request->use_book_info = $use_book_info;
$req->setInitiativeBatchTaskRequest(json_encode($initiative_batch_task_request));
$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.lingyang.utouch.submit.initiative.batch.task' \
-d 'partner_id=apidoc' \
-d 'sign=61F5C04496D5BCAFA7C7064D3FF860A7' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+16%3A10%3A34' \
-d 'v=2.0' \
-d 'initiative_batch_task_request=null'

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

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

req.initiative_batch_task_request="数据结构示例JSON格式"
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.lingyang.utouch.submit.initiative.batch.task");
add_param(pRequest,"initiative_batch_task_request","数据结构JSON示例");
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.lingyang.utouch.submit.initiative.batch.task', {
	'initiative_batch_task_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_lingyang_utouch_submit_initiative_batch_task_response>
    <result>
        <code>400</code>
        <data>
            <initiative_task_response>
                <task_id>123</task_id>
                <task_request>
                    <policy_id>123</policy_id>
                    <biz_id>BIZ_ID</biz_id>
                    <phone_number>18717866218</phone_number>
                    <outer_user_id>OUTER_USER_ID</outer_user_id>
                    <cms_user_id>123</cms_user_id>
                    <user_name>USER_NANE</user_name>
                    <source_id>123</source_id>
                    <cms_member_type>CMS_MEMBER_TYPE</cms_member_type>
                    <department_id>4124</department_id>
                    <email>qwer@qq.com</email>
                    <input_params>{}</input_params>
                    <output_params>{}</output_params>
                    <plan_execute_start_time>Thu Mar 14 15:16:52 CST 2024</plan_execute_start_time>
                    <appointment_time_id>80</appointment_time_id>
                    <book_user_id>123</book_user_id>
                    <book_charge_biz_info>{}</book_charge_biz_info>
                </task_request>
            </initiative_task_response>
        </data>
        <success>true</success>
        <message>参数错误</message>
    </result>
</alibaba_lingyang_utouch_submit_initiative_batch_task_response>

{
    "alibaba_lingyang_utouch_submit_initiative_batch_task_response":{
        "result":{
            "code":"400",
            "data":{
                "initiative_task_response":[
                    {
                        "task_id":123,
                        "task_request":{
                            "policy_id":123,
                            "biz_id":"BIZ_ID",
                            "phone_number":"18717866218",
                            "outer_user_id":"OUTER_USER_ID",
                            "cms_user_id":123,
                            "user_name":"USER_NANE",
                            "source_id":123,
                            "cms_member_type":"CMS_MEMBER_TYPE",
                            "department_id":4124,
                            "email":"qwer@qq.com",
                            "input_params":"{}",
                            "output_params":"{}",
                            "plan_execute_start_time":"Thu Mar 14 15:16:52 CST 2024",
                            "appointment_time_id":80,
                            "book_user_id":123,
                            "book_charge_biz_info":"{}"
                        }
                    }
                ]
            },
            "success":true,
            "message":"参数错误"
        }
    }
}

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下载

开放平台

瓴羊客服云

alibaba.lingyang.utouch.submit.initiative.batch.task (批量提交触达任务到售卖区)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ