TWtwilio
ConversationsV1AddressConfiguration

Create a new address configuration

Changed on

Create a new address configuration

post/v1/Configuration/Addresses

Request

  • Base URL
    https://conversations.twilio.com
  • URL
    https://conversations.twilio.com/v1/Configuration/Addresses
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

Type'sms' | 'whatsapp' | 'messenger' | 'gbm' | 'email' | 'rcs' | 'apple' | 'chat' required

Type of Address, value can be whatsapp or sms.

Addressstring required

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

FriendlyNamestring

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

AutoCreation.Enabledboolean

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

AutoCreation.Type'webhook' | 'studio' | 'default'
AutoCreation.ConversationServiceSidstring

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

AutoCreation.WebhookUrlstring

For type webhook, the url for the webhook request.

AutoCreation.WebhookMethod'get' | 'post'
AutoCreation.WebhookFiltersstring[]

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.StudioFlowSidstring

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

AutoCreation.StudioRetryCountinteger

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

AddressCountrystring

An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.

Response

Created

sidstring nullable

A 34 character string that uniquely identifies this resource.

account_sidstring nullable

The unique ID of the Account the address belongs to

typestring nullable

Type of Address, value can be whatsapp or sms.

addressstring nullable

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

friendly_namestring nullable

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

auto_creationunknown
date_createdstring date-time nullable

The date that this resource was created.

date_updatedstring date-time nullable

The date that this resource was last updated.

urlstring uri nullable

An absolute API resource URL for this address configuration.

address_countrystring nullable

An ISO 3166-1 alpha-2n country code which the address belongs to. This is currently only applicable to short code addresses.

Changes

  • v192d1169c37c2Revision changes
    • breaking

      removed the enum value GET of the request property

    • breaking

      removed the enum value POST of the request property

    • breaking

      the response's property type changed from object to no type for status

    • info

      added the new get enum value to the request property

    • info

      added the new post enum value to the request property

  • v1b4d0e634cd69Revision changes
    • breaking

      the response's property type changed from no type to object for status

    • info

      added the new chat enum value to the request property