API - NMS消息推送服务

消息推送

接口网址 :

• https://nms-aaa.nowapi.com/v1?app=main.publish

Header :

• "Content-Type: application/json; charset=utf-8",

Method :

• POST

Content :

{
    "accessKey"  : "8512547106565e12544125007942565e",
    "channels"   : ["myChannel"],
    "content"    : "testMessage...",
    "qos"        : "1',
    "userId"     : "user-001"
}

字段说明 :

• accessKey : (必须) 认证密钥，用户中心查看，该key有权限区分。
• channels : (必须) 通道，支持多个["myChannel1","myChannel2","myChannel3"]
• content : (必须) 消息实体
• qos : 0:离线不补发，1:离线补发，默认不补发。
• userId: 指定的客户端ID，用于区分不同终端，不需要创建，可随用随弃。

CURL :

curl -X POST https://nms-aaa.nowapi.com/v1?app=main.publish \
-H "Content-Type: application/json charset=UTF-8" \
-d '{"accessKey":"8512547106565e12544125007942565e","channels":["myChannel"],"content":"测试消息","qos":"1","userId":"user-001"}'

成功响应 :

{"resultCode":"200","resultMessage":"OK","resultContent":[]}

失败响应 :

{"resultCode":"400","resultMessage":"ERR_...","resultContent":[]}

消息读取接收

通过 API 方式读取通道（Channel）中的消息，该消息为任意类型的发布（Publish）推送，且 QoS 为 1 的消息。
 
接口网址 :

• https://nms-aaa.nowapi.com/v1?app=main.reading

Header :

• "Content-Type: application/json; charset=utf-8",

Method :

• POST

Content :

{
    "accessKey"  : "8512547106565e12544125007942565e",
    "channels"   : ["myChannel"],
    "userId"     : "user-001"
}

字段说明 :

• accessKey : (必须) 认证密钥，用户中心查看，该key有权限区分。
• channels : (必须) 通道，支持多个["myChannel1","myChannel2","myChannel3"]
• userId: (必须) 指定的客户端ID，用于区分不同终端，不需要创建，可随用随弃。

curl :

curl -X POST https://nms-aaa.nowapi.com/v1?app=main.reading \
-H "Content-Type: application/json charset=UTF-8" \
-d '{"instanceId":"ins-10003","accessKey":"8512547106565e12544125007942565e","channels":["myChannel"],"userId":"user-001"}'

成功响应 :

# 存在消息
{
  "resultCode": "201",
  "resultMessage": "NO_DATA",
  "resultContent": [
    {
      "i": "MG172500386528110075f42e41a538c186",
      "t": "1725003865281",
      "n": "myChannel",
      "c": "测试消息1"
    },
    {
      "i": "MG17250038675331009985cb7149689c3e",
      "t": "1725003867533",
      "n": "myChannel",
      "c": "测试消息2"
    }
  ]
}

# 没有消息
{
  "resultCode": "201",
  "resultMessage": "NO_DATA",
  "resultContent": [ ]
}

失败响应 :

{"resultCode":"400","resultMessage":"ERR_...","resultContent":[]}