淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
workcard_reserve_request	WorkcardReserveRequest	可选			请求参数
└ workcard_id Number 必须 12345 工单 ID └ worker_id Number 可选 1234567890 工人 ID └ reserve_type String 必须 reserve_success 预约成功/预约失败 └ operation_type String 可选 reserve 预约类型：预约/改约 └ reason_code Number 可选 1 改约/预约失败原因 code └ reserve_date Date 可选 2024-05-12 09:00:00 预约日期 └ reserve_time_range String 可选 09:00-12:00 预约时间段

名称	类型	示例值	描述
result	Result		返回对象
└ success Boolean false 是否成功 └ system_error Boolean 系统异常失败原因 └ msg_info String 系统异常失败原因 └ msg_code String 500 错误码

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaMsfserviceWorkcardReserveRequest req = new AlibabaMsfserviceWorkcardReserveRequest();
AlibabaMsfserviceWorkcardReserveRequest.WorkcardReserveRequest obj1 = new AlibabaMsfserviceWorkcardReserveRequest.WorkcardReserveRequest();
obj1.setWorkcardId(12345L);
obj1.setWorkerId(1234567890L);
obj1.setReserveType("reserve_success");
obj1.setOperationType("reserve");
obj1.setReasonCode(1L);
obj1.setReserveDate(StringUtils.parseDateTime("2024-05-12 09:00:00"));
obj1.setReserveTimeRange("09:00-12:00");
req.setWorkcardReserveRequest(obj1);
AlibabaMsfserviceWorkcardReserveResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaMsfserviceWorkcardReserveRequest req = new AlibabaMsfserviceWorkcardReserveRequest();
AlibabaMsfserviceWorkcardReserveRequest.WorkcardReserveRequestDomain obj1 = new AlibabaMsfserviceWorkcardReserveRequest.WorkcardReserveRequestDomain();
obj1.WorkcardId = 12345L;
obj1.WorkerId = 1234567890L;
obj1.ReserveType = "reserve_success";
obj1.OperationType = "reserve";
obj1.ReasonCode = 1L;
obj1.ReserveDate = DateTime.Parse(2024-05-12 09:00:00");
obj1.ReserveTimeRange = "09:00-12:00";
req.WorkcardReserveRequest_ = obj1;
AlibabaMsfserviceWorkcardReserveResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaMsfserviceWorkcardReserveRequest;
$workcard_reserve_request = new WorkcardReserveRequest;
$workcard_reserve_request->workcard_id="12345";
$workcard_reserve_request->worker_id="1234567890";
$workcard_reserve_request->reserve_type="reserve_success";
$workcard_reserve_request->operation_type="reserve";
$workcard_reserve_request->reason_code="1";
$workcard_reserve_request->reserve_date="2024-05-12 09:00:00";
$workcard_reserve_request->reserve_time_range="09:00-12:00";
$req->setWorkcardReserveRequest(json_encode($workcard_reserve_request));
$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=alibaba.msfservice.workcard.reserve' \
-d 'partner_id=apidoc' \
-d 'session=e22e7275-df08-472c-84a6-2a52a743e54d' \
-d 'sign=18D0A46AF357B9F1BA979459C7306DA9' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+17%3A33%3A29' \
-d 'v=2.0' \
-d 'workcard_reserve_request=null'

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

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

req.workcard_reserve_request="数据结构示例JSON格式"
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,"alibaba.msfservice.workcard.reserve");
add_param(pRequest,"workcard_reserve_request","数据结构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('alibaba.msfservice.workcard.reserve', {
	'workcard_reserve_request':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_msfservice_workcard_reserve_response>
    <result>
        <success>false</success>
        <system_error>系统异常</system_error>
        <msg_info>系统异常</msg_info>
        <msg_code>500</msg_code>
    </result>
</alibaba_msfservice_workcard_reserve_response>

{
    "alibaba_msfservice_workcard_reserve_response":{
        "result":{
            "success":false,
            "system_error":系统异常,
            "msg_info":"系统异常",
            "msg_code":"500"
        }
    }
}

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.msfservice.workcard.reserve (喵师傅工单预约/改约/预约失败)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