@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api Twilio - Messaging
@base https://messaging.twilio.com
@version 1.0.0
@auth Bearer basic
@endpoints 58
@hint download_for_search
@toc Services(33), a2p(8), Deactivations(1), LinkShortening(11), Tollfree(5)

@group Services
@endpoint POST /v1/Services/{ServiceSid}/AlphaSenders
@required {ServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under.}
@returns(201) {sid: str?, account_sid: str?, service_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, alpha_sender: str?, capabilities: [str]?, url: str(uri)?} # Created

@endpoint GET /v1/Services/{ServiceSid}/AlphaSenders
@required {ServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from.}
@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 1000., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}
@returns(200) {alpha_senders: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK

@endpoint GET /v1/Services/{ServiceSid}/AlphaSenders/{Sid}
@required {ServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from., Sid: str # The SID of the AlphaSender resource to fetch.}
@returns(200) {sid: str?, account_sid: str?, service_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, alpha_sender: str?, capabilities: [str]?, url: str(uri)?} # OK

@endpoint DELETE /v1/Services/{ServiceSid}/AlphaSenders/{Sid}
@required {ServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from., Sid: str # The SID of the AlphaSender resource to delete.}
@returns(204) The resource was deleted successfully.

@endgroup

@group a2p
@endpoint POST /v1/a2p/BrandRegistrations/{BrandRegistrationSid}/SmsOtp
@required {BrandRegistrationSid: str # Brand Registration Sid of Sole Proprietor Brand.}
@returns(201) {account_sid: str?, brand_registration_sid: str?} # Created

@endpoint GET /v1/a2p/BrandRegistrations/{Sid}
@required {Sid: str # The SID of the Brand Registration resource to fetch.}
@returns(200) {sid: str?, account_sid: str?, customer_profile_bundle_sid: str?, a2p_profile_bundle_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, brand_type: str?, status: str, tcr_id: str?, failure_reason: str?, errors: [any]?, url: str(uri)?, brand_score: int?, brand_feedback: [str]?, identity_status: str, russell_3000: bool?, government_entity: bool?, tax_exempt_status: str?, skip_automatic_sec_vet: bool?, mock: bool?, links: map?} # OK

@endpoint POST /v1/a2p/BrandRegistrations/{Sid}
@required {Sid: str # The SID of the Brand Registration resource to update.}
@returns(202) {sid: str?, account_sid: str?, customer_profile_bundle_sid: str?, a2p_profile_bundle_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, brand_type: str?, status: str, tcr_id: str?, failure_reason: str?, errors: [any]?, url: str(uri)?, brand_score: int?, brand_feedback: [str]?, identity_status: str, russell_3000: bool?, government_entity: bool?, tax_exempt_status: str?, skip_automatic_sec_vet: bool?, mock: bool?, links: map?} # Accepted

@endpoint GET /v1/a2p/BrandRegistrations
@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 1000., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}
@returns(200) {data: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK

@endpoint POST /v1/a2p/BrandRegistrations
@returns(201) {sid: str?, account_sid: str?, customer_profile_bundle_sid: str?, a2p_profile_bundle_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, brand_type: str?, status: str, tcr_id: str?, failure_reason: str?, errors: [any]?, url: str(uri)?, brand_score: int?, brand_feedback: [str]?, identity_status: str, russell_3000: bool?, government_entity: bool?, tax_exempt_status: str?, skip_automatic_sec_vet: bool?, mock: bool?, links: map?} # Created

@endpoint POST /v1/a2p/BrandRegistrations/{BrandSid}/Vettings
@required {BrandSid: str # The SID of the Brand Registration resource of the vettings to create .}
@returns(201) {account_sid: str?, brand_sid: str?, brand_vetting_sid: str?, date_updated: str(date-time)?, date_created: str(date-time)?, vetting_id: str?, vetting_class: str?, vetting_status: str?, vetting_provider: str, url: str(uri)?} # Created
@returns(202) {account_sid: str?, brand_sid: str?, brand_vetting_sid: str?, date_updated: str(date-time)?, date_created: str(date-time)?, vetting_id: str?, vetting_class: str?, vetting_status: str?, vetting_provider: str, url: str(uri)?} # Accepted

@endpoint GET /v1/a2p/BrandRegistrations/{BrandSid}/Vettings
@required {BrandSid: str # The SID of the Brand Registration resource of the vettings to read .}
@optional {VettingProvider: str # The third-party provider of the vettings to read}
@returns(200) {data: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK

@endpoint GET /v1/a2p/BrandRegistrations/{BrandSid}/Vettings/{BrandVettingSid}
@required {BrandSid: str # The SID of the Brand Registration resource of the vettings to read ., BrandVettingSid: str # The Twilio SID of the third-party vetting record.}
@returns(200) {account_sid: str?, brand_sid: str?, brand_vetting_sid: str?, date_updated: str(date-time)?, date_created: str(date-time)?, vetting_id: str?, vetting_class: str?, vetting_status: str?, vetting_provider: str, url: str(uri)?} # OK

@endgroup

@group Services
@endpoint GET /v1/Services/{MessagingServiceSid}/ChannelSenders
@required {MessagingServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from.}
@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 1000., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}
@returns(200) {senders: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK

@endpoint POST /v1/Services/{MessagingServiceSid}/ChannelSenders
@required {MessagingServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under.}
@returns(201) {account_sid: str?, messaging_service_sid: str?, sid: str?, sender: str?, sender_type: str?, country_code: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # Created

@endpoint GET /v1/Services/{MessagingServiceSid}/ChannelSenders/{Sid}
@required {MessagingServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from., Sid: str # The SID of the ChannelSender resource to fetch.}
@returns(200) {account_sid: str?, messaging_service_sid: str?, sid: str?, sender: str?, sender_type: str?, country_code: str?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # OK

@endpoint DELETE /v1/Services/{MessagingServiceSid}/ChannelSenders/{Sid}
@required {MessagingServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from., Sid: str # The SID of the Channel Sender resource to delete.}
@returns(204) The resource was deleted successfully.

@endgroup

@group Deactivations
@endpoint GET /v1/Deactivations
@desc Fetch a list of all United States numbers that have been deactivated on a specific date.
@optional {Date: str(date) # 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.}
@errors {307: Temporary Redirect}

@endgroup

@group Services
@endpoint POST /v1/Services/{ServiceSid}/DestinationAlphaSenders
@required {ServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under.}
@returns(201) {sid: str?, account_sid: str?, service_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, alpha_sender: str?, capabilities: [str]?, url: str(uri)?, iso_country_code: str?} # Created

@endpoint GET /v1/Services/{ServiceSid}/DestinationAlphaSenders
@required {ServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from.}
@optional {IsoCountryCode: str # Optional filter to return only alphanumeric sender IDs associated with the specified two-character ISO country code., PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 1000., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}
@returns(200) {alpha_senders: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK

@endpoint GET /v1/Services/{ServiceSid}/DestinationAlphaSenders/{Sid}
@required {ServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from., Sid: str # The SID of the AlphaSender resource to fetch.}
@returns(200) {sid: str?, account_sid: str?, service_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, alpha_sender: str?, capabilities: [str]?, url: str(uri)?, iso_country_code: str?} # OK

@endpoint DELETE /v1/Services/{ServiceSid}/DestinationAlphaSenders/{Sid}
@required {ServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from., Sid: str # The SID of the AlphaSender resource to delete.}
@returns(204) The resource was deleted successfully.

@endgroup

@group LinkShortening
@endpoint POST /v1/LinkShortening/Domains/{DomainSid}/Certificate
@required {DomainSid: str # Unique string used to identify the domain that this certificate should be associated with.}
@returns(200) {domain_sid: str?, date_updated: str(date-time)?, date_expires: str(date-time)?, date_created: str(date-time)?, domain_name: str(uri)?, certificate_sid: str?, url: str(uri)?, cert_in_validation: any?} # OK
@returns(201) {domain_sid: str?, date_updated: str(date-time)?, date_expires: str(date-time)?, date_created: str(date-time)?, domain_name: str(uri)?, certificate_sid: str?, url: str(uri)?, cert_in_validation: any?} # Created

@endpoint GET /v1/LinkShortening/Domains/{DomainSid}/Certificate
@required {DomainSid: str # Unique string used to identify the domain that this certificate should be associated with.}
@returns(200) {domain_sid: str?, date_updated: str(date-time)?, date_expires: str(date-time)?, date_created: str(date-time)?, domain_name: str(uri)?, certificate_sid: str?, url: str(uri)?, cert_in_validation: any?} # OK

@endpoint DELETE /v1/LinkShortening/Domains/{DomainSid}/Certificate
@required {DomainSid: str # Unique string used to identify the domain that this certificate should be associated with.}
@returns(204) The resource was deleted successfully.

@endpoint POST /v1/LinkShortening/Domains/{DomainSid}/Config
@required {DomainSid: str # Unique string used to identify the domain that this config should be associated with.}
@returns(200) {domain_sid: str?, config_sid: str?, fallback_url: str(uri)?, callback_url: str(uri)?, continue_on_failure: bool?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, disable_https: bool?} # OK
@returns(201) {domain_sid: str?, config_sid: str?, fallback_url: str(uri)?, callback_url: str(uri)?, continue_on_failure: bool?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, disable_https: bool?} # Created

@endpoint GET /v1/LinkShortening/Domains/{DomainSid}/Config
@required {DomainSid: str # Unique string used to identify the domain that this config should be associated with.}
@returns(200) {domain_sid: str?, config_sid: str?, fallback_url: str(uri)?, callback_url: str(uri)?, continue_on_failure: bool?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?, disable_https: bool?} # OK

@endpoint GET /v1/LinkShortening/MessagingService/{MessagingServiceSid}/DomainConfig
@required {MessagingServiceSid: str # Unique string used to identify the Messaging service that this domain should be associated with.}
@returns(200) {domain_sid: str?, config_sid: str?, messaging_service_sid: str?, fallback_url: str(uri)?, callback_url: str(uri)?, continue_on_failure: bool?, date_created: str(date-time)?, date_updated: str(date-time)?, url: str(uri)?} # OK

@endpoint GET /v1/LinkShortening/Domains/{DomainSid}/ValidateDns
@required {DomainSid: str # Unique string used to identify the domain.}
@returns(200) {domain_sid: str?, is_valid: bool?, reason: str?, url: str(uri)?} # OK

@endgroup

@group Services
@endpoint POST /v1/Services/PreregisteredUsa2p
@returns(201) {sid: str?, account_sid: str?, campaign_id: str?, messaging_service_sid: str?, date_created: str(date-time)?} # Created

@endgroup

@group LinkShortening
@endpoint POST /v1/LinkShortening/Domains/{DomainSid}/MessagingServices/{MessagingServiceSid}
@required {DomainSid: str # 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, MessagingServiceSid: str # 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}
@returns(201) {domain_sid: str?, messaging_service_sid: str?, url: str(uri)?} # Created

@endpoint DELETE /v1/LinkShortening/Domains/{DomainSid}/MessagingServices/{MessagingServiceSid}
@required {DomainSid: str # 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, MessagingServiceSid: str # 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}
@returns(204) The resource was deleted successfully.

@endpoint GET /v1/LinkShortening/MessagingServices/{MessagingServiceSid}/Domain
@required {MessagingServiceSid: str # Unique string used to identify the Messaging service that this domain should be associated with.}
@returns(200) {domain_sid: str?, messaging_service_sid: str?, url: str(uri)?} # OK

@endgroup

@group Services
@endpoint POST /v1/Services/{ServiceSid}/PhoneNumbers
@required {ServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under.}
@returns(200) {sid: str?, account_sid: str?, service_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, phone_number: str(phone-number)?, country_code: str?, capabilities: [str]?, url: str(uri)?} # OK
@returns(201) {sid: str?, account_sid: str?, service_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, phone_number: str(phone-number)?, country_code: str?, capabilities: [str]?, url: str(uri)?} # Created

@endpoint GET /v1/Services/{ServiceSid}/PhoneNumbers
@required {ServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from.}
@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 1000., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}
@returns(200) {phone_numbers: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK

@endpoint DELETE /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}
@required {ServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from., Sid: str # The SID of the PhoneNumber resource to delete.}
@returns(204) The resource was deleted successfully.

@endpoint GET /v1/Services/{ServiceSid}/PhoneNumbers/{Sid}
@required {ServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from., Sid: str # The SID of the PhoneNumber resource to fetch.}
@returns(200) {sid: str?, account_sid: str?, service_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, phone_number: str(phone-number)?, country_code: str?, capabilities: [str]?, url: str(uri)?} # OK

@endgroup

@group LinkShortening
@endpoint POST /v1/LinkShortening/Domains/{DomainSid}/RequestManagedCert
@required {DomainSid: str # Unique string used to identify the domain that this certificate should be associated with.}
@returns(200) {domain_sid: str?, date_updated: str(date-time)?, date_created: str(date-time)?, date_expires: str(date-time)?, domain_name: str(uri)?, certificate_sid: str?, url: str(uri)?, managed: bool?, requesting: bool?} # OK
@returns(201) {domain_sid: str?, date_updated: str(date-time)?, date_created: str(date-time)?, date_expires: str(date-time)?, domain_name: str(uri)?, certificate_sid: str?, url: str(uri)?, managed: bool?, requesting: bool?} # Created

@endgroup

@group Services
@endpoint POST /v1/Services
@returns(201) {sid: str?, account_sid: str?, friendly_name: str?, date_created: str(date-time)?, date_updated: str(date-time)?, inbound_request_url: str(uri)?, inbound_method: str(http-method)?, fallback_url: str(uri)?, fallback_method: str(http-method)?, status_callback: str(uri)?, sticky_sender: bool?, mms_converter: bool?, smart_encoding: bool?, scan_message_content: str, fallback_to_long_code: bool?, area_code_geomatch: bool?, synchronous_validation: bool?, validity_period: int, url: str(uri)?, links: map?, usecase: str?, us_app_to_person_registered: bool?, use_inbound_webhook_on_number: bool?} # Created

@endpoint GET /v1/Services
@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 1000., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}
@returns(200) {services: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK

@endpoint POST /v1/Services/{Sid}
@required {Sid: str # The SID of the Service resource to update.}
@returns(200) {sid: str?, account_sid: str?, friendly_name: str?, date_created: str(date-time)?, date_updated: str(date-time)?, inbound_request_url: str(uri)?, inbound_method: str(http-method)?, fallback_url: str(uri)?, fallback_method: str(http-method)?, status_callback: str(uri)?, sticky_sender: bool?, mms_converter: bool?, smart_encoding: bool?, scan_message_content: str, fallback_to_long_code: bool?, area_code_geomatch: bool?, synchronous_validation: bool?, validity_period: int, url: str(uri)?, links: map?, usecase: str?, us_app_to_person_registered: bool?, use_inbound_webhook_on_number: bool?} # OK

@endpoint GET /v1/Services/{Sid}
@required {Sid: str # The SID of the Service resource to fetch.}
@returns(200) {sid: str?, account_sid: str?, friendly_name: str?, date_created: str(date-time)?, date_updated: str(date-time)?, inbound_request_url: str(uri)?, inbound_method: str(http-method)?, fallback_url: str(uri)?, fallback_method: str(http-method)?, status_callback: str(uri)?, sticky_sender: bool?, mms_converter: bool?, smart_encoding: bool?, scan_message_content: str, fallback_to_long_code: bool?, area_code_geomatch: bool?, synchronous_validation: bool?, validity_period: int, url: str(uri)?, links: map?, usecase: str?, us_app_to_person_registered: bool?, use_inbound_webhook_on_number: bool?} # OK

@endpoint DELETE /v1/Services/{Sid}
@required {Sid: str # The SID of the Service resource to delete.}
@returns(204) The resource was deleted successfully.

@endpoint POST /v1/Services/{ServiceSid}/ShortCodes
@required {ServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under.}
@returns(200) {sid: str?, account_sid: str?, service_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, short_code: str?, country_code: str?, capabilities: [str]?, url: str(uri)?} # OK
@returns(201) {sid: str?, account_sid: str?, service_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, short_code: str?, country_code: str?, capabilities: [str]?, url: str(uri)?} # Created

@endpoint GET /v1/Services/{ServiceSid}/ShortCodes
@required {ServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from.}
@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 1000., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API.}
@returns(200) {short_codes: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK

@endpoint DELETE /v1/Services/{ServiceSid}/ShortCodes/{Sid}
@required {ServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from., Sid: str # The SID of the ShortCode resource to delete.}
@returns(204) The resource was deleted successfully.

@endpoint GET /v1/Services/{ServiceSid}/ShortCodes/{Sid}
@required {ServiceSid: str # The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from., Sid: str # The SID of the ShortCode resource to fetch.}
@returns(200) {sid: str?, account_sid: str?, service_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, short_code: str?, country_code: str?, capabilities: [str]?, url: str(uri)?} # OK

@endgroup

@group Tollfree
@endpoint GET /v1/Tollfree/Verifications/{Sid}
@desc Retrieve a tollfree verification
@required {Sid: str # A unique string identifying a Tollfree Verification.}
@returns(200) {sid: str?, account_sid: str?, customer_profile_sid: str?, trust_product_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, regulated_item_sid: str?, business_name: str?, business_street_address: str?, business_street_address2: str?, business_city: str?, business_state_province_region: str?, business_postal_code: str?, business_country: str?, business_website: str?, business_contact_first_name: str?, business_contact_last_name: str?, business_contact_email: str?, business_contact_phone: str(phone-number)?, notification_email: str?, use_case_categories: [str]?, use_case_summary: str?, production_message_sample: str?, opt_in_image_urls: [str]?, opt_in_type: str, message_volume: str?, additional_information: str?, tollfree_phone_number_sid: str?, tollfree_phone_number: str(phone-number)?, status: str, url: str(uri)?, rejection_reason: str?, error_code: int?, edit_expiration: str(date-time)?, edit_allowed: bool?, business_registration_number: str?, business_registration_authority: str?, business_registration_country: str?, business_type: str?, business_registration_phone_number: str?, doing_business_as: str?, opt_in_confirmation_message: str?, help_message_sample: str?, privacy_policy_url: str(uri)?, terms_and_conditions_url: str(uri)?, age_gated_content: bool?, opt_in_keywords: [str]?, rejection_reasons: [any]?, resource_links: any?, external_reference_id: str?, vetting_id: str?, vetting_provider: str?, vetting_id_expiration: str(date-time)?} # OK

@endpoint POST /v1/Tollfree/Verifications/{Sid}
@desc Edit a tollfree verification
@required {Sid: str # The unique string to identify Tollfree Verification.}
@returns(202) {sid: str?, account_sid: str?, customer_profile_sid: str?, trust_product_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, regulated_item_sid: str?, business_name: str?, business_street_address: str?, business_street_address2: str?, business_city: str?, business_state_province_region: str?, business_postal_code: str?, business_country: str?, business_website: str?, business_contact_first_name: str?, business_contact_last_name: str?, business_contact_email: str?, business_contact_phone: str(phone-number)?, notification_email: str?, use_case_categories: [str]?, use_case_summary: str?, production_message_sample: str?, opt_in_image_urls: [str]?, opt_in_type: str, message_volume: str?, additional_information: str?, tollfree_phone_number_sid: str?, tollfree_phone_number: str(phone-number)?, status: str, url: str(uri)?, rejection_reason: str?, error_code: int?, edit_expiration: str(date-time)?, edit_allowed: bool?, business_registration_number: str?, business_registration_authority: str?, business_registration_country: str?, business_type: str?, business_registration_phone_number: str?, doing_business_as: str?, opt_in_confirmation_message: str?, help_message_sample: str?, privacy_policy_url: str(uri)?, terms_and_conditions_url: str(uri)?, age_gated_content: bool?, opt_in_keywords: [str]?, rejection_reasons: [any]?, resource_links: any?, external_reference_id: str?, vetting_id: str?, vetting_provider: str?, vetting_id_expiration: str(date-time)?} # Accepted

@endpoint DELETE /v1/Tollfree/Verifications/{Sid}
@desc Delete a tollfree verification
@required {Sid: str # The unique string to identify Tollfree Verification.}
@returns(204) The resource was deleted successfully.

@endpoint GET /v1/Tollfree/Verifications
@desc List tollfree verifications
@optional {TollfreePhoneNumberSid: str # The SID of the Phone Number associated with the Tollfree Verification., Status: str # The compliance status of the Tollfree Verification record., ExternalReferenceId: str # Customer supplied reference id for the Tollfree Verification record., IncludeSubAccounts: bool # Whether to include Tollfree Verifications from sub accounts in list response., PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 1000., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API., TrustProductSid: [str] # The trust product sids / tollfree bundle sids of tollfree verifications}
@returns(200) {verifications: [map], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK

@endpoint POST /v1/Tollfree/Verifications
@desc Create a tollfree verification
@returns(201) {sid: str?, account_sid: str?, customer_profile_sid: str?, trust_product_sid: str?, date_created: str(date-time)?, date_updated: str(date-time)?, regulated_item_sid: str?, business_name: str?, business_street_address: str?, business_street_address2: str?, business_city: str?, business_state_province_region: str?, business_postal_code: str?, business_country: str?, business_website: str?, business_contact_first_name: str?, business_contact_last_name: str?, business_contact_email: str?, business_contact_phone: str(phone-number)?, notification_email: str?, use_case_categories: [str]?, use_case_summary: str?, production_message_sample: str?, opt_in_image_urls: [str]?, opt_in_type: str, message_volume: str?, additional_information: str?, tollfree_phone_number_sid: str?, tollfree_phone_number: str(phone-number)?, status: str, url: str(uri)?, rejection_reason: str?, error_code: int?, edit_expiration: str(date-time)?, edit_allowed: bool?, business_registration_number: str?, business_registration_authority: str?, business_registration_country: str?, business_type: str?, business_registration_phone_number: str?, doing_business_as: str?, opt_in_confirmation_message: str?, help_message_sample: str?, privacy_policy_url: str(uri)?, terms_and_conditions_url: str(uri)?, age_gated_content: bool?, opt_in_keywords: [str]?, rejection_reasons: [any]?, resource_links: any?, external_reference_id: str?, vetting_id: str?, vetting_provider: str?, vetting_id_expiration: str(date-time)?} # Created

@endgroup

@group Services
@endpoint POST /v1/Services/{MessagingServiceSid}/Compliance/Usa2p
@required {MessagingServiceSid: str # The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to create the resources from.}
@optional {X-Twilio-Api-Version: str # The version of the Messaging API to use for this request}
@returns(201) Created

@endpoint GET /v1/Services/{MessagingServiceSid}/Compliance/Usa2p
@required {MessagingServiceSid: str # The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from.}
@optional {PageSize: int(int64) # How many resources to return in each list page. The default is 50, and the maximum is 1000., Page: int # The page index. This value is simply for client state., PageToken: str # The page token. This is provided by the API., X-Twilio-Api-Version: str # The version of the Messaging API to use for this request}
@returns(200) {compliance: [any], meta: map{first_page_url: str(uri), key: str, next_page_url: str(uri)?, page: int, page_size: int, previous_page_url: str(uri)?, url: str(uri)}} # OK

@endpoint DELETE /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}
@required {MessagingServiceSid: str # The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to delete the resource from., Sid: str # The SID of the US A2P Compliance resource to delete `QE2c6890da8086d771620e9b13fadeba0b`.}
@returns(204) The resource was deleted successfully.

@endpoint GET /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}
@required {MessagingServiceSid: str # The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from., Sid: str # The SID of the US A2P Compliance resource to fetch `QE2c6890da8086d771620e9b13fadeba0b`.}
@optional {X-Twilio-Api-Version: str # The version of the Messaging API to use for this request}
@returns(200) OK

@endpoint POST /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}
@required {MessagingServiceSid: str # The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to update the resource from., Sid: str # The SID of the US A2P Compliance resource to update `QE2c6890da8086d771620e9b13fadeba0b`.}
@optional {X-Twilio-Api-Version: str # The version of the Messaging API to use for this request}
@returns(200) OK

@endpoint GET /v1/Services/{MessagingServiceSid}/Compliance/Usa2p/Usecases
@required {MessagingServiceSid: str # The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from.}
@optional {BrandRegistrationSid: str # The unique string to identify the A2P brand.}
@returns(200) {us_app_to_person_usecases: [any]?} # OK

@endpoint GET /v1/Services/Usecases
@returns(200) {usecases: [any]?} # OK

@endgroup

@end