Skip to content

批量添加群成员

在批量添加群成员过程中,如果添加列表中存在已经是该群的成员,将会忽略这些成员,继续正常添加列表中的其他成员

请求说明

请求地址https://openapi.wps.cn/v7/chats/{chat_id}/members/batch_create
请求方法POST
签名方式KSO-1
权限要求查询和管理会话(应用授权) kso.chat.readwrite

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

路径参数(Path)

名称参数类型说明
chat_idstring会话 id

请求体(Body)

名称参数类型是否必填说明
account_id_listobject[]加入会话的机器人或用户列表
∟ app_idstring应用id,type为sp时传入
∟ company_idstring公司id
∟ typestringsp:机器人,user:用户
∟ idstringtype为user传入用户id,type为sp传入spid
ignore_invalid_userbool是否自动过滤非法用户id和app_id,默认为“否”,即不过滤。当不过滤的情况下,有任一非法id,则本次调用将失败

请求地址示例

[POST] https://openapi.wps.cn/v7/chats/{chat_id}/members/batch_create

请求体示例

json
{
  "account_id_list": [
    {
      "app_id": "string",
      "company_id": "string",
      "type": "user",
      "id": "string"
    }
  ],
  "ignore_invalid_user": false
}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobjectdata
∟ failed_itemsobject邀请失败的成员信息
∟ ∟ account_id_listobject加入会话的机器人或用户列表
∟ ∟ ∟ app_idstring应用id,type为sp时传入
∟ ∟ ∟ company_idstring公司id
∟ ∟ ∟ typestringsp:机器人,user:用户
∟ ∟ ∟ idstringtype为user传入用户id,type为sp传入spid
∟ descriptionstring失败的原因

响应体示例

json
{
  "code": 0,
  "msg": "success",
  "data": {
    "failed_items": [
      {
        "account_id_list": [
          {
            "app_id": "string",
            "company_id": "string",
            "type": "user",
            "id": "string"
          }
        ],
        "description": "失败的原因"
      }
    ]
  }
}