Skip to content

获取会话信息

适用版本>=v7.0.2505a.20250515

v7.0.2603.20260326更新:新增会话操作权限设置项返回参数

接口说明:获取会话信息

使用说明

  • 单聊会话时,必须是该应用的单聊会话
  • 群聊会话时,应用需在群内

标签消息与群组

请求说明

字段
请求地址
配置域名+/openapi+/v7/chats/{chat_id}
HTTP 方法
GET
接口描述
获取会话信息
签名方式
KSO-1(配置域名+/openapi不参与签名)
限频策略
权限要求
查询和管理会话(应用授权) kso.chat.readwrite
查询会话(应用授权) kso.chat.read
MCP协作消息与会话管理(应用授权) kso.mcp_message.readwrite

请求头 (Headers)

属性名类型是否必填描述可选值
X-Kso-Date
stringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT-
X-Kso-Authorization
stringKSO-1 签名值,详见《签名方法》-
Authorization
string授权凭证,格式为:Bearer {access_token}-

路径参数 (Path)

属性名类型是否必填描述可选值
chat_id
string-

查询参数 (Query)

属性名类型是否必填描述可选值
with_group_ext_attrs
boolean是否返回 group_ext_attrs, 默认 false 不返回-
with_ext_attrs
boolean是否返回 ext_attrs, 默认 false 不返回-

响应体(Response)

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例

json
{
  "code": 0,
  "msg": "string",
  "data": {
    "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": true,
        "is_disable_part_send": true,
        "is_enable_history_messages": true,
        "is_enable_nickname": true,
        "is_external_join_approve": true,
        "is_join_approve": true,
        "is_owner_admin_add_bookmark": true,
        "is_owner_admin_at_all": true,
        "is_owner_admin_modify": true,
        "operation_permissions": {
          "initiate_meeting_permission": "only_owner",
          "initiate_vote_permission": "only_owner",
          "invite_member_permission": "only_owner",
          "manage_announcement_permission": "only_owner",
          "pin_message_permission": "only_owner",
          "urgent_message_permission": "only_owner"
        }
      }
    },
    "id": "string",
    "name": "string",
    "status": "active",
    "type": "p2p"
  }
}