1. bot-联系人
企微Work-bot
  • 开发指南
    • 了解Work-bot
    • 开发前必读
    • 基本概念介绍
    • 试用与支持
    • 获取token
      POST
  • 企微机器人
    • bot-发送消息
      • 获取表情包【matebot、probot、autobot】
      • 发送表情包【matebot、probot、autobot】
      • 收藏表情【matebot、probot、autobot】
      • 发送文本消息
      • 发送图片
      • 发送链接
      • 发送文件
      • 发送视频
      • 发送语音
      • 发送视频号视频消息
      • 发送小程序
      • 发送表情包、动图gif【nanobot、probot】
      • 发送群公告
      • 转发消息
      • 发送引用消息
      • 消息撤回
      • 语音转文字
      • 发送位置消息
      • 发送名片
    • bot-收到消息
      • 收到文本消息
      • 收到图片消息
      • 收到链接消息
      • 收到文件消息
      • 收到视频消息
      • 收到视频号消息
      • 收到小程序消息
      • 收到红包消息
      • 收到位置消息
      • 收到动图gif消息
      • 收到引用消息
      • 根据appInfo 查找引用消息
      • 对方撤回通知
      • 收到语音消息
      • 收到名片消息
    • bot-机器人
      • 检查授权码数量
      • 创建机器人
      • 企微机器人列表
      • 获取登录二维码
      • 提交验证码
      • 登录检查
      • 下线机器人(退出企微登录)
      • 删除机器人
      • 登录通知
      • 退出通知
      • 账号退出
      • 机器人企业成员信息通知
    • bot-联系人
      • 同步联系人
        POST
      • 查询联系人
        POST
      • 同步标签
        POST
      • 同步企业成员
        POST
      • 给客户打标签
        POST
      • 设置客户备注、描述
        POST
      • 设置客户手机号
        POST
      • 手机号加粉
        POST
      • 添加手机号搜索到的客户微信
        POST
      • 删除好友
        POST
    • bot-客户群
      • 同步客户群
      • 客户群列表
      • 创建群
      • 添加群成员
      • 查询群信息
      • 修改群名
      • 修改群公告
      • 群解散
      • 群踢人(移除群成员)
      • 拉人进群
      • 退出群聊
      • 添加/删除群管理员
      • 开启/关闭群邀请验证
      • 转让群主
      • 群二维码
      • 禁止修改群名开关
    • bot-朋友圈
      • 获取朋友圈详情
      • 大文件上传
      • 发朋友圈
    • bot-回调通知
      • 联系人通知
        • 查询收到的好友请求列表
        • 添加好友请求(客户添加机器人)
        • 通过添加好友邀请
        • 新增好友通知
        • 好友删除通知
      • 客户群通知
        • 新增群成员通知robot.members.chain
        • 新增群成员通知robot.group.member.changed
        • 新增群成员通知robot.contact.modify
        • 群成员退群通知
        • 群名称变更通知
        • 新增群聊通知
        • 群管理变更通知
    • bot-数据转换
      • 官方群chatId转换为企微群ID
      • 官方客户数据转机器人数据
      • 机器人客户数据转官方自建应用客户数据
      • 机器人企业成员数据转官方自建应用企业成员数据
      • 机器人群id转为官方群id
  • 企微SCRM
    • 客户群
      • 群成员列表
    • 企业成员
      • 企业成员
    • 消息群发
      • 新建群发任务-4
      • 群发任务详情
      • 终止群发任务
      • 群发任务列表
    • 入群邀请
      • 创建拉群任务
    • 机器人设置-群聊
      • 群欢迎语-开启关闭
      • 群欢迎语内容-设置
      • 群欢迎语内容-查询
      • 群欢迎语时间-设置
      • 群欢迎语时间-查询
      • 模板参数-设置
      • 机器人客户群列表
      • 默认回复开关-打开/关闭
      • 默认回复内容-设置
      • 图片回复内容-设置
      • 图片回复内容-查询
      • 图片回复规则-查询
      • 图片回复规则-设置
      • 群管理员-设置
    • 机器人设置-私聊
      • 获取私聊设置
      • 自动拉人入群-设置
      • 自动拉人进群-打开/关闭
      • 图片回复开关-打开/关闭
      • 链接回复内容-设置
      • 链接回复开关-打开/关闭
      • 口令入群-打开/关闭
      • 口令入群-设置
      • 默认回复-设置
      • 默认回复开关-打开/关闭
      • 默认回复时间设置-查询
      • 关键字打标签开关状态-查询
      • 关键词打标签-开启/关闭
      • 关键词打标签配置信息-查询
    • 机器人设置-通用
      • 私聊/群聊 关键词回复内容设置
      • 查询标签数据
      • 打开/关闭 关键词回复开关
      • 获取关键词回复设置
    • 客户与客户群
      • 接口拓客手机号列表
      • 企微群列表
      • 企微群成员列表
      • 客户列表
    • 其它
      • 上传图片/文件
      • 资源url加签名
    • 账号
      • 删除子账号(注意删除后不能在创建同名账号)
      • 创建子账号
    • 会话
      • 聊天记录
      • 最近会话列表
    • scrm-回调通知
      • 添加企业客户事件
      • 删除企业客户事件
      • 删除跟进成员事件
  • 数据模型
    • 示例数据模型
      • Pet
      • Category
      • Tag
    • Schemas
      • TaskData
      • MessageContent
      • AcceptTarget
      • TextMessage
      • ImageMessage
      • LinkMessage
  1. bot-联系人

