メニュー

Expand
ページを評価:

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

このリソースを一意に識別する 34 文字の文字列です。

account_sid
sid<AC> Not PII

The unique ID of the Account the address belongs to

type
文字列 Not PII

Type of Address, value can be whatsapp or sms.

address
文字列 PII MTL: 30 DAYS

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

friendly_name
文字列 Not PII

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

auto_creation
オブジェクト Not PII

Auto Creation configuration for the address.

date_created
date_time<iso8601> Not PII

このリソースの作成された日付です。

date_updated
date_time<iso8601> Not PII

このリソースが最後に更新された日付です。

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 in REST API format
type
必須
post ienum:type Not PII

Type of Address. Value can be whatsapp or sms.

address
必須
post 文字列 PII MTL: 30 DAYS

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

friendly_name
オプション
post 文字列 Not PII

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

auto_creation.enabled
オプション
post boolean Not PII

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

auto_creation.type
オプション
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
オプション
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
オプション
post 文字列 Not PII

For type webhook, the url for the webhook request.

auto_creation.webhook_method
オプション
post ienum:method Not PII

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

auto_creation.webhook_filters
オプション
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
オプション
post sid<FW> Not PII

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

auto_creation.studio_retry_count
オプション
post integer Not PII

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

例 1
        
        
        

        Fetch an AddressConfiguration resource

        GET
        https://conversations.twilio.com/v1/Configuration/Addresses/{Sid}
        パラメーター
        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

        例 1
              
              
              

              Read multiple AddressConfiguration resources

              GET
              https://conversations.twilio.com/v1/Configuration/Addresses
              パラメーター
              Parameters in REST API format
              type
              オプション
              GET 文字列 Not PII

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

              例 1
                    
                    
                    

                    Update an AddressConfiguration resource

                    post
                    https://conversations.twilio.com/v1/Configuration/Addresses/{Sid}
                    パラメーター
                    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
                    オプション
                    post 文字列 Not PII

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

                    auto_creation.enabled
                    オプション
                    post boolean Not PII

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

                    auto_creation.type
                    オプション
                    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
                    オプション
                    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
                    オプション
                    post 文字列 Not PII

                    For type webhook, the url for the webhook request.

                    auto_creation.webhook_method
                    オプション
                    post ienum:method Not PII

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

                    auto_creation.webhook_filters
                    オプション
                    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
                    オプション
                    post sid<FW> Not PII

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

                    auto_creation.studio_retry_count
                    オプション
                    post integer Not PII

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

                    例 1
                          
                          
                          

                          Delete an AddressConfiguration resource

                          削除する
                          https://conversations.twilio.com/v1/Configuration/Addresses/{Sid}
                          パラメーター
                          Parameters in REST API format
                          sid
                          Path
                          削除する 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

                          例 1
                                
                                
                                

                                ページを評価:

                                ヘルプが必要ですか?

                                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.

                                      
                                      
                                      

                                      フィードバックくださりありがとうございます!

                                      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!

                                      Refer us and get $10 in 3 simple steps!

                                      ステップ1

                                      Get link

                                      Get a free personal referral link here

                                      ステップ2:

                                      Give $10

                                      Your user signs up and upgrade using link

                                      ステップ3

                                      Get $10

                                      1,250 free SMSes
                                      OR 1,000 free voice mins
                                      OR 12,000 chats
                                      OR more