语聚AI

查询外部联系人(列表)

POST

/v1/openapi/contacts

根据筛选条件, 返回所有符合条件的外部联系人

请求参数

Query 参数

apiKey

string

必需

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

示例值:

YMLUEcmsN8UYsNfxfm2403sv1711016924

Body 参数application/json

filter

array [object {3}]

筛选条件

必需

filter_key

string

筛选字段

必需

filter_condition

string

筛选条件

必需

equal: 等于

filter_value

string

筛选值

必需

示例

{
    "filter": [
        {
            "filter_key": "name",
            "filter_condition": "equal",
            "filter_value": "访客290"
        }
    ]
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://chat.jijyun.cn/v1/openapi/contacts?apiKey=YMLUEcmsN8UYsNfxfm2403sv1711016924' \
--header 'Content-Type: application/json' \
--data-raw '{
    "filter": [
        {
            "filter_key": "name",
            "filter_condition": "equal",
            "filter_value": "访客290"
        }
    ]
}'

返回响应

🟢200成功

application/json

Body

Code

integer

必需

Data

array [object {4}]

必需

null

可选

string

可选

mobile

string

可选

name

string

可选

Msg

string

必需

示例

{
    "Code": 0,
    "Data": [
        {
            "email": null,
            "id": "string",
            "mobile": "string",
            "name": "string"
        }
    ],
    "Msg": "string"
}

查询外部联系人(详情)

删除外部联系人