小程序
取消
开发
中文
EN
取消
  • 指南

    • # 获取面单联系人信息

    调试诊断

    接口应在服务器端调用，不可在前端（小程序、网页、APP等）直接调用，具体可参考接口调用指南

    接口英文名：getContact

    该接口用于获取面单联系人信息。

    # 1. 调用方式

    # HTTPS 调用

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

    # 云调用

    • 调用方法：logistics.getContact

    • 出入参和 HTTPS 调用相同，调用方式可查看 云调用 说明文档

    # 第三方调用

    • 本接口不支持第三方平台调用。

    # 2. 请求参数

    # 查询参数 Query String parameters

    参数名类型必填说明
    access_tokenstring是接口调用凭证，可使用 access_token

    # 请求体 Request Payload

    参数名类型必填说明
    tokenstring是商户侧下单事件中推送的 Token 字段
    waybill_idstring是运单 ID

    # 3. 返回参数

    # 返回体 Response Payload

    参数名类型说明
    waybill_idstring运单 ID
    senderobject发件人信息
    receiverobject收件人信息

    # Res.sender Object Payload

    发件人信息

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

    # Res.receiver Object Payload

    收件人信息

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

    # 4. 注意事项

    本接口无特殊注意事项

    # 5. 代码示例

    # 5.1 HTTPS调用

    请求示例

    {
  "token": "TOKEN",
  "waybill_id": "12345678901234567890"
}

    返回示例

    {
  "waybill_id": "12345678901234567890",
  "sender": {
    "address": "广东省广州市海珠区XX路XX号XX大厦XX栋XX",
    "name": "张三",
    "tel": "020-88888888",
    "mobile": "18666666666"
  },
  "receiver": {
    "address": "广东省广州市天河区XX路XX号XX大厦XX栋XX",
    "name": "王小蒙",
    "tel": "029-77777777",
    "mobile": "18610000000"
  }
}

    # 5.2 云函数调用

    请求示例

    const cloud = require('wx-server-sdk')
cloud.init({
  env: cloud.DYNAMIC_CURRENT_ENV,
})
exports.main = async (event, context) => {
  try {
    const result = await cloud.openapi.logistics.getContact({
        "token": 'TOKEN',
        "waybillId": '12345678901234567890'
      })
    return result
  } catch (err) {
    return err
  }
}

    返回示例

    {
  "waybillId": "12345678901234567890",
  "sender": {
    "address": "广东省广州市海珠区XX路XX号XX大厦XX栋XX",
    "name": "张三",
    "tel": "020-88888888",
    "mobile": "18666666666"
  },
  "receiver": {
    "address": "广东省广州市天河区XX路XX号XX大厦XX栋XX",
    "name": "王小蒙",
    "tel": "029-77777777",
    "mobile": "18610000000"
  },
  "errMsg": "openapi.logistics.getContact:ok"
}

    # 6. 错误码

    以下是本接口的错误码列表，其他错误码可参考 通用错误码；调用接口遇到报错，可使用官方提供的 API 诊断工具 辅助定位和分析问题。

    错误码错误描述解决方案
    -1system error系统繁忙，此时请开发者稍候再试

    # 7. 适用范围

    本接口暂未明确可调用账号类型，或在业务中根据调用传参自行确定是否可调用，请已实际调用情况为准。