语聚AI

创建外部联系人

POST

/v1/openapi/contacts/add

创建一个外部联系人, 完成后返回外部联系人id

请求参数

Query 参数

apiKey

string

必需

接口请求凭证(apiKey)。应用助手集成配置页面获取

示例值:

YMLUEcmsN8UYsNfxfm2403sv1711016924

Body 参数application/json

contact

object

联系人信息

必需

name

string

联系人名称

必需

channel

object

渠道信息

可选

company

object

企业信息

可选

custom

object

自定义信息

可选

示例

{
    "contact": {
        "name": "访客310"
    },
    "channel": {},
    "company": {},
    "custom": {}
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://chat.jijyun.cn/v1/openapi/contacts/add?apiKey=YMLUEcmsN8UYsNfxfm2403sv1711016924' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contact": {
        "name": "访客310"
    },
    "channel": {},
    "company": {},
    "custom": {}
}'

返回响应

🟢200成功

application/json

Body

Code

integer

必需

Data

object

必需

string

必需

Msg

string

必需

示例

{
  "Code": 2000,
  "Data": {
    "id": "ed44e798cf594b43b924d8b0d745f48c"
  },
  "Msg": "成功"
}

删除外部联系人

更新外部联系人