Path parameters

• MessagingServiceSid string Required

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

  Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MG[0-9a-fA-F]{32}$.

Query parameters

• PageSize integer(int64)

  How many resources to return in each list page. The default is 50, and the maximum is 1000.

  Minimum value is 1, maximum value is 1000.

• Page integer

  The page index. This value is simply for client state.

  Minimum value is 0.

• PageToken string

  The page token. This is provided by the API.

Responses

• 200 application/json

  OK

  Hide headers attributes Show headers attributes

  • Access-Control-Allow-Origin string

    Specify the origin(s) allowed to access the resource

  • Access-Control-Allow-Methods string

    Specify the HTTP methods allowed when accessing the resource

  • Access-Control-Allow-Headers string

    Specify the headers allowed when accessing the resource

  • Access-Control-Allow-Credentials boolean

    Indicates whether the browser should include credentials

  • Access-Control-Expose-Headers string

    Headers exposed to the client

  Hide response attributes Show response attributes object

  • compliance array[object]
    Hide compliance attributes Show compliance attributes object

    • sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^QE[0-9a-fA-F]{32}$.

    • account_sid string | null

      The SID of the Account that the Campaign belongs to.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^AC[0-9a-fA-F]{32}$.

    • brand_registration_sid string | null

      The unique string to identify the A2P brand.

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^BN[0-9a-fA-F]{32}$.

    • messaging_service_sid string | null

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

      Minimum length is 34, maximum length is 34. Format should match the following pattern: ^MG[0-9a-fA-F]{32}$.

    • description string | null

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

    • message_samples array[string] | null

      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.

    • us_app_to_person_usecase string | null

      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.

    • has_embedded_links boolean | null

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

    • has_embedded_phone boolean | null

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

    • subscriber_opt_in boolean | null

      A boolean that specifies whether campaign has Subscriber Optin or not.

    • age_gated boolean | null

      A boolean that specifies whether campaign is age gated or not.

    • direct_lending boolean | null

      A boolean that specifies whether campaign allows direct lending or not.

    • campaign_status string | null

      Campaign status. Examples: IN_PROGRESS, VERIFIED, FAILED.

    • campaign_id string | null

      The Campaign Registry (TCR) Campaign ID.

    • is_externally_registered boolean | null

      Indicates whether the campaign was registered externally or not.

    • rate_limits object | null

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

    • message_flow string | null

      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.

    • opt_in_message string | null

      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.

    • opt_out_message string | null

      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.

    • help_message string | null

      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.

    • opt_in_keywords array[string] | null

      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.

    • opt_out_keywords array[string] | null

      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.

    • help_keywords array[string] | null

      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.

    • date_created string(date-time) | null

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

    • date_updated string(date-time) | null

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

    • url string(uri) | null

      The absolute URL of the US App to Person resource.

    • mock boolean | null

      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.

    • errors array | null

      Details indicating why a campaign registration failed. These errors can indicate one or more fields that were incorrect or did not meet review requirements.

  • meta object
    Hide meta attributes Show meta attributes object

    • first_page_url string(uri)
    • key string
    • next_page_url string(uri) | null
    • page integer
    • page_size integer
    • previous_page_url string(uri) | null
    • url string(uri)