资源工坊

添加群聊成员/机器人 ​

用于将用户或应用机器人拉进指定群聊，需满足两个前提条件：

  • 应用机器人需在群聊内。
  • 如果群设置了进群需群主或管理员审核，将向群聊群主和管理员发起入群申请审核，审核通过后才可成功将用户拉进指定群聊。

请求说明 ​

请求地址配置域名+ /o/woa/api/v1/developer/app/chats/{chatid}/members
请求方法POST
签名方式wps-4
支持应用类型企业自建应用、第三方企业应用
权限要求管理会话及会话成员信息(kso.im.chat.manage)

请求头 ​

Header 名称是否必填说明
Content-Type是目前固定为："application/json"
Wps-Docs-Date是取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT
Wps-Docs-Authorization是计算方法参考签名说明
Authorization是授权token，格式：Bearer ${access_token}，${access_token}需替换为从授权接口获取的access_token值

路径参数（Path） ​

名称类型是否必填说明
chatidinteger是群聊会话 id

请求地址示例 ​

http
[POST] 配置域名+ /o/woa/api/v1/developer/app/chats/{chatid}/members

请求体（Body） ​

名称类型是否必填说明
company_idinteger是企业id
mids[]integer否需要添加到群聊的成员的 company_uid,上限 100 人（mids 和 app_ids 至少必传一个）
app_ids[]string否需要添加到群聊的应用机器人的 app_id,上限 10 个（mids 和 app_ids 至少必传一个）
ignore_invalid_userboolean否是否忽略加群失败的用户。若选择否，则本次调用将不会添加任何成员。若选择是，则本次调用将会添加加群成功的用户

请求体示例 ​

json
{
  "company_id": 1,
  "mids": [123, 456],
  "app_ids": ["string", "string"],
  "ignore_invalid_user": true
}

响应体 ​

名称类型说明
resultinteger状态码，非 0 表示失败，参照《状态码说明》
fail_user_ids[]integer添加失败的用户
fail_app_ids[]string添加失败的应用机器人

响应体示例 ​

json
{
  "fail_user_ids": [123],
  "fail_app_ids": ["string", "string"],
  "result": 0
}