POST api/FirebaseNotificationApi/SendRichNotification

Request Information

URI Parameters

None.

Body Parameters

BaseNotificationRequest
NameDescriptionTypeAdditional information
Message

BaseMessage

None.

Request Formats

application/json, text/json

Sample:
{
  "Message": {
    "Tokens": [
      {
        "DriverId": 1,
        "FcmToken": "sample string 2",
        "IsAndroid": true
      },
      {
        "DriverId": 1,
        "FcmToken": "sample string 2",
        "IsAndroid": true
      }
    ],
    "Notification": {
      "Title": "sample string 1",
      "Body": "sample string 2"
    },
    "Data": {
      "sample string 1": "sample string 2",
      "sample string 3": "sample string 4"
    },
    "Android": {
      "Priority": "sample string 1",
      "Notification": {
        "ChannelId": "sample string 1",
        "Sound": "sample string 2"
      }
    },
    "Apns": {
      "Headers": {
        "sample string 1": "sample string 2",
        "sample string 3": "sample string 4"
      },
      "Aps": {
        "Sound": "sample string 1",
        "Badge": 2,
        "Category": "sample string 3",
        "MutableContent": true
      }
    }
  }
}

text/html

Sample:
{"Message":{"Tokens":[{"DriverId":1,"FcmToken":"sample string 2","IsAndroid":true},{"DriverId":1,"FcmToken":"sample string 2","IsAndroid":true}],"Notification":{"Title":"sample string 1","Body":"sample string 2"},"Data":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"Android":{"Priority":"sample string 1","Notification":{"ChannelId":"sample string 1","Sound":"sample string 2"}},"Apns":{"Headers":{"sample string 1":"sample string 2","sample string 3":"sample string 4"},"Aps":{"Sound":"sample string 1","Badge":2,"Category":"sample string 3","MutableContent":true}}}}

application/xml, text/xml

Sample:
<BaseNotificationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ALSDispatchAPI.Controllers">
  <Message>
    <Android>
      <Notification>
        <ChannelId>sample string 1</ChannelId>
        <Sound>sample string 2</Sound>
      </Notification>
      <Priority>sample string 1</Priority>
    </Android>
    <Apns>
      <Aps>
        <Badge>2</Badge>
        <Category>sample string 3</Category>
        <MutableContent>true</MutableContent>
        <Sound>sample string 1</Sound>
      </Aps>
      <Headers xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 1</d4p1:Key>
          <d4p1:Value>sample string 2</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>sample string 3</d4p1:Key>
          <d4p1:Value>sample string 4</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Headers>
    </Apns>
    <Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 1</d3p1:Key>
        <d3p1:Value>sample string 2</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>sample string 3</d3p1:Key>
        <d3p1:Value>sample string 4</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Data>
    <Notification>
      <Body>sample string 2</Body>
      <Title>sample string 1</Title>
    </Notification>
    <Tokens>
      <FcmTokenClass>
        <DriverId>1</DriverId>
        <FcmToken>sample string 2</FcmToken>
        <IsAndroid>true</IsAndroid>
      </FcmTokenClass>
      <FcmTokenClass>
        <DriverId>1</DriverId>
        <FcmToken>sample string 2</FcmToken>
        <IsAndroid>true</IsAndroid>
      </FcmTokenClass>
    </Tokens>
  </Message>
</BaseNotificationRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BaseNotificationRequest'.

Response Information

Resource Description

boolean

Response Formats

application/json, text/json, text/html

Sample:
true

application/xml, text/xml

Sample:
<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>