Retrieve a list of address configurations for an account

GET /v1/Configuration/Addresses

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

Retrieve a list of address configurations for an account

Query parameters

  • Type string

    Filter the address configurations by its type. This value can be one of: whatsapp, sms.

  • PageSize integer(int64)

    How many resources to return in each list page. The default is 50, and the maximum is 50.

    Minimum value is 1, maximum value is 50.

  • Page integer

    The page index. This value is simply for client state.

    Minimum value is 0.

  • PageToken string

    The page token. This is provided by the API.

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
    • address_configurations array[object]
      Hide address_configurations attributes Show address_configurations 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.

    • meta object
      Hide meta attributes Show meta attributes object
      • first_page_url string(uri)
      • key string
      • next_page_url string(uri) | null
      • page integer
      • page_size integer
      • previous_page_url string(uri) | null
      • url string(uri)
GET /v1/Configuration/Addresses
curl \
 --request GET 'https://conversations.twilio.com/v1/Configuration/Addresses' \
 --user "username:password"
Response examples (200)
{
  "meta": {
    "key": "address_configurations",
    "url": "https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "address_configurations": [
    {
      "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"
    },
    {
      "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
      "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
      "type": "sms",
      "address": "+37256123458",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "date_created": "2016-03-24T21:05:50Z",
      "date_updated": "2016-03-24T21:05:50Z",
      "auto_creation": {
        "type": "studio",
        "enabled": false,
        "studio_flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "studio_retry_count": 3,
        "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
      },
      "friendly_name": "Studio Test Configuration",
      "address_country": "US"
    },
    {
      "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac",
      "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac",
      "type": "sms",
      "address": "+37256123459",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "date_created": "2016-03-24T21:05:50Z",
      "date_updated": "2016-03-24T21:05:50Z",
      "auto_creation": {
        "type": "default",
        "enabled": true
      },
      "friendly_name": "Default Test Configuration",
      "address_country": "NG"
    }
  ]
}
{
  "meta": {
    "key": "address_configurations",
    "url": "https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://conversations.twilio.com/v1/Configuration/Addresses?PageSize=50&Page=0",
    "previous_page_url": null
  },
  "address_configurations": []
}
{
  "meta": {
    "key": "address_configurations",
    "url": "https://conversations.twilio.com/v1/Configuration/Addresses?Type=sms&PageSize=50&Page=0",
    "page": 0,
    "page_size": 50,
    "next_page_url": null,
    "first_page_url": "https://conversations.twilio.com/v1/Configuration/Addresses?Type=sms&PageSize=50&Page=0",
    "previous_page_url": null
  },
  "address_configurations": [
    {
      "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"
    },
    {
      "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
      "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab",
      "type": "sms",
      "address": "+37256123458",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "date_created": "2016-03-24T21:05:50Z",
      "date_updated": "2016-03-24T21:05:50Z",
      "auto_creation": {
        "type": "studio",
        "enabled": false,
        "studio_flow_sid": "FWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
        "studio_retry_count": 3,
        "conversation_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
      },
      "friendly_name": "Studio Test Configuration",
      "address_country": "US"
    },
    {
      "sid": "IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac",
      "url": "https://conversations.twilio.com/v1/Configuration/Addresses/IGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac",
      "type": "sms",
      "address": "+37256123459",
      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
      "date_created": "2016-03-24T21:05:50Z",
      "date_updated": "2016-03-24T21:05:50Z",
      "auto_creation": {
        "type": "default",
        "enabled": true
      },
      "friendly_name": "Default Test Configuration",
      "address_country": "NG"
    }
  ]
}