操作场景

本章节指导用户通过API使用移动推送。API的调用方法请参见如何调用API。

前提条件

• 若使用HMS，已获取到PUSH服务参数（APP ID和APP SECRET）。
• 若使用APNS，已获取到P12格式IOS推送证书及其密码。

涉及接口

• 获取用户Token：通过用户名/密码的方式进行认证来获取IAM用户Token。
• 创建Application：创建平台应用。
• 创建Application endpoint：创建应用平台的endpoint终端。
• App消息发布：将消息直发给endpoint设备。

调试

您可以在API Explorer中调试该接口。

操作步骤

1. Token认证，具体操作请参考认证鉴权。
2. 创建Application。
   1. 发送“POST https://{SMN_Endpoint}/v2/{project_id}/notifications/applications”。
   2. 在Request Header中增加“X-Auth-Token”。
   3. 在Request Body中传入如下参数。
      详细的参数说明请参见“创建主题”

      {     
          "name": "application_name",      
          "platform": "HMS",      
          "platform_principal": "appId",      
          "platform_credential": "appSecret" 
      }

      响应示例：

      {     
          "request_id": "6a63a18b8bab40ffb71ebd9cb80d0085",      
          "application_urn": "urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:app-HMS-application_name",
          "application_id": "4f9ad22e1c244034995a77760252553c"
      }

3. 创建Application endpoint。
   1. 发送“POST https://{SMN_Endpoint}/v2/{project_id}/notifications/applications/{application_urn}/endpoints”。

      其中，application_urn可在2.c的返回体中获取。

   2. 在Request Header中增加“X-Auth-Token”。
   3. 在Request Body中传入参数如下：

      {
          "token": "37082*******383445",
          "user_data": "add endpoint"
      }

      响应示例：

      {     
          "request_id": "6a63a18b8bab40ffb71ebd9cb80d0085",      
          "endpoint_urn": "urn:smn:regionId:f96188c7ccaf4ffba0c9aa149ab2bd57:endpoint-APNS-example_application_name-37a2cb947fa43a20bc66e91281194e7a" 
      }

可以为Application添加多个endpoint，且endpoint信息支持修改，详见更新Application endpoint。

4. App消息发布。
   1. 发送“POST https://{SMN_Endpoint}/v2/{project_id}/notifications/topics/{topic_urn}/publish”。
   2. 在Request Header中增加“X-Auth-Token”。
   3. 在Request Body中传入参数如下所示。

      {
          "message":{
               "hps":{
                     "msg":{
                           "action":{ 
                                 "param":{
                                      "intent": "#Intent;compo=com.HC.SmnAppPush.defaultAction/.Activity;S.W=U;end"
                                 },
                                 "type": 1
                           },
                           "body": {
                                 "title": "hello world",
                                 "content": "hello world"
                           },
                           "type": 3
                      }
               }
          }
      }

      响应示例：

      {    
          "request_id": "6a63a18b8bab40ffb71ebd9cb80d0085",   
          "message_id": "992bbd32819448af95f83814cb3c7454"  
      }

      

      确保4.c中的token参数正确，否则您可能无法收到移动应用消息。