API 参考
在线调试

创建会话

更新时间: 2024/07/17 16:54:48

功能描述

该接口用于创建一条空会话。

  • 用户在收发消息时会主动触发创建会话的操作,不需要额外再调用该接口。
  • 该接口主要适用于需要占位空会话的场景。
  • 若调用该接口创建一个空会话,但是该会话中没有消息(没有进行消息收发),那么该会话仅操作者可见。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求

URL

POST https://open.yunxinapi.com/im/v2/conversations

请求 Header 的参数说明请参见请求 Header

请求体参数

参数名称 类型 是否必选 描述 示例
conversation_id String 必选 会话 ID。会话 ID 需要用户自行拼装,拼装规则:
owner_id|conversation_type|other_idowner_id|conversation_type|team_id
  • owner_id:操作者账号 ID
  • conversation_type:会话类型,1:单聊会话;2:高级群会话;3:超大群会话
  • other_id:对方账号 ID(单聊对话)
  • team_id:群组 ID(群组会话)
单聊会话:Accid1|1|Accid2
高级群会话:Accid1|2|tid
超大群会话:Accid1|3|tid

请求体示例

json{
    "conversation_id": "Accid1|1|Accid2"
}

响应

Header

响应 Header 的参数说明请参见响应 Header

响应体参数

参数名称 类型 描述 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
data Object 返回的 JSON 数据对象,请求失败则返回空对象。

响应体示例

json{
    "code":200,
    "msg":"success",
    "data":{
            "conversation_id": "Accid1|1|Accid2",
            "type": 1,   
            "stick_top": true,  
            "group_ids": [1,2,3],
            "server_extension":"extension",  
            "unread_count":0,  
            "sort_oder":1,
            "create_time":1,     
            "update_time":1
    }
}

错误码

错误码 错误码描述 错误信息示例
200 请求成功 success
414 参数错误 parameter error
102404 用户不存在 account not exist
500 服务器内部错误 internal server error
此文档是否对你有帮助?
有帮助
去反馈
  • 功能描述
  • 调用频率
  • 请求
  • URL
  • Header
  • 请求体参数
  • 请求体示例
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码