logistics.getContact

本接口应在服务器端调用,详细说明参见服务端API

本接口支持云调用。需开发者工具版本 >= 1.02.1904090(最新稳定版下载),wx-server-sdk >= 0.4.0

获取面单联系人信息

调用方式:

HTTPS 调用

请求地址

  1. POST https://api.weixin.qq.com/cgi-bin/express/delivery/contact/get?access_token=ACCESS_TOKEN

请求参数

属性类型默认值必填说明
access_tokenstring接口调用凭证
tokenstring商户侧下单事件中推送的 Token 字段
waybill_idstring运单 ID

返回值

Object

属性类型说明
waybill_idstring运单 ID
senderArray.<Object>发件人信息
receiverArray.<Object>收件人信息
errcodenumber错误码
errmsgstring错误信息

sender 的结构

属性类型说明
addressstring地址,已经将省市区信息合并
namestring用户姓名
telstring座机号码
mobilestring手机号码

receiver 的结构

属性类型说明
addressstring地址,已经将省市区信息合并
namestring用户姓名
telstring座机号码
mobilestring手机号码

errcode 的合法值

说明最低版本
0成功
-1其他错误
40199运单 ID 错误,未查到运单
9300507Token 不正确

请求数据示例

  1. {
  2. "token": "TOKEN",
  3. "waybill_id": "12345678901234567890"
  4. }

返回数据示例

  1. {
  2. "waybill_id": "12345678901234567890",
  3. "sender": {
  4. "address": "广东省广州市海珠区XX路XX号XX大厦XX栋XX",
  5. "name": "张三",
  6. "tel": "020-88888888",
  7. "mobile": "18666666666"
  8. },
  9. "receiver": {
  10. "address": "广东省广州市天河区XX路XX号XX大厦XX栋XX",
  11. "name": "王小蒙",
  12. "tel": "029-77777777",
  13. "mobile": "18610000000"
  14. }
  15. }

云调用

云调用是小程序·云开发提供的在云函数中调用微信开放接口的能力,需要在云函数中通过 wx-server-sdk 使用。

接口方法

  1. openapi.logistics.getContact

需在 config.json 中配置 logistics.getContact API 的权限,详情

请求参数

属性类型默认值必填说明
tokenstring商户侧下单事件中推送的 Token 字段
waybillIdstring运单 ID

返回值

Object

属性类型说明
waybillIdstring运单 ID
senderArray.<Object>发件人信息
receiverArray.<Object>收件人信息
errCodenumber错误码
errMsgstring错误信息

sender 的结构

属性类型说明
addressstring地址,已经将省市区信息合并
namestring用户姓名
telstring座机号码
mobilestring手机号码

receiver 的结构

属性类型说明
addressstring地址,已经将省市区信息合并
namestring用户姓名
telstring座机号码
mobilestring手机号码

errCode 的合法值

说明最低版本
0成功

异常

Object

抛出的异常

属性类型说明
errCodenumber错误码
errMsgstring错误信息

errCode 的合法值

说明最低版本
-1其他错误
40199运单 ID 错误,未查到运单
9300507Token 不正确

请求数据示例

  1. const cloud = require('wx-server-sdk')
  2. cloud.init()
  3. exports.main = async (event, context) => {
  4. try {
  5. const result = await cloud.openapi.logistics.getContact({
  6. token: 'TOKEN',
  7. waybillId: '12345678901234567890'
  8. })
  9. console.log(result)
  10. return result
  11. } catch (err) {
  12. console.log(err)
  13. return err
  14. }
  15. }

返回数据示例

  1. {
  2. "waybillId": "12345678901234567890",
  3. "sender": {
  4. "address": "广东省广州市海珠区XX路XX号XX大厦XX栋XX",
  5. "name": "张三",
  6. "tel": "020-88888888",
  7. "mobile": "18666666666"
  8. },
  9. "receiver": {
  10. "address": "广东省广州市天河区XX路XX号XX大厦XX栋XX",
  11. "name": "王小蒙",
  12. "tel": "029-77777777",
  13. "mobile": "18610000000"
  14. },
  15. "errMsg": "openapi.logistics.getContact:ok"
  16. }