消息服务

消息服务API，用于应用服务器单向发送消息到RTS消息服务，与客户端SDK消息服务接口相对应。

• 当客户端SDK收到来自服务端API发送的消息时，发送方 userId 统一为 0。
• 消息服务API的请求频率限制为50次/秒。

发送实时消息给指定用户

请求

POST /rtm/message
Host: api.pano.video
Content-Type: application/json
Authorization: PanoSign <PanoSign>
Tracking-Id: ef9b2acc8e1f4d598090eb6d9cbe8596

{
  "channelId": "HelloPano",     // String，必填，频道ID
  "action": 0,                  // int，   必填，固定是0
  "userId": "12345",            // String，必填，接收消息的用户的ID
  "message": "SGVsbG9QYW5v"     // String，必填，Base64编码后的消息，编码前的原始消息最大为4KB
}

响应

状态码	说明
200	请求成功处理
400	请求格式错误
401	认证错误
500	服务器端内部错误

响应示例

200 OK
Tracking-Id: "ef9b2acc8e1f4d598090eb6d9cbe8596"

{
    "errorCode": "0",
    "message": "success",
}

广播实时消息给所有用户

请求

POST /rtm/message
Host: api.pano.video
Content-Type: application/json
Authorization: PanoSign <PanoSign>
Tracking-Id: ef9b2acc8e1f4d598090eb6d9cbe8596

{
  "channelId": "HelloPano",     // String，必填，频道ID
  "action": 1,                  // int，   必填，固定是1
  "message": "SGVsbG9QYW5v"     // String，必填，Base64编码后的消息，编码前的原始消息最大为4KB
}

响应

状态码	说明
200	请求成功处理
400	请求格式错误
401	认证错误
500	服务器端内部错误

响应示例

200 OK
Tracking-Id: "ef9b2acc8e1f4d598090eb6d9cbe8596"

{
    "errorCode": "0",
    "message": "success",
}

发布消息到指定主题

请求

POST /rtm/message
Host: api.pano.video
Content-Type: application/json
Authorization: PanoSign <PanoSign>
Tracking-Id: ef9b2acc8e1f4d598090eb6d9cbe8596

{
  "channelId": "HelloPano",     // String，必填，频道ID
  "action": 4,                  // int，   必填，固定是4
  "topic": "topic",             // String，必填，主题名称
  "message": "SGVsbG9QYW5v"     // String，必填，Base64编码后的消息，编码前的原始消息最大为4KB
}

响应

状态码	说明
200	请求成功处理
400	请求格式错误
401	认证错误
500	服务器端内部错误

响应示例

200 OK
Tracking-Id: "ef9b2acc8e1f4d598090eb6d9cbe8596"

{
    "errorCode": "0",
    "message": "success",
}

设置消息服务属性

请求

POST /rtm/message
Host: api.pano.video
Content-Type: application/json
Authorization: PanoSign <PanoSign>
Tracking-Id: ef9b2acc8e1f4d598090eb6d9cbe8596

{
  "channelId": "HelloPano",      // String，必填，频道ID
  "action": 5,                   // int，   必填，固定是5
  "propertyId": "propertyId",    // String，必填，属性ID
  "property": "SGVsbG9QYW5v"     // String，必填，Base64编码后的属性，编码前的原始属性最大为4KB
}

响应

状态码	说明
200	请求成功处理
400	请求格式错误
401	认证错误
500	服务器端内部错误

响应示例

200 OK
Tracking-Id: "ef9b2acc8e1f4d598090eb6d9cbe8596"

{
    "errorCode": "0",
    "message": "success",
}