— notify-v1 · SKMTC Hub

NotifyV1Notification

post/v1/Services/{ServiceSid}/Notifications

Path parameters

ServiceSidstring required

The SID of the Service to create the resource under.

Response

Created

sidstring nullable

The unique string that we created to identify the Notification resource.

account_sidstring nullable

The SID of the Account that created the Notification resource.

service_sidstring nullable

The SID of the Service the resource is associated with.

date_createdstring date-time nullable

The date and time in GMT when the resource was created specified in RFC 2822 format.

identitiesstring[] nullable

The list of identity values of the Users to notify. We will attempt to deliver notifications only to Bindings with an identity in this list.

tagsstring[] nullable

The tags that select the Bindings to notify. Notifications will be attempted only to Bindings that have all of the tags listed in this property.

segmentsstring[] nullable

The list of Segments to notify. The Segment resource is deprecated. Use the tags property, instead.

priority'high' | 'low'

The priority of the notification. Can be: low or high and the default is high. A value of low optimizes the client app's battery consumption; however, notifications may be delivered with unspecified delay. For FCM and GCM, low priority is the same as Normal priority. For APNS low priority is the same as 5. A value of high sends the notification immediately, and can wake up a sleeping device. For FCM and GCM, high is the same as High priority. For APNS, high is a priority 10. SMS does not support this property.

ttlinteger

How long, in seconds, the notification is valid. Can be an integer between 0 and 2,419,200, which is 4 weeks, the default and the maximum supported time to live (TTL). Delivery should be attempted if the device is offline until the TTL elapses. Zero means that the notification delivery is attempted immediately, only once, and is not stored for future delivery. SMS does not support this property.

titlestring nullable

The notification title. For FCM and GCM, this translates to the data.twi_title value. For APNS, this translates to the aps.alert.title value. SMS does not support this property. This field is not visible on iOS phones and tablets but appears on Apple Watch and Android devices.

bodystring nullable

The notification text. For FCM and GCM, translates to data.twi_body. For APNS, translates to aps.alert.body. For SMS, translates to body. SMS requires either this body value, or media_urls attribute defined in the sms parameter of the notification.

soundstring nullable

The name of the sound to be played for the notification. For FCM and GCM, this Translates to data.twi_sound. For APNS, this translates to aps.sound. SMS does not support this property.

actionstring nullable

The actions to display for the notification. For APNS, translates to the aps.category value. For GCM, translates to the data.twi_action value. For SMS, this parameter is not supported and is omitted from deliveries to those channels.

{"stackTrail":"components:schemas:notify.v1.service.notification:properties:data","oasType":"schema","type":"unknown","description":"The custom key-value pairs of the notification's payload. For FCM and GCM, this value translates to `data` in the FCM and GCM payloads. FCM and GCM [reserve certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref) that cannot be used in those channels. For APNS, attributes of `data` are inserted into the APNS payload as custom properties outside of the `aps` dictionary. In all channels, we reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed and are rejected as 400 Bad request with no delivery attempted. For SMS, this parameter is not supported and is omitted from deliveries to those channels.","nullable":true}

{"stackTrail":"components:schemas:notify.v1.service.notification:properties:apn","oasType":"schema","type":"unknown","description":"The APNS-specific payload that overrides corresponding attributes in the generic payload for APNS Bindings. This property maps to the APNS `Payload` item, therefore the `aps` key must be used to change standard attributes. Adds custom key-value pairs to the root of the dictionary. See the [APNS documentation](https://developer.apple.com/library/content/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/CommunicatingwithAPNs.html) for more details. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed.","nullable":true}

{"stackTrail":"components:schemas:notify.v1.service.notification:properties:gcm","oasType":"schema","type":"unknown","description":"The GCM-specific payload that overrides corresponding attributes in the generic payload for GCM Bindings. This property maps to the root JSON dictionary. Target parameters `to`, `registration_ids`, and `notification_key` are not allowed. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed.","nullable":true}

