Fetch an address configuration

GET /v1/Configuration/Addresses/{Sid}
Account sid auth token

Address Configuration resource manages the configurations related to a unique address within Conversations

Fetch an address configuration

Path parameters

  • Sid string Required

    The SID of the Address Configuration resource. This value can be either the sid or the address of the configuration

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: ^IG[0-9a-fA-F]{32}$.

    • account_sid string | null

      The unique ID of the Account the address belongs to

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

    • type string | null

      Type of Address, value can be whatsapp or sms.

    • address string | null

      The unique address to be configured. The address can be a whatsapp address or phone number

    • friendly_name string | null

      The human-readable name of this configuration, limited to 256 characters. Optional.

    • auto_creation

      Auto Creation configuration for the address.

    • 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.

    • url string(uri) | null

      An absolute API resource URL for this address configuration.

    • address_country string | null

      An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.
GET /v1/Configuration/Addresses/{Sid} 
curl \
 --request GET 'https://conversations.twilio.com/v1/Configuration/Addresses/{Sid}' \
 --user "username:password"
Response examples (200) 
{
  "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "type": "sms",
  "address": "+37256123457",
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "2016-03-24T21:05:50Z",
  "date_updated": "2016-03-24T21:05:50Z",
  "auto_creation": {
    "type": "webhook",
    "enabled": true,
    "webhook_url": "https://example.com",
    "webhook_method": "POST",
    "webhook_filters": [
      "onParticipantAdded",
      "onMessageAdded"
    ],
    "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
  },
  "friendly_name": "My Test Configuration",
  "address_country": "CA"
}