components: securitySchemes: accountSid_authToken: scheme: basic type: http schemas: messaging.v1.service.alpha_sender: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^AI[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the AlphaSender resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AlphaSender resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource is associated with. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. alpha_sender: type: string nullable: true description: The Alphanumeric Sender ID string. capabilities: type: array items: type: string nullable: true description: 'An array of values that describe whether the number can receive calls or messages. Can be: `SMS`.' url: type: string format: uri nullable: true description: The absolute URL of the AlphaSender resource. messaging.v1.brand_registrations.brand_registration_otp: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Brand Registration resource. brand_registration_sid: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ nullable: true description: The unique string to identify Brand Registration of Sole Proprietor Brand messaging.v1.brand_registrations: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ nullable: true description: The unique string to identify Brand Registration. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Brand Registration resource. customer_profile_bundle_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: A2P Messaging Profile Bundle BundleSid. a2p_profile_bundle_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: A2P Messaging Profile Bundle BundleSid. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. brand_type: type: string nullable: true description: 'Type of brand. One of: "STANDARD", "SOLE_PROPRIETOR". SOLE_PROPRIETOR is for the low volume, SOLE_PROPRIETOR campaign use case. There can only be one SOLE_PROPRIETOR campaign created per SOLE_PROPRIETOR brand. STANDARD is for all other campaign use cases. Multiple campaign use cases can be created per STANDARD brand.' status: $ref: '#/components/schemas/brand_registrations_enum_status' tcr_id: type: string nullable: true description: Campaign Registry (TCR) Brand ID. Assigned only after successful brand registration. failure_reason: type: string nullable: true description: DEPRECATED. A reason why brand registration has failed. Only applicable when status is FAILED. errors: type: array items: type: object nullable: true description: A list of errors that occurred during the brand registration process. url: type: string format: uri nullable: true description: The absolute URL of the Brand Registration resource. brand_score: type: integer nullable: true description: The secondary vetting score if it was done. Otherwise, it will be the brand score if it's returned from TCR. It may be null if no score is available. brand_feedback: type: array items: $ref: '#/components/schemas/brand_registrations_enum_brand_feedback' nullable: true description: DEPRECATED. Feedback on how to improve brand score identity_status: $ref: '#/components/schemas/brand_registrations_enum_identity_status' russell_3000: type: boolean nullable: true description: Publicly traded company identified in the Russell 3000 Index government_entity: type: boolean nullable: true description: Identified as a government entity tax_exempt_status: type: string nullable: true description: Nonprofit organization tax-exempt status per section 501 of the U.S. tax code. skip_automatic_sec_vet: type: boolean nullable: true description: A flag to disable automatic secondary vetting for brands which it would otherwise be done. mock: type: boolean nullable: true description: A boolean that specifies whether brand should be a mock or not. If true, brand will be registered as a mock brand. Defaults to false if no value is provided. links: type: object format: uri-map nullable: true brand_registrations_enum_status: type: string enum: - PENDING - APPROVED - FAILED - IN_REVIEW - DELETION_PENDING - DELETION_FAILED - SUSPENDED description: Brand Registration status. One of "PENDING", "APPROVED", "FAILED", "IN_REVIEW", "DELETION_PENDING", "DELETION_FAILED", "SUSPENDED". brand_registrations_enum_identity_status: type: string enum: - SELF_DECLARED - UNVERIFIED - VERIFIED - VETTED_VERIFIED description: When a brand is registered, TCR will attempt to verify the identity of the brand based on the supplied information. brand_registrations_enum_brand_feedback: type: string enum: - TAX_ID - STOCK_SYMBOL - NONPROFIT - GOVERNMENT_ENTITY - OTHERS description: DEPRECATED. Feedback on how to improve brand score messaging.v1.brand_registrations.brand_vetting: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the vetting record. brand_sid: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ nullable: true description: The unique string to identify Brand Registration. brand_vetting_sid: type: string minLength: 34 maxLength: 34 pattern: ^VT[0-9a-fA-F]{32}$ nullable: true description: The Twilio SID of the third-party vetting record. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. vetting_id: type: string nullable: true description: The unique identifier of the vetting from the third-party provider. vetting_class: type: string nullable: true description: "The type of vetting that has been conducted. One of \u201C\ STANDARD\u201D (Aegis) or \u201CPOLITICAL\u201D (Campaign Verify)." vetting_status: type: string nullable: true description: "The status of the import vetting attempt. One of \u201CPENDING,\u201D\ \ \u201CSUCCESS,\u201D or \u201CFAILED\u201D." vetting_provider: $ref: '#/components/schemas/brand_vetting_enum_vetting_provider' url: type: string format: uri nullable: true description: The absolute URL of the Brand Vetting resource. brand_vetting_enum_vetting_provider: type: string enum: - campaign-verify - aegis description: "The third-party provider that has conducted the vetting. One of\ \ \u201CCampaignVerify\u201D (Campaign Verify tokens) or \u201CAEGIS\u201D\ \ (Secondary Vetting)." messaging.v1.service.channel_sender: type: object properties: account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ChannelSender resource. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/messaging/services) the resource is associated with. sid: type: string minLength: 34 maxLength: 34 pattern: ^XE[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the ChannelSender resource. sender: type: string nullable: true description: The unique string that identifies the sender e.g whatsapp:+123456XXXX. sender_type: type: string nullable: true description: A string value that identifies the sender type e.g WhatsApp, Messenger. country_code: type: string nullable: true description: The 2-character [ISO Country Code](https://www.iso.org/iso-3166-country-codes.html) of the number. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the ChannelSender resource. messaging.v1.deactivation: type: object properties: redirect_to: type: string format: uri nullable: true description: Returns an authenticated url that redirects to a file containing the deactivated numbers for the requested day. This url is valid for up to two minutes. messaging.v1.service.destination_alpha_sender: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^AI[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the AlphaSender resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AlphaSender resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource is associated with. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. alpha_sender: type: string nullable: true description: The Alphanumeric Sender ID string. capabilities: type: array items: type: string nullable: true description: 'An array of values that describe whether the number can receive calls or messages. Can be: `SMS`.' url: type: string format: uri nullable: true description: The absolute URL of the AlphaSender resource. iso_country_code: type: string nullable: true description: The Two Character ISO Country Code the Alphanumeric Sender ID will be used for. For Default Alpha Senders that work across countries, this value will be an empty string messaging.v1.domain_cert_v4: type: object properties: domain_sid: type: string minLength: 34 maxLength: 34 pattern: ^DN[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Domain resource. date_updated: type: string format: date-time nullable: true description: Date that this Domain was last updated. date_expires: type: string format: date-time nullable: true description: Date that the private certificate associated with this domain expires. You will need to update the certificate before that date to ensure your shortened links will continue to work. date_created: type: string format: date-time nullable: true description: Date that this Domain was registered to the Twilio platform to create a new Domain object. domain_name: type: string format: uri nullable: true description: Full url path for this domain. certificate_sid: type: string minLength: 34 maxLength: 34 pattern: ^CW[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify this Certificate resource. url: type: string format: uri nullable: true cert_in_validation: type: object nullable: true description: Optional JSON field describing the status and upload date of a new certificate in the process of validation messaging.v1.domain_config: type: object properties: domain_sid: type: string minLength: 34 maxLength: 34 pattern: ^DN[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Domain resource. config_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZK[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Domain config (prefix ZK). fallback_url: type: string format: uri nullable: true description: Any requests we receive to this domain that do not match an existing shortened message will be redirected to the fallback url. These will likely be either expired messages, random misdirected traffic, or intentional scraping. callback_url: type: string format: uri nullable: true description: URL to receive click events to your webhook whenever the recipients click on the shortened links. continue_on_failure: type: boolean nullable: true description: Boolean field to set customer delivery preference when there is a failure in linkShortening service date_created: type: string format: date-time nullable: true description: Date this Domain Config was created. date_updated: type: string format: date-time nullable: true description: Date that this Domain Config was last updated. url: type: string format: uri nullable: true disable_https: type: boolean nullable: true description: Customer's choice to send links with/without "https://" attached to shortened url. If true, messages will not be sent with https:// at the beginning of the url. If false, messages will be sent with https:// at the beginning of the url. False is the default behavior if it is not specified. messaging.v1.domain_config_messaging_service: type: object properties: domain_sid: type: string minLength: 34 maxLength: 34 pattern: ^DN[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Domain resource. config_sid: type: string minLength: 34 maxLength: 34 pattern: ^ZK[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Domain config (prefix ZK). messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the messaging service fallback_url: type: string format: uri nullable: true description: Any requests we receive to this domain that do not match an existing shortened message will be redirected to the fallback url. These will likely be either expired messages, random misdirected traffic, or intentional scraping. callback_url: type: string format: uri nullable: true description: URL to receive click events to your webhook whenever the recipients click on the shortened links. continue_on_failure: type: boolean nullable: true description: Boolean field to set customer delivery preference when there is a failure in linkShortening service date_created: type: string format: date-time nullable: true description: Date this Domain Config was created. date_updated: type: string format: date-time nullable: true description: Date that this Domain Config was last updated. url: type: string format: uri nullable: true messaging.v1.external_campaign: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^QE[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies a US A2P Compliance resource `QE2c6890da8086d771620e9b13fadeba0b`. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Campaign belongs to. campaign_id: type: string nullable: true description: ID of the preregistered campaign. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. messaging.v1.linkshortening_messaging_service: type: object properties: domain_sid: type: string minLength: 34 maxLength: 34 pattern: ^DN[0-9a-fA-F]{32}$ nullable: true description: The unique string identifies the domain resource messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the messaging service url: type: string format: uri nullable: true messaging.v1.linkshortening_messaging_service_domain_association: type: object properties: domain_sid: type: string minLength: 34 maxLength: 34 pattern: ^DN[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Domain resource. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies the messaging service url: type: string format: uri nullable: true messaging.v1.service.phone_number: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the PhoneNumber resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the PhoneNumber resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource is associated with. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. phone_number: type: string format: phone-number nullable: true description: The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. country_code: type: string nullable: true description: The 2-character [ISO Country Code](https://www.iso.org/iso-3166-country-codes.html) of the number. capabilities: type: array items: type: string nullable: true description: 'An array of values that describe whether the number can receive calls or messages. Can be: `Voice`, `SMS`, and `MMS`.' url: type: string format: uri nullable: true description: The absolute URL of the PhoneNumber resource. messaging.v1.request_managed_cert: type: object properties: domain_sid: type: string minLength: 34 maxLength: 34 pattern: ^DN[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Domain resource. date_updated: type: string format: date-time nullable: true description: Date that this Domain was last updated. date_created: type: string format: date-time nullable: true description: Date that this Domain was registered to the Twilio platform to create a new Domain object. date_expires: type: string format: date-time nullable: true description: Date that the private certificate associated with this domain expires. This is the expiration date of your existing cert. domain_name: type: string format: uri nullable: true description: Full url path for this domain. certificate_sid: type: string minLength: 34 maxLength: 34 pattern: ^CW[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify this Certificate resource. url: type: string format: uri nullable: true managed: type: boolean nullable: true description: A boolean flag indicating if the certificate is managed by Twilio. requesting: type: boolean nullable: true description: A boolean flag indicating if a managed certificate needs to be fulfilled by Twilio. messaging.v1.service: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the Service resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Service resource. friendly_name: type: string nullable: true description: The string that you assigned to describe the resource. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. inbound_request_url: type: string format: uri nullable: true description: The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service. inbound_method: type: string format: http-method enum: - GET - POST nullable: true description: The HTTP method we use to call `inbound_request_url`. Can be `GET` or `POST`. fallback_url: type: string format: uri nullable: true description: The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service. fallback_method: type: string format: http-method enum: - GET - POST nullable: true description: 'The HTTP method we use to call `fallback_url`. Can be: `GET` or `POST`.' status_callback: type: string format: uri nullable: true description: The URL we call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery. sticky_sender: type: boolean nullable: true description: Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance. mms_converter: type: boolean nullable: true description: Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance. smart_encoding: type: boolean nullable: true description: Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance. scan_message_content: $ref: '#/components/schemas/service_enum_scan_message_content' fallback_to_long_code: type: boolean nullable: true description: '[OBSOLETE] Former feature used to fallback to long code sender after certain short code message failures.' area_code_geomatch: type: boolean nullable: true description: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance. synchronous_validation: type: boolean nullable: true description: Reserved. validity_period: type: integer default: 0 description: How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `36,000`. Default value is `36,000`. url: type: string format: uri nullable: true description: The absolute URL of the Service resource. links: type: object format: uri-map nullable: true description: The absolute URLs of related resources. usecase: type: string nullable: true description: A string that describes the scenario in which the Messaging Service will be used. Possible values are `notifications`, `marketing`, `verification`, `discussion`, `poll`, `undeclared`. us_app_to_person_registered: type: boolean nullable: true description: Whether US A2P campaign is registered for this Service. use_inbound_webhook_on_number: type: boolean nullable: true description: A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service. service_enum_scan_message_content: type: string enum: - inherit - enable - disable description: Reserved. messaging.v1.service.short_code: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^SC[0-9a-fA-F]{32}$ nullable: true description: The unique string that we created to identify the ShortCode resource. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ShortCode resource. service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) the resource is associated with. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. short_code: type: string nullable: true description: The [E.164](https://www.twilio.com/docs/glossary/what-e164) format of the short code. country_code: type: string nullable: true description: The 2-character [ISO Country Code](https://www.iso.org/iso-3166-country-codes.html) of the number. capabilities: type: array items: type: string nullable: true description: 'An array of values that describe whether the number can receive calls or messages. Can be: `SMS` and `MMS`.' url: type: string format: uri nullable: true description: The absolute URL of the ShortCode resource. messaging.v1.tollfree_verification: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^HH[0-9a-fA-F]{32}$ nullable: true description: The unique string to identify Tollfree Verification. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Tollfree Verification resource. customer_profile_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: Customer's Profile Bundle BundleSid. trust_product_sid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ nullable: true description: Tollfree TrustProduct Bundle BundleSid. date_created: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. regulated_item_sid: type: string minLength: 34 maxLength: 34 pattern: ^RA[0-9a-fA-F]{32}$ nullable: true description: The SID of the Regulated Item. business_name: type: string nullable: true description: The name of the business or organization using the Tollfree number. business_street_address: type: string nullable: true description: The address of the business or organization using the Tollfree number. business_street_address2: type: string nullable: true description: The address of the business or organization using the Tollfree number. business_city: type: string nullable: true description: The city of the business or organization using the Tollfree number. business_state_province_region: type: string nullable: true description: The state/province/region of the business or organization using the Tollfree number. business_postal_code: type: string nullable: true description: The postal code of the business or organization using the Tollfree number. business_country: type: string nullable: true description: The country of the business or organization using the Tollfree number. business_website: type: string nullable: true description: The website of the business or organization using the Tollfree number. business_contact_first_name: type: string nullable: true description: The first name of the contact for the business or organization using the Tollfree number. business_contact_last_name: type: string nullable: true description: The last name of the contact for the business or organization using the Tollfree number. business_contact_email: type: string nullable: true description: The email address of the contact for the business or organization using the Tollfree number. business_contact_phone: type: string format: phone-number nullable: true description: The E.164 formatted phone number of the contact for the business or organization using the Tollfree number. notification_email: type: string nullable: true description: The email address to receive the notification about the verification result. . use_case_categories: type: array items: type: string nullable: true description: The category of the use case for the Tollfree Number. List as many are applicable.. use_case_summary: type: string nullable: true description: Use this to further explain how messaging is used by the business or organization. production_message_sample: type: string nullable: true description: An example of message content, i.e. a sample message. opt_in_image_urls: type: array items: type: string nullable: true description: Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL. opt_in_type: $ref: '#/components/schemas/tollfree_verification_enum_opt_in_type' message_volume: type: string nullable: true description: Estimate monthly volume of messages from the Tollfree Number. additional_information: type: string nullable: true description: Additional information to be provided for verification. tollfree_phone_number_sid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ nullable: true description: The SID of the Phone Number associated with the Tollfree Verification. status: $ref: '#/components/schemas/tollfree_verification_enum_status' url: type: string format: uri nullable: true description: The absolute URL of the Tollfree Verification resource. rejection_reason: type: string nullable: true description: The rejection reason given when a Tollfree Verification has been rejected. error_code: type: integer nullable: true description: The error code given when a Tollfree Verification has been rejected. edit_expiration: type: string format: date-time nullable: true description: The date and time when the ability to edit a rejected verification expires. edit_allowed: type: boolean nullable: true description: If a rejected verification is allowed to be edited/resubmitted. Some rejection reasons allow editing and some do not. rejection_reasons: type: array items: type: object nullable: true description: A list of rejection reasons and codes describing why a Tollfree Verification has been rejected. resource_links: type: object nullable: true description: The URLs of the documents associated with the Tollfree Verification resource. external_reference_id: type: string nullable: true description: An optional external reference ID supplied by customer and echoed back on status retrieval. tollfree_verification_enum_status: type: string enum: - PENDING_REVIEW - IN_REVIEW - TWILIO_APPROVED - TWILIO_REJECTED description: The compliance status of the Tollfree Verification record. tollfree_verification_enum_opt_in_type: type: string enum: - VERBAL - WEB_FORM - PAPER_FORM - VIA_TEXT - MOBILE_QR_CODE - IMPORT - IMPORT_PLEASE_REPLACE description: Describe how a user opts-in to text messages. messaging.v1.service.us_app_to_person: type: object properties: sid: type: string minLength: 34 maxLength: 34 pattern: ^QE[0-9a-fA-F]{32}$ nullable: true description: The unique string that identifies a US A2P Compliance resource `QE2c6890da8086d771620e9b13fadeba0b`. account_sid: type: string minLength: 34 maxLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that the Campaign belongs to. brand_registration_sid: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ nullable: true description: The unique string to identify the A2P brand. messaging_service_sid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ nullable: true description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with. description: type: string nullable: true description: 'A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.' message_samples: type: array items: type: string nullable: true description: '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: type: string nullable: true description: '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: type: boolean nullable: true description: Indicate that this SMS campaign will send messages that contain links. has_embedded_phone: type: boolean nullable: true description: Indicates that this SMS campaign will send messages that contain phone numbers. subscriber_opt_in: type: boolean nullable: true description: A boolean that specifies whether campaign has Subscriber Optin or not. age_gated: type: boolean nullable: true description: A boolean that specifies whether campaign is age gated or not. direct_lending: type: boolean nullable: true description: A boolean that specifies whether campaign allows direct lending or not. campaign_status: type: string nullable: true description: 'Campaign status. Examples: IN_PROGRESS, VERIFIED, FAILED.' campaign_id: type: string nullable: true description: The Campaign Registry (TCR) Campaign ID. is_externally_registered: type: boolean nullable: true description: Indicates whether the campaign was registered externally or not. rate_limits: type: object nullable: true description: Rate limit and/or classification set by each carrier, Ex. AT&T or T-Mobile. message_flow: type: string nullable: true description: 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: type: string nullable: true description: 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: type: string nullable: true description: 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: type: string nullable: true description: 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: type: array items: type: string nullable: true description: 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: type: array items: type: string nullable: true description: 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: type: array items: type: string nullable: true description: 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: type: string format: date-time nullable: true description: The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. date_updated: type: string format: date-time nullable: true description: The date and time in GMT when the resource was last updated specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format. url: type: string format: uri nullable: true description: The absolute URL of the US App to Person resource. mock: type: boolean nullable: true description: 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: type: array items: type: object nullable: true description: Details indicating why a campaign registration failed. These errors can indicate one or more fields that were incorrect or did not meet review requirements. messaging.v1.service.us_app_to_person_usecase: type: object properties: us_app_to_person_usecases: type: array items: type: object nullable: true description: Human readable name, code, description and post_approval_required (indicates whether or not post approval is required for this Use Case) of A2P Campaign Use Cases. messaging.v1.usecase: type: object properties: usecases: type: array items: type: object nullable: true description: Human readable use case details (usecase, description and purpose) of Messaging Service Use Cases. whatsapp_sender_enum_status: type: string enum: - Configuring - PendingVerification - Configured - ConfigurationError - VerificationError description: 'The status of the sender. Configuring: We are in the process of registering the sender. If your sender stays in this state for a long period of time it is possible that there is an issue with parameters you provided; PendingVerification: We have successfully registered the sender with WhatsApp and you should receive a code from their services; Configured: The sender has been successfully verified with WhatsApp and is all set to start sending messages; ConfigurationError - If configuration fails due to below possibilities: parameters provided were incorrect, Twilio account suspended or deleted, whatsapp api failed, Twilio internal error. VerificationError - If verification api fails, please check error_message for more details' whatsapp_template_enum_category: type: string enum: - ACCOUNT_UPDATE - ALERT_UPDATE - AUTO_REPLY - APPOINTMENT_UPDATE - ISSUE_RESOLUTION - PAYMENT_UPDATE - PERSONAL_FINANCE_UPDATE - RESERVATION_UPDATE - SHIPPING_UPDATE - TICKET_UPDATE - TRANSPORTATION_UPDATE - MARKETING - OTP - TRANSACTIONAL - AUTHENTICATION - UTILITY description: The Category of this WhatsApp Template. One of `ACCOUNT_UPDATE`, `ALERT_UPDATE`, `APPOINTMENT_UPDATE`, `AUTO_REPLY`, `ISSUE_RESOLUTION`, `PAYMENT_UPDATE`, `PERSONAL_FINANCE_UPDATE`, `RESERVATION_UPDATE`, `SHIPPING_UPDATE`, `TICKET_UPDATE`, `TRANSPORTATION_UPDATE`, `MARKETING`, `AUTHENTICATION`, `UTILITY`, `OTP` or `TRANSACTIONAL`. info: title: Twilio - Messaging description: This is the public Twilio REST API. termsOfService: https://www.twilio.com/legal/tos contact: name: Twilio Support url: https://support.twilio.com email: support@twilio.com license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html version: 1.0.0 openapi: 3.0.1 paths: /v1/Services/{ServiceSid}/AlphaSenders: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add, fetch or remove an Alpha Sender ID from a Messaging Service. x-twilio: defaultOutputProperties: - sid - alpha_sender parent: /Services/{Sid} pathType: list post: description: '' summary: '' tags: - MessagingV1AlphaSender parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.alpha_sender' examples: create: value: sid: AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' alpha_sender: Twilio capabilities: - SMS url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders/AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateAlphaSender requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateAlphaSenderRequest properties: AlphaSender: type: string description: The Alphanumeric Sender ID string. Can be up to 11 characters long. Valid characters are A-Z, a-z, 0-9, space, hyphen `-`, plus `+`, underscore `_` and ampersand `&`. This value cannot contain only numbers. required: - AlphaSender examples: create: value: AlphaSender: Twilio get: description: '' summary: '' tags: - MessagingV1AlphaSender parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: alpha_senders: type: array items: $ref: '#/components/schemas/messaging.v1.service.alpha_sender' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListAlphaSenderResponse examples: readFull: value: meta: page: 0 page_size: 20 first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders?PageSize=20&Page=0 previous_page_url: null next_page_url: null key: alpha_senders url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders?PageSize=20&Page=0 alpha_senders: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' alpha_sender: Twilio capabilities: - SMS url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders/AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListAlphaSender /v1/Services/{ServiceSid}/AlphaSenders/{Sid}: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add, fetch or remove an Alpha Sender ID from a Messaging Service. x-twilio: defaultOutputProperties: - sid - alpha_sender parent: /Services/{Sid} pathType: instance get: description: '' summary: '' tags: - MessagingV1AlphaSender parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the AlphaSender resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.alpha_sender' examples: fetch: value: sid: AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' alpha_sender: Twilio capabilities: - SMS url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders/AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchAlphaSender delete: description: '' summary: '' tags: - MessagingV1AlphaSender parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the AlphaSender resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteAlphaSender /v1/a2p/BrandRegistrations/{BrandRegistrationSid}/SmsOtp: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to retry OTP verification for Sole Proprietor Brand Registrations. x-twilio: defaultOutputProperties: - account_sid - brand_registration_sid parent: /a2p/BrandRegistrations/{Sid} mountName: brand_registration_otps pathType: list post: description: '' summary: '' tags: - MessagingV1BrandRegistrationOtp parameters: - name: BrandRegistrationSid in: path description: Brand Registration Sid of Sole Proprietor Brand. schema: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations.brand_registration_otp' examples: create: value: account_sid: AC78e8e67fc0246521490fb9907fd0c165 brand_registration_sid: BN0044409f7e067e279523808d267e2d85 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateBrandRegistrationOtp /v1/a2p/BrandRegistrations/{Sid}: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add and fetch Brand Registrations. x-twilio: defaultOutputProperties: - sid - date_created dependentProperties: brand_vettings: mapping: brand_sid: sid resource_url: /v1/a2p/BrandRegistrations/{brand_sid}/Vettings brand_registration_otps: mapping: brand_registration_sid: sid resource_url: /v1/a2p/BrandRegistrations/{brand_registration_sid}/SmsOtp pathType: instance get: description: '' summary: '' tags: - MessagingV1BrandRegistration parameters: - name: Sid in: path description: The SID of the Brand Registration resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations' examples: fetch: value: sid: BN0044409f7e067e279523808d267e2d85 account_sid: AC78e8e67fc0246521490fb9907fd0c165 customer_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 a2p_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 date_created: '2021-01-27T14:18:35Z' date_updated: '2021-01-27T14:18:36Z' brand_type: STANDARD status: PENDING tcr_id: BXXXXXX failure_reason: Registration error url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85 brand_score: 42 brand_feedback: - TAX_ID - NONPROFIT identity_status: VERIFIED russell_3000: true government_entity: false tax_exempt_status: 501c3 skip_automatic_sec_vet: false mock: false errors: [] links: brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp fetchSoleProprietorPending: value: sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa a2p_profile_bundle_sid: BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb customer_profile_bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: PENDING identity_status: null brand_type: SOLE_PROPRIETOR mock: false tcr_id: null brand_score: null russell_3000: null brand_feedback: null failure_reason: null government_entity: null tax_exempt_status: null skip_automatic_sec_vet: false errors: [] date_updated: '2023-03-15T14:21:42Z' date_created: '2023-03-15T14:21:42Z' url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp fetchSoleProprietorRegisteredUnverified: value: sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa a2p_profile_bundle_sid: BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb customer_profile_bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: APPROVED identity_status: UNVERIFIED brand_type: SOLE_PROPRIETOR mock: false tcr_id: null brand_score: null russell_3000: null brand_feedback: null failure_reason: null government_entity: null tax_exempt_status: null skip_automatic_sec_vet: false errors: [] date_updated: '2023-03-15T14:21:42Z' date_created: '2023-03-15T14:21:42Z' url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp fetchSoleProprietorRegisteredSelfDeclared: value: sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa a2p_profile_bundle_sid: BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb customer_profile_bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: APPROVED identity_status: SELF_DECLARED brand_type: SOLE_PROPRIETOR mock: false tcr_id: null brand_score: null russell_3000: null brand_feedback: null failure_reason: null government_entity: null tax_exempt_status: null skip_automatic_sec_vet: false errors: [] date_updated: '2023-03-15T14:21:42Z' date_created: '2023-03-15T14:21:42Z' url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp fetchSoleProprietorRegisteredVerified: value: sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa a2p_profile_bundle_sid: BUbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb customer_profile_bundle_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: APPROVED identity_status: VERIFIED brand_type: SOLE_PROPRIETOR mock: false tcr_id: null brand_score: null russell_3000: null brand_feedback: null failure_reason: null government_entity: null tax_exempt_status: null skip_automatic_sec_vet: false errors: [] date_updated: '2023-03-15T14:21:42Z' date_created: '2023-03-15T14:21:42Z' url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchBrandRegistrations post: description: '' summary: '' tags: - MessagingV1BrandRegistration parameters: - name: Sid in: path description: The SID of the Brand Registration resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ required: true responses: '202': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations' examples: update: value: sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa customer_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 a2p_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 date_created: '2021-01-27T14:18:35Z' date_updated: '2021-01-27T14:18:36Z' brand_type: STANDARD status: PENDING tcr_id: BXXXXXX failure_reason: Registration error url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa brand_score: 42 brand_feedback: - TAX_ID - NONPROFIT identity_status: VERIFIED russell_3000: false government_entity: false tax_exempt_status: 501c3 skip_automatic_sec_vet: false errors: [] mock: false links: brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp updateSoleProprietorBrand: value: sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa customer_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 a2p_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 date_created: '2021-01-27T14:18:35Z' date_updated: '2021-01-27T14:18:36Z' brand_type: SOLE_PROPRIETOR status: PENDING tcr_id: BXXXXXX failure_reason: null brand_score: null brand_feedback: null identity_status: UNVERIFIED russell_3000: false government_entity: false tax_exempt_status: null skip_automatic_sec_vet: false errors: [] mock: false url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa links: brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Vettings brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/SmsOtp headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Accepted security: - accountSid_authToken: [] operationId: UpdateBrandRegistrations /v1/a2p/BrandRegistrations: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add and fetch Brand Registrations. x-twilio: defaultOutputProperties: - sid - date_created dependentProperties: brand_vettings: mapping: brand_sid: sid resource_url: /v1/a2p/BrandRegistrations/{brand_sid}/Vettings brand_registration_otps: mapping: brand_registration_sid: sid resource_url: /v1/a2p/BrandRegistrations/{brand_registration_sid}/SmsOtp pathType: list get: description: '' summary: '' tags: - MessagingV1BrandRegistration parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/messaging.v1.brand_registrations' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListBrandRegistrationsResponse examples: read: value: meta: page: 0 page_size: 50 first_page_url: https://messaging.twilio.com/v1/a2p/BrandRegistrations?PageSize=50&Page=0 previous_page_url: null next_page_url: null key: data url: https://messaging.twilio.com/v1/a2p/BrandRegistrations?PageSize=50&Page=0 data: - sid: BN0044409f7e067e279523808d267e2d85 account_sid: AC78e8e67fc0246521490fb9907fd0c165 customer_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 a2p_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 date_created: '2021-01-27T14:18:35Z' date_updated: '2021-01-27T14:18:36Z' brand_type: STANDARD status: APPROVED tcr_id: BXXXXXX failure_reason: Registration error url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85 brand_score: 42 brand_feedback: - TAX_ID - NONPROFIT identity_status: VERIFIED russell_3000: true tax_exempt_status: 501c3 government_entity: false skip_automatic_sec_vet: false errors: [] mock: false links: brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp readFailed: value: meta: page: 0 page_size: 50 first_page_url: https://messaging.twilio.com/v1/a2p/BrandRegistrations?PageSize=50&Page=0 previous_page_url: null next_page_url: null key: data url: https://messaging.twilio.com/v1/a2p/BrandRegistrations?PageSize=50&Page=0 data: - sid: BN0044409f7e067e279523808d267e2d85 account_sid: AC78e8e67fc0246521490fb9907fd0c165 customer_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 a2p_profile_bundle_sid: BU3344409f7e067e279523808d267e2d85 date_created: '2021-01-27T14:18:35Z' date_updated: '2021-01-27T14:18:36Z' brand_type: STANDARD status: APPROVED tcr_id: BXXXXXX failure_reason: Registration error url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85 brand_score: 42 brand_feedback: - TAX_ID - NONPROFIT identity_status: VERIFIED russell_3000: true tax_exempt_status: 501c3 government_entity: false skip_automatic_sec_vet: false errors: - url: https://www.twilio.com/docs/api/errors/30701 error_code: 30701 description: Invalid State/Region/Province. please check the input field value [Max length 20, For The United States, please use 2 character codes. E.g. 'CA' for California] and retry. fields: - region mock: false links: brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListBrandRegistrations post: description: '' summary: '' tags: - MessagingV1BrandRegistration responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations' examples: create: value: sid: BN0044409f7e067e279523808d267e2d85 account_sid: AC78e8e67fc0246521490fb9907fd0c165 customer_profile_bundle_sid: BU0000009f7e067e279523808d267e2d90 a2p_profile_bundle_sid: BU1111109f7e067e279523808d267e2d85 date_created: '2021-01-28T10:45:51Z' date_updated: '2021-01-28T10:45:51Z' brand_type: STANDARD status: PENDING tcr_id: BXXXXXX failure_reason: Registration error url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85 brand_score: 42 brand_feedback: - TAX_ID - NONPROFIT identity_status: VERIFIED russell_3000: true government_entity: false tax_exempt_status: 501c3 skip_automatic_sec_vet: false errors: [] mock: false links: brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp createSoleProprietorBrand: value: sid: BN0044409f7e067e279523808d267e2d85 account_sid: AC78e8e67fc0246521490fb9907fd0c165 customer_profile_bundle_sid: BU0000009f7e067e279523808d267e2d90 a2p_profile_bundle_sid: BU1111109f7e067e279523808d267e2d85 date_created: '2021-01-28T10:45:51Z' date_updated: '2021-01-28T10:45:51Z' brand_type: SOLE_PROPRIETOR status: PENDING tcr_id: BXXXXXX failure_reason: null brand_score: null brand_feedback: null identity_status: UNVERIFIED russell_3000: false government_entity: false tax_exempt_status: null skip_automatic_sec_vet: false errors: [] mock: false url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85 links: brand_vettings: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings brand_registration_otps: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/SmsOtp headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateBrandRegistrations requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateBrandRegistrationsRequest properties: CustomerProfileBundleSid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ description: Customer Profile Bundle Sid. A2PProfileBundleSid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ description: A2P Messaging Profile Bundle Sid. BrandType: type: string description: 'Type of brand being created. One of: "STANDARD", "SOLE_PROPRIETOR". SOLE_PROPRIETOR is for low volume, SOLE_PROPRIETOR use cases. STANDARD is for all other use cases.' Mock: type: boolean description: A boolean that specifies whether brand should be a mock or not. If true, brand will be registered as a mock brand. Defaults to false if no value is provided. SkipAutomaticSecVet: type: boolean description: A flag to disable automatic secondary vetting for brands which it would otherwise be done. required: - CustomerProfileBundleSid - A2PProfileBundleSid examples: create: value: CustomerProfileBundleSid: BU0000009f7e067e279523808d267e2d90 A2PProfileBundleSid: BU1111109f7e067e279523808d267e2d85 BrandType: STANDARD SkipAutomaticSecVet: false Mock: false createSoleProprietorBrand: value: CustomerProfileBundleSid: BU0000009f7e067e279523808d267e2d90 A2PProfileBundleSid: BU1111109f7e067e279523808d267e2d85 BrandType: STANDARD SkipAutomaticSecVet: false Mock: false /v1/a2p/BrandRegistrations/{BrandSid}/Vettings: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add and get Brand Vettings. x-twilio: defaultOutputProperties: - account_sid - brand_sid - brand_vetting_sid - date_created - date_updated - vetting_status - vetting_class parent: /a2p/BrandRegistrations/{Sid} mountName: brand_vettings pathType: list post: description: '' summary: '' tags: - MessagingV1BrandVetting parameters: - name: BrandSid in: path description: The SID of the Brand Registration resource of the vettings to create . schema: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations.brand_vetting' examples: create: value: account_sid: AC78e8e67fc0246521490fb9907fd0c165 brand_sid: BN0044409f7e067e279523808d267e2d85 brand_vetting_sid: VT12445353 vetting_provider: campaign-verify vetting_id: cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY vetting_class: POLITICAL vetting_status: IN_PROGRESS date_created: '2021-01-27T14:18:35Z' date_updated: '2021-01-27T14:18:35Z' url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created '202': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations.brand_vetting' examples: create202Response: value: account_sid: AC78e8e67fc0246521490fb9907fd0c165 brand_sid: BN0044409f7e067e279523808d267e2d85 brand_vetting_sid: VT12445353 vetting_provider: campaign-verify vetting_id: cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY vetting_class: POLITICAL vetting_status: IN_PROGRESS date_created: '2021-01-27T14:18:35Z' date_updated: '2021-01-27T14:18:35Z' url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Accepted security: - accountSid_authToken: [] operationId: CreateBrandVetting requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateBrandVettingRequest properties: VettingProvider: $ref: '#/components/schemas/brand_vetting_enum_vetting_provider' VettingId: type: string description: The unique ID of the vetting required: - VettingProvider examples: create: value: VettingProvider: campaign-verify VettingId: cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY create202Response: value: VettingProvider: campaign-verify VettingId: cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY get: description: '' summary: '' tags: - MessagingV1BrandVetting parameters: - name: BrandSid in: path description: The SID of the Brand Registration resource of the vettings to read . schema: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ required: true - name: VettingProvider in: query description: The third-party provider of the vettings to read schema: $ref: '#/components/schemas/brand_vetting_enum_vetting_provider' responses: '200': content: application/json: schema: type: object properties: data: type: array items: $ref: '#/components/schemas/messaging.v1.brand_registrations.brand_vetting' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListBrandVettingResponse examples: read: value: meta: page: 0 page_size: 50 first_page_url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings previous_page_url: null next_page_url: null key: data url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings data: - account_sid: AC78e8e67fc0246521490fb9907fd0c165 brand_sid: BN0044409f7e067e279523808d267e2d85 brand_vetting_sid: VT12445353 vetting_provider: campaign-verify vetting_id: cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY vetting_class: POLITICAL vetting_status: IN_PROGRESS date_created: '2021-01-27T14:18:35Z' date_updated: '2021-01-27T14:18:35Z' url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListBrandVetting /v1/a2p/BrandRegistrations/{BrandSid}/Vettings/{BrandVettingSid}: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add and get Brand Vettings. x-twilio: defaultOutputProperties: - account_sid - brand_sid - brand_vetting_sid - date_created - date_updated - vetting_status - vetting_class parent: /a2p/BrandRegistrations/{Sid} mountName: brand_vettings pathType: instance get: description: '' summary: '' tags: - MessagingV1BrandVetting parameters: - name: BrandSid in: path description: The SID of the Brand Registration resource of the vettings to read . schema: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ required: true - name: BrandVettingSid in: path description: The Twilio SID of the third-party vetting record. schema: type: string minLength: 34 maxLength: 34 pattern: ^VT[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.brand_registrations.brand_vetting' examples: fetch: value: account_sid: AC78e8e67fc0246521490fb9907fd0c165 brand_sid: BN0044409f7e067e279523808d267e2d85 brand_vetting_sid: VT12445353 vetting_provider: campaign-verify vetting_id: cv|1.0|tcr|10dlc|9975c339-d46f-49b7-a399-EXAMPLETOKEN|GQ3EXAMPLETOKENAXXBUNBT2AgL-LdQuPveFhEyY vetting_class: POLITICAL vetting_status: IN_PROGRESS date_created: '2021-01-27T14:18:35Z' date_updated: '2021-01-27T14:18:35Z' url: https://messaging.twilio.com/v1/a2p/BrandRegistrations/BN0044409f7e067e279523808d267e2d85/Vettings/VT12445353 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchBrandVetting /v1/Services/{MessagingServiceSid}/ChannelSenders: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to read, fetch all Channel Senders associated with a Messaging Service. x-twilio: defaultOutputProperties: - sid - sender - sender_type parent: /Services/{Sid} pathType: list get: description: '' summary: '' tags: - MessagingV1ChannelSender parameters: - name: MessagingServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: senders: type: array items: $ref: '#/components/schemas/messaging.v1.service.channel_sender' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListChannelSenderResponse examples: readFull: value: meta: page: 0 page_size: 20 first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders?PageSize=20&Page=0 previous_page_url: null next_page_url: null key: senders url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders?PageSize=20&Page=0 senders: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sender: whatsapp:+12487960483 sender_type: WhatsApp country_code: US date_created: '2023-07-30T20:12:31Z' date_updated: '2023-07-30T20:12:33Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab sender: messenger:104794531907950 sender_type: Messenger country_code: US date_created: '2023-07-30T20:12:31Z' date_updated: '2023-07-30T20:12:33Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac sender: rcs:ms_dev_ttatqler_agent sender_type: RCS country_code: US date_created: '2023-07-30T20:12:31Z' date_updated: '2023-07-30T20:12:33Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListChannelSender post: description: '' summary: '' tags: - MessagingV1ChannelSender parameters: - name: MessagingServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.channel_sender' examples: createwhatsappsender: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sender: whatsapp:+12487960483 sender_type: WhatsApp country_code: US date_created: '2023-07-30T20:12:31Z' date_updated: '2023-07-30T20:12:33Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createfbsender: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab sender: messenger:104794531907950 sender_type: Messanger country_code: US date_created: '2023-07-30T20:12:31Z' date_updated: '2023-07-30T20:12:33Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab creatercssender: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac sender: rcs:ms_dev_test_agent sender_type: RCS country_code: US date_created: '2023-07-30T20:12:31Z' date_updated: '2023-07-30T20:12:33Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateChannelSender requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateChannelSenderRequest properties: Sid: type: string minLength: 34 maxLength: 34 pattern: ^XE[0-9a-fA-F]{32}$ description: The SID of the Channel Sender being added to the Service. required: - Sid examples: createwhatsappsender: value: Sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createfbsender: value: Sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab creatercssender: value: Sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac /v1/Services/{MessagingServiceSid}/ChannelSenders/{Sid}: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to read, fetch all Channel Senders associated with a Messaging Service. x-twilio: defaultOutputProperties: - sid - sender - sender_type parent: /Services/{Sid} pathType: instance get: description: '' summary: '' tags: - MessagingV1ChannelSender parameters: - name: MessagingServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the ChannelSender resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.channel_sender' examples: fetchwhatsappsender: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sender: whatsapp:+12487960483 sender_type: WhatsApp country_code: US date_created: '2023-07-30T20:12:31Z' date_updated: '2023-07-30T20:12:33Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fetchfbsender: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab sender: messenger:104794531907950 sender_type: Messenger country_code: US date_created: '2023-07-30T20:12:31Z' date_updated: '2023-07-30T20:12:33Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaab fetchrcssender: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac sender: rcs:ms_dev_test_agent sender_type: RCS country_code: US date_created: '2023-07-30T20:12:31Z' date_updated: '2023-07-30T20:12:33Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders/XEaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaac headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchChannelSender delete: description: '' summary: '' tags: - MessagingV1ChannelSender parameters: - name: MessagingServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the Channel Sender resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteChannelSender /v1/Deactivations: servers: - url: https://messaging.twilio.com description: A Deactivation resource to retrieve a list of United States phone numbers that have been deactivated by mobile carriers on a specific date. x-twilio: defaultOutputProperties: - redirect_to className: deactivations pathType: instance get: description: Fetch a list of all United States numbers that have been deactivated on a specific date. summary: Fetch a list of all United States numbers that have been deactivated on a specific date. tags: - MessagingV1Deactivations parameters: - name: Date in: query description: The request will return a list of all United States Phone Numbers that were deactivated on the day specified by this parameter. This date should be specified in YYYY-MM-DD format. schema: type: string format: date responses: '307': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.deactivation' examples: fetch: value: redirect_to: https://com-twilio-dev-messaging-deactivations.s3.amazonaws.com headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Temporary Redirect security: - accountSid_authToken: [] operationId: FetchDeactivation /v1/Services/{ServiceSid}/DestinationAlphaSenders: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add, fetch or remove Destination and Default Alpha Sender IDs from a Messaging Service. Destination Alpha Sender can send to a particular ISO country code. Default Alpha Senders can send to all countries. x-twilio: defaultOutputProperties: - sid - alpha_sender parent: /Services/{Sid} pathType: list post: description: '' summary: '' tags: - MessagingV1DestinationAlphaSender parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.destination_alpha_sender' examples: create: value: sid: AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' alpha_sender: Twilio capabilities: - SMS iso_country_code: FR url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DestinationAlphaSenders/AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateDestinationAlphaSender requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateDestinationAlphaSenderRequest properties: AlphaSender: type: string description: The Alphanumeric Sender ID string. Can be up to 11 characters long. Valid characters are A-Z, a-z, 0-9, space, hyphen `-`, plus `+`, underscore `_` and ampersand `&`. This value cannot contain only numbers. IsoCountryCode: type: string description: The Optional Two Character ISO Country Code the Alphanumeric Sender ID will be used for. If the IsoCountryCode is not provided, a default Alpha Sender will be created that can be used across all countries. required: - AlphaSender examples: create: value: AlphaSender: Twilio IsoCountryCode: FR get: description: '' summary: '' tags: - MessagingV1DestinationAlphaSender parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: IsoCountryCode in: query description: Optional filter to return only alphanumeric sender IDs associated with the specified two-character ISO country code. schema: type: string - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: alpha_senders: type: array items: $ref: '#/components/schemas/messaging.v1.service.destination_alpha_sender' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListDestinationAlphaSenderResponse examples: readFull: value: meta: page: 0 page_size: 20 first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DestinationAlphaSenders?PageSize=20&Page=0 previous_page_url: null next_page_url: null key: alpha_senders url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DestinationAlphaSenders?PageSize=20&Page=0 alpha_senders: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' alpha_sender: Twilio capabilities: - SMS iso_country_code: FR url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DestinationAlphaSenders/AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListDestinationAlphaSender /v1/Services/{ServiceSid}/DestinationAlphaSenders/{Sid}: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add, fetch or remove Destination and Default Alpha Sender IDs from a Messaging Service. Destination Alpha Sender can send to a particular ISO country code. Default Alpha Senders can send to all countries. x-twilio: defaultOutputProperties: - sid - alpha_sender parent: /Services/{Sid} pathType: instance get: description: '' summary: '' tags: - MessagingV1DestinationAlphaSender parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the AlphaSender resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.destination_alpha_sender' examples: fetch: value: sid: AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' alpha_sender: Twilio capabilities: - SMS iso_country_code: FR url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DestinationAlphaSenders/AIaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchDestinationAlphaSender delete: description: '' summary: '' tags: - MessagingV1DestinationAlphaSender parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the AlphaSender resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteDestinationAlphaSender /v1/LinkShortening/Domains/{DomainSid}/Certificate: servers: - url: https://messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - certificate_sid - domain_name - domain_sid - date_expires - date_created - date_updated - url mountName: domain_certs className: domain_certs pathType: instance post: description: '' summary: '' tags: - MessagingV1DomainCerts parameters: - name: DomainSid in: path description: Unique string used to identify the domain that this certificate should be associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^DN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_cert_v4' examples: update: value: certificate_sid: CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa domain_name: https://api.example.com domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_expires: '2021-02-06T18:02:04Z' date_created: '2021-02-06T18:02:04Z' date_updated: '2021-02-06T18:02:04Z' url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificate cert_in_validation: date_expires: '2021-02-06T18:02:04Z' status: pending headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_cert_v4' examples: create: value: certificate_sid: CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa domain_name: https://api.example.com domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_expires: null date_created: '2021-02-06T18:02:04Z' date_updated: '2021-02-06T18:02:04Z' url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificate cert_in_validation: date_expires: '2021-02-06T18:02:04Z' status: pending headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: UpdateDomainCertV4 requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateDomainCertV4Request properties: TlsCert: type: string description: 'Contains the full TLS certificate and private for this domain in PEM format: https://en.wikipedia.org/wiki/Privacy-Enhanced_Mail. Twilio uses this information to process HTTPS traffic sent to your domain.' required: - TlsCert examples: update: value: TlsCert: '-----BEGIN CERTIFICATE-----MIIDcDCCAlgCCQD0iHbJmcUyYDANBgkqhkiG9w0BAQsFADB6MQswCQYDVQQGEwJ1czELMAkGA1UECAwCdXMxCzAJBgNVBAcMAnVzMQswCQYDVQQKDAJ1czELMAkGA1UECwwCdXMxGDAWBgNVBAMMD2FwaS5leGFtcGxlLmNvbTEdMBsGCSqGSIb3DQEJARYOamRqZEBmamZkai5jb20wHhcNMjAwMjA3MTgwMjA0WhcNMjEwMjA2MTgwMjA0WjB6MQswCQYDVQQGEwJ1czELMAkGA1UECAwCdXMxCzAJBgNVBAcMAnVzMQswCQYDVQQKDAJ1czELMAkGA1UECwwCdXMxGDAWBgNVBAMMD2FwaS5leGFtcGxlLmNvbTEdMBsGCSqGSIb3DQEJARYOamRqZEBmamZkai5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCo6AAEeYlR6bFAnxRvx/0BsKfZVhOlB3ua+fQc3yvdDbpQ+zxpKl4bki0HU9q2flRSc52NV6m1XGtSknHSuTlTPj3eRTJpbVpSDfI55zSKsMOgo7JvjdYZXzzPQqhruWXw2exwK1wQjVko3AIW/G2vC4nSPa7C2cxhQe6lYDhJazwFi1/TN0nqKPDuU9DL2BohjX40NzXpJ3yFEHogPTrzHyADIDtXqJzWofzz4zbkNuLAfijmHQnudvDpJoGZzzVOLk8i4eIY8aQECBC+8E2hmlJGhUSONqIYrdy0MD800ervCor0WhAdPe1293fkMER9PjYgtpP2CeSf1umUzwZjAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAHjWBgL4K7BuYF50ocWm5nMk4X0wsLx6+Z4n3cQurFOPBH0lKzUgxp8s/CDDI9Qa5/WTk2C0bvarcQdf0pjX5foNc/WtHmr1wu0w5Ykjhbw/uBDXzdMy2Dnk6hvDJYuXP+0VVw4tykXIE4mBYNG/dk5vptY5OG/YBMMR995pXLn8a0FJNdnznx0ocWpCeLVP6ddzgRYsU0BdO7v9lQRhRnxBYpL52VQ4uNcW77WcirLFpbbbQTDRQcTAE8maVGgO2Q/mG572/OzQ3VryNbuc2/fYJvZuavawIQR1/H9SA6aT5+fruz1e0UuPpIkKDS4emuqIOKIRpB4lIJj97esKhX8=-----END CERTIFICATE----------BEGIN PRIVATE KEY----- MIIEpAIBAAKCAQEAu3589qzU1kyEjPJ8v3p7RGOaESNX4+hDw3Nv6nPNd1ysTVXV 80+v2iTANVlCLK6bpqOVq8VMs+6BAcWrZvfgBwKnad+cqLbrgjSsMLOD5e+zNO7A p1ItO/dpecLbTN4HItbiywAk/HKVZ11/1mh4wPvKtpIUJpBwB2h4j3oGBIjhK3MP k0evPohP+kWIBHT73cK/IkcpSIptDEhzKfwnYbni7N4TrF84ba+ykFJn1N5/mD8R ZT4jFhRKOwVNtfW+b8svlVt2n9O8viaUHO4UaAmkSsGuLd7BbfUUaMCBhVZECDnX G2xmOWAj7DW/NMUFNZiKfsCuBo0l4EBH9V8plQIDAQABAoIBAQChHptIZ1EnLu4h KSgma5yOMoFtBNA8W5YP2Z1s/kKstgijFIYc5neZoEdEEQYa25mKY7z0tUGqxeQ6 n6EhhRURMSiohK5dFYPgil8GIt3PtGJttFX981JH297Z8ab+sTW0rLCL/f3KqrTU 9LYsi+5o+HdE2NdUJH8A/rfLo/KT5Yv5qWgR0F3R6iYBpsq1TAfuYTN0HZPURXUq 3QkWwICdvKEvx/at92Q9a91Rkm+c+31CgmzSJBsNerSZLC3y/KOlVA3fNtq8Bzjh TOw4ReH1Bwze18mt+zOQ0t/2l7uIFGkhqDczqVlJUNKWDZ7s9o7CdOxwfVdUP9ft Btm1ZXeBAoGBAN2SracmzVLHOnQJLlPm2LAy8Y7Yl7VNL7bk9dN/+A7HXjIEUsFR /B6zfoYsVLmYbjhqFpMAzepj5HXdI2FRw30nB9SJguW9D4jPJrS635aD5+UM7sKY /77OKIv5gTRhaHP1gFPMsUQRZZ8RAfL4lXDlOGwKMYT9Hmx+s30runlFAoGBANig SIXbCNKM/vc+Xx9nyqfAHzEw444erVEoW7S/ZoL1z2+47Z+Cu9Il+i1bWKazvOEx 4xN8aGEga0uCBEGB3g7o7LlxoMqexfZiMgWiLTXB1cpOVvV7oT8ZVm8sJXH/PwBG SLR7igcBuOF2888rPf1+slz/HqOSATgufXYCxGwRAoGAF9Tz+puQ0At/vQVTx1B4 FBOWqb+gKa8Ap9Jeon4MJ0LIXebbI9H2pTK3NCVGg6PijwzSGsOmYkSWSRsc+BW8 ShTNoc2cl6tLJXLqfdvvupe7dIZ8k8+zCknQUKXogMLNYlOQlvLYSjL41DAXHpQg NsFg3TYHd39mK1NBaQAwEWUCgYBuJVmazht3S3/c4VbmlhTCJPr3PR+HROvlZzrx 9Zw/HJOEACi6wXOU0ACcDWVPJfb1HjOS1eAQ+rXzp8FYOZtaQ28Sf8c9H2wS8izz FlocilmVSy4GFf2QIucDEhRcGWfEUPho5KPzGhoScjRX82nKuiAhDwtaKkP6eBEM 7y1GsQKBgQDYA+/CsjoDT//pc1AaetuBT0INviCGJKiRDJwvVJgwi/CHZYUZuXbv syI3EUey4OL7in0N4oxCuBMEs+PVz39PRfANFTqQ/j74jazUnmCRHlReJy5A8DvZ 9tUKnGAnoUlrl7oz139om8ZW+DjLBRgr8ao1bC8UC8jX4SpB1IMP0Q== -----END PRIVATE KEY-----' create: value: TlsCert: '-----BEGIN CERTIFICATE-----MIIDcDCCAlgCCQD0iHbJmcUyYDANBgkqhkiG9w0BAQsFADB6MQswCQYDVQQGEwJ1czELMAkGA1UECAwCdXMxCzAJBgNVBAcMAnVzMQswCQYDVQQKDAJ1czELMAkGA1UECwwCdXMxGDAWBgNVBAMMD2FwaS5leGFtcGxlLmNvbTEdMBsGCSqGSIb3DQEJARYOamRqZEBmamZkai5jb20wHhcNMjAwMjA3MTgwMjA0WhcNMjEwMjA2MTgwMjA0WjB6MQswCQYDVQQGEwJ1czELMAkGA1UECAwCdXMxCzAJBgNVBAcMAnVzMQswCQYDVQQKDAJ1czELMAkGA1UECwwCdXMxGDAWBgNVBAMMD2FwaS5leGFtcGxlLmNvbTEdMBsGCSqGSIb3DQEJARYOamRqZEBmamZkai5jb20wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCo6AAEeYlR6bFAnxRvx/0BsKfZVhOlB3ua+fQc3yvdDbpQ+zxpKl4bki0HU9q2flRSc52NV6m1XGtSknHSuTlTPj3eRTJpbVpSDfI55zSKsMOgo7JvjdYZXzzPQqhruWXw2exwK1wQjVko3AIW/G2vC4nSPa7C2cxhQe6lYDhJazwFi1/TN0nqKPDuU9DL2BohjX40NzXpJ3yFEHogPTrzHyADIDtXqJzWofzz4zbkNuLAfijmHQnudvDpJoGZzzVOLk8i4eIY8aQECBC+8E2hmlJGhUSONqIYrdy0MD800ervCor0WhAdPe1293fkMER9PjYgtpP2CeSf1umUzwZjAgMBAAEwDQYJKoZIhvcNAQELBQADggEBAHjWBgL4K7BuYF50ocWm5nMk4X0wsLx6+Z4n3cQurFOPBH0lKzUgxp8s/CDDI9Qa5/WTk2C0bvarcQdf0pjX5foNc/WtHmr1wu0w5Ykjhbw/uBDXzdMy2Dnk6hvDJYuXP+0VVw4tykXIE4mBYNG/dk5vptY5OG/YBMMR995pXLn8a0FJNdnznx0ocWpCeLVP6ddzgRYsU0BdO7v9lQRhRnxBYpL52VQ4uNcW77WcirLFpbbbQTDRQcTAE8maVGgO2Q/mG572/OzQ3VryNbuc2/fYJvZuavawIQR1/H9SA6aT5+fruz1e0UuPpIkKDS4emuqIOKIRpB4lIJj97esKhX8=-----END CERTIFICATE----------BEGIN PRIVATE KEY----- MIIEpAIBAAKCAQEAu3589qzU1kyEjPJ8v3p7RGOaESNX4+hDw3Nv6nPNd1ysTVXV 80+v2iTANVlCLK6bpqOVq8VMs+6BAcWrZvfgBwKnad+cqLbrgjSsMLOD5e+zNO7A p1ItO/dpecLbTN4HItbiywAk/HKVZ11/1mh4wPvKtpIUJpBwB2h4j3oGBIjhK3MP k0evPohP+kWIBHT73cK/IkcpSIptDEhzKfwnYbni7N4TrF84ba+ykFJn1N5/mD8R ZT4jFhRKOwVNtfW+b8svlVt2n9O8viaUHO4UaAmkSsGuLd7BbfUUaMCBhVZECDnX G2xmOWAj7DW/NMUFNZiKfsCuBo0l4EBH9V8plQIDAQABAoIBAQChHptIZ1EnLu4h KSgma5yOMoFtBNA8W5YP2Z1s/kKstgijFIYc5neZoEdEEQYa25mKY7z0tUGqxeQ6 n6EhhRURMSiohK5dFYPgil8GIt3PtGJttFX981JH297Z8ab+sTW0rLCL/f3KqrTU 9LYsi+5o+HdE2NdUJH8A/rfLo/KT5Yv5qWgR0F3R6iYBpsq1TAfuYTN0HZPURXUq 3QkWwICdvKEvx/at92Q9a91Rkm+c+31CgmzSJBsNerSZLC3y/KOlVA3fNtq8Bzjh TOw4ReH1Bwze18mt+zOQ0t/2l7uIFGkhqDczqVlJUNKWDZ7s9o7CdOxwfVdUP9ft Btm1ZXeBAoGBAN2SracmzVLHOnQJLlPm2LAy8Y7Yl7VNL7bk9dN/+A7HXjIEUsFR /B6zfoYsVLmYbjhqFpMAzepj5HXdI2FRw30nB9SJguW9D4jPJrS635aD5+UM7sKY /77OKIv5gTRhaHP1gFPMsUQRZZ8RAfL4lXDlOGwKMYT9Hmx+s30runlFAoGBANig SIXbCNKM/vc+Xx9nyqfAHzEw444erVEoW7S/ZoL1z2+47Z+Cu9Il+i1bWKazvOEx 4xN8aGEga0uCBEGB3g7o7LlxoMqexfZiMgWiLTXB1cpOVvV7oT8ZVm8sJXH/PwBG SLR7igcBuOF2888rPf1+slz/HqOSATgufXYCxGwRAoGAF9Tz+puQ0At/vQVTx1B4 FBOWqb+gKa8Ap9Jeon4MJ0LIXebbI9H2pTK3NCVGg6PijwzSGsOmYkSWSRsc+BW8 ShTNoc2cl6tLJXLqfdvvupe7dIZ8k8+zCknQUKXogMLNYlOQlvLYSjL41DAXHpQg NsFg3TYHd39mK1NBaQAwEWUCgYBuJVmazht3S3/c4VbmlhTCJPr3PR+HROvlZzrx 9Zw/HJOEACi6wXOU0ACcDWVPJfb1HjOS1eAQ+rXzp8FYOZtaQ28Sf8c9H2wS8izz FlocilmVSy4GFf2QIucDEhRcGWfEUPho5KPzGhoScjRX82nKuiAhDwtaKkP6eBEM 7y1GsQKBgQDYA+/CsjoDT//pc1AaetuBT0INviCGJKiRDJwvVJgwi/CHZYUZuXbv syI3EUey4OL7in0N4oxCuBMEs+PVz39PRfANFTqQ/j74jazUnmCRHlReJy5A8DvZ 9tUKnGAnoUlrl7oz139om8ZW+DjLBRgr8ao1bC8UC8jX4SpB1IMP0Q== -----END PRIVATE KEY-----' get: description: '' summary: '' tags: - MessagingV1DomainCerts parameters: - name: DomainSid in: path description: Unique string used to identify the domain that this certificate should be associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^DN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_cert_v4' examples: fetch: value: certificate_sid: CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa domain_name: https://api.example.com domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_expires: '2021-02-06T18:02:04Z' date_created: '2021-02-06T18:02:04Z' date_updated: '2021-02-06T18:02:04Z' url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Certificate cert_in_validation: date_expires: '2021-02-06T18:02:04Z' status: pending headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchDomainCertV4 delete: description: '' summary: '' tags: - MessagingV1DomainCerts parameters: - name: DomainSid in: path description: Unique string used to identify the domain that this certificate should be associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^DN[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteDomainCertV4 /v1/LinkShortening/Domains/{DomainSid}/Config: servers: - url: https://messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - config_sid - fallback_url - callback_url - continue_on_failure - date_created - date_updated - url - disable_https mountName: domain_config pathType: instance post: description: '' summary: '' tags: - MessagingV1DomainConfig parameters: - name: DomainSid in: path description: Unique string used to identify the domain that this config should be associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^DN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_config' examples: update: value: domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa config_sid: ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fallback_url: https://www.example.com callback_url: https://www.example.com continue_on_failure: true date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Config disable_https: false headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_config' examples: create: value: domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa config_sid: ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fallback_url: https://www.example.com callback_url: https://www.example.com continue_on_failure: true date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Config disable_https: false headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: UpdateDomainConfig requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateDomainConfigRequest properties: FallbackUrl: type: string format: uri description: Any requests we receive to this domain that do not match an existing shortened message will be redirected to the fallback url. These will likely be either expired messages, random misdirected traffic, or intentional scraping. CallbackUrl: type: string format: uri description: URL to receive click events to your webhook whenever the recipients click on the shortened links ContinueOnFailure: type: boolean description: Boolean field to set customer delivery preference when there is a failure in linkShortening service DisableHttps: type: boolean description: Customer's choice to send links with/without "https://" attached to shortened url. If true, messages will not be sent with https:// at the beginning of the url. If false, messages will be sent with https:// at the beginning of the url. False is the default behavior if it is not specified. examples: update: value: FallbackUrl: https://www.example.com CallbackUrl: https://www.example.com ContinueOnFailure: true DisableHttps: false create: value: FallbackUrl: https://www.example.com CallbackUrl: https://www.example.com DisableHttps: false ContinueOnFailure: true get: description: '' summary: '' tags: - MessagingV1DomainConfig parameters: - name: DomainSid in: path description: Unique string used to identify the domain that this config should be associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^DN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_config' examples: fetch: value: domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa config_sid: ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fallback_url: https://www.example.com callback_url: https://www.example.com continue_on_failure: true date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Config disable_https: false headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchDomainConfig /v1/LinkShortening/MessagingService/{MessagingServiceSid}/DomainConfig: servers: - url: https://messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - domain_sid - config_sid - fallback_url - callback_url - continue_on_failure - date_created - date_updated - url - messaging_service_sid mountName: domain_config_messaging_service pathType: instance get: description: '' summary: '' tags: - MessagingV1DomainConfigMessagingService parameters: - name: MessagingServiceSid in: path description: Unique string used to identify the Messaging service that this domain should be associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.domain_config_messaging_service' examples: fetch: value: domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa config_sid: ZKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa fallback_url: https://www.example.com callback_url: https://www.example.com continue_on_failure: true date_created: '2015-07-30T20:00:00Z' date_updated: '2015-07-30T20:00:00Z' url: https://messaging.twilio.com/v1/LinkShortening/MessagingService/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DomainConfig messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchDomainConfigMessagingService /v1/Services/PreregisteredUsa2p: servers: - url: https://messaging.twilio.com description: Resource to associate preregistered campaign with Messaging Service. x-twilio: defaultOutputProperties: - campaign_id - messaging_service_sid mountName: external_campaign pathType: list post: description: '' summary: '' tags: - MessagingV1ExternalCampaign responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.external_campaign' examples: create: value: sid: QE2c6890da8086d771620e9b13fadeba0b messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa campaign_id: CMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2021-03-21T21:31:00Z' headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateExternalCampaign requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateExternalCampaignRequest properties: CampaignId: type: string description: ID of the preregistered campaign. MessagingServiceSid: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with. CnpMigration: type: boolean description: Customers should use this flag during the ERC registration process to indicate to Twilio that the campaign being registered is undergoing CNP migration. It is important for the user to first trigger the CNP migration process for said campaign in their CSP portal and have Twilio accept the sharing request, before making this api call. required: - CampaignId - MessagingServiceSid examples: create: value: MessagingServiceSid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa CampaignId: CMaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa CnpMigration: false /v1/LinkShortening/Domains/{DomainSid}/MessagingServices/{MessagingServiceSid}: servers: - url: https://messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - messaging_service_sid - domain_sid - url mountName: linkshortening_messaging_service pathType: instance post: description: '' summary: '' tags: - MessagingV1LinkshorteningMessagingService parameters: - name: DomainSid in: path description: The domain SID to associate with a messaging service. With URL shortening enabled, links in messages sent with the associated messaging service will be shortened to the provided domain schema: type: string minLength: 34 maxLength: 34 pattern: ^DN[0-9a-fA-F]{32}$ required: true - name: MessagingServiceSid in: path description: A messaging service SID to associate with a domain. With URL shortening enabled, links in messages sent with the provided messaging service will be shortened to the associated domain schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.linkshortening_messaging_service' examples: create: value: domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/MessagingServices/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateLinkshorteningMessagingService delete: description: '' summary: '' tags: - MessagingV1LinkshorteningMessagingService parameters: - name: DomainSid in: path description: The domain SID to dissociate from a messaging service. With URL shortening enabled, links in messages sent with the associated messaging service will be shortened to the provided domain schema: type: string minLength: 34 maxLength: 34 pattern: ^DN[0-9a-fA-F]{32}$ required: true - name: MessagingServiceSid in: path description: A messaging service SID to dissociate from a domain. With URL shortening enabled, links in messages sent with the provided messaging service will be shortened to the associated domain schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteLinkshorteningMessagingService /v1/LinkShortening/MessagingServices/{MessagingServiceSid}/Domain: servers: - url: https://messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - domain_sid - messaging_service_sid - url mountName: linkshortening_messaging_service_domain_association pathType: instance get: description: '' summary: '' tags: - MessagingV1LinkshorteningMessagingServiceDomainAssociation parameters: - name: MessagingServiceSid in: path description: Unique string used to identify the Messaging service that this domain should be associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.linkshortening_messaging_service_domain_association' examples: fetch: value: domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://messaging.twilio.com/v1/LinkShortening/MessagingServices/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Domain headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchLinkshorteningMessagingServiceDomainAssociation /v1/Services/{ServiceSid}/PhoneNumbers: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add, fetch or remove phone numbers from a Messaging Service. x-twilio: defaultOutputProperties: - sid - phone_number - country_code parent: /Services/{Sid} pathType: list post: description: '' summary: '' tags: - MessagingV1PhoneNumber parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.phone_number' examples: create: value: sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' phone_number: '+987654321' country_code: US capabilities: [] url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createWithCapabilities: value: sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' phone_number: '+987654321' country_code: US capabilities: - MMS - SMS - Voice url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.phone_number' examples: createWithCapabilitiesWhenDownstreamResponse200: value: sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' phone_number: '+987654321' country_code: US capabilities: - MMS - SMS - Voice url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: CreatePhoneNumber requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreatePhoneNumberRequest properties: PhoneNumberSid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ description: The SID of the Phone Number being added to the Service. required: - PhoneNumberSid examples: create: value: PhoneNumberSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createWithCapabilities: value: PhoneNumberSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createWithCapabilitiesWhenDownstreamResponse200: value: PhoneNumberSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' summary: '' tags: - MessagingV1PhoneNumber parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: phone_numbers: type: array items: $ref: '#/components/schemas/messaging.v1.service.phone_number' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListPhoneNumberResponse examples: readFull: value: meta: page: 0 page_size: 20 first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=20&Page=0 previous_page_url: null next_page_url: null key: phone_numbers url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers?PageSize=20&Page=0 phone_numbers: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' phone_number: '+987654321' country_code: US capabilities: [] url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListPhoneNumber /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add, fetch or remove phone numbers from a Messaging Service. x-twilio: defaultOutputProperties: - sid - phone_number - country_code parent: /Services/{Sid} pathType: instance delete: description: '' summary: '' tags: - MessagingV1PhoneNumber parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the PhoneNumber resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeletePhoneNumber get: description: '' summary: '' tags: - MessagingV1PhoneNumber parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the PhoneNumber resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.phone_number' examples: fetch: value: sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' phone_number: '12345' country_code: US capabilities: [] url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers/PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchPhoneNumber /v1/LinkShortening/Domains/{DomainSid}/RequestManagedCert: servers: - url: https://messaging.twilio.com description: '' x-twilio: defaultOutputProperties: - certificate_sid - domain_name - domain_sid - date_created - date_updated - url - managed - requesting pathType: instance post: description: '' summary: '' tags: - MessagingV1RequestManagedCert parameters: - name: DomainSid in: path description: Unique string used to identify the domain that this certificate should be associated with. schema: type: string minLength: 34 maxLength: 34 pattern: ^DN[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.request_managed_cert' examples: update: value: certificate_sid: CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa domain_name: https://api.example.com domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2021-02-06T18:02:04Z' date_updated: '2021-02-06T18:02:04Z' date_expires: '2021-02-06T18:02:04Z' url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RequestManagedCert managed: true requesting: true headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.request_managed_cert' examples: create: value: certificate_sid: CWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa domain_name: https://api.example.com domain_sid: DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2021-02-06T18:02:04Z' date_updated: '2021-02-06T18:02:04Z' date_expires: null url: https://messaging.twilio.com/v1/LinkShortening/Domains/DNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/RequestManagedCert managed: true requesting: true headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: UpdateRequestManagedCert /v1/Services: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to create, fetch, update, delete or add/remove senders from Messaging Services. x-twilio: defaultOutputProperties: - sid - friendly_name - date_created dependentProperties: phone_numbers: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/PhoneNumbers short_codes: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/ShortCodes alpha_senders: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/AlphaSenders messages: mapping: messaging_service_sid: sid resource_url: /v1/Services/{messaging_service_sid}/Messages us_app_to_person: mapping: messaging_service_sid: sid resource_url: /v1/Services/{messaging_service_sid}/Compliance/Usa2p us_app_to_person_usecases: mapping: messaging_service_sid: sid resource_url: /v1/Services/{messaging_service_sid}/Compliance/Usa2p/Usecases channel_senders: mapping: messaging_service_sid: sid resource_url: /v1/Services/{messaging_service_sid}/ChannelSenders destination_alpha_senders: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/DestinationAlphaSenders pathType: list post: description: '' summary: '' tags: - MessagingV1Service responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service' examples: create: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' friendly_name: My Service! inbound_request_url: https://www.example.com/ inbound_method: POST fallback_url: https://www.example.com fallback_method: GET status_callback: https://www.example.com sticky_sender: true smart_encoding: false mms_converter: true fallback_to_long_code: true scan_message_content: inherit area_code_geomatch: true validity_period: 600 synchronous_validation: true usecase: marketing us_app_to_person_registered: false use_inbound_webhook_on_number: true sending_windows: [] links: phone_numbers: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers short_codes: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes alpha_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders messages: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages us_app_to_person: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p us_app_to_person_usecases: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases channel_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders destination_alpha_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DestinationAlphaSenders url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateService requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateServiceRequest properties: FriendlyName: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. InboundRequestUrl: type: string format: uri description: The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service. InboundMethod: type: string format: http-method enum: - GET - POST description: The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`. FallbackUrl: type: string format: uri description: The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service. FallbackMethod: type: string format: http-method enum: - GET - POST description: 'The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.' StatusCallback: type: string format: uri description: The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery. StickySender: type: boolean description: Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance. MmsConverter: type: boolean description: Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance. SmartEncoding: type: boolean description: Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance. ScanMessageContent: $ref: '#/components/schemas/service_enum_scan_message_content' FallbackToLongCode: type: boolean description: '[OBSOLETE] Former feature used to fallback to long code sender after certain short code message failures.' AreaCodeGeomatch: type: boolean description: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance. ValidityPeriod: type: integer description: How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `36,000`. Default value is `36,000`. SynchronousValidation: type: boolean description: Reserved. Usecase: type: string description: A string that describes the scenario in which the Messaging Service will be used. Possible values are `notifications`, `marketing`, `verification`, `discussion`, `poll`, `undeclared`. UseInboundWebhookOnNumber: type: boolean description: A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service. required: - FriendlyName examples: create: value: FriendlyName: My Service! StickySender: true MmsConverter: true SmartEncoding: false FallbackToLongCode: true InboundRequestUrl: https://www.example.com InboundMethod: POST FallbackMethod: GET FallbackUrl: https://www.example.com StatusCallback: https://www.example.com ScanMessageContent: inherit AreaCodeGeomatch: true ValidityPeriod: 600 SynchronousValidation: true Usecase: marketing UseInboundWebhookOnNumber: true get: description: '' summary: '' tags: - MessagingV1Service parameters: - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: services: type: array items: $ref: '#/components/schemas/messaging.v1.service' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListServiceResponse examples: readFull: value: meta: page: 0 page_size: 20 first_page_url: https://messaging.twilio.com/v1/Services?PageSize=20&Page=0 previous_page_url: null next_page_url: null key: services url: https://messaging.twilio.com/v1/Services?PageSize=20&Page=0 services: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: My Service! sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' sticky_sender: true mms_converter: true smart_encoding: false fallback_to_long_code: true area_code_geomatch: true validity_period: 600 scan_message_content: inherit synchronous_validation: true inbound_request_url: https://www.example.com/ inbound_method: POST fallback_url: null fallback_method: POST status_callback: https://www.example.com usecase: marketing us_app_to_person_registered: false use_inbound_webhook_on_number: false sending_windows: - start_time: '10:00' end_time: '21:00' links: phone_numbers: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers short_codes: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes alpha_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders messages: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages us_app_to_person: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p us_app_to_person_usecases: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases channel_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders destination_alpha_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DestinationAlphaSenders url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListService /v1/Services/{Sid}: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to create, fetch, update, delete or add/remove senders from Messaging Services. x-twilio: defaultOutputProperties: - sid - friendly_name - date_created dependentProperties: phone_numbers: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/PhoneNumbers short_codes: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/ShortCodes alpha_senders: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/AlphaSenders messages: mapping: messaging_service_sid: sid resource_url: /v1/Services/{messaging_service_sid}/Messages us_app_to_person: mapping: messaging_service_sid: sid resource_url: /v1/Services/{messaging_service_sid}/Compliance/Usa2p us_app_to_person_usecases: mapping: messaging_service_sid: sid resource_url: /v1/Services/{messaging_service_sid}/Compliance/Usa2p/Usecases channel_senders: mapping: messaging_service_sid: sid resource_url: /v1/Services/{messaging_service_sid}/ChannelSenders destination_alpha_senders: mapping: service_sid: sid resource_url: /v1/Services/{service_sid}/DestinationAlphaSenders pathType: instance post: description: '' summary: '' tags: - MessagingV1Service parameters: - name: Sid in: path description: The SID of the Service resource to update. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service' examples: update: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa friendly_name: My Service! sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' sticky_sender: false mms_converter: true smart_encoding: false fallback_to_long_code: true scan_message_content: inherit synchronous_validation: true area_code_geomatch: true validity_period: 600 inbound_request_url: https://www.example.com inbound_method: POST fallback_url: null fallback_method: POST status_callback: https://www.example.com usecase: marketing us_app_to_person_registered: false use_inbound_webhook_on_number: true sending_windows: [] links: phone_numbers: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers short_codes: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes alpha_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders messages: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages us_app_to_person: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p us_app_to_person_usecases: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases channel_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders destination_alpha_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DestinationAlphaSenders url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateService requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateServiceRequest properties: FriendlyName: type: string description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. InboundRequestUrl: type: string format: uri description: The URL we call using `inbound_method` when a message is received by any phone number or short code in the Service. When this property is `null`, receiving inbound messages is disabled. All messages sent to the Twilio phone number or short code will not be logged and received on the Account. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `inbound_request_url` defined for the Messaging Service. InboundMethod: type: string format: http-method enum: - GET - POST description: The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`. FallbackUrl: type: string format: uri description: The URL that we call using `fallback_method` if an error occurs while retrieving or executing the TwiML from the Inbound Request URL. If the `use_inbound_webhook_on_number` field is enabled then the webhook url defined on the phone number will override the `fallback_url` defined for the Messaging Service. FallbackMethod: type: string format: http-method enum: - GET - POST description: 'The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.' StatusCallback: type: string format: uri description: The URL we should call to [pass status updates](https://www.twilio.com/docs/sms/api/message-resource#message-status-values) about message delivery. StickySender: type: boolean description: Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance. MmsConverter: type: boolean description: Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance. SmartEncoding: type: boolean description: Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance. ScanMessageContent: $ref: '#/components/schemas/service_enum_scan_message_content' FallbackToLongCode: type: boolean description: '[OBSOLETE] Former feature used to fallback to long code sender after certain short code message failures.' AreaCodeGeomatch: type: boolean description: Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance. ValidityPeriod: type: integer description: How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `36,000`. Default value is `36,000`. SynchronousValidation: type: boolean description: Reserved. Usecase: type: string description: A string that describes the scenario in which the Messaging Service will be used. Possible values are `notifications`, `marketing`, `verification`, `discussion`, `poll`, `undeclared`. UseInboundWebhookOnNumber: type: boolean description: A boolean value that indicates either the webhook url configured on the phone number will be used or `inbound_request_url`/`fallback_url` url will be called when a message is received from the phone number. If this field is enabled then the webhook url defined on the phone number will override the `inbound_request_url`/`fallback_url` defined for the Messaging Service. examples: update: value: StickySender: false get: description: '' summary: '' tags: - MessagingV1Service parameters: - name: Sid in: path description: The SID of the Service resource to fetch. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service' examples: fetch: value: account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' friendly_name: My Service! inbound_request_url: https://www.example.com/ inbound_method: POST fallback_url: null fallback_method: POST status_callback: https://www.example.com sticky_sender: true mms_converter: true smart_encoding: false fallback_to_long_code: true area_code_geomatch: true validity_period: 600 scan_message_content: inherit synchronous_validation: true usecase: marketing us_app_to_person_registered: false use_inbound_webhook_on_number: true sending_windows: - start_time: '10:00' end_time: '21:00' links: phone_numbers: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumbers short_codes: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes alpha_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/AlphaSenders messages: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Messages us_app_to_person: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p us_app_to_person_usecases: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/Usecases channel_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelSenders destination_alpha_senders: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/DestinationAlphaSenders url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchService delete: description: '' summary: '' tags: - MessagingV1Service parameters: - name: Sid in: path description: The SID of the Service resource to delete. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteService /v1/Services/{ServiceSid}/ShortCodes: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add, fetch or remove short code numbers from a Messaging Service. x-twilio: defaultOutputProperties: - sid - short_code - country_code parent: /Services/{Sid} pathType: list post: description: '' summary: '' tags: - MessagingV1ShortCode parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.short_code' examples: create: value: sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' short_code: '12345' country_code: US capabilities: - SMS url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.short_code' examples: createwith200Downstreamresponse: value: sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' short_code: '12345' country_code: US capabilities: - SMS url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: CreateShortCode requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateShortCodeRequest properties: ShortCodeSid: type: string minLength: 34 maxLength: 34 pattern: ^SC[0-9a-fA-F]{32}$ description: The SID of the ShortCode resource being added to the Service. required: - ShortCodeSid examples: create: value: ShortCodeSid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa createwith200Downstreamresponse: value: ShortCodeSid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa get: description: '' summary: '' tags: - MessagingV1ShortCode parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: short_codes: type: array items: $ref: '#/components/schemas/messaging.v1.service.short_code' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListShortCodeResponse examples: readFull: value: meta: page: 0 page_size: 20 first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=20&Page=0 previous_page_url: null next_page_url: null key: short_codes url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes?PageSize=20&Page=0 short_codes: - account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' short_code: '12345' country_code: US capabilities: - SMS url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListShortCode /v1/Services/{ServiceSid}/ShortCodes/{Sid}: servers: - url: https://messaging.twilio.com description: A Messaging Service resource to add, fetch or remove short code numbers from a Messaging Service. x-twilio: defaultOutputProperties: - sid - short_code - country_code parent: /Services/{Sid} pathType: instance delete: description: '' summary: '' tags: - MessagingV1ShortCode parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the ShortCode resource to delete. schema: type: string required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteShortCode get: description: '' summary: '' tags: - MessagingV1ShortCode parameters: - name: ServiceSid in: path description: The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the ShortCode resource to fetch. schema: type: string required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.short_code' examples: fetch: value: sid: SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2015-07-30T20:12:31Z' date_updated: '2015-07-30T20:12:33Z' short_code: '12345' country_code: US capabilities: - SMS url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ShortCodes/SCaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchShortCode /v1/Tollfree/Verifications/{Sid}: servers: - url: https://messaging.twilio.com description: A Messaging resource to create and retrieve Tollfree Verifications. x-twilio: defaultOutputProperties: - sid - date_created mountName: tollfree_verifications pathType: instance get: description: '' summary: '' tags: - MessagingV1TollfreeVerification parameters: - name: Sid in: path description: A unique string identifying a Tollfree Verification. schema: type: string minLength: 34 maxLength: 34 pattern: ^HH[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.tollfree_verification' examples: fetch: value: sid: HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulated_item_sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2021-01-27T14:18:35Z' date_updated: '2021-01-27T14:18:36Z' business_name: Owl, Inc. business_street_address: 123 Main Street business_street_address2: Suite 101 business_city: Anytown business_state_province_region: AA business_postal_code: '11111' business_country: US business_website: http://www.company.com business_contact_first_name: firstname business_contact_last_name: lastname business_contact_email: email@company.com business_contact_phone: '+11231231234' notification_email: support@company.com use_case_categories: - TWO_FACTOR_AUTHENTICATION - MARKETING use_case_summary: This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop production_message_sample: lorem ipsum opt_in_image_urls: - https://testbusiness.com/images/image1.jpg - https://testbusiness.com/images/image2.jpg opt_in_type: VERBAL message_volume: '2000' additional_information: see our privacy policy here www.johnscoffeeshop.com/privacypolicy tollfree_phone_number_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: TWILIO_APPROVED rejection_reason: null error_code: null edit_expiration: null edit_allowed: null rejection_reasons: null resource_links: customer_profile: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_endpoint_assignment: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa url: https://messaging.twilio.com/v1/Tollfree/Verifications/HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa external_reference_id: abc123xyz567 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchTollfreeVerification post: description: '' summary: '' tags: - MessagingV1TollfreeVerification parameters: - name: Sid in: path description: The unique string to identify Tollfree Verification. schema: type: string minLength: 34 maxLength: 34 pattern: ^HH[0-9a-fA-F]{32}$ required: true responses: '202': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.tollfree_verification' examples: update: value: sid: HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulated_item_sid: null customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product_sid: null status: PENDING_REVIEW date_created: '2021-01-27T14:18:35Z' date_updated: '2021-01-27T14:18:36Z' business_name: Owl, Inc. business_street_address: 123 Main Street business_street_address2: Suite 101 business_city: Anytown business_state_province_region: AA business_postal_code: '11111' business_country: US business_website: http://www.company.com business_contact_first_name: firstname business_contact_last_name: lastname business_contact_email: email@company.com business_contact_phone: '+11231231234' notification_email: support@company.com use_case_categories: - TWO_FACTOR_AUTHENTICATION - MARKETING use_case_summary: This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop production_message_sample: lorem ipsum opt_in_image_urls: - https://testbusiness.com/images/image1.jpg - https://testbusiness.com/images/image2.jpg opt_in_type: VERBAL message_volume: 1,000 additional_information: see our privacy policy here www.johnscoffeeshop.com/privacypolicy tollfree_phone_number_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa rejection_reason: null error_code: null edit_expiration: null edit_allowed: null rejection_reasons: null resource_links: {} url: https://messaging.twilio.com/v1/Tollfree/Verifications/HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa external_reference_id: null headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Accepted security: - accountSid_authToken: [] operationId: UpdateTollfreeVerification requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateTollfreeVerificationRequest properties: BusinessName: type: string description: The name of the business or organization using the Tollfree number. BusinessWebsite: type: string description: The website of the business or organization using the Tollfree number. NotificationEmail: type: string description: The email address to receive the notification about the verification result. . UseCaseCategories: type: array items: type: string description: The category of the use case for the Tollfree Number. List as many are applicable.. UseCaseSummary: type: string description: Use this to further explain how messaging is used by the business or organization. ProductionMessageSample: type: string description: An example of message content, i.e. a sample message. OptInImageUrls: type: array items: type: string description: Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL. OptInType: $ref: '#/components/schemas/tollfree_verification_enum_opt_in_type' MessageVolume: type: string description: Estimate monthly volume of messages from the Tollfree Number. BusinessStreetAddress: type: string description: The address of the business or organization using the Tollfree number. BusinessStreetAddress2: type: string description: The address of the business or organization using the Tollfree number. BusinessCity: type: string description: The city of the business or organization using the Tollfree number. BusinessStateProvinceRegion: type: string description: The state/province/region of the business or organization using the Tollfree number. BusinessPostalCode: type: string description: The postal code of the business or organization using the Tollfree number. BusinessCountry: type: string description: The country of the business or organization using the Tollfree number. AdditionalInformation: type: string description: Additional information to be provided for verification. BusinessContactFirstName: type: string description: The first name of the contact for the business or organization using the Tollfree number. BusinessContactLastName: type: string description: The last name of the contact for the business or organization using the Tollfree number. BusinessContactEmail: type: string description: The email address of the contact for the business or organization using the Tollfree number. BusinessContactPhone: type: string format: phone-number description: The E.164 formatted phone number of the contact for the business or organization using the Tollfree number. EditReason: type: string description: Describe why the verification is being edited. If the verification was rejected because of a technical issue, such as the website being down, and the issue has been resolved this parameter should be set to something similar to 'Website fixed'. examples: update: value: BusinessName: Owl, Inc. BusinessStreetAddress: 123 Main Street BusinessStreetAddress2: Suite 101 BusinessCity: Anytown BusinessStateProvinceRegion: AA BusinessPostalCode: '11111' BusinessCountry: US BusinessWebsite: http://www.company.com BusinessContactFirstName: firstname BusinessContactLastName: lastname BusinessContactEmail: email@company.com BusinessContactPhone: '+11231231234' NotificationEmail: support@company.com UseCaseCategories: - TWO_FACTOR_AUTHENTICATION - MARKETING UseCaseSummary: This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop ProductionMessageSample: lorem ipsum OptInImageUrls: - https://testbusiness.com/images/image1.jpg - https://testbusiness.com/images/image2.jpg OptInType: VERBAL MessageVolume: 1,000 AdditionalInformation: see our privacy policy here www.johnscoffeeshop.com/privacypolicy EditReason: Website fixed delete: description: '' summary: '' tags: - MessagingV1TollfreeVerification parameters: - name: Sid in: path description: The unique string to identify Tollfree Verification. schema: type: string minLength: 34 maxLength: 34 pattern: ^HH[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteTollfreeVerification /v1/Tollfree/Verifications: servers: - url: https://messaging.twilio.com description: A Messaging resource to create and retrieve Tollfree Verifications. x-twilio: defaultOutputProperties: - sid - date_created mountName: tollfree_verifications pathType: list get: description: '' summary: '' tags: - MessagingV1TollfreeVerification parameters: - name: TollfreePhoneNumberSid in: query description: The SID of the Phone Number associated with the Tollfree Verification. schema: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ examples: read: value: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa - name: Status in: query description: The compliance status of the Tollfree Verification record. schema: $ref: '#/components/schemas/tollfree_verification_enum_status' examples: read: value: TWILIO_APPROVED - name: ExternalReferenceId in: query description: Customer supplied reference id for the Tollfree Verification record. schema: type: string examples: read: value: abc123xyz567 - name: IncludeSubAccounts in: query description: Whether to include Tollfree Verifications from sub accounts in list response. schema: type: boolean examples: read: value: false - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: verifications: type: array items: $ref: '#/components/schemas/messaging.v1.tollfree_verification' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListTollfreeVerificationResponse examples: read: value: meta: page: 0 page_size: 50 first_page_url: https://messaging.twilio.com/v1/Tollfree/Verifications?Status=TWILIO_APPROVED&ExternalReferenceId=abc123xyz567&TollfreePhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&IncludeSubAccounts=false&PageSize=50&Page=0 previous_page_url: null next_page_url: null key: verifications url: https://messaging.twilio.com/v1/Tollfree/Verifications?Status=TWILIO_APPROVED&ExternalReferenceId=abc123xyz567&TollfreePhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&IncludeSubAccounts=false&PageSize=50&Page=0 verifications: - sid: HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulated_item_sid: RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa date_created: '2021-01-27T14:18:35Z' date_updated: '2021-01-27T14:18:36Z' business_name: Owl, Inc. business_street_address: 123 Main Street business_street_address2: Suite 101 business_city: Anytown business_state_province_region: AA business_postal_code: '11111' business_country: US business_website: http://www.company.com business_contact_first_name: firstname business_contact_last_name: lastname business_contact_email: email@company.com business_contact_phone: '+11231231234' notification_email: support@company.com use_case_categories: - TWO_FACTOR_AUTHENTICATION - MARKETING use_case_summary: This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop production_message_sample: lorem ipsum opt_in_image_urls: - https://testbusiness.com/images/image1.jpg - https://testbusiness.com/images/image2.jpg opt_in_type: VERBAL message_volume: 1,000 additional_information: see our privacy policy here www.johnscoffeeshop.com/privacypolicy tollfree_phone_number_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa status: TWILIO_APPROVED url: https://messaging.twilio.com/v1/Tollfree/Verifications/HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa rejection_reason: null error_code: null edit_expiration: null edit_allowed: null rejection_reasons: null resource_links: customer_profile: https://trusthub.twilio.com/v1/CustomerProfiles/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa trust_product: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa channel_endpoint_assignment: https://trusthub.twilio.com/v1/TrustProducts/BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/ChannelEndpointAssignments/RAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa external_reference_id: abc123xyz567 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListTollfreeVerification post: description: '' summary: '' tags: - MessagingV1TollfreeVerification responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.tollfree_verification' examples: create: value: sid: HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulated_item_sid: null customer_profile_sid: null trust_product_sid: null status: PENDING_REVIEW date_created: '2021-01-27T14:18:35Z' date_updated: '2021-01-27T14:18:36Z' business_name: Owl, Inc. business_street_address: 123 Main Street business_street_address2: Suite 101 business_city: Anytown business_state_province_region: AA business_postal_code: '11111' business_country: US business_website: http://www.company.com business_contact_first_name: firstname business_contact_last_name: lastname business_contact_email: email@company.com business_contact_phone: '+11231231234' notification_email: support@company.com use_case_categories: - TWO_FACTOR_AUTHENTICATION - MARKETING use_case_summary: This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop production_message_sample: lorem ipsum opt_in_image_urls: - https://testbusiness.com/images/image1.jpg - https://testbusiness.com/images/image2.jpg opt_in_type: VERBAL message_volume: '10' additional_information: see our privacy policy here www.johnscoffeeshop.com/privacypolicy tollfree_phone_number_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa rejection_reason: null error_code: null edit_expiration: null edit_allowed: null rejection_reasons: null resource_links: {} url: https://messaging.twilio.com/v1/Tollfree/Verifications/HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa external_reference_id: abc123xyz567 create2: value: sid: HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa customer_profile_sid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa regulated_item_sid: null trust_product_sid: null business_name: Owl, Inc. status: PENDING_REVIEW date_created: '2021-01-27T14:18:35Z' date_updated: '2021-01-27T14:18:36Z' business_street_address: 123 Main Street business_street_address2: Suite 101 business_city: Anytown business_state_province_region: AA business_postal_code: '11111' business_country: US business_website: http://www.company.com business_contact_first_name: firstname business_contact_last_name: lastname business_contact_email: email@company.com business_contact_phone: '+11231231234' notification_email: support@company.com use_case_categories: - TWO_FACTOR_AUTHENTICATION - MARKETING use_case_summary: This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop production_message_sample: lorem ipsum opt_in_image_urls: - https://testbusiness.com/images/image1.jpg - https://testbusiness.com/images/image2.jpg opt_in_type: VERBAL message_volume: '10' additional_information: see our privacy policy here www.johnscoffeeshop.com/privacypolicy tollfree_phone_number_sid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa rejection_reason: null error_code: null edit_expiration: null edit_allowed: null rejection_reasons: null resource_links: {} url: https://messaging.twilio.com/v1/Tollfree/Verifications/HHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa external_reference_id: abc123xyz567 headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateTollfreeVerification requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateTollfreeVerificationRequest properties: BusinessName: type: string description: The name of the business or organization using the Tollfree number. BusinessWebsite: type: string description: The website of the business or organization using the Tollfree number. NotificationEmail: type: string description: The email address to receive the notification about the verification result. . UseCaseCategories: type: array items: type: string description: The category of the use case for the Tollfree Number. List as many are applicable.. UseCaseSummary: type: string description: Use this to further explain how messaging is used by the business or organization. ProductionMessageSample: type: string description: An example of message content, i.e. a sample message. OptInImageUrls: type: array items: type: string description: Link to an image that shows the opt-in workflow. Multiple images allowed and must be a publicly hosted URL. OptInType: $ref: '#/components/schemas/tollfree_verification_enum_opt_in_type' MessageVolume: type: string description: Estimate monthly volume of messages from the Tollfree Number. TollfreePhoneNumberSid: type: string minLength: 34 maxLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ description: The SID of the Phone Number associated with the Tollfree Verification. CustomerProfileSid: type: string minLength: 34 maxLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ description: Customer's Profile Bundle BundleSid. BusinessStreetAddress: type: string description: The address of the business or organization using the Tollfree number. BusinessStreetAddress2: type: string description: The address of the business or organization using the Tollfree number. BusinessCity: type: string description: The city of the business or organization using the Tollfree number. BusinessStateProvinceRegion: type: string description: The state/province/region of the business or organization using the Tollfree number. BusinessPostalCode: type: string description: The postal code of the business or organization using the Tollfree number. BusinessCountry: type: string description: The country of the business or organization using the Tollfree number. AdditionalInformation: type: string description: Additional information to be provided for verification. BusinessContactFirstName: type: string description: The first name of the contact for the business or organization using the Tollfree number. BusinessContactLastName: type: string description: The last name of the contact for the business or organization using the Tollfree number. BusinessContactEmail: type: string description: The email address of the contact for the business or organization using the Tollfree number. BusinessContactPhone: type: string format: phone-number description: The E.164 formatted phone number of the contact for the business or organization using the Tollfree number. ExternalReferenceId: type: string description: An optional external reference ID supplied by customer and echoed back on status retrieval. required: - BusinessName - BusinessWebsite - NotificationEmail - UseCaseCategories - UseCaseSummary - ProductionMessageSample - OptInImageUrls - OptInType - MessageVolume - TollfreePhoneNumberSid examples: create: value: BusinessName: Owl, Inc. BusinessStreetAddress: 123 Main Street BusinessStreetAddress2: Suite 101 BusinessCity: Anytown BusinessStateProvinceRegion: AA BusinessPostalCode: '11111' BusinessCountry: US BusinessWebsite: http://www.company.com BusinessContactFirstName: firstname BusinessContactLastName: lastname BusinessContactEmail: email@company.com BusinessContactPhone: '+11231231234' NotificationEmail: support@company.com UseCaseCategories: - TWO_FACTOR_AUTHENTICATION - MARKETING UseCaseSummary: This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop ProductionMessageSample: lorem ipsum OptInImageUrls: - https://testbusiness.com/images/image1.jpg - https://testbusiness.com/images/image2.jpg OptInType: VERBAL MessageVolume: '10' AdditionalInformation: see our privacy policy here www.johnscoffeeshop.com/privacypolicy TollfreePhoneNumberSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ExternalReferenceId: abc123xyz567 create2: value: CustomerProfileSid: BUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa BusinessName: Owl, Inc. BusinessWebsite: http://www.company.com NotificationEmail: support@company.com UseCaseCategories: - TWO_FACTOR_AUTHENTICATION - MARKETING UseCaseSummary: This number is used to send out promotional offers and coupons to the customers of John's Coffee Shop ProductionMessageSample: lorem ipsum OptInImageUrls: - https://testbusiness.com/images/image1.jpg - https://testbusiness.com/images/image2.jpg OptInType: VERBAL MessageVolume: '10' AdditionalInformation: see our privacy policy here www.johnscoffeeshop.com/privacypolicy TollfreePhoneNumberSid: PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa ExternalReferenceId: abc123xyz567 /v1/Services/{MessagingServiceSid}/Compliance/Usa2p: servers: - url: https://messaging.twilio.com description: A service for (fetch/create/delete) A2P Campaign for a Messaging Service x-twilio: defaultOutputProperties: - brand_registration_sid - campaign_status - date_created parent: /Services/{Sid} mountName: us_app_to_person pathType: list post: description: '' summary: '' tags: - MessagingV1UsAppToPerson parameters: - name: MessagingServiceSid in: path description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to create the resources from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person' examples: create: value: sid: QE2c6890da8086d771620e9b13fadeba0b account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Send marketing messages about sales to opted in customers. message_samples: - 'EXPRESS: Denim Days Event is ON' - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' us_app_to_person_usecase: MARKETING has_embedded_links: true has_embedded_phone: false subscriber_opt_in: false age_gated: false direct_lending: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false rate_limits: att: mps: 600 msg_class: A tmobile: brand_tier: TOP message_flow: End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in. opt_in_message: 'Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP' opt_out_message: You have successfully been unsubscribed from Acme Corporation. You will not receive any more messages from this number. help_message: 'Acme Corporation: Please visit www.example.com to get support. To opt-out, reply STOP.' opt_in_keywords: - START opt_out_keywords: - STOP help_keywords: - HELP date_created: '2021-02-18T14:48:52Z' date_updated: '2021-02-18T14:48:52Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b mock: false errors: [] createWithDefaults: value: sid: QE2c6890da8086d771620e9b13fadeba0b account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Send marketing messages about sales to opted in customers. message_samples: - 'EXPRESS: Denim Days Event is ON' - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' us_app_to_person_usecase: MARKETING has_embedded_links: true has_embedded_phone: false subscriber_opt_in: true age_gated: false direct_lending: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false rate_limits: att: mps: 600 msg_class: A tmobile: brand_tier: TOP message_flow: End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in. opt_in_message: 'Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP' opt_out_message: You have successfully been unsubscribed. You will not receive any more messages from this number. Reply START to resubscribe. help_message: Reply STOP to unsubscribe. Msg&Data Rates May Apply. opt_in_keywords: - START opt_out_keywords: - STOP - STOPALL - UNSUBSCRIBE - CANCEL - END - QUIT help_keywords: - HELP - INFO date_created: '2021-02-18T14:48:52Z' date_updated: '2021-02-18T14:48:52Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b mock: false errors: [] createWithDefaultsSoleProprietor: value: sid: QE2c6890da8086d771620e9b13fadeba0b account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Send marketing messages about sales to opted in customers. message_samples: - 'EXPRESS: Denim Days Event is ON' - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' us_app_to_person_usecase: SOLE_PROPRIETOR has_embedded_links: true has_embedded_phone: false subscriber_opt_in: true age_gated: false direct_lending: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false rate_limits: att: mps: 0.25 msg_class: A tmobile: brand_tier: LOW message_flow: End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in. opt_in_message: 'Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP' opt_out_message: You have successfully been unsubscribed. You will not receive any more messages from this number. Reply START to resubscribe. help_message: Reply STOP to unsubscribe. Msg&Data Rates May Apply. opt_in_keywords: - START opt_out_keywords: - STOP - STOPALL - UNSUBSCRIBE - CANCEL - END - QUIT help_keywords: - HELP - INFO date_created: '2021-02-18T14:48:52Z' date_updated: '2021-02-18T14:48:52Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b mock: false errors: [] headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: Created security: - accountSid_authToken: [] operationId: CreateUsAppToPerson requestBody: content: application/x-www-form-urlencoded: schema: type: object title: CreateUsAppToPersonRequest properties: BrandRegistrationSid: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ description: A2P Brand Registration SID Description: type: string description: 'A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.' MessageFlow: type: string description: Required for all Campaigns. 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. MessageSamples: type: array items: type: string description: '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.' UsAppToPersonUsecase: type: string description: 'A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING..]' HasEmbeddedLinks: type: boolean description: Indicates that this SMS campaign will send messages that contain links. HasEmbeddedPhone: type: boolean description: Indicates that this SMS campaign will send messages that contain phone numbers. OptInMessage: type: string description: 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. OptOutMessage: type: string description: 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. HelpMessage: type: string description: 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. OptInKeywords: type: array items: type: string description: 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. OptOutKeywords: type: array items: type: string description: 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. HelpKeywords: type: array items: type: string description: 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. SubscriberOptIn: type: boolean description: A boolean that specifies whether campaign has Subscriber Optin or not. AgeGated: type: boolean description: A boolean that specifies whether campaign is age gated or not. DirectLending: type: boolean description: A boolean that specifies whether campaign allows direct lending or not. required: - BrandRegistrationSid - Description - MessageFlow - MessageSamples - UsAppToPersonUsecase - HasEmbeddedLinks - HasEmbeddedPhone examples: create: value: BrandRegistrationSid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Description: Send marketing messages about sales to opted in customers. MessageSamples: - 'EXPRESS: Denim Days Event is ON' - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' UsAppToPersonUsecase: MARKETING MessageFlow: End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in. OptInMessage: 'Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP' OptOutMessage: You have successfully been unsubscribed from Acme Corporation. You will not receive any more messages from this number. HelpMessage: 'Acme Corporation: Please visit www.example.com to get support. To opt-out, reply STOP.' OptInKeywords: - START OptOutKeywords: - STOP HelpKeywords: - HELP HasEmbeddedLinks: true HasEmbeddedPhone: false SubscriberOptIn: false AgeGated: false DirectLending: false createWithDefaults: value: BrandRegistrationSid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Description: Send marketing messages about sales to opted in customers. MessageSamples: - 'EXPRESS: Denim Days Event is ON' - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' UsAppToPersonUsecase: MARKETING MessageFlow: End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in. OptInMessage: 'Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP' OptInKeywords: - START HasEmbeddedLinks: true HasEmbeddedPhone: false AgeGated: false DirectLending: false createWithDefaultsSoleProprietor: value: BrandRegistrationSid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa Description: Send marketing messages about sales to opted in customers. MessageSamples: - 'EXPRESS: Denim Days Event is ON' - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' UsAppToPersonUsecase: SOLE_PROPRIETOR MessageFlow: End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in. OptInMessage: 'Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP' OptInKeywords: - START HasEmbeddedLinks: true HasEmbeddedPhone: false AgeGated: false DirectLending: false get: description: '' summary: '' tags: - MessagingV1UsAppToPerson parameters: - name: MessagingServiceSid in: path description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: PageSize in: query description: How many resources to return in each list page. The default is 50, and the maximum is 1000. schema: type: integer format: int64 minimum: 1 maximum: 1000 - name: Page in: query description: The page index. This value is simply for client state. schema: type: integer minimum: 0 - name: PageToken in: query description: The page token. This is provided by the API. schema: type: string responses: '200': content: application/json: schema: type: object properties: compliance: type: array items: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person' meta: properties: first_page_url: format: uri type: string key: type: string next_page_url: format: uri nullable: true type: string page: type: integer page_size: type: integer previous_page_url: format: uri nullable: true type: string url: format: uri type: string type: object title: ListUsAppToPersonResponse examples: readFull: value: compliance: - sid: QE2c6890da8086d771620e9b13fadeba0b account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Send marketing messages about sales to opted in customers. message_samples: - 'EXPRESS: Denim Days Event is ON' - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' us_app_to_person_usecase: MARKETING has_embedded_links: true has_embedded_phone: false subscriber_opt_in: true age_gated: false direct_lending: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false rate_limits: att: mps: 600 msg_class: A tmobile: brand_tier: TOP message_flow: End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in. opt_in_message: 'Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP' opt_out_message: You have successfully been unsubscribed from Acme Corporation. You will not receive any more messages from this number. help_message: 'Acme Corporation: Please visit www.example.com to get support. To opt-out, reply STOP.' opt_in_keywords: - START opt_out_keywords: - STOP help_keywords: - HELP date_created: '2021-02-18T14:48:52Z' date_updated: '2021-02-18T14:48:52Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b mock: false errors: [] meta: page: 0 page_size: 20 first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=20&Page=0 previous_page_url: null next_page_url: null url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=20&Page=0 key: compliance readFailed: value: compliance: - sid: QE2c6890da8086d771620e9b13fadeba0b account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Send marketing messages about sales to opted in customers. message_samples: - 'EXPRESS: Denim Days Event is ON' - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' us_app_to_person_usecase: MARKETING has_embedded_links: true has_embedded_phone: false subscriber_opt_in: true age_gated: false direct_lending: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false rate_limits: att: mps: 600 msg_class: A tmobile: brand_tier: TOP message_flow: End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in. opt_in_message: 'Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP' opt_out_message: You have successfully been unsubscribed from Acme Corporation. You will not receive any more messages from this number. help_message: 'Acme Corporation: Please visit www.example.com to get support. To opt-out, reply STOP.' opt_in_keywords: - START opt_out_keywords: - STOP help_keywords: - HELP date_created: '2021-02-18T14:48:52Z' date_updated: '2021-02-18T14:48:52Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b mock: false errors: - error_code: 30897 fields: - MESSAGE_FLOW url: https://www.twilio.com/docs/api/errors/30897 description: The campaign submission has been reviewed and it was rejected due to Disallowed Content. meta: page: 0 page_size: 20 first_page_url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=20&Page=0 previous_page_url: null next_page_url: null url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p?PageSize=20&Page=0 key: compliance headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: ListUsAppToPerson /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}: servers: - url: https://messaging.twilio.com description: A service for (fetch/create/delete) A2P Campaign for a Messaging Service x-twilio: defaultOutputProperties: - brand_registration_sid - campaign_status - date_created parent: /Services/{Sid} mountName: us_app_to_person pathType: instance delete: description: '' summary: '' tags: - MessagingV1UsAppToPerson parameters: - name: MessagingServiceSid in: path description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to delete the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the US A2P Compliance resource to delete `QE2c6890da8086d771620e9b13fadeba0b`. schema: type: string minLength: 34 maxLength: 34 pattern: ^QE[0-9a-fA-F]{32}$ required: true responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] operationId: DeleteUsAppToPerson get: description: '' summary: '' tags: - MessagingV1UsAppToPerson parameters: - name: MessagingServiceSid in: path description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the US A2P Compliance resource to fetch `QE2c6890da8086d771620e9b13fadeba0b`. schema: type: string minLength: 34 maxLength: 34 pattern: ^QE[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person' examples: fetch: value: sid: QE2c6890da8086d771620e9b13fadeba0b account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Send marketing messages about sales to opted in customers. message_samples: - 'EXPRESS: Denim Days Event is ON' - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' us_app_to_person_usecase: MARKETING has_embedded_links: true has_embedded_phone: false subscriber_opt_in: true age_gated: false direct_lending: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false rate_limits: att: mps: 600 msg_class: A tmobile: brand_tier: TOP message_flow: End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in. opt_in_message: 'Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP' opt_out_message: You have successfully been unsubscribed from Acme Corporation. You will not receive any more messages from this number. help_message: 'Acme Corporation: Please visit www.example.com to get support. To opt-out, reply STOP.' opt_in_keywords: - START opt_out_keywords: - STOP help_keywords: - HELP date_created: '2021-02-18T14:48:52Z' date_updated: '2021-02-18T14:48:52Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b mock: false errors: [] fetchSoleProprietorCampaign: value: sid: QE2c6890da8086d771620e9b13fadeba0b account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Send confirmation messages about scheduled home repair services message_samples: - 'EXPRESS: Denim Days Event is ON' - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' us_app_to_person_usecase: SOLE_PROPRIETOR has_embedded_links: true has_embedded_phone: false subscriber_opt_in: true age_gated: false direct_lending: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false rate_limits: att: mps: 600 msg_class: A tmobile: brand_tier: TOP message_flow: 'End users call (111)-222-3333 to schedule appointments, where they''re also asked whether they would like to provide their phone numbers to receive appointment reminders ' opt_in_message: 'John Doe''s Home Repair: You are now opted-in. For help, reply HELP. To opt-out, reply STOP' opt_out_message: You have successfully been unsubscribed from John Doe's Home Repair. You will not receive any more messages from this number. help_message: 'John Doe''s Home Repair: Please call (111)-222-3333 to get help. To opt-out, please reply STOP' opt_in_keywords: - START opt_out_keywords: - STOP help_keywords: - HELP date_created: '2021-02-18T14:48:52Z' date_updated: '2021-02-18T14:48:52Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b mock: false errors: [] fetchFailedWithErrors: value: sid: QE2c6890da8086d771620e9b13fadeba0b account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Send confirmation messages about scheduled home repair services message_samples: - 'EXPRESS: Denim Days Event is ON' - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' us_app_to_person_usecase: SOLE_PROPRIETOR has_embedded_links: true has_embedded_phone: false subscriber_opt_in: true age_gated: false direct_lending: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false rate_limits: att: mps: 600 msg_class: A tmobile: brand_tier: TOP message_flow: 'End users call (111)-222-3333 to schedule appointments, where they''re also asked whether they would like to provide their phone numbers to receive appointment reminders ' opt_in_message: 'John Doe''s Home Repair: You are now opted-in. For help, reply HELP. To opt-out, reply STOP' opt_out_message: You have successfully been unsubscribed from John Doe's Home Repair. You will not receive any more messages from this number. help_message: 'John Doe''s Home Repair: Please call (111)-222-3333 to get help. To opt-out, please reply STOP' opt_in_keywords: - START opt_out_keywords: - STOP help_keywords: - HELP date_created: '2021-02-18T14:48:52Z' date_updated: '2021-02-18T14:48:52Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b mock: false errors: - error_code: 30897 fields: - MESSAGE_FLOW url: https://www.twilio.com/docs/api/errors/30897 description: The campaign submission has been reviewed and it was rejected due to Disallowed Content. headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchUsAppToPerson post: description: '' summary: '' tags: - MessagingV1UsAppToPerson parameters: - name: MessagingServiceSid in: path description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to update the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: Sid in: path description: The SID of the US A2P Compliance resource to update `QE2c6890da8086d771620e9b13fadeba0b`. schema: type: string minLength: 34 maxLength: 34 pattern: ^QE[0-9a-fA-F]{32}$ required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person' examples: update: value: sid: QE2c6890da8086d771620e9b13fadeba0b account_sid: ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa brand_registration_sid: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa messaging_service_sid: MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa description: Send marketing messages about sales to opted in customers. message_samples: - 'EXPRESS: Denim Days Event is ON' - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' us_app_to_person_usecase: MARKETING has_embedded_links: true has_embedded_phone: false campaign_status: PENDING campaign_id: CFOOBAR is_externally_registered: false rate_limits: att: mps: 600 msg_class: A tmobile: brand_tier: TOP subscriber_opt_in: false age_gated: false direct_lending: false date_created: '2021-02-18T14:48:52Z' date_updated: '2021-02-18T14:48:52Z' url: https://messaging.twilio.com/v1/Services/MGaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Compliance/Usa2p/QE2c6890da8086d771620e9b13fadeba0b message_flow: End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in. opt_in_message: 'Acme Corporation: You are now opted-in. For help, reply HELP. To opt-out, reply STOP' opt_out_message: You have successfully been unsubscribed from Acme Corporation. You will not receive any more messages from this number. opt_in_keywords: - START opt_out_keywords: - STOP help_keywords: - HELP help_message: 'Acme Corporation: Please visit www.example.com to get support. To opt-out, reply STOP.' mock: false errors: [] headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: UpdateUsAppToPerson requestBody: content: application/x-www-form-urlencoded: schema: type: object title: UpdateUsAppToPersonRequest properties: HasEmbeddedLinks: type: boolean description: Indicates that this SMS campaign will send messages that contain links. HasEmbeddedPhone: type: boolean description: Indicates that this SMS campaign will send messages that contain phone numbers. MessageSamples: type: array items: type: string description: '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.' MessageFlow: type: string description: Required for all Campaigns. 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. Description: type: string description: 'A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.' AgeGated: type: boolean description: A boolean that specifies whether campaign requires age gate for federally legal content. DirectLending: type: boolean description: A boolean that specifies whether campaign allows direct lending or not. required: - HasEmbeddedLinks - HasEmbeddedPhone - MessageSamples - MessageFlow - Description - AgeGated - DirectLending examples: update: value: Description: Send marketing messages about sales to opted in customers. MessageSamples: - 'EXPRESS: Denim Days Event is ON' - 'LAST CHANCE: Book your next flight for just 1 (ONE) EUR' MessageFlow: End users opt-in by visiting www.example.com and adding their phone number. They then check a box agreeing to receive text messages from Example Brand. Additionally, end users can also opt-in by texting START to (111) 222-3333 to opt in. HasEmbeddedLinks: true HasEmbeddedPhone: false AgeGated: false DirectLending: false /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/Usecases: servers: - url: https://messaging.twilio.com description: Messaging Service Use Case resource. Fetch possible use cases for service. The Use Cases API returns an empty list if there is an issue with the customer's A2P brand registration. This Brand cannot register any campaign use cases. Customers are requested to contact support with their A2P brand information. x-twilio: defaultOutputProperties: - us_app_to_person_usecases parent: /Services/{Sid} mountName: us_app_to_person_usecases pathType: list get: description: '' summary: '' tags: - MessagingV1UsAppToPersonUsecase parameters: - name: MessagingServiceSid in: path description: The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from. schema: type: string minLength: 34 maxLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ required: true - name: BrandRegistrationSid in: query description: The unique string to identify the A2P brand. schema: type: string minLength: 34 maxLength: 34 pattern: ^BN[0-9a-fA-F]{32}$ examples: fetchWithBrandRegistrationSid: value: BNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.service.us_app_to_person_usecase' examples: fetchWithBrandRegistrationSid: value: us_app_to_person_usecases: - code: 2FA name: Two-Factor authentication (2FA) description: Two-Factor authentication, one-time use password, password reset post_approval_required: false - code: ACCOUNT_NOTIFICATION name: Account Notification description: 'All reminders, alerts, and notifications. (Examples include: flight delayed, hotel booked, appointment reminders.)' post_approval_required: false - code: AGENTS_FRANCHISES name: Agents and Franchises description: For brands that have multiple agents, franchises or offices in the same brand vertical, but require individual localised numbers per agent/location/office. post_approval_required: true - code: CHARITY name: Charity description: 'Includes: 5013C Charity Does not include: Religious organizations' post_approval_required: false - code: PROXY name: Proxy description: 'Peer-to-peer app-based group messaging with proxy/pooled numbers (For example: GroupMe) Supporting personalized services and non-exposure of personal numbers for enterprise or A2P communications. (Examples include: Uber and AirBnb.)' post_approval_required: true - code: CUSTOMER_CARE name: Customer Care description: All customer care messaging, including account management and support post_approval_required: false - code: DELIVERY_NOTIFICATION name: Delivery Notification description: Information about the status of the delivery of a product or service post_approval_required: false - code: EMERGENCY name: Emergency description: Notification services designed to support public safety / health during natural disasters, armed conflicts, pandemics and other national or regional emergencies post_approval_required: true - code: FRAUD_ALERT name: Fraud Alert Messaging description: Fraud alert notification post_approval_required: false - code: HIGHER_EDUCATION name: Higher Education description: For campaigns created on behalf of Colleges or Universities and will also include School Districts etc that fall outside of any "free to the consumer" messaging model post_approval_required: false - code: K12_EDUCATION name: K-12 Education description: Campaigns created for messaging platforms that support schools from grades K-12 and distance learning centers. This is not for Post-Secondary schools. post_approval_required: true - code: LOW_VOLUME name: Low Volume Mixed description: 'Low throughput, any combination of use-cases. Examples include: test, demo accounts' post_approval_required: false - code: MARKETING name: Marketing description: Any communication with marketing and/or promotional content post_approval_required: false - code: MIXED name: Mixed description: Mixed messaging reserved for specific consumer service industry post_approval_required: false - code: POLITICAL name: Political description: Part of organized effort to influence decision making of specific group. All campaigns to be verified post_approval_required: false - code: POLLING_VOTING name: Polling and voting description: Polling and voting post_approval_required: false - code: PUBLIC_SERVICE_ANNOUNCEMENT name: Public Service Announcement description: An informational message that is meant to raise the audience awareness about an important issue post_approval_required: false - code: SECURITY_ALERT name: Security Alert description: A notification that the security of a system, either software or hardware, has been compromised in some way and there is an action you need to take post_approval_required: false - code: SOCIAL name: Social description: 'Communication within or between closed communities (For example: influencers alerts)' post_approval_required: true - code: SWEEPSTAKE name: Sweepstake description: Sweepstake post_approval_required: true fetchWithoutBrandRegistrationSid: value: us_app_to_person_usecases: - code: 2FA name: Two-Factor authentication (2FA) description: Two-Factor authentication, one-time use password, password reset post_approval_required: false - code: ACCOUNT_NOTIFICATION name: Account Notification description: 'All reminders, alerts, and notifications. (Examples include: flight delayed, hotel booked, appointment reminders.)' post_approval_required: false - code: AGENTS_FRANCHISES name: Agents and Franchises description: For brands that have multiple agents, franchises or offices in the same brand vertical, but require individual localised numbers per agent/location/office. post_approval_required: true - code: CHARITY name: Charity description: 'Includes: 5013C Charity Does not include: Religious organizations' post_approval_required: false - code: PROXY name: Proxy description: 'Peer-to-peer app-based group messaging with proxy/pooled numbers (For example: GroupMe) Supporting personalized services and non-exposure of personal numbers for enterprise or A2P communications. (Examples include: Uber and AirBnb.)' post_approval_required: true - code: CUSTOMER_CARE name: Customer Care description: All customer care messaging, including account management and support post_approval_required: false - code: DELIVERY_NOTIFICATION name: Delivery Notification description: Information about the status of the delivery of a product or service post_approval_required: false - code: EMERGENCY name: Emergency description: Notification services designed to support public safety / health during natural disasters, armed conflicts, pandemics and other national or regional emergencies post_approval_required: true - code: FRAUD_ALERT name: Fraud Alert Messaging description: Fraud alert notification post_approval_required: false - code: HIGHER_EDUCATION name: Higher Education description: For campaigns created on behalf of Colleges or Universities and will also include School Districts etc that fall outside of any "free to the consumer" messaging model post_approval_required: false - code: K12_EDUCATION name: K-12 Education description: Campaigns created for messaging platforms that support schools from grades K-12 and distance learning centers. This is not for Post-Secondary schools. post_approval_required: true - code: LOW_VOLUME name: Low Volume Mixed description: 'Low throughput, any combination of use-cases. Examples include: test, demo accounts' post_approval_required: false - code: MARKETING name: Marketing description: Any communication with marketing and/or promotional content post_approval_required: false - code: MIXED name: Mixed description: Mixed messaging reserved for specific consumer service industry post_approval_required: false - code: POLITICAL name: Political description: Part of organized effort to influence decision making of specific group. All campaigns to be verified post_approval_required: false - code: POLLING_VOTING name: Polling and voting description: Polling and voting post_approval_required: false - code: PUBLIC_SERVICE_ANNOUNCEMENT name: Public Service Announcement description: An informational message that is meant to raise the audience awareness about an important issue post_approval_required: false - code: SECURITY_ALERT name: Security Alert description: A notification that the security of a system, either software or hardware, has been compromised in some way and there is an action you need to take post_approval_required: false - code: SOCIAL name: Social description: 'Communication within or between closed communities (For example: influencers alerts)' post_approval_required: true - code: SWEEPSTAKE name: Sweepstake description: Sweepstake post_approval_required: true headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchUsAppToPersonUsecase /v1/Services/Usecases: servers: - url: https://messaging.twilio.com description: Use Case resource. Fetch possible use cases for a Messaging Service. x-twilio: defaultOutputProperties: - usecases pathType: list get: description: '' summary: '' tags: - MessagingV1Usecase responses: '200': content: application/json: schema: $ref: '#/components/schemas/messaging.v1.usecase' examples: fetch: value: usecases: - usecase: notifications description: Transactional notifications and Alerts for any Delivery, Account, Reminder, Order, Fraud, Security, Public Service, or Emergency announcements. purpose: Notify my users. - usecase: marketing description: Marketing messages may contain product information, offers, and calls to action to engage with your organization. purpose: Market my services. headers: Access-Control-Allow-Origin: description: Specify the origin(s) allowed to access the resource schema: type: string example: '*' Access-Control-Allow-Methods: description: Specify the HTTP methods allowed when accessing the resource schema: type: string example: POST, OPTIONS Access-Control-Allow-Headers: description: Specify the headers allowed when accessing the resource schema: type: string example: Content-Type, Authorization Access-Control-Allow-Credentials: description: Indicates whether the browser should include credentials schema: type: boolean Access-Control-Expose-Headers: description: Headers exposed to the client schema: type: string example: X-Custom-Header1, X-Custom-Header2 description: OK security: - accountSid_authToken: [] operationId: FetchUsecase servers: - url: https://messaging.twilio.com tags: - name: MessagingV1AlphaSender - name: MessagingV1BrandRegistration - name: MessagingV1BrandRegistrationOtp - name: MessagingV1BrandVetting - name: MessagingV1ChannelSender - name: MessagingV1Deactivations - name: MessagingV1DestinationAlphaSender - name: MessagingV1DomainCerts - name: MessagingV1DomainConfig - name: MessagingV1DomainConfigMessagingService - name: MessagingV1ExternalCampaign - name: MessagingV1Index - name: MessagingV1LinkshorteningMessagingService - name: MessagingV1LinkshorteningMessagingServiceDomainAssociation - name: MessagingV1Message - name: MessagingV1PhoneNumber - name: MessagingV1RequestManagedCert - name: MessagingV1Service - name: MessagingV1ShortCode - name: MessagingV1TollfreeVerification - name: MessagingV1UsAppToPerson - name: MessagingV1UsAppToPersonUsecase - name: MessagingV1Usecase - name: MessagingV1Version - name: MessagingV1WhatsappSender - name: MessagingV1WhatsappTemplate security: - accountSid_authToken: []