メニュー

Expand
ページを評価:

US App to Person Campaign Resource

This resource is related to United States A2P 10DLC registration. For more information on A2P 10DLC registration, please see our support article What is A2P 10DLC?

The US App to Person (A2P) Campaign Resource allows you to create a US A2P Campaign Use Case for a Messaging Service.

You can think of an A2P campaign use case as a use case for your brand that will show the intent of the messages you send with your Messaging Service. Some example A2P campaign use cases are:

  • Marketing messages
  • 通知
  • Verification messages

With this REST API you can:

This resource is part of the A2P 10DLC registration process. For Independent Software Vendors (ISVs), please see the ISV A2P 10DLC API registration guide for a step-by-step walkthrough on registering your customers for A2P 10DLC.

US App to Person Campaign Resource Properties

Resource Properties in REST API format
sid
sid<QE> Not PII

The unique string that identifies a US A2P Compliance resource QE2c6890da8086d771620e9b13fadeba0b.

account_sid
sid<AC> Not PII

The SID of the Account that the Campaign belongs to.

brand_registration_sid
sid<BN> Not PII

The unique string to identify the A2P brand.

messaging_service_sid
sid<MG> Not PII

The SID of the Messaging Service that the resource is associated with.

description
文字列 Not PII

A short description of what this SMS campaign does. Max length: 4096 characters.

message_samples
string[] Not PII

Message samples, at least 2 and up to 5 sample messages, <=1024 chars each.

us_app_to_person_usecase
文字列 Not PII

A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING, STARTER...]. STARTER campaign use cases can only be created by STARTER Brands, and there can only be one STARTER campaign created per STARTER Brand.

has_embedded_links
boolean Not PII

Indicate that this SMS campaign will send messages that contain links.

has_embedded_phone
boolean Not PII

Indicates that this SMS campaign will send messages that contain phone numbers.

campaign_status
文字列 Not PII

Campaign status. Examples: IN_PROGRESS, VERIFIED, FAILED.

campaign_id
文字列 Not PII

The Campaign Registry (TCR) Campaign ID.

is_externally_registered
boolean Not PII

Indicates whether the campaign was registered externally or not.

rate_limits
オブジェクト Not PII

Rate limit and/or classification set by each carrier, Ex. AT&T or T-Mobile.

date_created
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

url
url Not PII

The absolute URL of the US App to Person resource.

mock
boolean Not PII

A boolean that specifies whether campaign is a mock or not. Mock campaigns will be automatically created if using a mock brand. Mock campaigns should only be used for testing purposes.

Create a US A2P Campaign Use Case

post
https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/Compliance/Usa2p
パラメーター
Parameters in REST API format
messaging_service_sid
Path
post sid<MG> Not PII

The SID of the Messaging Service to create the resources from.

brand_registration_sid
必須
post sid<BN> Not PII

A2P Brand Registration SID

description
必須
post 文字列 Not PII

A short description of what this SMS campaign does.

message_samples
必須
post string[] Not PII

Message samples, at least 2 and up to 5 sample messages, <=1024 chars each.

us_app_to_person_usecase
必須
post 文字列 Not PII

A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING..]

has_embedded_links
必須
post boolean Not PII

Indicates that this SMS campaign will send messages that contain links.

has_embedded_phone
必須
post boolean Not PII

Indicates that this SMS campaign will send messages that contain phone numbers.

例 1
        
        
        

        Fetch a US A2P Campaign Use Case

        GET
        https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}

        Example 1: The value of Sid will always be the US A2P Compliance resource identifier: QE2c6890da8086d771620e9b13fadeba0b.

        パラメーター
        Parameters in REST API format
        messaging_service_sid
        Path
        GET sid<MG> Not PII

        The SID of the Messaging Service to fetch the resource from.

        sid
        Path
        GET sid<QE> Not PII

        The SID of the US A2P Compliance resource to fetch QE2c6890da8086d771620e9b13fadeba0b.

        例 1
              
              
              

              Fetch a list of possible US A2P Campaign Use Cases

              To fetch a list of possible US A2P campaign use cases for a Messaging Service, provide the BrandRegistrationSID (BNXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX) as shown in Example 2.

              If you haven not yet created a brand, please see one of the following US A2P ISV API guides on how to do so:

              For more information on possible campaign use cases for Messaging Services, head over to the US App to Person Messaging Service Use Case Resource.

              例 2
                    
                    
                    

                    Read a List of US A2P Campaign Use Cases

                    GET
                    https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/Compliance/Usa2p
                    パラメーター
                    Parameters in REST API format
                    messaging_service_sid
                    Path
                    GET sid<MG> Not PII

                    The SID of the Messaging Service to fetch the resource from.

                    例 1
                          
                          
                          

                          Delete a US A2P Campaign Use Case

                          削除する
                          https://messaging.twilio.com/v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}

                          Note: The value of Sid will always be the US A2P Compliance resource identifier: QE2c6890da8086d771620e9b13fadeba0b.

                          パラメーター
                          Parameters in REST API format
                          messaging_service_sid
                          Path
                          削除する sid<MG> Not PII

                          The SID of the Messaging Service to delete the resource from.

                          sid
                          Path
                          削除する sid<QE> Not PII

                          The SID of the US A2P Compliance resource to delete QE2c6890da8086d771620e9b13fadeba0b.

                          例 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 Community Forums or browsing the Twilio tag on Stack Overflow.

                                      
                                      
                                      

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

                                      We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

                                      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