飞猪 - 开放平台

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
rq	BtripUserSyncRq	必须			人员同步请求
user_list UserSyncRq [] 必须人员列表，最大长度5000 └ email String 可选 123@163.com 邮箱 └ phone String 可选 12311112222 手机号（除政府企业、特殊企业外，均为必填;如有特殊需求，请先联系商旅） └ depart_id Number 可选 10 商旅部门ID └ leave_status Number 可选 0 是否离职（0 否 1是） └ position_level String 可选 20 职级 └ position String 可选开发职位 └ real_name_en String 可选 xiaoming 英文姓名请用"/"分隔，中间不能含有空格。顺序：姓/名(last_name/first_name)) └ user_name String 必须小明姓名 └ user_id String 必须 123 第三方人员ID └ job_no String 可选 8797 工号 └ third_depart_id String 可选 test001 第三方部门ID └ third_depart_id_list String [] 可选 ["1","2","3"] 部门列表，depart_id \| third_depart_id \| third_depart_id_list只传其一，优先级为third_depart_id_list > third_depart_id > depart_id └ manager_user_id String 可选 123456 直属主管id └ base_city_code String 可选 330100 工作地 6 位行政编码, 最多传入两个不同的行政编码. 格式要求: 若需传入两个行程编码时，请使用英文逗号","进行分隔 └ corp_id String 必须 12345 第三方企业ID

名称	类型	示例值	描述
result_msg	String	系统错误	错误信息
result_code	Number	500	错误码
success_flag	Boolean	true	成功标示
module	String	{"errorCode":100,"errorMsg":"企业ID不能为空","userSyncRq":{错误用户信息}}	返回错误用户信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlitripBtripCorpopUserSyncRequest req = new AlitripBtripCorpopUserSyncRequest();
AlitripBtripCorpopUserSyncRequest.BtripUserSyncRq obj1 = new AlitripBtripCorpopUserSyncRequest.BtripUserSyncRq();
List<AlitripBtripCorpopUserSyncRequest.UserSyncRq> list3 = new ArrayList<AlitripBtripCorpopUserSyncRequest.UserSyncRq>();
AlitripBtripCorpopUserSyncRequest.UserSyncRq obj4 = new AlitripBtripCorpopUserSyncRequest.UserSyncRq();
list3.add(obj4);
obj4.setEmail("123@163.com");
obj4.setPhone("12311112222");
obj4.setDepartId(10L);
obj4.setLeaveStatus(0L);
obj4.setPositionLevel("20");
obj4.setPosition("开发");
obj4.setRealNameEn("xiaoming");
obj4.setUserName("小明");
obj4.setUserId("123");
obj4.setJobNo("8797");
obj4.setThirdDepartId("test001");
obj4.setThirdDepartIdList(""1","2","3"");
obj4.setManagerUserId("123456");
obj4.setBaseCityCode("330100");
obj1.setUserList(list3);
obj1.setCorpId("12345");
req.setRq(obj1);
AlitripBtripCorpopUserSyncResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlitripBtripCorpopUserSyncRequest req = new AlitripBtripCorpopUserSyncRequest();
AlitripBtripCorpopUserSyncRequest.BtripUserSyncRqDomain obj1 = new AlitripBtripCorpopUserSyncRequest.BtripUserSyncRqDomain();
List<AlitripBtripCorpopUserSyncRequest.UserSyncRqDomain> list3 = new List<AlitripBtripCorpopUserSyncRequest.UserSyncRqDomain>();
AlitripBtripCorpopUserSyncRequest.UserSyncRqDomain obj4 = new AlitripBtripCorpopUserSyncRequest.UserSyncRqDomain();
list3.Add(obj4);
obj4.Email = "123@163.com";
obj4.Phone = "12311112222";
obj4.DepartId = 10L;
obj4.LeaveStatus = 0L;
obj4.PositionLevel = "20";
obj4.Position = "开发";
obj4.RealNameEn = "xiaoming";
obj4.UserName = "小明";
obj4.UserId = "123";
obj4.JobNo = "8797";
obj4.ThirdDepartId = "test001";
obj4.ThirdDepartIdList = ""1","2","3"";
obj4.ManagerUserId = "123456";
obj4.BaseCityCode = "330100";
obj1.UserList= list3;
obj1.CorpId = "12345";
req.Rq_ = obj1;
AlitripBtripCorpopUserSyncResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlitripBtripCorpopUserSyncRequest;
$rq = new BtripUserSyncRq;
$user_list = new UserSyncRq;
$user_list->email="123@163.com";
$user_list->phone="12311112222";
$user_list->depart_id="10";
$user_list->leave_status="0";
$user_list->position_level="20";
$user_list->position="开发";
$user_list->real_name_en="xiaoming";
$user_list->user_name="小明";
$user_list->user_id="123";
$user_list->job_no="8797";
$user_list->third_depart_id="test001";
$user_list->third_depart_id_list="[\"1\",\"2\",\"3\"]";
$user_list->manager_user_id="123456";
$user_list->base_city_code="330100";
$rq->user_list = $user_list;
$rq->corp_id="12345";
$req->setRq(json_encode($rq));
$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=alitrip.btrip.corpop.user.sync' \
-d 'partner_id=apidoc' \
-d 'session=ae6d168b-b2a3-45f6-8f3a-af8667a27a7c' \
-d 'sign=309DE988FEECD65F58FCF9DFF0630CF3' \
-d 'sign_method=hmac' \
-d 'timestamp=2024-11-21+19%3A35%3A32' \
-d 'v=2.0' \
-d 'rq=null'

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

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

req.rq=""
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,"alitrip.btrip.corpop.user.sync");
add_param(pRequest,"rq","数据结构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('alitrip.btrip.corpop.user.sync', {
	'rq':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alitrip_btrip_corpop_user_sync_response>
    <result_msg>系统错误</result_msg>
    <result_code>500</result_code>
    <success_flag>true</success_flag>
    <module>{&quot;errorCode&quot;:100,&quot;errorMsg&quot;:&quot;企业ID不能为空&quot;,&quot;userSyncRq&quot;:{错误用户信息}}</module>
</alitrip_btrip_corpop_user_sync_response>

{
    "alitrip_btrip_corpop_user_sync_response":{
        "result_msg":"系统错误",
        "result_code":500,
        "success_flag":true,
        "module":"{\"errorCode\":100,\"errorMsg\":\"企业ID不能为空\",\"userSyncRq\":{错误用户信息}}"
    }
}

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

alitrip.btrip.corpop.user.sync (外部人员同步)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