Fetch a push notification binding from the conversation service

GET /v1/Services/{ChatServiceSid}/Bindings/{Sid}

A Binding resource represents a push notification binding and its configuration, for delivering conversation events to mobile or web endpoints.

Fetch a push notification binding from the conversation service

Path parameters

  • ChatServiceSid string Required

    The SID of the Conversation Service the Binding resource is associated with.

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

  • Sid string Required

    A 34 character string that uniquely identifies this resource.

    Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BS[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
    • sid string | null

      A 34 character string that uniquely identifies this resource.

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

    • account_sid string | null

      The unique ID of the Account responsible for this binding.

      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 Binding resource is associated with.

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

    • credential_sid string | null

      The SID of the Credential for the binding. See push notification configuration for more info.

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

    • date_created string(date-time) | null

      The date that this resource was created.

    • date_updated string(date-time) | null

      The date that this resource was last updated.

    • endpoint string | null

      The unique endpoint identifier for the Binding. The format of this value depends on the binding_type.

    • identity string | null

      The application-defined string that uniquely identifies the Conversation User within the Conversation Service. See access tokens for more info.

    • binding_type string

      The push technology to use for the Binding. Can be: apn, gcm, or fcm. See push notification configuration for more info.

      Values are apn, gcm, or fcm.

    • message_types array[string] | null

      The Conversation message types the binding is subscribed to.

    • url string(uri) | null

      An absolute API resource URL for this binding.

GET /v1/Services/{ChatServiceSid}/Bindings/{Sid}
curl \
 --request GET 'https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Bindings/{Sid}' \
 --user "username:password"
Response examples (200)
{
  "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "endpoint": "TestUser-endpoint",
  "identity": "TestUser",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "binding_type": "gcm",
  "date_created": "2016-10-21T11:37:03Z",
  "date_updated": "2016-10-21T11:37:03Z",
  "message_types": [
    "removed_from_conversation",
    "new_message",
    "added_to_conversation"
  ],
  "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}