Retrieve a list of address configurations for an account
Address Configuration resource manages the configurations related to a unique address within Conversations
Retrieve a list of address configurations for an account
Query parameters
-
Filter the address configurations by its type. This value can be one of:
whatsapp
,sms
. -
How many resources to return in each list page. The default is 50, and the maximum is 50.
Minimum value is
1
, maximum value is50
. -
The page index. This value is simply for client state.
Minimum value is
0
. -
The page token. This is provided by the API.
GET
/v1/Configuration/Addresses
curl \
--request GET 'https://conversations.twilio.com/v1/Configuration/Addresses' \
--user "username:password"
Response examples (200)
Read all
{
"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"
}
]
}