语聚AI
  1. 外部联系人
语聚AI
  • 语聚AI应用助手API使用说明
  • AI助手 API
    • 验证apiKey
      GET
    • 查询指定AI助手下的动作列表（工具列表）
      GET
    • 执行动作（文本格式）
      POST
    • 执行动作（NLP方式）
      POST
    • 获取动作配置页面地址
      GET
    • 查询执行日志记录
      GET
    • 创建会话消息
      POST
  • 外部联系人API
    • 查询外部联系人(详情)
      GET
    • 查询外部联系人(列表)
      POST
    • 删除外部联系人
      DELETE
    • 创建外部联系人
      POST
    • 更新外部联系人
      PUT
  • 知识库
    • 查询文本知识库列表
      GET
    • 现有文本知识库中同步新内容
      POST
    • 查询知识库内容
      GET
    • 更新知识库内容
      PUT
    • 查询文本知识库文档文件列表
      GET
  • 通用功能API
    • 查询账户当前余额
    • 查询助手列表
    • 发送消息给指定用户
    • 费用明细查询接口
  • AI营销
    • AI外呼
      • 添加号码到外呼任务中
      • 获取外呼任务列表
      • 添加CRM公海线索后同步到外呼任务
      • 添加CRM公海线索
      • 重置指定号码外呼状态
      • 添加指定号码到黑名单
      • 查询通话记录
      • 下载通话录音
      • 黑名单组列表
      • 查询通话记录ID列表
      • 查询联系人字段列表
    • 企业微信代运营/托管
      • 对话消息接收与发送
        • 对话消息回调
        • 发送消息
      • 群管理
        • 创建企业微信群
        • 获取群列表信息
        • 查询指定用户下所在群信息
        • 入群事件回调
        • 离群事件回调
      • 外部联系人
        • 获取企业联系人列表
          GET
        • 创建好友添加任务
          POST
        • 好友通过事件回调
          GET
      • 基础设置
        • 获取当前企业托管账号列表
        • 获取企业员工列表
  1. 外部联系人

获取企业联系人列表

GET
/v1/api/ai/marketing/contacts/list

请求参数

Query 参数
apiKey
string 
必需
接口请求凭证(apiKey)，在语聚AI的API接口页面获取
current
string 
当前页数
可选
示例值:
1
pageSize
string 
每页条数
可选
示例值:
20
wxid
string 
wxid用户id
可选
includeStranger
boolean 
是否查询单删好友
可选

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://chat.jijyun.cn/v1/api/ai/marketing/contacts/list?apiKey&current=1&pageSize=20&wxid&includeStranger'

返回响应

🟢200成功
application/json
Body
Code
integer 
必需
Data
object 
必需
code
integer 
必需
data
array [object {18}] 
必需
page
object 
必需
Msg
string 
必需
示例
{
    "Code": 0,
    "Data": {
        "code": 0,
        "data": [
            {
                "alias": "string",
                "avatarUrl": "string",
                "botInfo": {
                    "nickName": "string",
                    "weixin": "string",
                    "wxid": "string"
                },
                "chatId": "string",
                "city": null,
                "contactType": 0,
                "coworker": true,
                "deleted": true,
                "externalUserId": "string",
                "friendshipStatus": 0,
                "gender": 0,
                "labels": [
                    "string"
                ],
                "newFriendTimestamp": 0,
                "nickName": "string",
                "province": null,
                "tags": [
                    "string"
                ],
                "weixin": "string",
                "wxid": "string"
            }
        ],
        "page": {
            "current": 0,
            "total": 0
        }
    },
    "Msg": "string"
}
上一页
离群事件回调
下一页
创建好友添加任务
Built with