CCC API v8.4.0.0

<back to all web services

SubscribeForNotificationAlerts

The following routes are available for this service:
POST/api/notificationsAdd a notification subscription
SubscribeForNotificationAlerts Parameters:
NameParameterData TypeRequiredDescription
DeviceTypebodyNotificationDeviceTypeYes

Allowable Values

  • Android
  • iOS
  • Pusher
DeviceIdbodyStringYes
ClientAppIdbodyStringYes
PushTokenbodyStringYes
SubscribeForNotificationAlertsResponse Parameters:
NameParameterData TypeRequiredDescription
SubscriberGuidbodyGuidYes
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /api/notifications HTTP/1.1 
Host: api.secure-messaging.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{
  "deviceType": "String",
  "deviceId": "String",
  "clientAppId": "String",
  "pushToken": "String"
}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{
  "subscriberGuid": "00000000000000000000000000000000",
  "responseStatus": {
    "errorCode": "String",
    "message": "String",
    "stackTrace": "String",
    "errors": [
      {
        "errorCode": "String",
        "fieldName": "String",
        "message": "String",
        "meta": {
          "String": "String"
        }
      }
    ],
    "meta": {
      "String": "String"
    }
  }
}