文档中心 > API类目 > 菜鸟无线API

cainiao.guoguo.fulfil.check.needuploadimage (快递员开箱验视服务checkNeedUploadImage)

checkNeedUploadImage

公共参数

请求地址：

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

请求参数

名称	类型	是否必须	示例值	更多限制	描述
app_context_param	AppContextParam	可选			客户端信息
└ app_battery String 可选 45 电池用电量 └ device_type String 可选 ios app是android还是ios └ loc_accuracy String 可选 23 小件员-定位时间 └ loc_auth String 可选 true gps-定位权限授予 └ loc_lat String 可选 123.22 小件员-所在的纬度 └ loc_lng String 可选 123.22 小件员-所在的经度 └ loc_open String 可选 true gps-定位是否打开,GPS定位开启 └ loc_succ String 可选 true gps-定位是否成功 └ loc_time Number 可选 123 小件员-定位时间 └ loc_type String 可选 gps 小件员-定位方式 └ pkg_id String 可选 fsdfId 对应包裹侠的包id └ pkg_name String 可选 fsdf.sdf 对应包裹侠的包名 └ sdk_version String 可选 6.0.1 sdk的版本号
execute_user_list	ExecuteUserDto []	可选		最大列表长度：20	账号list
└ execute_user_id Number 可选 0 参数executeUserId └ execute_user_type String 可选 foo 参数executeUserType
gps_latitude	String	可选	124.113		签收时维度
gps_longitude	String	可选	124.113		签收时经度
personal_session	String	必须	dsdf324234234324		个人账号sessionCode不能为空
personal_user_id	Number	必须	324234234324		个人账号ID不能为空
task_order_id	Number	必须	1042423423		履行任务单ID不能为空

响应参数

名称	类型	示例值	描述
data	Boolean	false	参数data
status_code	String	PARAMS_CANNOT_BE_NULL	错误码
status_message	String	参数不能为空	错误描述
is_success	Boolean	true	是否成功
trace_id	String	0be4314615320739620257888e18e2	鹰眼ID

请求示例

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoFulfilCheckNeeduploadimageRequest req = new CainiaoGuoguoFulfilCheckNeeduploadimageRequest();
CainiaoGuoguoFulfilCheckNeeduploadimageRequest.AppContextParam obj1 = new CainiaoGuoguoFulfilCheckNeeduploadimageRequest.AppContextParam();
obj1.setAppBattery("45");
obj1.setDeviceType("ios");
obj1.setLocAccuracy("23");
obj1.setLocAuth("true");
obj1.setLocLat("123.22");
obj1.setLocLng("123.22");
obj1.setLocOpen("true");
obj1.setLocSucc("true");
obj1.setLocTime(123L);
obj1.setLocType("gps");
obj1.setPkgId("fsdfId");
obj1.setPkgName("fsdf.sdf");
obj1.setSdkVersion("6.0.1");
req.setAppContextParam(obj1);
List<CainiaoGuoguoFulfilCheckNeeduploadimageRequest.ExecuteUserDto> list3 = new ArrayList<CainiaoGuoguoFulfilCheckNeeduploadimageRequest.ExecuteUserDto>();
CainiaoGuoguoFulfilCheckNeeduploadimageRequest.ExecuteUserDto obj4 = new CainiaoGuoguoFulfilCheckNeeduploadimageRequest.ExecuteUserDto();
list3.add(obj4);
obj4.setExecuteUserId(0L);
obj4.setExecuteUserType("foo");
req.setExecuteUserList(list3);
req.setGpsLatitude("124.113");
req.setGpsLongitude("124.113");
req.setPersonalSession("dsdf324234234324");
req.setPersonalUserId(324234234324L);
req.setTaskOrderId(1042423423L);
CainiaoGuoguoFulfilCheckNeeduploadimageResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

响应示例

XML示例
JSON示例

<cainiao_guoguo_fulfil_check_needuploadimage_response>
    <data>false</data>
    <status_code>PARAMS_CANNOT_BE_NULL</status_code>
    <status_message>参数不能为空</status_message>
    <is_success>true</is_success>
    <trace_id>0be4314615320739620257888e18e2</trace_id>
</cainiao_guoguo_fulfil_check_needuploadimage_response>

异常示例

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>

错误码解释

错误码	错误描述	解决方案

API工具

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

如何获得此API

FAQ

我要提问

返回
顶部

淘宝开放平台

菜鸟无线API

cainiao.guoguo.fulfil.check.needuploadimage (快递员开箱验视服务checkNeedUploadImage)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