一米家
  1. 圈组
一米家
  • 登录
  • LoginController
    • login
    • login
    • getUserInfo
  • FileController
    • 实名认证
  • 用户接口
    • 实名认证
  • 微信小程序用户接口
    • 登陆接口
    • <pre>
    • <pre>
  • WxPortalController
    • authGet
    • post
  • <pre>
    • 上传临时素材
    • 下载临时素材
    • error404
    • error500
  • IM
    • 网易云通信ID
      • 创建网易云通信ID
      • 更新网易云通信token
      • 重置网易云通信token
      • 封禁网易云通信ID
      • 解禁网易云通信ID
    • 用户名片
      • 更新用户名片
      • 获取用户名片
    • 用户设置
      • 设置桌面端在线时,移动端是否需要推送
      • 账号全局禁言
      • 账号全局禁用音视频
    • 用户关系托管
      • 添加好友
      • 更新好友
      • 删除好友
      • 获取好友关系
      • 设置黑名单/静音
      • 查看指定用户的黑名单和静音列表
    • 消息功能
      • 发送普通消息
      • 批量发送点对点普通消息
      • 发送自定义系统通知
      • 批量发送点对点自定义系统通知
      • 文件上传
      • 文件上传(multipart方式)
      • 上传NOS文件清理任务
      • 消息撤回
      • 发送广播消息
      • 单向撤回消息
      • 删除会话漫游
    • 群组功能(高级群)
      • 创建群
      • 拉人入群
      • 踢人出群
      • 解散群
      • 编辑群资料
      • 群信息与成员列表查询
      • 获取群组详细信息
      • 获取群组已读消息的已读详情信息
      • 移交群主
      • 任命管理员
      • 移除管理员
      • 获取某用户所加入的群信息
      • 修改群昵称
      • 修改消息提醒开关
      • 禁言群成员
      • 主动退群
      • 将群组整体禁言
      • 获取群组禁言列表
    • 群组功能(超大群)
      • 创建群
      • 解散群
      • 拉人入群
      • 踢人出群
      • 修改群信息
      • 获取群信息
      • 修改群成员信息
      • 获取群成员信息
      • 发送超大群消息
      • 查询超大群云端历史消息
      • 主动退群
      • 移交群主
      • 添加管理员
      • 解除管理员
      • 禁言群
      • 禁言群成员
    • 聊天室
      • 创建聊天室
      • 查询聊天室信息
      • 批量查询聊天室信息
      • 更新聊天室信息
      • 修改聊天室开/关闭状态
      • 设置聊天室内用户角色
      • 请求聊天室地址
      • 发送聊天室消息
      • 往聊天室内添加机器人
      • 从聊天室内删除机器人
      • 设置临时禁言状态
      • 往聊天室有序队列中新加或更新元素
      • 从队列中取出元素
      • 排序列出队列中所有元素
      • 删除清理整个队列
      • 初始化队列
      • 将聊天室整体禁言
      • 查询聊天室统计指标TopN
      • 分页获取成员列表
      • 批量获取在线成员信息
      • 变更聊天室内的角色信息
      • 批量更新聊天室队列元素
      • 查询用户创建的开启状态聊天室列表
      • 关闭指定聊天室进出通知
    • 历史记录
      • 单聊云端历史消息查询
      • 群聊云端历史消息查询
      • 聊天室云端历史消息查询
      • 删除聊天室云端历史消息
      • 用户登录登出事件记录查询
      • 批量查询广播消息
      • 查询单条广播消息
    • 在线状态
      • 订阅在线状态事件
      • 取消在线状态事件订阅
      • 取消全部在线状态事件订阅
      • 查询在线状态事件订阅关系
    • 圈组
      • 创建服务器
        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
      • 查询云端历史消息
        POST
      • 创建服务器身份组
        POST
      • 删除服务器身份组
        POST
      • 更新服务器身份组
        POST
      • 分页查询服务器身份组
        POST
      • 创建频道身份组
        POST
      • 删除频道身份组
        POST
      • 更新频道身份组
        POST
      • 分页查询频道身份组
        POST
      • 在频道下为某个人定制权限
        POST
      • 删除频道下某人的定制权限
        POST
      • 更新频道下用户定制权限
        POST
      • 分页查询频道下用户的定制权限
        POST
      • 把某些人拉进某服务器身份组
        POST
      • 将某些人移除某个服务器身份组
        POST
      • 分页查询某个服务器身份组中有哪些人
        POST
      • 分页查询某个用户在哪些身份组
        POST
  1. 圈组

