Menu

Expand
Rate this page:

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
sid<IG> Not PII

A 34 character string that uniquely identifies this resource.

account_sid
sid<AC> Not PII

The unique ID of the Account the address belongs to

type
string Not PII

Type of Address, value can be whatsapp or sms.

address

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

friendly_name
string Not PII

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

auto_creation
object Not PII

Auto Creation configuration for the address.

date_created
date_time<iso8601> Not PII

The date that this resource was created.

date_updated
date_time<iso8601> Not PII

The date that this resource was last updated.

url
url Not PII

An absolute API resource URL for this address configuration.

Create an AddressConfiguration resource

post
https://conversations.twilio.com/v1/Configuration/Addresses
Parameters
Parameters in REST API format
type
Required
post ienum:type Not PII

Type of Address. Value can be whatsapp or sms.

address
Required
post string PII MTL: 30 DAYS

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

friendly_name
Optional
post string Not PII

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

auto_creation.enabled
Optional
post boolean Not PII

Enable/Disable auto-creating conversations for messages to this address

auto_creation.type
Optional
post ienum:auto_creation_type Not PII

Type of Auto Creation. Value can be one of webhook, studio or default.

auto_creation.conversation_service_sid
Optional
post sid<IS> Not PII

Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.

auto_creation.webhook_url
Optional
post string Not PII

For type webhook, the url for the webhook request.

auto_creation.webhook_method
Optional
post ienum:method Not PII

For type webhook, the HTTP method to be used when sending a webhook request.

auto_creation.webhook_filters
Optional
post string[] Not PII

The list of events, firing webhook event for this Conversation. Values can be any of the following: onMessageAdded, onMessageUpdated, onMessageRemoved, onConversationUpdated, onConversationStateUpdated, onConversationRemoved, onParticipantAdded, onParticipantUpdated, onParticipantRemoved, onDeliveryUpdated

auto_creation.studio_flow_sid
Optional
post sid<FW> Not PII

For type studio, the studio flow SID where the webhook should be sent to.

auto_creation.studio_retry_count
Optional
post integer Not PII

For type studio, number of times to retry the webhook request

Example 1
        
        
        

        Fetch an AddressConfiguration resource

        get
        https://conversations.twilio.com/v1/Configuration/Addresses/{Sid}
        Parameters
        Parameters in REST API format
        sid
        Path
        get sid_like<IG> Not PII

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

        Example 1
              
              
              

              Read multiple AddressConfiguration resources

              get
              https://conversations.twilio.com/v1/Configuration/Addresses
              Parameters
              Parameters in REST API format
              type
              Optional
              get string Not PII

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

              Example 1
                    
                    
                    

                    Update an AddressConfiguration resource

                    post
                    https://conversations.twilio.com/v1/Configuration/Addresses/{Sid}
                    Parameters
                    Parameters in REST API format
                    sid
                    Path
                    post sid_like<IG> Not PII

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

                    friendly_name
                    Optional
                    post string Not PII

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

                    auto_creation.enabled
                    Optional
                    post boolean Not PII

                    Enable/Disable auto-creating conversations for messages to this address

                    auto_creation.type
                    Optional
                    post ienum:auto_creation_type Not PII

                    Type of Auto Creation. Value can be one of webhook, studio or default.

                    auto_creation.conversation_service_sid
                    Optional
                    post sid<IS> Not PII

                    Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.

                    auto_creation.webhook_url
                    Optional
                    post string Not PII

                    For type webhook, the url for the webhook request.

                    auto_creation.webhook_method
                    Optional
                    post ienum:method Not PII

                    For type webhook, the HTTP method to be used when sending a webhook request.

                    auto_creation.webhook_filters
                    Optional
                    post string[] Not PII

                    The list of events, firing webhook event for this Conversation. Values can be any of the following: onMessageAdded, onMessageUpdated, onMessageRemoved, onConversationUpdated, onConversationStateUpdated, onConversationRemoved, onParticipantAdded, onParticipantUpdated, onParticipantRemoved, onDeliveryUpdated

                    auto_creation.studio_flow_sid
                    Optional
                    post sid<FW> Not PII

                    For type studio, the studio flow SID where the webhook should be sent to.

                    auto_creation.studio_retry_count
                    Optional
                    post integer Not PII

                    For type studio, number of times to retry the webhook request

                    Example 1
                          
                          
                          

                          Delete an AddressConfiguration resource

                          delete
                          https://conversations.twilio.com/v1/Configuration/Addresses/{Sid}
                          Parameters
                          Parameters in REST API format
                          sid
                          Path
                          delete sid_like<IG> Not PII

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

                          Example 1
                                
                                
                                

                                Rate this page:

                                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.

                                      
                                      
                                      

                                      Thank you for your feedback!

                                      Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                                      Sending your feedback...
                                      🎉 Thank you for your feedback!
                                      Something went wrong. Please try again.

                                      Thanks for your feedback!

                                      thanks-feedback-gif