Cyan Web API - Version 1


GET api/messageBodies/pushNotification

            Gets and example of the message body format for a "PushNotification" message.
            

Response Information

Response body formats

application/json, text/json

Sample:
{
  "to": "sample string 1",
  "registration_ids": [
    "sample string 1",
    "sample string 2",
    "sample string 3"
  ],
  "collapse_key": "sample string 2",
  "priority": "sample string 3",
  "delay_while_idle": true,
  "time_to_live": 5,
  "dry_run": true,
  "data": {
    "sample string 1": {},
    "sample string 3": {},
    "sample string 5": {}
  },
  "notification": {
    "title": "sample string 1",
    "body": "sample string 2",
    "icon": "sample string 3",
    "sound": "sample string 4",
    "badge": "sample string 5",
    "tag": "sample string 6",
    "color": "sample string 7",
    "click_action": "sample string 8",
    "body_loc_key": "sample string 9",
    "body_loc_args": "sample string 10",
    "title_loc_key": "sample string 11",
    "title_loc_args": "sample string 12"
  }
}

application/xml, text/xml

Sample:
<FCMPushMessageBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.Messaging">
  <collapse_key>sample string 2</collapse_key>
  <data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 5</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </data>
  <delay_while_idle>true</delay_while_idle>
  <dry_run>true</dry_run>
  <notification xmlns:d2p1="http://schemas.datacontract.org/2004/07/BlueDot.Cyan.Server.Core.Models.FCM">
    <d2p1:badge>sample string 5</d2p1:badge>
    <d2p1:body>sample string 2</d2p1:body>
    <d2p1:body_loc_args>sample string 10</d2p1:body_loc_args>
    <d2p1:body_loc_key>sample string 9</d2p1:body_loc_key>
    <d2p1:click_action>sample string 8</d2p1:click_action>
    <d2p1:color>sample string 7</d2p1:color>
    <d2p1:icon>sample string 3</d2p1:icon>
    <d2p1:sound>sample string 4</d2p1:sound>
    <d2p1:tag>sample string 6</d2p1:tag>
    <d2p1:title>sample string 1</d2p1:title>
    <d2p1:title_loc_args>sample string 12</d2p1:title_loc_args>
    <d2p1:title_loc_key>sample string 11</d2p1:title_loc_key>
  </notification>
  <priority>sample string 3</priority>
  <registration_ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
    <d2p1:string>sample string 3</d2p1:string>
  </registration_ids>
  <time_to_live>5</time_to_live>
  <to>sample string 1</to>
</FCMPushMessageBody>