Skip to content

创建单聊会话

用于创建两个用户之间的单聊会话。

请求说明

请求地址配置域名+/o/woa/api/v1/developer/openplatform/chats
请求方法POST
签名方式wps-4
支持应用类型企业自建应用
权限要求管理会话及会话成员信息(kso.im.chat.manage)

请求头

名称是否必填说明
Content-Type固定为: application/json
Wps-Docs-Date取当前时间, 示例: Wed, 23 Jan 2013 06:43:08 GMT
Wps-Docs-Authorization计算方法参考签名说明
Authorization授权token,格式:Bearer ${access_token},${access_token}需替换为从授权接口获取的access_token值

请求地址示例

http
[POST] 配置域名+/o/woa/api/v1/developer/openplatform/chats

请求体(Body)

参数类型是否必填说明
useridinteger发送方用户 id
to_useridinteger接收方用户 id

请求体示例

json
{
  "userid": ZGplZGplaWlqZGUK,
  "to_userid": FV7ENDE
}

响应体

名称类型说明
resultinteger状态码,非 0 表示失败,参照《状态码说明》
dataobject会话信息
 ∟ chat_idinteger会话 id
 ∟ urlstring会话 deeplink

响应体示例

json
{
  "result": 0,
  "data": {
    "chat_id": 125109,
    "url": "ksoxz://xz.wps.cn"
  }
}