API接口文档 (小组级)
  1. 加好友接口
API接口文档 (小组级)
  • 接入说明
  • 快速入门
    • 加密手机号加好友方案
    • 加密版接口
    • 如何发送一条消息
    • 通过接口实现群发
    • 加密externalUserId打通方案
    • unionId打通方案
  • 接口文档
    • 小组级接口
      • 小组级接口说明
      • 基础接口
        • 获取托管企业微信列表
        • 获取个人微信授权到期及首次扫码登录的时间
        • 获取联系人列表
        • 获取群列表
        • 获取群列表(不包含成员信息)
        • 发送系统通知
        • 获取自定义标签列表
        • 获取组内员工列表
      • 群聊接口
        • 加入群聊
        • 退出群聊事件回调
        • 加入群聊事件回调
        • 更改群名事件回调
        • 创建群聊
        • 通过联系人id获取联系人所在群聊
      • 会话接口
        • 开发建议
        • 获取指定会话
        • 获取会话列表
        • 会话事件回调
        • 分配会话
        • 消息置顶
      • 加好友接口
        • 通过手机号加好友接口
          POST
        • 加好友任务成功回调
          POST
        • 好友通过后回调
          POST
        • 群聊加好友接口
          POST
      • 消息接口
        • 获取原图
        • 发送消息
        • 小组级接收消息回调
        • 聊天历史
        • 企微id发消息
      • 群发接口
        • 创建群发
        • 创建群发 Copy
        • 重发群发
        • 取消群发
        • 删除群发
        • 群发回调
        • 获取群发任务的失败列表
        • 获取群发任务的没有发送的列表
        • 获取群发任务的进度
    • 自建应用依赖接口
      • 自建应用依赖接口说明
      • 客户信息接口
        • 修改客户备注
        • 添加跟进记录
      • 雷达接口
        • 雷达访问接口
      • id信息获取接口
        • 获取chatId
        • 通过unionId获取chatId
    • 废弃接口
      • 会话小结
      • 渠道二维码管理
        • 获取渠道列表(企业控制台数据)
      • 通过企微id群聊加好友
      • 新增客户
      • 获取成员详情
      • 获取客户列表(2023/12/05 废弃)
      • 秒回数据同步
      • 获取群列表
      • 获取客户详情
      • 获取群信息
      • 绑定企业微信官方ID
      • 通过externalUserId获取chatId
      • 获取群列表(2023/2/05 废弃)
  • 更新日志
    • 更新日志
  1. 加好友接口

通过手机号加好友接口

POST
/addFriend/send

请求参数

Body 参数application/json
token
string 
调用接口凭证
必需
phoneNum
string 
手机号
必需
remark
string 
备注信息
可选
helloMsg
string 
邀请语
必需
extraInfo
string 
附加信息,回调原样返回
可选
userId
string 
托管账号的企业微信员工Id,不填则由对应小组随机托管账号执行加好友操作
可选
instant
boolean 
是否实时执行任务
可选
是否是实时执行加好友任务. true代表实时, 开启后不受页面涨粉设置所限制
isEncrypt
boolean 
可选
是否是一个加密的手机号加好友
示例
{
  "token": "string",
  "phoneNum": "string",
  "remark": "string",
  "helloMsg": "string",
  "extraInfo": "string",
  "userId": "string",
  "instant": true,
  "isEncrypt": true
}

示例代码

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://aa-stream-api.ddregion.com/addFriend/send' \
--header 'Content-Type: application/json' \
--data-raw '{
    "token": "string",
    "phoneNum": "string",
    "remark": "string",
    "helloMsg": "string",
    "extraInfo": "string",
    "userId": "string",
    "instant": true,
    "isEncrypt": true
}'

返回响应

🟢200成功
application/json
Body
code
number 
返回码
必需
示例
{
  "code\t": 0
}
上一页
消息置顶
下一页
加好友任务成功回调
Built with