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

api加好友任务成功回调

POST
/friend/send
功能说明:
本接口会将成功添加好友任务的数据进行回调
如果需要加好友事件回调,可以参考:https://apifox.com/apidoc/shared/d292e311-af7c-4a68-bfe4-416fd1d657b6/api-315430856
⚠重试机制:若回调请求超时,则会重试,最多5次,如果3分钟内有10个回调重试5次全部失败,则禁用回调地址30分钟。
⚠建议收到后回调后进行异步处理,防止处理超时导致我们重复推送。

请求参数

Body 参数application/json

示例
{
    "code": 0,
    "data": {
        "fromwxid": "16888******78438",
        "fromwxName": "张三4321",
        "fromwxAvatar": "https://qpic.cn/wwpic3az/375283_30QqeKdzQkKC_kj_1752047248/0",
        "extraInfo": "test",
        "type": 1,
        "phoneNum": "153****0211",
        "createTimestamp": 1753092732086,
        "sendTimestamp": 1753092854675,
        "token": "669dc78a*****23e04351d6",
        "payload": {
            "avatar": "http://qlogo.cn/mmhead/bVy2VQVTWzbt6h7DOt8RLLgW1O3WKurmfLQ8W7EQHIGvD2XDLyofYTaryeL9jQiadgQjb7SZPrxY/0",
            "name": "f2",
            "gender": 0,
            "wxid": "78813*****347451",
            "friend": false
        }
    }
}

请求示例代码

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/friend/send' \
--header 'Content-Type: application/json' \
--data-raw '{
    "code": 0,
    "data": {
        "fromwxid": "16888******78438",
        "fromwxName": "张三4321",
        "fromwxAvatar": "https://qpic.cn/wwpic3az/375283_30QqeKdzQkKC_kj_1752047248/0",
        "extraInfo": "test",
        "type": 1,
        "phoneNum": "153****0211",
        "createTimestamp": 1753092732086,
        "sendTimestamp": 1753092854675,
        "token": "669dc78a*****23e04351d6",
        "payload": {
            "avatar": "http://qlogo.cn/mmhead/bVy2VQVTWzbt6h7DOt8RLLgW1O3WKurmfLQ8W7EQHIGvD2XDLyofYTaryeL9jQiadgQjb7SZPrxY/0",
            "name": "f2",
            "gender": 0,
            "wxid": "78813*****347451",
            "friend": false
        }
    }
}'

返回响应

🟢200成功
application/json
Body

示例
{}
修改于 2025-12-30 07:15:54
上一页
通过手机号加好友接口
下一页
好友通过后回调
Built with