Skip to content

根据userid获取会话信息

通过该接口,可获取应用与用户单聊的会话信息

请求说明

请求地址配置域名+/openapi+/v7/chats/get_p2p_chat
请求方法GET
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求查询和管理会话消息(应用授权) kso.chat_message.readwrite

请求头(Header)

Header参数类型是否必填说明
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}
X-Kso-Id-TypestringID 类型,可选值为 internalexternal,不传默认为internal。当值为 external 时,开启三方 ID 模式,此时接口请求和响应中的 user_id 和 dept_id 应为三方ID,即 ex_user_id 和 ex_dept_id

查询参数(Query)

名称参数类型是否必填说明
user_idstring用户id,仅能获取到当前应用与用户的对话

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败
msgstring响应信息
dataobject数据信息
∟ ctimeint会话创建时间
∟ idstring会话id
∟ namestring会话名称
∟ statusstring会话状态:active-活跃,dismissed-解散,默认是活跃的
∟ typestring会话类型:p2p-单聊

响应体示例

json
{
  "data": {
    "ctime": 0,
    "id": "string",
    "name": "string",
    "status": "active",
    "type": "p2p"
  },
  "code": 0,
  "msg": "string"
}