同步会话
适用版本>=v7.0.2502b.20250227
接口说明:同步会话
请求说明
| 请求地址 | 配置域名+/openapi+/v7/sync/chats |
|---|---|
| 请求方法 | POST |
| 签名方式 | KSO-1(配置域名+/openapi不参与签名) |
| 权限要求 | 同步-会话同步读写权限(应用授权)kso.chat_sync.readwrite |
请求头(Header)
| Header | 参数类型 | 是否必填 | 说明 |
|---|---|---|---|
| X-Kso-Date | string | 是 | RFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT |
| X-Kso-Authorization | string | 是 | KSO-1 签名值,详见《签名方法》 |
| Authorization | string | 是 | 授权凭证,格式为:Bearer {access_token} |
| X-Kso-Id-Type | string | 否 | ID 类型,可选值为 internal 或 external,不传默认为internal。当值为 external 时,开启三方 ID 模式,此时接口请求和响应中的 user_id 和 dept_id 应为三方ID,即 ex_user_id 和 ex_dept_id |
请求体(Body)
| 名称 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| name | string | 否 | 会话创建者,group类型会话需要传入,单聊可不用传入 |
| creator | object | 否 | 会话创建者,group类型会话需要传入,单聊可不用传入 |
| ∟ id | string | 是 | 身份ID |
| ∟ type | string | 是 | 身份类型,用户:"user",服务主体:"sp","未知":"unknow" |
| ∟ name | string | 否 | 用户或应用的名称 |
| ∟ avatar | string | 否 | 用户或应用的头像 |
| ∟ company_id | string | 否 | 身份所归属的公司 |
| ctime | int | 否 | 会话创建时间戳 单位秒 |
| chat_id | string | 否 | 会话ID |
| type | string | 是 | 会话类型 单聊会话:"p2p",群聊会话:"group" |
| p2p_members | array[object] | 否 | 单聊成员列表,p2p会话时必须传入单聊成员 |
| ∟ id | string | 是 | 身份ID |
| ∟ type | string | 是 | 身份类型,用户:"user",服务主体:"sp","未知":"unknow" |
| ∟ name | string | 否 | 用户或应用的名称 |
| ∟ avatar | string | 否 | 用户或应用的头像 |
| ∟ company_id | string | 否 | 身份所归属的公司 |
响应体(Response)
| 名称 | 类型 | 说明 |
|---|---|---|
| code | integer | code |
| msg | string | msg |
| data | object | data |
| ∟ chat_id | string | 会话ID |
响应体示例
json
{
"code": 0,
"msg": "string",
"data": {
"chat_id": "string"
}
}