批量获取会话

批量获取会话

请求说明

请求地址	https://openapi.wps.cn/v7/chats/batch_get
请求方法	POST
签名方式	KSO-1
权限要求	查询和管理会话（应用授权） kso.chat.readwrite 查询会话（应用授权） kso.chat.read

请求头（Header）

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

请求体（Body）

名称	参数类型	是否必填	说明
chat_id_list	array[string]	否	会话Id列表，大于0小于等于100，与部门ID列表二者必传一个，两者都传则以会话ID列表为准
dept_id_list	array[string]	否	部门Id列表，大于0小于等于100，与会话ID列表二者必传一个，两者都传则以会话ID列表为准
with_ext_attrs	bool	否	是否获取会话扩展属性
with_group_ext_attrs	bool	否	是否获取群聊会话扩展属性

请求地址示例

[POST] https://openapi.wps.cn/v7/chats/batch_get

请求体示例

{
  "chat_id_list": ["string"],
  "dept_id_list": ["string"],
  "with_ext_attrs": false,
  "with_group_ext_attrs": false
}

响应体（Response）

名称	参数类型	说明
code	integer	code
msg	string	msg
data	object	null
∟ items	array[object]
∟ ∟ id	string	会话ID
∟ ∟ type	string	会话类型 "p2p" "group"
∟ ∟ name	string	会话名称
∟ ∟ ctime	integer	创建时间
∟ ∟ status	string	参与者类型, user: 用户类型; group: 用户组，用户组数据需要通过日程参与者成员接口 展开
∟ ∟ ext_attrs	array[object]	拓展属性
∟ ∟ ∟ name	string	拓展属性名称
∟ ∟ ∟ value	string	拓展属性值
∟ ∟ group_ext_attrs	object	群聊会话属性
∟ ∟ ∟ avatar	string	群聊会话头像
∟ ∟ ∟ ∟ avatars	array[string]	群聊会话链接列表
∟ ∟ ∟ ∟ type	string	群聊会话头像类型 默认："default" 自定义："custom"
∟ ∟ ∟ owner_id	string	群主
∟ ∟ ∟ dept_id	string	部门ID，非空则为部门群
∟ ∟ ∟ settings	string	会话设置属性
∟ ∟ ∟ ∟ is_disable_all_send	string	全员禁言
∟ ∟ ∟ ∟ is_disable_part_send	string	部分成员禁言
∟ ∟ ∟ ∟ is_enable_nickname	string	开启昵称
∟ ∟ ∟ ∟ is_external_join_approve	string	外部企业进群审核
∟ ∟ ∟ ∟ is_join_approve	string	进群审核
∟ ∟ ∟ ∟ is_owner_admin_at_all	string	只允许群主或管理员@所有人
∟ ∟ ∟ ∟ is_owner_admin_modify	string	只允许群主和管理修改群属性
more	object	更多的错误信息

响应体示例

{
  "code": 0,
  "data": {
    "items": [
      {
        "ctime": 0,
        "ext_attrs": [
          {
            "name": "string",
            "value": "string"
          }
        ],
        "group_ext_attrs": {
          "avatar": {
            "avatars": ["string"],
            "type": "default"
          },
          "dept_id": "string",
          "owner_id": "string",
          "settings": {
            "is_disable_all_send": false,
            "is_disable_part_send": false,
            "is_enable_nickname": true,
            "is_external_join_approve": true,
            "is_join_approve": false,
            "is_owner_admin_at_all": false,
            "is_owner_admin_modify": false
          }
        },
        "id": "string",
        "name": "string",
        "status": "active",
        "type": "group"
      }
    ]
  },
  "msg": "success"
}