接口说明
- 用于查询项目下的外部出行人信息
- 适用于会议场景,需先联系滴滴侧对接人开启相关白名单
基本信息
|
HTTP URL |
/open-apis/v2/project/outTravelerList |
|---|---|
|
HTTP Method |
GET |
|
权限要求 |
|
请求头
|
参数名称 |
参数值 |
|---|---|
|
Content-Type |
application/x-www-form-urlencoded |
请求参数
|
字段名 |
字段说明 |
字段类型 |
必填 |
备注 |
|---|---|---|---|---|
|
client_id |
应用唯一标识 |
string |
Y |
滴滴开放平台创建应用时,由平台分配的唯一标识,用于识别调用方身份 |
|
access_token |
接口调用授权凭证 |
string |
Y |
授权认证后获取的访问令牌,用于校验接口调用权限;授权认证方式参见【接口认证-授权认证】 |
|
company_id |
租户唯一标识 |
string |
Y |
滴滴企业版租户唯一 ID,代表当前操作的企业主体 |
|
timestamp |
当前时间戳 |
int |
Y |
当前时间戳,精确到秒级 |
|
sign |
签名 |
string |
Y |
根据规则生成的接口签名,用于校验请求合法性与完整性;生成方式参见【接口认证-授权认证】 |
|
project_id |
项目滴滴侧ID |
string |
N(有条件必填) |
项目ID(当前只支持单个) |
|
out_budget_id |
项目外部编号 |
string |
N(有条件必填) |
项目编号(当前只支持单个) |
|
page |
页码 |
int32 |
N |
页码,从1开始,默认1 |
|
page_size |
页数 |
int32 |
N |
每页大小,默认20,最大100 |
请求示例
curl -X GET \
-H "content-type:application/x-www-form-urlencoded" \
-d '{
"client_id":"client_id_test",
"access_token":"1e79178d3bfeb40be24404a3048f541f34dd6268",
"timestamp":1583484681,
"company_id":"12345678980",
"project_id":"1125904357323169",
"sign":"b517f48fcbe57a2d66dcefd560452da1",
"page":1,
"page_size":20
}'
响应参数
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
errno |
错误编码 |
int |
数字 0 表示成功,非 0 表示失败 |
|
errmsg |
错误信息 |
string |
errno=0时为常量"SUCCESS",errno!=0时为错误信息 |
|
data |
返回数据 |
array |
无匹配结果时返回null |
data
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
out_travelers |
外部出行人列表 |
[]*OutTravelerInfo |
|
|
total |
此次查询符合条件的人员总数 |
int64 |
|
OutTravelerInfo 外部出行人信息
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
traveler_id |
外部出行人滴滴侧ID |
int64 |
与创建外部出行人时滴滴返回 ID 一致 |
|
out_traveler_id |
外部出行人编码 |
string |
与创建外部出行人时传入编码一致 |
|
phone |
手机号 |
string |
使用海外手机号时为 +90 137****0001 ,国内不加区号 |
|
name |
姓名 |
string |
|
|
english_surname |
英文姓 |
string |
|
|
english_name |
英文名 |
string |
|
|
remark |
备注信息 |
string |
|
|
sex |
性别 |
int32 |
枚举值数字: |
|
birth_date |
出生日期 |
string |
格式为 yyyy-MM-dd |
|
card_list |
证件信息列表 |
[]*CardInfo |
|
|
related_employees |
关联内部员工列表 |
[]*RelatedEmployeeInfo |
该外部出行人所归属的的企业内部员工 |
|
project_id |
所属项目滴滴侧ID |
string |
|
|
project_name |
所属项目名称 |
string |
|
|
out_budget_id |
所属项目编码 |
string |
|
CardInfo 证件信息
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
card_no |
证件号码 |
string |
|
|
card_type |
证件类型编码 |
int32 |
|
|
expire_date |
证件有效期 |
string |
|
RelatedEmployeeInfo 关联员工信息
|
字段名 |
字段说明 |
字段类型 |
备注 |
|---|---|---|---|
|
related_employee_id |
关联员工滴滴 ID |
string |
|
|
related_employee_phone |
关联员工手机号 |
string |
|
|
related_employee_employee_number |
关联员工工号 |
string |
|
|
related_employee_email |
关联员工邮箱 |
string |
|
响应示例
正常示例
{
"errno": 0,
"errmsg": "SUCCESS",
"data": {
"out_travelers": [
{
"traveler_id": "4503599690839935",
"out_traveler_id": "out_traveler_id_11",
"phone": "+852 000****8060",
"name": "TYPE_3_外部_11",
"english_surname": "Wai",
"english_name": "BuCuXingRen",
"remark": "备注",
"sex": 1,
"birth_date": "8j7tDr8x/7k1KK/wxgbSwQ==",
"card_list": [
{
"card_no": "iyB+DOkzzSyo0cq0eeKKq/QtSp8KC17JTUmG7hYVH5w=",
"card_type": 1,
"expire_date": "5ClSL6sDiDKfu9en9mRX3A=="
}
],
"related_employees": null,
"project_id": "4503600193081934",
"project_name": "项目_test_8",
"out_budget_id": "xm_test_8"
}
],
"total": 1
},
"request_id": "4KcWC3fcNbTc0glzVB7fqX1o4UBzA5QLIy3pO/DuUkFnioiw7unq47iWwD320pZ7"
}
异常示例
{
"errno": 10003,
"errmsg": "未找到对应的项目",
"request_id": "MnJoknHiPeVg1rl4g3uR2FKJuFN83yE6n7lU7KfxnhJ9xuQgcX3pMmBDwoiI2dr2"
}
错误码
版本记录
|
日期 |
更新内容 |
上线时间 |
|---|---|---|
|
2026.6.23 |
新增文档 |
2026.6.23 |