获取客户id - 探马OpenAPI

通过外部唯一标识，获取探马内部客户id，目前仅支持企微客户id、探马自定义字段（单行文本类型）

自定义字段支持说明：外部系统和探马系统客户数据关联，建立自定义字段绑定外部系统客户唯一标识，其他场景暂不支持。

请求参数

Header 参数

appId

string

应用 appId

必需

默认值:

timestamp

string

请求时间戳

必需

默认值:

sign

string

请求消息签名值

必需

默认值:

appKey

string

应用 appKey

可选

默认值:

Body 参数application/json

以下参数任一查询条件满足即可

externalUserId

string

企微客户id

可选

unionId

string

公众号授权unionId

可选

field

object

自定义字段

可选

fieldId

number

自定义字段id

可选

探马系统中自定义字段id，可通过“查询客户字段列表”接口获得

values

string

自定义字段value

可选

单行文本

示例

{
  "externalUserId": "121314141414",
  "unionId": "1213134131313"
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢200成功

application/json

Body

code

integer

业务状态码

必需

message

string

消息

必需

data

array [object {3}]

消息体

必需

customerId

string

探马客户id

必需

externalUserId

string

企微客户id

可选

有企微好友关系的才会返回

unionId

string

客户unionId

可选

公众号授权才会返回

示例

成功示例异常示例

{
  "code": 0,
  "message": "success",
  "data": [
    {
      "customerId": "480559642546368",
      "externalUserId": "wm9Df1dQAAsvxHwPMB5IsuNp4jgo0alw",
      "unionId": "oStmX5lOkPi5mLS6TdcSR-scusgQ"
    }
  ]
}