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.
sid
type: SID<IG>A 34 character string that uniquely identifies this resource.
^IG[0-9a-fA-F]{32}$
34
34
account_sid
type: SID<AC>The unique ID of the Account the address belongs to
^AC[0-9a-fA-F]{32}$
34
34
address
type: stringThe unique address to be configured. The address can be a whatsapp address or phone number
friendly_name
type: stringThe human-readable name of this configuration, limited to 256 characters. Optional.
address_country
type: stringAn ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.
POST https://conversations.twilio.com/v1/Configuration/Addresses
Type
type: enum<string>RequiredType of Address. Value can be whatsapp
or sms
.
sms
whatsapp
messenger
gbm
email
Address
type: stringRequiredThe unique address to be configured. The address can be a whatsapp address or phone number
FriendlyName
type: stringThe human-readable name of this configuration, limited to 256 characters. Optional.
AutoCreation.Enabled
type: booleanEnable/Disable auto-creating conversations for messages to this address
AutoCreation.Type
type: enum<string>Type of Auto Creation. Value can be one of webhook
, studio
or default
. default
creates a new Conversation under the default Conversation service, without a webhook or Studio integration.
webhook
studio
default
AutoCreation.ConversationServiceSid
type: SID<IS>Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
^IS[0-9a-fA-F]{32}$
34
34
AutoCreation.WebhookMethod
type: enum<string>For type webhook
, the HTTP method to be used when sending a webhook request.
GET
POST
AutoCreation.WebhookFilters
type: array[string]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
AutoCreation.StudioFlowSid
type: SID<FW>For type studio
, the studio flow SID where the webhook should be sent to.
^FW[0-9a-fA-F]{32}$
34
34
AutoCreation.StudioRetryCount
type: integerFor type studio
, number of times to retry the webhook request
AddressCountry
type: stringAn ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.
GET https://conversations.twilio.com/v1/Configuration/Addresses/{Sid}
Sid
type: stringThe SID of the Address Configuration resource. This value can be either the sid
or the address
of the configuration
GET https://conversations.twilio.com/v1/Configuration/Addresses
Type
type: stringFilter the address configurations by its type. This value can be one of: whatsapp
, sms
.
PageSize
type: integerHow many resources to return in each list page. The default is 50, and the maximum is 1000.
1
Page
type: integerThe page index. This value is simply for client state.
0
POST https://conversations.twilio.com/v1/Configuration/Addresses/{Sid}
Sid
type: stringThe SID of the Address Configuration resource. This value can be either the sid
or the address
of the configuration
FriendlyName
type: stringThe human-readable name of this configuration, limited to 256 characters. Optional.
AutoCreation.Enabled
type: booleanEnable/Disable auto-creating conversations for messages to this address
AutoCreation.Type
type: enum<string>Type of Auto Creation. Value can be one of webhook
, studio
or default
.
webhook
studio
default
AutoCreation.ConversationServiceSid
type: SID<IS>Conversation Service for the auto-created conversation. If not set, the conversation is created in the default service.
^IS[0-9a-fA-F]{32}$
34
34
AutoCreation.WebhookMethod
type: enum<string>For type webhook
, the HTTP method to be used when sending a webhook request.
GET
POST
AutoCreation.WebhookFilters
type: array[string]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
AutoCreation.StudioFlowSid
type: SID<FW>For type studio
, the studio flow SID where the webhook should be sent to.
^FW[0-9a-fA-F]{32}$
34
34
AutoCreation.StudioRetryCount
type: integerFor type studio
, number of times to retry the webhook request
DELETE https://conversations.twilio.com/v1/Configuration/Addresses/{Sid}
Sid
type: stringThe SID of the Address Configuration resource. This value can be either the sid
or the address
of the configuration