邀请成员

POST

https://qyapi.weixin.qq.com/cgi-bin/batch/invite

服务端API企业内部开发第三方应用开发智慧硬件开发

企业可通过接口批量邀请成员使用企业微信，邀请后将通过短信或邮件下发通知。

权限说明：
须拥有指定成员、部门或标签的查看权限。
第三方仅通讯录应用可调用。

更多说明：
user, party, tag三者不能同时为空；
如果部分接收人无权限或不存在，邀请仍然执行，但会返回无效的部分（即invaliduser或invalidparty或invalidtag）;
同一用户只须邀请一次，被邀请的用户如果未安装企业微信，在3天内每天会收到一次通知，最多持续3天。
因为邀请频率是异步检查的，所以调用接口返回成功，并不代表接收者一定能收到邀请消息（可能受上述频率限制无法接收）。

请求示例

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://qyapi.weixin.qq.com/cgi-bin/batch/invite?access_token=' \
--header 'Content-Type: application/json' \
--data-raw '{"user":["UserID1","UserID2","UserID3"],"party":[PartyID1,PartyID2],"tag":[TagID1,TagID2]}'

响应示例

{
  "errcode": 0,
  "errmsg": "ok",
  "invaliduser": [
    "UserID1",
    "UserID2"
  ],
  "invalidparty": [
    "PartyID1",
    "PartyID2"
  ],
  "invalidtag": [
    "TagID1",
    "TagID2"
  ]
}

请求参数

Query 参数

access_token

调用接口凭证

必需

示例值:

Body 参数application/json

access_token

array[string]

调用接口凭证

必需

tag

array[string]

可选

标签ID列表，最多支持100个。

user

array[string]

可选

成员ID列表, 最多支持1000个。

party

array[string]

可选

部门ID列表，最多支持100个。

示例

返回响应

🟢200成功

application/json

Body

errcode

integer

必需

errmsg

string

必需

对返回码的文本描述内容

invaliduser

array[string]

非法成员列表

必需

invalidparty

array[string]

非法部门列表

必需

invalidtag

array[string]

非法标签列表

必需

修改于 2022-11-30 08:53:44

二次验证

获取加入企业二维码