Address Configuration Resource
The Address Configuration resource manages the configurations related to a unique address within the Conversations product, allowing you to specify which addresses should auto-create a Conversation upon receiving an inbound message.
The unique address must be a single address (i.e. a WhatsApp or SMS phone number) that belongs to your Twilio Account.
The configuration can optionally include automatically attaching a Conversation-scoped Webhook to the auto-created conversations.
AddressConfiguration properties
| Resource Properties in REST API format | |
|---|---|
sid
|
A 34 character string that uniquely identifies this resource. |
account_sid
|
The unique ID of the Account the address belongs to |
type
|
Type of Address, value can be |
address
|
The unique address to be configured. The address can be a whatsapp address or phone number |
friendly_name
|
The human-readable name of this configuration, limited to 256 characters. Optional. |
auto_creation
|
Auto Creation configuration for the address. |
date_created
|
The date that this resource was created. |
date_updated
|
The date that this resource was last updated. |
url
|
An absolute API resource URL for this address configuration. |
address_country
|
An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses. |
Create an AddressConfiguration resource
https://conversations.twilio.com/v1/Configuration/Addresses
Parameters
| Parameters in REST API format | |
|---|---|
type
Required
|
Type of Address. Value can be |
address
Required
|
The unique address to be configured. The address can be a whatsapp address or phone number |
friendly_name
Optional
|
The human-readable name of this configuration, limited to 256 characters. Optional. |
auto_creation.enabled
Optional
|
Enable/Disable auto-creating conversations for messages to this address |
auto_creation.type
Optional
|
Type of Auto Creation. Value can be one of |
auto_creation.conversation_service_sid
Optional
|
Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service. |
auto_creation.webhook_url
Optional
|
For type |
auto_creation.webhook_method
Optional
|
For type |
auto_creation.webhook_filters
Optional
|
The list of events, firing webhook event for this Conversation. Values can be any of the following: |
auto_creation.studio_flow_sid
Optional
|
For type |
auto_creation.studio_retry_count
Optional
|
For type |
address_country
Optional
|
An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses. |
Example 1
Fetch an AddressConfiguration resource
https://conversations.twilio.com/v1/Configuration/Addresses/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the Address Configuration resource. This value can be either the |
Example 1
Read multiple AddressConfiguration resources
https://conversations.twilio.com/v1/Configuration/Addresses
Parameters
| Parameters in REST API format | |
|---|---|
type
Optional
|
Filter the address configurations by its type. This value can be one of: |
Example 1
Update an AddressConfiguration resource
https://conversations.twilio.com/v1/Configuration/Addresses/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the Address Configuration resource. This value can be either the |
friendly_name
Optional
|
The human-readable name of this configuration, limited to 256 characters. Optional. |
auto_creation.enabled
Optional
|
Enable/Disable auto-creating conversations for messages to this address |
auto_creation.type
Optional
|
Type of Auto Creation. Value can be one of |
auto_creation.conversation_service_sid
Optional
|
Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service. |
auto_creation.webhook_url
Optional
|
For type |
auto_creation.webhook_method
Optional
|
For type |
auto_creation.webhook_filters
Optional
|
The list of events, firing webhook event for this Conversation. Values can be any of the following: |
auto_creation.studio_flow_sid
Optional
|
For type |
auto_creation.studio_retry_count
Optional
|
For type |
Example 1
Delete an AddressConfiguration resource
https://conversations.twilio.com/v1/Configuration/Addresses/{Sid}
Parameters
| Parameters in REST API format | |
|---|---|
sid
Path
|
The SID of the Address Configuration resource. This value can be either the |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