{"stackTrail":"components:schemas:notify.v1.service.notification:properties:fcm","oasType":"schema","type":"unknown","description":"The FCM-specific payload that overrides corresponding attributes in the generic payload for FCM Bindings. This property maps to the root JSON dictionary. See the [FCM documentation](https://firebase.google.com/docs/cloud-messaging/http-server-ref#downstream) for more details. Target parameters `to`, `registration_ids`, `condition`, and `notification_key` are not allowed in this parameter. We reserve keys that start with `twi_` for future use. Custom keys that start with `twi_` are not allowed. FCM also [reserves certain keys](https://firebase.google.com/docs/cloud-messaging/http-server-ref), which cannot be used in that channel.","nullable":true}

{"stackTrail":"components:schemas:notify.v1.service.notification:properties:sms","oasType":"schema","type":"unknown","description":"The SMS-specific payload that overrides corresponding attributes in the generic payload for SMS Bindings. Each attribute in this value maps to the corresponding `form` parameter of the Twilio [Message](https://www.twilio.com/docs/sms/api/message-resource) resource. These parameters of the Message resource are supported in snake case format: `body`, `media_urls`, `status_callback`, and `max_price`. The `status_callback` parameter overrides the corresponding parameter in the messaging service, if configured. The `media_urls` property expects a JSON array.","nullable":true}

{"stackTrail":"components:schemas:notify.v1.service.notification:properties:facebook_messenger","oasType":"schema","type":"unknown","description":"Deprecated.","nullable":true}

{"stackTrail":"components:schemas:notify.v1.service.notification:properties:alexa","oasType":"schema","type":"unknown","description":"Deprecated.","nullable":true}

Changes

Changed in 4 of the 50 revisions of this API.219

Jul 3, 2025v1583aa4c53e8677See the full diff
- ▲
  the alexa response's property type/format changed from object/ to / for status 201
  response-property-type-changed
- ▲
  the apn response's property type/format changed from object/ to / for status 201
  response-property-type-changed
- ▲
  the data response's property type/format changed from object/ to / for status 201
  response-property-type-changed
- ▲
  the facebook_messenger response's property type/format changed from object/ to / for status 201
  response-property-type-changed
- ▲
  the fcm response's property type/format changed from object/ to / for status 201
  response-property-type-changed
- ▲
  the gcm response's property type/format changed from object/ to / for status 201
  response-property-type-changed
- ▲
  the sms response's property type/format changed from object/ to / for status 201
  response-property-type-changed
- ○
  the Alexa request property type/format was generalized from object/ to /
  request-property-type-generalized
- ○
  the Apn request property type/format was generalized from object/ to /
  request-property-type-generalized
- ○
  the Data request property type/format was generalized from object/ to /
  request-property-type-generalized
- ○
  the FacebookMessenger request property type/format was generalized from object/ to /
  request-property-type-generalized
- ○
  the Fcm request property type/format was generalized from object/ to /
  request-property-type-generalized
- ○
  the Gcm request property type/format was generalized from object/ to /
  request-property-type-generalized
- ○
  the Sms request property type/format was generalized from object/ to /
  request-property-type-generalized
Mar 11, 2025v12ca19460d8e914See the full diff
- ▲
  the Alexa request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the Apn request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the Data request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the FacebookMessenger request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the Fcm request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the Gcm request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the Sms request property type/format changed from / to object/
  request-property-type-changed
- ▲
  the alexa response's property type/format changed from / to object/ for status 201
  response-property-type-changed
- ▲
  the apn response's property type/format changed from / to object/ for status 201
  response-property-type-changed
- ▲
  the data response's property type/format changed from / to object/ for status 201
  response-property-type-changed
- ▲
  the facebook_messenger response's property type/format changed from / to object/ for status 201
  response-property-type-changed
- ▲
  the fcm response's property type/format changed from / to object/ for status 201
  response-property-type-changed
- ▲
  the gcm response's property type/format changed from / to object/ for status 201
  response-property-type-changed
- ▲
  the sms response's property type/format changed from / to object/ for status 201
  response-property-type-changed
Aug 26, 2024v19eb3ac13755f1See the full diff
- ○
  the ttl response's property default value 0 was added for the status 201
  response-property-default-value-added
Aug 10, 2023v17c12f6a8cb191See the full diff
- ○
  api tag NotifyV1Notification added
  api-tag-added

Full history