手机号加粉

POST
/wxworkapi/message/exchange
命令字Type : robot.phone.contact.add
该命令支持两种业务逻辑:
手机号搜索客户微信、添加客户微信合并执行 isSearchOnly = 0
手机号搜索客户微信、添加客户微信分步执行 isSearchOnly = 1

请求示例:#

{
  "messageId": "20200205161619572724162503",
  "phone":"13480110474",
  "type": "robot.phone.contact.add",
  "robotKey": "bcc23c5e76ab6887d51b0197cd017e66",
  "reason": "加好友的话术"
  "isSearchOnly": 1
}

参数说明:#

名称类型必须描述
typestring是命令字”robot.add.friend.from.group“
messageldString是请求消息id,32个字符的唯一,应答时原样回传
robotKeyString是机器人robotKey
userIdstring是userid,示例 "7881302985963919"
reasonstring是请求信息,示例 "我是xxxxx企业微信与xxx吧"
isSearchOnlyInteger否执行逻辑,1只查询客户微信,不添加 ,0查询客户微信并发送添加请求 ,默认为 0

回调通知:#

isSearchOnly = 1 时应答#

{
    "messageId": "20240318145946810761850001",
    "phone": "17865431234",
    "robotKey": "ae96354c66e94d0da8da62d784e1580c",
    "dts": 1710846468318,
    "code": "0",
    "msg": "success",
    "robotType": 2,
    "isSearchOnly": 1,
    "users": [
        {
            "corpName": "微信",
            "namePinyin": "XXXX.",
            "avatorUrl": "http:\/\/wx.qlogo.cn\/mmhead\/XxxxxDianwrKhSc\/0",
            "wxOpenId": "orFrbsgyEVzq4LrwH79D_tzFjMYM",
            "corpShortName": "微信",
            "wechatImgUrl": "http:\/\/wx.qlogo.cn\/mmhead\/xxxxxrKhSc\/0",
            "corpAuthType": 0,
            "realName": "",
            "isCustomer": 0,
            "userId": 7881299590998761,
            "corpanyId": 1970325134026788,
            "name": "YANG.",
            "isExternalUser": 1,
            "wechatName": "",
            "nameStatus": 1,
            "isOuterUser": 1,
            "isWorkChatCustomer": false,
            "corpDescription": ""
        },
        {
            "namePinyin": "**xy",
            "avatorUrl": "http:\/\/wework.qpic.cn\/bizmail\/SULNrITeFbrURMic2PKNc2lHO0pU4qibLawgVRCaxVxBGfc1DCGIoFcQ\/0",
            "wechatImgUrl": "http:\/\/wework.qpic.cn\/bizmail\/SULNrITeFbrURMic2PKNc2lHO0pU4qibLawgVRCaxVxBGfc1DCGIoFcQ\/0",
            "realName": "**xy",
            "isCustomer": 0,
            "userId": 312834213941209029,
            "corpanyId": 1970325052210733,
            "name": "**夕阳",
            "isExternalUser": 1,
            "wechatName": "",
            "ticket": "38C460577B3E35FAF08AFB4436A923A215AC283E933F9BE48BA6B09143471328D6E91C113DB43B44B9AD0F26498E2A0E4538F7A50337DE71B10D6C1B51F6D9F30EE4A495E9604B9A7091AFD07DA2DAF1",
            "nameStatus": 1,
            "isOuterUser": 0,
            "isWorkChatCustomer": false
        }
    ],
    "type": "phone.contact.add",
    "isCorpPhoneOrExternalUserPhone": 0
}

