Fetch push notification service settings

GET /v1/Services/{ChatServiceSid}/Configuration/Notifications
Account sid auth token

A Service Notification resource manages a set of settings to determine push notification behavior at service level.

Fetch push notification service settings

Path parameters

  • ChatServiceSid string Required

    The SID of the Conversation Service the Configuration applies to.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

Responses

  • 200 application/json

    OK

    Hide headers attributes Show headers attributes
    • Access-Control-Allow-Origin string

      Specify the origin(s) allowed to access the resource

    • Access-Control-Allow-Methods string

      Specify the HTTP methods allowed when accessing the resource

    • Access-Control-Allow-Headers string

      Specify the headers allowed when accessing the resource

    • Access-Control-Allow-Credentials boolean

      Indicates whether the browser should include credentials

    • Access-Control-Expose-Headers string

      Headers exposed to the client

    Hide response attributes Show response attributes object
    • account_sid string | null

      The unique ID of the Account responsible for this configuration.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • chat_service_sid string | null

      The SID of the Conversation Service the Configuration applies to.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^IS[0-9a-fA-F]{32}$.

    • new_message

      The Push Notification configuration for New Messages.

    • added_to_conversation

      The Push Notification configuration for being added to a Conversation.

    • removed_from_conversation

      The Push Notification configuration for being removed from a Conversation.

    • log_enabled boolean | null

      Weather the notification logging is enabled.

    • url string(uri) | null

      An absolute API resource URL for this configuration.
GET /v1/Services/{ChatServiceSid}/Configuration/Notifications 
curl \
 --request GET 'https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration/Notifications' \
 --user "username:password"
Response examples (200) 
{
  "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "log_enabled": false,
  "new_message": {
    "sound": "ring",
    "enabled": true,
    "template": "You have a new message in ${CONVERSATION} from ${PARTICIPANT}: ${MESSAGE}",
    "with_media": {
      "enabled": false,
      "template": "You have a new message in ${CONVERSATION} with ${MEDIA_COUNT} media files: ${MEDIA}"
    },
    "badge_count_enabled": false
  },
  "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "added_to_conversation": {
    "sound": "ring",
    "enabled": true,
    "template": "You have been added to a Conversation: ${CONVERSATION}"
  },
  "removed_from_conversation": {
    "sound": "ring",
    "enabled": true,
    "template": "You have been removed from a Conversation: ${CONVERSATION}"
  }
}