Skip to content

同步会话

适用版本>=v7.0.2502b.20250227

接口说明:同步会话

请求说明

请求地址配置域名+/openapi+/v7/sync/chats
请求方法POST
签名方式KSO-1(配置域名+/openapi不参与签名)
权限要求同步-会话同步读写权限(应用授权)kso.chat_sync.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

请求体(Body)

名称类型是否必填说明
namestring会话创建者,group类型会话需要传入,单聊可不用传入
creatorobject会话创建者,group类型会话需要传入,单聊可不用传入
idstring身份ID
typestring身份类型,用户:"user",服务主体:"sp","未知":"unknow"
namestring用户或应用的名称
avatarstring用户或应用的头像
company_idstring身份所归属的公司
ctimeint会话创建时间戳 单位秒
chat_idstring会话ID
typestring会话类型 单聊会话:"p2p",群聊会话:"group"
p2p_membersarray[object]单聊成员列表,p2p会话时必须传入单聊成员
idstring身份ID
typestring身份类型,用户:"user",服务主体:"sp","未知":"unknow"
namestring用户或应用的名称
avatarstring用户或应用的头像
company_idstring身份所归属的公司

响应体(Response)

名称类型说明
codeintegercode
msgstringmsg
dataobjectdata
chat_idstring会话ID

响应体示例

json
{
  "code": 0,
  "msg": "string",
  "data": {
    "chat_id": "string"
  }
}