Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

批量添加群成员

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

请求说明

请求地址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_listarray[object]添加的成员 id 列表
∟ avatarstring用户头像
∟ company_idstring企业 id
∟ idstring用户 id
∟ namestring用户名称
∟ typestring[enum]身份类型
user:用户;sp:服务主体
ignore_invalid_userboolean是否自动过滤非法用户 id 和 app_id,默认值为:true
true:过滤掉非法成员 id,同时添加合法的成员 id;
false:若入参中存在非法成员 id,则中断请求,不添加任何成员

请求地址示例

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

请求体示例

json
{
  "account_id_list": [
    {
      "avatar": "string",
      "company_id": "string",
      "id": "string",
      "name": "string",
      "type": "string[enum]"
    }
  ],
  "ignore_invalid_user": false
}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ failed_itemsarray[object]邀请失败的成员信息
∟ ∟ account_id_listarray[object]邀请失败的成员 id 列表
∟ ∟ ∟ avatarstring用户头像
∟ ∟ ∟ company_idstring企业 id
∟ ∟ ∟ idstring用户 id
∟ ∟ ∟ namestring用户名称
∟ ∟ ∟ typestring[enum]身份类型
user:用户;sp:服务主体
∟ ∟ descriptionstring失败的原因
moreobject更多的错误信息

响应体示例

json
{
  "code": 0,
  "data": {
    "failed_items": [
      {
        "account_id_list": [
          {
            "avatar": "string",
            "company_id": "string",
            "id": "string",
            "name": "string",
            "type": "string[enum]"
          }
        ],
        "description": "string"
      }
    ]
  },
  "msg": "string"
}
回到旧版