发送圈组消息

POST
/nimserver/qchat/sendMsg.action

请求参数

Header 参数
AppKey
string 
必需
示例值:
{{AppKey}}
Nonce
string 
必需
示例值:
{{Nonce}}
CurTime
string 
必需
示例值:
{{CurTime}}
CheckSum
string 
必需
示例值:
{{CheckSum}}
Content-Type
string 
必需
示例值:
application/x-www-form-urlencoded
Body 参数application/x-www-form-urlencoded
serverId
string 
服务器唯一标识
必需
channelId
string 
频道唯一标识
必需
from
string 
必需
用户帐号,消息发送者
type
string 
必需
0 表示文本消息,
1 表示图片,
2 表示语音,
3 表示视频,
4 表示地理位置信息,
6 表示文件,
10 表示提示消息,
100 自定义消息类型(特别注意,对于未对接易盾反垃圾功能的应用,该类型的消息不会提交反垃圾系统检测)
body
string 
必需
消息内容,最大5000字符
文本消息:请在body字段填写消息文案;
其它类型消息,请填写attach字段,格式参考 消息格式示例;
attach
string 
必需
消息附件,最大5000字符
ext
string 
必需
扩展字段,最大1024字符
msgIdClient
string 
客户端消息id
必需
pushContent
string 
必需
推送文案,最长500个字符。具体参见 推送配置参数详解。
pushPayload
string 
必需
必须是JSON,不能超过2k字符。该参数与APNs推送的payload含义不同。具体参见 推送配置参数详解。
option
string 
必需
消息时特殊指定的行为选项,JSON格式,可用于指定消息的存云端历史,推送等特殊行为;option中字段不填时表示默认值 ,option示例:
{"push":false,"history":false,"badge":false,"needPushNick":true}
字段说明:
1.
history: 该消息是否存云端历史,默认true;
2.
push: 该消息是否需要APNS推送或安卓系统通知栏推送,默认true;
3.
badge:该消息是否需要计入到未读计数中,默认true;
4.
needPushNick: 推送文案是否需要带上昵称,不设置该参数时默认true;
mentionedAll
string 
必需
是否艾特所有人,0或者1,默认0
mentionedAccidList
string 
必需
艾特的accid列表,JSONArray格式,最大100个,如果mentionedAll=1,则本参数无效

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/nimserver/qchat/sendMsg.action' \
--header 'AppKey: {{AppKey}}' \
--header 'Nonce: {{Nonce}}' \
--header 'CurTime: {{CurTime}}' \
--header 'CheckSum: {{CheckSum}}' \
--header 'Content-Type: application/x-www-form-urlencoded' \
--data-urlencode 'serverId=' \
--data-urlencode 'channelId=' \
--data-urlencode 'from=' \
--data-urlencode 'type=' \
--data-urlencode 'body=' \
--data-urlencode 'attach=' \
--data-urlencode 'ext=' \
--data-urlencode 'msgIdClient=' \
--data-urlencode 'pushContent=' \
--data-urlencode 'pushPayload=' \
--data-urlencode 'option=' \
--data-urlencode 'mentionedAll=' \
--data-urlencode 'mentionedAccidList='

返回响应

🟢200成功
application/json
Body
object {0}
示例
{}
修改于 2024-12-31 09:11:15
上一页
请求圈组服务器地址
下一页
发送圈组自定义系统通知
Built with