unionId上传&关联externalUserId - 尘锋SCRM开放平台

服务商无法通过添加企微好友获取好友的unionId，只能通过使用绑定在服务商或客户的自有小程序&公众号获取unionId，然后通过unionId查询对应的企微好友，且公众号&小程序认证主体、绑定开放平台主体和企微认证主体一致，或主体有法人或集团公司的关系

POST https://qw-openapi-tx.dustess.com/open-integration-api/mid/v1/qw/queryExternalUserIdByUnionId?accessToken=

接口限制：每分钟调用600次；注意微信限制该接口每天调用上限为30000次；

使用说明：

使用场景：服务商无法通过添加企微好友获取好友的unionid，只能通过绑定在服务商或客户自有小程序&公众号获取unionid，然后通过unionid查询对应的企微好友
接口能力：本接口支持上传unionid，若此unionid对应好友已被添加，会直接将此unionid写入对应好友和联系人数据中并返回对应企微好友ID；若在上传unionid后90天内被添加，会直接将此unionid写入对应好友和联系人数据中，可通过好友新增事件中传输的unionid字段维护关联关系，或者通过unionid查询好友和联系人接口获取对应关系
注意：新上传unionid写入联系人和好友数据中会有一个过程，若同时新增好友和上传unionid，可能导致新增好友事件没有unionid，建议设计补充机制通过查询接口重新获取数据；服务商获取的企微好友ID为加密ID无法和自建应用获取的企微好友ID同时使用；

请求header

字段	值
Content-Type	application/json

Params:

字段	类型	描述	是否必须
accessToken	`String`	accessToken	true

请求参数

请求参数名	类型	说明	是否必须
openId	`String`	openId	true
unionId	`String`	unionId	true

请求参数示例
json - Request-Example:

{
    "openId":"onntsuHkEwjMVunv9QJasMWs9wcE",
    "unionId":"osBV75t5lxixxCM-TJ2Zdc2_VZkQ"
}

成功响应

响应参数名	类型	说明
code	`Int`	响应码，0:成功
msg	`String`	消息提示
success	`Bool`	成功标识
data	`Object`	响应码
data.unionId	`String`	unionId
data.externalUserId	`String`	外部联系人id

成功响应示例

//已经是好友的返回值
{
    "success": true,
    "code": 0,
    "msg": "",
    "data": {
        "unionId": "osBV75t5lxixxCM-TJ2Zdc2_VZkQ22",
        "externalUserId": "wmnBvEDAAA4Ct1NiYA_eJ00c92fq-NYQ11"
    },
    "trace_id": "81d869b0-ae7d-40e4-8d98-a14e6a941852"
}

//没有成为好友的返回值，以实际返回为准
{
    "success": true,
    "code": 0,
    "msg": "",
    "data": {
        "unionId": "",
        "externalUserId": ""
    },
    "trace_id": "70203147-b2d2-4d00-89f0-ee7f721db688"
}

错误响应示例


{
    "success": true,
    "code": 40073,
    "msg": " invalid openId",
    "data": {
        "unionId": "",
        "externalUserId": ""
    },
    "trace_id": "cfd6522e-cf1c-4db7-a0a5-aa17a83caf21"
}


{
    "success": false,
    "code": 40020,
    "msg": "param enable error ex:0|1|2",
    "data": {}
}