github.com/twilio/twilio-go@v1.20.1/rest/messaging/v1/model_messaging_v1_us_app_to_person.go (about)

     1  /*
     2   * This code was generated by
     3   * ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
     4   *  |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
     5   *  |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
     6   *
     7   * Twilio - Messaging
     8   * This is the public Twilio REST API.
     9   *
    10   * NOTE: This class is auto generated by OpenAPI Generator.
    11   * https://openapi-generator.tech
    12   * Do not edit the class manually.
    13   */
    14  
    15  package openapi
    16  
    17  import (
    18  	"time"
    19  )
    20  
    21  // MessagingV1UsAppToPerson struct for MessagingV1UsAppToPerson
    22  type MessagingV1UsAppToPerson struct {
    23  	// The unique string that identifies a US A2P Compliance resource `QE2c6890da8086d771620e9b13fadeba0b`.
    24  	Sid *string `json:"sid,omitempty"`
    25  	// The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Campaign belongs to.
    26  	AccountSid *string `json:"account_sid,omitempty"`
    27  	// The unique string to identify the A2P brand.
    28  	BrandRegistrationSid *string `json:"brand_registration_sid,omitempty"`
    29  	// The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with.
    30  	MessagingServiceSid *string `json:"messaging_service_sid,omitempty"`
    31  	// A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.
    32  	Description *string `json:"description,omitempty"`
    33  	// An array of sample message strings, min two and max five. Min length for each sample: 20 chars. Max length for each sample: 1024 chars.
    34  	MessageSamples *[]string `json:"message_samples,omitempty"`
    35  	// A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING, SOLE_PROPRIETOR...]. SOLE_PROPRIETOR campaign use cases can only be created by SOLE_PROPRIETOR Brands, and there can only be one SOLE_PROPRIETOR campaign created per SOLE_PROPRIETOR Brand.
    36  	UsAppToPersonUsecase *string `json:"us_app_to_person_usecase,omitempty"`
    37  	// Indicate that this SMS campaign will send messages that contain links.
    38  	HasEmbeddedLinks *bool `json:"has_embedded_links,omitempty"`
    39  	// Indicates that this SMS campaign will send messages that contain phone numbers.
    40  	HasEmbeddedPhone *bool `json:"has_embedded_phone,omitempty"`
    41  	// A boolean that specifies whether campaign has Subscriber Optin or not.
    42  	SubscriberOptIn *bool `json:"subscriber_opt_in,omitempty"`
    43  	// A boolean that specifies whether campaign is age gated or not.
    44  	AgeGated *bool `json:"age_gated,omitempty"`
    45  	// A boolean that specifies whether campaign allows direct lending or not.
    46  	DirectLending *bool `json:"direct_lending,omitempty"`
    47  	// Campaign status. Examples: IN_PROGRESS, VERIFIED, FAILED.
    48  	CampaignStatus *string `json:"campaign_status,omitempty"`
    49  	// The Campaign Registry (TCR) Campaign ID.
    50  	CampaignId *string `json:"campaign_id,omitempty"`
    51  	// Indicates whether the campaign was registered externally or not.
    52  	IsExternallyRegistered *bool `json:"is_externally_registered,omitempty"`
    53  	// Rate limit and/or classification set by each carrier, Ex. AT&T or T-Mobile.
    54  	RateLimits *interface{} `json:"rate_limits,omitempty"`
    55  	// Details around how a consumer opts-in to their campaign, therefore giving consent to receive their messages. If multiple opt-in methods can be used for the same campaign, they must all be listed. 40 character minimum. 2048 character maximum.
    56  	MessageFlow *string `json:"message_flow,omitempty"`
    57  	// If end users can text in a keyword to start receiving messages from this campaign, the auto-reply messages sent to the end users must be provided. The opt-in response should include the Brand name, confirmation of opt-in enrollment to a recurring message campaign, how to get help, and clear description of how to opt-out. This field is required if end users can text in a keyword to start receiving messages from this campaign. 20 character minimum. 320 character maximum.
    58  	OptInMessage *string `json:"opt_in_message,omitempty"`
    59  	// Upon receiving the opt-out keywords from the end users, Twilio customers are expected to send back an auto-generated response, which must provide acknowledgment of the opt-out request and confirmation that no further messages will be sent. It is also recommended that these opt-out messages include the brand name. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum.
    60  	OptOutMessage *string `json:"opt_out_message,omitempty"`
    61  	// When customers receive the help keywords from their end users, Twilio customers are expected to send back an auto-generated response; this may include the brand name and additional support contact information. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). 20 character minimum. 320 character maximum.
    62  	HelpMessage *string `json:"help_message,omitempty"`
    63  	// If end users can text in a keyword to start receiving messages from this campaign, those keywords must be provided. This field is required if end users can text in a keyword to start receiving messages from this campaign. Values must be alphanumeric. 255 character maximum.
    64  	OptInKeywords *[]string `json:"opt_in_keywords,omitempty"`
    65  	// End users should be able to text in a keyword to stop receiving messages from this campaign. Those keywords must be provided. This field is required if managing opt out keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum.
    66  	OptOutKeywords *[]string `json:"opt_out_keywords,omitempty"`
    67  	// End users should be able to text in a keyword to receive help. Those keywords must be provided as part of the campaign registration request. This field is required if managing help keywords yourself (i.e. not using Twilio's Default or Advanced Opt Out features). Values must be alphanumeric. 255 character maximum.
    68  	HelpKeywords *[]string `json:"help_keywords,omitempty"`
    69  	// The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    70  	DateCreated *time.Time `json:"date_created,omitempty"`
    71  	// The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
    72  	DateUpdated *time.Time `json:"date_updated,omitempty"`
    73  	// The absolute URL of the US App to Person resource.
    74  	Url *string `json:"url,omitempty"`
    75  	// 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.
    76  	Mock *bool `json:"mock,omitempty"`
    77  	// Details indicating why a campaign registration failed. These errors can indicate one or more fields that were incorrect or did not meet review requirements.
    78  	Errors *[]interface{} `json:"errors,omitempty"`
    79  }