发送控制指令
更新时间: 2025/08/19 15:37:22
该接口支持在信令频道房间中发送自定义控制指令,可用于实现自定义相关的业务逻辑。
发送时可以指定接收用户,如果不指定,则默认发送给频道房间内的所有人。
调用频率
单个应用默认最高调用频率请参考 频控说明。
请求信息
请求 URL
httpsPOST https://api.yunxinapi.com/nimserver/signal/ctrlRoom.action HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8
请求头参数
请求 Header 的参数说明请参考 请求 Header。
请求体参数
| 参数名称 | 类型 | 是否必选 | 描述 |
|---|---|---|---|
channelId |
String | 是 | 信令频道 ID。 |
from |
String | 否 | 控制指令发送者账号 ID。 |
to |
String | 否 | 控制指令接收者账号 ID。 |
attachExt |
String | 否 | 通知扩展字段,最大长度为 4096 字符。 |
isRoute |
Integer | 否 | 是否抄送,0(默认):不抄送;1:抄送。 |
请求示例
curlcurl -X POST -H "AppKey: go9dnk49***w0803mgq3" -H "Nonce: 4tggge**23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb**cc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'channelId=ch_87654321' 'https://api.yunxinapi.com/nimserver/signal/ctrlRoom.action'
响应示例
响应头参数
响应 Header 的参数说明请参考 响应 Header。
响应体参数
| 参数名称 | 类型 | 说明 |
|---|---|---|
code |
Integer | 状态码,200 表示请求成功。 |
data |
Object | 返回的 JSON 数据对象,请求失败则返回空对象。 |
响应体示例
JSON{
"code": 200,
"data": {}
}
错误码
完整错误码请参考 错误码。
此文档是否对你有帮助?




