语聚AI
  1. 外部联系人API
语聚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
    • 查询账户当前余额
      GET
    • 查询助手列表
      GET
    • 发送消息给指定用户
      POST
    • 费用明细查询接口
      GET
  • AI营销
    • AI外呼
      • 添加号码到外呼任务中
      • 获取外呼任务列表
      • 添加CRM公海线索后同步到外呼任务
      • 添加CRM公海线索
      • 重置指定号码外呼状态
      • 添加指定号码到黑名单
      • 查询通话记录
      • 下载通话录音
      • 黑名单组列表
      • 查询通话记录ID列表
      • 查询联系人字段列表
    • 企业微信代运营/托管
      • 对话消息接收与发送
        • 对话消息回调
        • 发送消息
      • 群管理
        • 创建企业微信群
        • 获取群列表信息
        • 查询指定用户下所在群信息
        • 入群事件回调
        • 离群事件回调
      • 外部联系人
        • 获取企业联系人列表
        • 创建好友添加任务
        • 好友通过事件回调
      • 基础设置
        • 获取当前企业托管账号列表
        • 获取企业员工列表
  1. 外部联系人API

更新外部联系人

PUT
/v1/openapi/contacts
根据外部联系人id, 更新外部联系人信息, 返回修改后的联系人信息

请求参数

Query 参数
apiKey
string 
必需
接口请求凭证(apiKey)。应用助手集成配置页面获取
示例值:
YMLUEcmsN8UYsNfxfm2403sv1711016924
Body 参数application/json
contact_id
string 
外部联系人id
必需
contact
object 
联系人信息
可选
email
string 
联系人邮箱
可选
该字段为示例, 以实际是否需要为主
channel
object 
渠道信息
可选
company
object 
企业信息
可选
custom
object 
自定义信息
可选
示例
{
    "contact_id": "ed44e798cf594b43b924d8b0d745f48c",
    "contact": {
        "email": "test123@test.com"
    },
    "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 PUT 'https://chat.jijyun.cn/v1/openapi/contacts?apiKey=YMLUEcmsN8UYsNfxfm2403sv1711016924' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contact_id": "ed44e798cf594b43b924d8b0d745f48c",
    "contact": {
        "email": "test123@test.com"
    },
    "channel": {},
    "company": {},
    "custom": {}
}'

返回响应

🟢200成功
application/json
Body
Code
integer 
必需
Data
object 
必需
avatar
null 
必需
chatid
null 
必需
company
null 
必需
company_address
null 
必需
company_website
null 
必需
companyid
null 
必需
contact_id
null 
必需
contact_name
null 
必需
conversation_id
null 
必需
create_time
string 
必需
device_id
string 
必需
email
string 
必需
id
string 
必需
message_id
null 
必需
mobile
null 
必需
name
string 
必需
open_id
null 
必需
product_name
null 
必需
roomTopic
null 
必需
room_id
null 
必需
update_time
string 
必需
userid
null 
必需
Msg
string 
必需
示例
{
  "Code": 2000,
  "Data": {
    "avatar": null,
    "chatid": null,
    "company": null,
    "company_address": null,
    "company_website": null,
    "companyid": null,
    "contact_id": null,
    "contact_name": null,
    "conversation_id": null,
    "create_time": "2024-06-06 15:04:18",
    "device_id": "ed44e798cf594b43b924d8b0d745f48c-988028",
    "email": "test123@test.com",
    "id": "ed44e798cf594b43b924d8b0d745f48c",
    "message_id": null,
    "mobile": null,
    "name": "访客310",
    "open_id": null,
    "product_name": null,
    "roomTopic": null,
    "room_id": null,
    "update_time": "2024-06-06 15:13:39",
    "userid": null
  },
  "Msg": "成功"
}
上一页
创建外部联系人
下一页
查询文本知识库列表
Built with