isSearchOnly = 0 或未传 时应答#

{
  "messageId": "20240318145946810761850001",
  "phone": "15622170229",
  "robotKey": "ae96354c66e94d0da8da62d784e1580c",
  "code": "0",
  "msg": "OK",
  "userData": {
    "corpName": "微信",
    "namePinyin": "listen",
    "avatorUrl": "http:\/\/wx.qlogo.cn\/mmhead\/wprMnqDUJH4HN2usTRwDu4x8DiasJ5YibATCFxEoib3hkyLmnDLdCaKbQ\/0",
    "wxOpenId": "orFrbsm6a4FyTCTCNx_F80Yx3ZAE",
    "corpShortName": "微信",
    "wechatImgUrl": "http:\/\/wx.qlogo.cn\/mmhead\/wprMnqDUJH4HN2usTRwDu4x8DiasJ5YibATCFxEoib3hkyLmnDLdCaKbQ\/0",
    "corpAuthType": 0,
    "realName": "",
    "userId": 7881300384921417,
    "corpanyId": 1970325134026788,
    "name": "listen",
    "isExternalUser": 1,
    "wechatName": "",
    "nameStatus": 1,
    "isOuterUser": 1,
    "isWorkChatCustomer": false,
    "corpDescription": ""
  },
  "type": "phone.contact.add",
  "isCorpPhoneOrExternalUserPhone": 0,
  "robotType": 2,
  "dts": 1710901815064
}

参数说明:#

名称类型必须描述
isExternalUserInteger是是否可添加微信 1 是, 0 否
isOuterUserInteger是微信类型 0 企业微信 1 个人微信
ticketInteger是添加企业微信时的 ticket, 对个人微信为 空
wxOpenIdInteger是添加个人微信的标识, 企业微信为空
isCustomerInteger是是否已经是客户, 1 是, 0 否

错误码:#

code错误描述平台描述
-1搜索的联系人不存在,请检查账号准确性win
-18000039添加好友过于频繁,请稍后再重试win
-18000093向微信好友发消息功能已被限制使用win
1mac的提示信息mac
100好友关系已存在mac
102未搜索到客户信息mac

请求参数

Authorization
Query 参数

Header 参数

请求示例代码

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://www.example.com/wxworkapi/message/exchange?acttype=contactadd' \
--header 'type: contactadd'

返回响应

🟢200成功
application/json
Bodyapplication/json

示例
{}
修改于 2025-04-02 08:35:46
上一页
设置客户手机号
下一页
添加手机号搜索到的客户微信
Built with