获取会话信息
获取会话信息
请求说明
| 请求地址 | 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_ext_attrs | boolean | 否 | 是否返回 ext_attrs，默认 false 不返回 |
| with_group_ext_attrs | boolean | 否 | 是否返回 group_ext_attrs，默认 false 不返回 |
请求地址示例
[GET] https://openapi.wps.cn/v7/chats/{chat_id}?with_ext_attrs={boolean}&with_group_ext_attrs={boolean}响应体
| 名称 | 参数类型 | 说明 |
|---|---|---|
| code | integer | 响应代码。非 0 表示失败，参照《状态码说明》 |
| msg | string | 响应信息 |
| data | object | 响应数据 |
| ∟ ctime | integer | 会话创建时间 |
| ∟ ext_attrs | array[object] | 自定义扩展字段 |
| ∟ ∟ name | string | 属性名 |
| ∟ ∟ value | string | 属性值 |
| ∟ group_ext_attrs | object | 群聊扩展字段，当会话类型为群聊 group 时，该字段才有值 |
| ∟ ∟ avatar | object | 群聊头像 |
| ∟ ∟ ∟ avatars | array[string] | 头像链接，自定义头像则返回 1 张，九宫格头像则返回 1 至 9 张 |
| ∟ ∟ ∟ type | string[enum] | 群聊头像类型 default：默认类型，即九宫格头像；custom：自定义头像 |
| ∟ ∟ owner_id | string | 群主 id |
| ∟ ∟ settings | object | 群组设置 |
| ∟ ∟ ∟ is_disable_all_send | boolean | 是否开启【全员禁言】 |
| ∟ ∟ ∟ is_disable_part_send | boolean | 是否开启【部分成员禁言】 |
| ∟ ∟ ∟ is_enable_nickname | boolean | 是否开启【群昵称优先展示】 |
| ∟ ∟ ∟ is_external_join_approve | boolean | 是否开启【非群主所属企业的人员进群需审核】 |
| ∟ ∟ ∟ is_join_approve | boolean | 是否开启【群主所属企业的人员进群需审核】 |
| ∟ ∟ ∟ is_owner_admin_at_all | boolean | 是否开启【仅群主和管理员可 at 所有人】 |
| ∟ ∟ ∟ is_owner_admin_modify | boolean | 是否开启【仅群主和管理员可修改群信息】 |
| ∟ id | string | 会话 id |
| ∟ name | string | 会话标题，当会话类型为单聊 p2p 时，name 字段返回为空 |
| ∟ status | string[enum] | 会话状态，默认是活跃的 active：活跃的；dismissed：已解散的 |
| ∟ type | string[enum] | 会话类型 p2p：单聊会话；group：群聊会话 |
| more | object | 更多的错误信息 |
响应体示例
json
{
"code": 0,
"data": {
"ctime": 0,
"ext_attrs": [
{
"name": "string",
"value": "string"
}
],
"group_ext_attrs": {
"avatar": {
"avatars": [
"string"
],
"type": "string[enum]"
},
"owner_id": "string",
"settings": {
"is_disable_all_send": false,
"is_disable_part_send": false,
"is_enable_nickname": false,
"is_external_join_approve": false,
"is_join_approve": false,
"is_owner_admin_at_all": false,
"is_owner_admin_modify": false
}
},
"id": "string",
"name": "string",
"status": "string[enum]",
"type": "string[enum]"
},
"msg": "string"
}