获取会话信息

获取会话信息

请求说明

请求地址	https://openapi.wps.cn/v7/chats/{chat_id}
请求方法	GET
签名方式	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}

路径参数（Path）

名称	参数类型	说明
chat_id	string	会话 id

查询参数（Query）

名称	参数类型	是否必填	说明
with_group_ext_attrs	boolean	否	是否返回 group_ext_attrs，默认 false 不返回

请求地址示例

[GET] https://openapi.wps.cn/v7/chats/{chat_id}?&with_group_ext_attrs={boolean}

响应体

名称	参数类型	说明
code	integer	响应代码。非 0 表示失败，参照《状态码说明》
msg	string	响应信息
data	object	data
∟ id	string	会话ID
∟ type	string	会话类型 "p2p" "group"
∟ name	string	会话名称
∟ ctime	integer	创建时间
∟ status	string	active:活跃 dismissed：解散
∟ group_ext_attrs	object	群聊会话属性
∟ ∟ avatar	object	群聊会话头像
∟ ∟ ∟ avatars	array[string]	群聊会话链接列表
∟ ∟ ∟ type	string	群聊会话头像类型 默认："default" 自定义："custom"
∟ ∟ owner_id	string	群主
∟ ∟ dept_id	string	部门ID
∟ ∟ settings	object	会话设置属性
∟ ∟ ∟ is_disable_all_send	bool	全员禁言
∟ ∟ ∟ is_disable_part_send	bool	部分成员禁言
∟ ∟ ∟ is_enable_nickname	bool	开启昵称
∟ ∟ ∟ is_external_join_approve	bool	非群主所属企业的人员进群是否需审核
∟ ∟ ∟ is_join_approve	bool	群主所属企业的人员进群是否需审核
∟ ∟ ∟ is_owner_admin_at_all	bool	只允许群主或管理员@所有人
∟ ∟ ∟ is_owner_admin_modify	bool	只允许群主和管理修改群属性
∟ ∟ ∟ is_owner_admin_add_bookmark	bool	是否仅群主和管理员可添加群书签
∟ ∟ ∟ is_enable_history_messages	bool	新入群成员是否可查看历史消息

响应体示例

{
  "code": 0,
  "data": {
    "ctime": 0,
    "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,
        "is_owner_admin_add_bookmark": false,
        "is_enable_history_messages": false
      }
    },
    "id": "string",
    "name": "string",
    "status": "active",
    "type": "group"
  },
  "msg": "success"
}