新增客户回调 - API接口文档

请求参数

Query 参数

token

string

调用接口凭证

可选

Body 参数application/json

type

string

固定为add_external_contact

必需

event

object

必需

ToUserName

string

企业微信企业id-cropid

必需

FromUserName

string

固定sys

必需

CreateTime

string

添加时间（秒）

必需

MsgType

string

固定event

必需

Event

string

固定change_external_contact

必需

ChangeType

string

固定add_external_contact/add_half_external_contact

必需

UserID

string

企业微信员工id

必需

ExternalUserID

string

企业微信外部联系人id

必需

State

string

添加此用户的「渠道活码方式配置的state参数，可用于识别添加此用户的渠道, 详见state

可选

WelcomeCode

string

欢迎语code，可用于发送欢迎语

可选

data

object

必需

unionId

string

客户开放平台id

必需

name

string

客户姓名

必需

avatar

string

客户头像

可选

externalUserId

string

企业微信外部联系人id

必需

gender

number

客户性别 0 -未知 1 -男性 2 -女性

必需

type

number

客户的类型

必需

1 表示该客户是微信用户，2 表示该客户是企业微信用户

followUser

array [object {7}]

必需

timestamp

integer

时间戳（毫秒）

必需

示例

{
  "type": "string",
  "event": {
    "ToUserName": "string",
    "FromUserName": "string",
    "CreateTime": "string",
    "MsgType": "string",
    "Event": "string",
    "ChangeType": "string",
    "UserID": "string",
    "ExternalUserID": "string",
    "State": "string",
    "WelcomeCode": "string"
  },
  "data": {
    "unionId": "string",
    "name": "string",
    "avatar": "string",
    "externalUserId": "string",
    "gender": 0,
    "type": 0,
    "followUser": [
      {
        "userId": "string",
        "name": "string",
        "remark": "string",
        "avatar": "string",
        "createTimestamp": 0,
        "tags": [
          {
            "groupName": "string",
            "tagName": "string",
            "type": "string",
            "tagId": "string"
          }
        ],
        "remarkMobiles": [
          "string"
        ]
      }
    ]
  },
  "timestamp": 0
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/v1/notify/add/customer?token=' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200成功

application/json

Body

errCode

integer

返回码

必需

示例

{
  "errCode": 0
}