API接口文档 (小组级)-新
  1. 废弃接口
API接口文档 (小组级)-新
  • api接入说明
  • 系统使用说明
  • 接口文档
    • 小组级接口
      • 小组级接口说明
      • 基础接口
        • 获取托管账号列表
        • 获取联系人列表
        • 获取群列表
        • 获取群列表(不包含成员信息)
        • 发送系统通知
        • 获取自定义标签列表
        • 获取组内员工列表
      • 群聊接口
        • 加入群聊
        • 退出群聊事件回调
        • 加入群聊事件回调
        • 更改群名事件回调
        • 创建群聊
        • 通过联系人id获取联系人所在群聊
      • 会话接口
        • 开发建议
        • 会话超时跟进回调
        • 获取会话ai状态
        • 获取指定会话
        • 会话ai状态切换
        • 获取会话列表
        • 会话事件回调
        • 分配会话
        • 消息置顶
      • 加好友接口
        • 通过手机号加好友接口
        • api加好友任务成功回调
        • 好友通过后回调
        • 群聊加好友接口
      • 消息接口
        • 小组级发送消息回调
        • 获取原图
        • 发送消息
        • 小组级接收消息回调
        • 聊天历史
        • im员工id发消息
      • 群发接口
        • 创建群发
        • 重发群发
        • 取消群发
        • 删除群发
        • 群发回调
        • 获取群发任务的失败列表
        • 获取群发任务的没有发送的列表
        • 获取群发任务的进度
    • 自建应用依赖接口
      • 客户信息接口
        • 修改客户备注
        • 添加跟进记录
      • 雷达接口
        • 雷达访问接口
      • id信息获取接口
        • 通过unionId获取chatId
    • 废弃接口
      • 会话小结
      • 渠道二维码管理
        • 获取渠道列表(企业控制台数据)
      • 通过im群聊id加好友
        POST
      • 新增客户
        POST
      • 获取成员详情
        GET
      • 秒回数据同步
        POST
      • 获取群列表
        GET
      • 获取客户详情
        GET
      • 获取群信息
        POST
      • 绑定im官方ID
        GET
      • 通过externalUserId获取chatId
        GET
  1. 废弃接口

新增客户

POST
/v1/notify/add/customer

请求参数

Query 参数

Body 参数application/json

示例
{
    "type": "string",
    "event": {
        "ToUserName": "string",
        "FromUserName": "string",
        "CreateTime": "string",
        "MsgType": "string",
        "Event": "string",
        "ChangeType": "string",
        "UserID": "string",
        "ExternalUserID": "string",
        "State": "string",
        "WelcomeCode": "string"
    },
    "data": {
        "unionId": "string",
        "name": "string",
        "avatar": "string",
        "externalUserId": "string",
        "gender": 0,
        "type": 1,
        "followUser": [
            {
                "userId": "string",
                "name": "string",
                "remark": "string",
                "avatar": "string",
                "createTimestamp": 0,
                "tags": [
                    {
                        "groupName": "string",
                        "tagName": "string",
                        "type": "1",
                        "tagId": "string"
                    }
                ],
                "remarkMobiles": [
                    "string"
                ]
            }
        ]
    },
    "timestamp": 0
}

请求示例代码

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://zan-api.xiaoshunai.com/v1/notify/add/customer?token=' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "string",
    "event": {
        "ToUserName": "string",
        "FromUserName": "string",
        "CreateTime": "string",
        "MsgType": "string",
        "Event": "string",
        "ChangeType": "string",
        "UserID": "string",
        "ExternalUserID": "string",
        "State": "string",
        "WelcomeCode": "string"
    },
    "data": {
        "unionId": "string",
        "name": "string",
        "avatar": "string",
        "externalUserId": "string",
        "gender": 0,
        "type": 1,
        "followUser": [
            {
                "userId": "string",
                "name": "string",
                "remark": "string",
                "avatar": "string",
                "createTimestamp": 0,
                "tags": [
                    {
                        "groupName": "string",
                        "tagName": "string",
                        "type": "1",
                        "tagId": "string"
                    }
                ],
                "remarkMobiles": [
                    "string"
                ]
            }
        ]
    },
    "timestamp": 0
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "errCode": 0
}
修改于 2025-07-19 12:04:08
上一页
通过im群聊id加好友
下一页
获取成员详情
Built with