齐成云·IM消息服务
消息管理
复制页面
齐成云·IM消息服务
项目说明
基础介绍
消息类型介绍
对话类型介绍
会话管理
创建或获取会话
POST
获取会话列表
POST
设置会话置顶
POST
设置会话免打扰
POST
删除会话
POST
用户管理
设置用户语言
POST
获取支持的语言列表
POST
获取用户在线客户端
POST
强制用户下线
POST
通过用户名搜索用户
POST
更新好友验证设置
POST
获取用户信息
POST
检查用户是否存在
POST
好友管理
添加好友请求
POST
接受好友请求
POST
拒绝好友请求
POST
删除好友
POST
获取好友列表
POST
获取好友请求列表
POST
设置好友昵称
POST
设置好友备注
POST
设置星标好友
POST
设置好友消息提醒
POST
设置会话置顶
POST
获取好友设置信息
POST
获取置顶会话列表
POST
黑名单管理
添加用户到黑名单
从黑名单中移除用户
获取黑名单列表
检查黑名单状态
消息管理
发送消息
POST
获取对话的所有消息
POST
分页获取消息列表
POST
更新消息状态
POST
撤回消息
POST
删除消息
POST
批量标记消息为已读
POST
搜索消息
POST
客户端管理
获取用户在线客户端
强制客户端下线
向用户发送消息
向指定客户端发送消息
服务器管理
获取当前服务器状态
获取所有服务器信息
获取客户端分布情况
查找客户端所在服务器
发布订阅
发送消息到指定主题
客户端订阅主题
客户端取消订阅主题
获取客户端订阅列表
批量获取多个客户端的订阅列表
群组管理
创建群组
解散群组
更新群组信息
获取群组信息
获取群组成员列表
邀请用户加入群组
将用户踢出群组
退出群组
设置群管理员
取消群管理员
禁言群成员
解除群成员禁言
更新群组设置
获取群组设置
获取我的群组列表
搜索群组
通过群号码获取群组信息
群组消息
发送群消息
获取群消息历史
撤回群消息
群组消息已读状态
获取消息已读状态
标记消息为已读
搜索群消息
订阅日志管理
获取推送统计信息
获取清理服务状态
手动执行清理
获取清理预估信息
控制清理服务
连接WEBSOCKET
连接WEBSOCKET-创建好友对话
连接WEBSOCKET-测试发送订阅消息
连接WEBSOCKET-测试发送消息给某个用户(全部客户端都会收到)
连接WEBSOCKET-测试发送消息给某些客户端(支持同时发多个)
消息管理
复制页面
发送消息
POST
/ChatsMessage/sendMessage
调试
Run in Apifox
Run in Apifox
发送各种类型的消息,支持文本、图片、语音、视频等
请求参数
Header 参数
生成代码
Authorization
string
可选
默认值:
Bearer QC2b8fd0ca342c72f857f5f96
Appid
string
可选
默认值:
1001
ClientId
string
可选
默认值:
131231231223
TimeStamp
string
可选
默认值:
{{$date.timestamp}}
Client-Type
string
可选
默认值:
EnterpriseCenterWEB
Body 参数
application/json
生成代码
receiverId
string
接收方ID
必需
示例值:
user_123456
conversationType
enum<string>
会话类型
必需
枚举值:
friend
group
service
temporary
system
customer_service
示例值:
friend
messageType
enum<string>
消息类型
必需
枚举值:
text
image
audio
video
file
location
card
system
示例值:
text
messageContent
必需
消息内容( 根据messageType不同而不同)
One of
object
object
文本消息
text
string
可选
示例值:
Hello, how are you?
messageExtra
object
可选
消息扩展信息(可选)
示例值:
{}
replyToMessageKey
string
可选
回复的消息Key(可选)
>= 1 字符
<= 50 字符