语聚AI
  1. 外部联系人API
语聚AI
  • 语聚AI API接口使用说明
  • AI助手 API
    • 验证apiKey
      GET
    • 查询指定AI助手下的动作列表（工具列表）
      GET
    • 执行动作（文本格式）
      POST
    • 执行动作（NLP方式）
      POST
    • 获取动作配置页面地址
      GET
    • 查询执行日志记录
      GET
    • 创建会话消息
      POST
    • 查询助手列表
      GET
    • 查询对话模型列表
      GET
  • 外部联系人API
    • 查询外部联系人(详情)
      GET
    • 查询外部联系人(列表)
      POST
    • 删除外部联系人
      DELETE
    • 创建外部联系人
      POST
    • 更新外部联系人
      PUT
  • 知识库
    • 查询文本知识库列表
      GET
    • 现有文本知识库中同步新内容
      POST
    • 查询知识库内容
      GET
    • 更新知识库内容
      PUT
    • 查询文本知识库文档文件列表
      GET
  • Webhook消息回调
    • 如何使用Webhook
    • 当聚合对话有新消息时
      POST
    • 当AI助手中无匹配知识时
      POST
    • 当AI助手意图不满足时
      POST
    • 当AI助手当意图满足时
      POST
    • 当有联系人新增时
      POST
    • 当有联系人更新时
      POST
    • 当有联系人删除时
      POST
    • 当有新用户创建时
      POST
    • 当有用户信息更新时
      POST
    • 当人工服务解决时
      POST
    • 当有用户进入人工服务时
      POST
    • 当有人工客服回复时
      POST
    • 当用户进入会话时
      POST
    • 当知识库文件同步完成时
      POST
    • 当对话完成时
      POST
  • 聚合对话
    • 当聚合对话有新消息时
    • 发送/回复聚合对话消息
    • 分配对话给指定坐席
  • AI营销
    • AI外呼
      • 添加号码到外呼任务中
      • 获取外呼任务列表
      • 获取外呼任务2.0列表
      • 添加CRM公海线索后同步到外呼任务
      • 添加CRM公海线索
      • 重置指定号码外呼状态
      • 添加指定号码到黑名单
      • 查询通话记录
      • 下载通话录音
      • 黑名单组列表
      • 查询通话记录ID列表
      • 查询联系人字段列表
    • 企业微信代运营/托管
      • 对话消息接收与发送
        • 对话消息回调
        • 发送消息
        • 获取指定托管账号的聊天历史
        • 获取消息原图
      • 群管理
        • 创建企业微信群
        • 获取群列表信息
        • 查询指定用户下所在群信息
        • 入群事件回调
        • 离群事件回调
        • 获取群二维码
        • 获取群详情
        • 将客户移除群聊
      • 外部联系人
        • 获取企业联系人列表
        • 创建好友添加任务
        • 好友通过事件回调
        • 查询联系人对话记录
        • 系统wxid转换企业微信外部联系人externalUserId
      • 基础设置
        • 获取当前企业托管账号列表
        • 获取企业员工列表
    • 查询可用对话渠道
    • 查询全部授权账户
    • 查询会话列表
    • 查询会话内容
    • 查询指定对话渠道素材
  • AI流程及流程模版API
    • 查询AI流程列表
    • 查询AI流程详情配置
    • 使用流程模板创建AI流程
    • 创建AI流程模板
    • 修改AI流程状态
  • 通用功能API
    • 查询账户当前余额
    • 费用明细查询接口
  • 嵌入方案目录
    • API支持生成登录token
    • 查询语聚AI成员列表
  • 已废弃接口
    • 发送消息给指定用户
  1. 外部联系人API

创建外部联系人

POST
/v1/openapi/contacts/add
创建一个外部联系人, 完成后返回外部联系人id

请求参数

Query 参数

Body 参数application/json

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

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
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": 2000,
  "Data": {
    "id": "ed44e798cf594b43b924d8b0d745f48c"
  },
  "Msg": "成功"
}
修改于 2024-06-06 08:50:47
上一页
删除外部联系人
下一页
更新外部联系人
Built with