UNPKG

openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

1 lines 117 kB
{"openapi":"3.0.1","servers":[{"url":"https://messaging.twilio.com"}],"info":{"contact":{"email":"support@twilio.com","name":"Twilio Support","url":"https://support.twilio.com"},"description":"This is the public Twilio REST API.","license":{"name":"Apache 2.0","url":"https://www.apache.org/licenses/LICENSE-2.0.html"},"termsOfService":"https://www.twilio.com/legal/tos","title":"Twilio - Messaging","version":"1.55.0","x-apisguru-categories":["telecom","messaging"],"x-logo":{"url":"https://static1.twilio.com/marketing/bundles/marketing/img/logos/wordmark-red.svg"},"x-origin":[{"format":"openapi","url":"https://raw.githubusercontent.com/twilio/twilio-oai/main/spec/json/twilio_messaging_v1.json","version":"3.0"}],"x-providerName":"twilio.com","x-serviceName":"twilio_messaging_v1"},"tags":[{"name":"MessagingV1AlphaSender"},{"name":"MessagingV1BrandRegistration"},{"name":"MessagingV1BrandRegistrationOtp"},{"name":"MessagingV1BrandVetting"},{"name":"MessagingV1ChannelSender"},{"name":"MessagingV1Deactivations"},{"name":"MessagingV1DomainCerts"},{"name":"MessagingV1DomainConfig"},{"name":"MessagingV1DomainConfigMessagingService"},{"name":"MessagingV1ExternalCampaign"},{"name":"MessagingV1LinkshorteningMessagingService"},{"name":"MessagingV1LinkshorteningMessagingServiceDomainAssociation"},{"name":"MessagingV1PhoneNumber"},{"name":"MessagingV1Service"},{"name":"MessagingV1ShortCode"},{"name":"MessagingV1TollfreeVerification"},{"name":"MessagingV1UsAppToPerson"},{"name":"MessagingV1UsAppToPersonUsecase"},{"name":"MessagingV1Usecase"}],"paths":{"/v1/Deactivations":{"description":"A Deactivation resource to retrieve a list of United States phone numbers that have been deactivated by mobile carriers on a specific date.","get":{"description":"Fetch a list of all United States numbers that have been deactivated on a specific date.","operationId":"FetchDeactivation","parameters":[{"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.","in":"query","name":"Date","schema":{"format":"date","type":"string"}}],"responses":{"307":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.deactivation"}}},"description":"Temporary Redirect"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1Deactivations"],"x-maturity":["GA"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"className":"deactivations","defaultOutputProperties":["redirect_to"],"pathType":"instance"}},"/v1/LinkShortening/Domains/{DomainSid}/Certificate":{"delete":{"description":"","operationId":"DeleteDomainCertV4","parameters":[{"description":"Unique string used to identify the domain that this certificate should be associated with.","in":"path","name":"DomainSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^DN[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1DomainCerts"],"x-maturity":["Beta"]},"description":"TODO: Resource-level docs","get":{"description":"","operationId":"FetchDomainCertV4","parameters":[{"description":"Unique string used to identify the domain that this certificate should be associated with.","in":"path","name":"DomainSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^DN[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.domain_cert_v4"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1DomainCerts"],"x-maturity":["Beta"]},"post":{"description":"","operationId":"UpdateDomainCertV4","parameters":[{"description":"Unique string used to identify the domain that this certificate should be associated with.","in":"path","name":"DomainSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^DN[0-9a-fA-F]{32}$","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"TlsCert":{"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.","type":"string"}},"required":["TlsCert"],"title":"UpdateDomainCertV4Request","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.domain_cert_v4"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.domain_cert_v4"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1DomainCerts"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"className":"domain_certs","defaultOutputProperties":["certificate_sid","domain_name","domain_sid","date_expires","date_created","date_updated","url"],"mountName":"domain_certs","pathType":"instance"}},"/v1/LinkShortening/Domains/{DomainSid}/Config":{"description":"TODO: Resource-level docs","get":{"description":"","operationId":"FetchDomainConfig","parameters":[{"description":"Unique string used to identify the domain that this config should be associated with.","in":"path","name":"DomainSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^DN[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.domain_config"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1DomainConfig"],"x-maturity":["Beta"]},"post":{"description":"","operationId":"UpdateDomainConfig","parameters":[{"description":"Unique string used to identify the domain that this config should be associated with.","in":"path","name":"DomainSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^DN[0-9a-fA-F]{32}$","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"CallbackUrl":{"description":"URL to receive click events to your webhook whenever the recipients click on the shortened links","format":"uri","type":"string"},"ContinueOnFailure":{"description":"Boolean field to set customer delivery preference when there is a failure in linkShortening service","type":"boolean"},"DisableHttps":{"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.","type":"boolean"},"FallbackUrl":{"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.","format":"uri","type":"string"}},"title":"UpdateDomainConfigRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.domain_config"}}},"description":"OK"},"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.domain_config"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1DomainConfig"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["config_sid","fallback_url","callback_url","continue_on_failure","date_created","date_updated","url","disable_https"],"mountName":"domain_config","pathType":"instance"}},"/v1/LinkShortening/Domains/{DomainSid}/MessagingServices/{MessagingServiceSid}":{"delete":{"description":"","operationId":"DeleteLinkshorteningMessagingService","parameters":[{"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","in":"path","name":"DomainSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^DN[0-9a-fA-F]{32}$","type":"string"}},{"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","in":"path","name":"MessagingServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1LinkshorteningMessagingService"],"x-maturity":["Beta"]},"description":"TODO: Resource-level docs","post":{"description":"","operationId":"CreateLinkshorteningMessagingService","parameters":[{"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","in":"path","name":"DomainSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^DN[0-9a-fA-F]{32}$","type":"string"}},{"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","in":"path","name":"MessagingServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.linkshortening_messaging_service"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1LinkshorteningMessagingService"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["messaging_service_sid","domain_sid","url"],"mountName":"linkshortening_messaging_service","pathType":"instance"}},"/v1/LinkShortening/MessagingService/{MessagingServiceSid}/DomainConfig":{"description":"TODO: Resource-level docs","get":{"description":"","operationId":"FetchDomainConfigMessagingService","parameters":[{"description":"Unique string used to identify the Messaging service that this domain should be associated with.","in":"path","name":"MessagingServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.domain_config_messaging_service"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1DomainConfigMessagingService"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"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"}},"/v1/LinkShortening/MessagingServices/{MessagingServiceSid}/Domain":{"description":"TODO: Resource-level docs","get":{"description":"","operationId":"FetchLinkshorteningMessagingServiceDomainAssociation","parameters":[{"description":"Unique string used to identify the Messaging service that this domain should be associated with.","in":"path","name":"MessagingServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.linkshortening_messaging_service_domain_association"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1LinkshorteningMessagingServiceDomainAssociation"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["domain_sid","messaging_service_sid","url"],"mountName":"linkshortening_messaging_service_domain_association","pathType":"instance"}},"/v1/Services":{"description":"A Messaging Service resource to create, fetch, update, delete or add/remove senders from Messaging Services.","get":{"description":"","operationId":"ListService","parameters":[{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"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"},"services":{"items":{"$ref":"#/components/schemas/messaging.v1.service"},"type":"array"}},"title":"ListServiceResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1Service"],"x-maturity":["Beta"]},"post":{"description":"","operationId":"CreateService","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"AreaCodeGeomatch":{"description":"Whether to enable [Area Code Geomatch](https://www.twilio.com/docs/messaging/services#area-code-geomatch) on the Service Instance.","type":"boolean"},"FallbackMethod":{"description":"The HTTP method we should use to call `fallback_url`. Can be: `GET` or `POST`.","enum":["HEAD","GET","POST","PATCH","PUT","DELETE"],"format":"http-method","type":"string"},"FallbackToLongCode":{"description":"[OBSOLETE] Former feature used to fallback to long code sender after certain short code message failures.","type":"boolean"},"FallbackUrl":{"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.","format":"uri","type":"string"},"FriendlyName":{"description":"A descriptive string that you create to describe the resource. It can be up to 64 characters long.","type":"string"},"InboundMethod":{"description":"The HTTP method we should use to call `inbound_request_url`. Can be `GET` or `POST` and the default is `POST`.","enum":["HEAD","GET","POST","PATCH","PUT","DELETE"],"format":"http-method","type":"string"},"InboundRequestUrl":{"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.","format":"uri","type":"string"},"MmsConverter":{"description":"Whether to enable the [MMS Converter](https://www.twilio.com/docs/messaging/services#mms-converter) for messages sent through the Service instance.","type":"boolean"},"ScanMessageContent":{"$ref":"#/components/schemas/service_enum_scan_message_content","description":"Reserved.","type":"string"},"SmartEncoding":{"description":"Whether to enable [Smart Encoding](https://www.twilio.com/docs/messaging/services#smart-encoding) for messages sent through the Service instance.","type":"boolean"},"StatusCallback":{"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.","format":"uri","type":"string"},"StickySender":{"description":"Whether to enable [Sticky Sender](https://www.twilio.com/docs/messaging/services#sticky-sender) on the Service instance.","type":"boolean"},"SynchronousValidation":{"description":"Reserved.","type":"boolean"},"UseInboundWebhookOnNumber":{"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.","type":"boolean"},"Usecase":{"description":"A string that describes the scenario in which the Messaging Service will be used. Possible values are `notifications`, `marketing`, `verification`, `discussion`, `poll`, `undeclared`.","type":"string"},"ValidityPeriod":{"description":"How long, in seconds, messages sent from the Service are valid. Can be an integer from `1` to `14,400`.","type":"integer"}},"required":["FriendlyName"],"title":"CreateServiceRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.service"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1Service"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","friendly_name","date_created"],"dependentProperties":{"alpha_senders":{"mapping":{"service_sid":"sid"},"resource_url":"/v1/Services/{service_sid}/AlphaSenders"},"channel_senders":{"mapping":{"messaging_service_sid":"sid"},"resource_url":"/v1/Services/{messaging_service_sid}/ChannelSenders"},"messages":{"mapping":{"messaging_service_sid":"sid"},"resource_url":"/v1/Services/{messaging_service_sid}/Messages"},"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"},"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"}},"pathType":"list"}},"/v1/Services/PreregisteredUsa2p":{"description":"Resource to associate preregistered campaign with Messaging Service.","post":{"description":"","operationId":"CreateExternalCampaign","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"CampaignId":{"description":"ID of the preregistered campaign.","type":"string"},"MessagingServiceSid":{"description":"The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) that the resource is associated with.","maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},"required":["CampaignId","MessagingServiceSid"],"title":"CreateExternalCampaignRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.external_campaign"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1ExternalCampaign"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["campaign_id","messaging_service_sid"],"mountName":"external_campaign","pathType":"list"}},"/v1/Services/Usecases":{"description":"Use Case resource. Fetch possible use cases for a Messaging Service.","get":{"description":"","operationId":"FetchUsecase","responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.usecase"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1Usecase"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["usecases"],"pathType":"list"}},"/v1/Services/{MessagingServiceSid}/ChannelSenders":{"description":"A Messaging Service resource to read, fetch all Channel Senders associated with a Messaging Service.","get":{"description":"","operationId":"ListChannelSender","parameters":[{"description":"The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from.","in":"path","name":"MessagingServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"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"},"senders":{"items":{"$ref":"#/components/schemas/messaging.v1.service.channel_sender"},"type":"array"}},"title":"ListChannelSenderResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1ChannelSender"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","sender","sender_type"],"parent":"/Services/{Sid}","pathType":"list"}},"/v1/Services/{MessagingServiceSid}/ChannelSenders/{Sid}":{"description":"A Messaging Service resource to read, fetch all Channel Senders associated with a Messaging Service.","get":{"description":"","operationId":"FetchChannelSender","parameters":[{"description":"The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from.","in":"path","name":"MessagingServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the ChannelSender resource to fetch.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.service.channel_sender"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1ChannelSender"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","sender","sender_type"],"parent":"/Services/{Sid}","pathType":"instance"}},"/v1/Services/{MessagingServiceSid}/Compliance/Usa2p":{"description":"A service for (fetch/create/delete) A2P Campaign for a Messaging Service","get":{"description":"","operationId":"ListUsAppToPerson","parameters":[{"description":"The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from.","in":"path","name":"MessagingServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"compliance":{"items":{"$ref":"#/components/schemas/messaging.v1.service.us_app_to_person"},"type":"array"},"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","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1UsAppToPerson"],"x-maturity":["Beta"]},"post":{"description":"","operationId":"CreateUsAppToPerson","parameters":[{"description":"The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to create the resources from.","in":"path","name":"MessagingServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"AgeGated":{"description":"A boolean that specifies whether campaign is age gated or not.","type":"boolean"},"BrandRegistrationSid":{"description":"A2P Brand Registration SID","maxLength":34,"minLength":34,"pattern":"^BN[0-9a-fA-F]{32}$","type":"string"},"Description":{"description":"A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.","type":"string"},"DirectLending":{"description":"A boolean that specifies whether campaign allows direct lending or not.","type":"boolean"},"HasEmbeddedLinks":{"description":"Indicates that this SMS campaign will send messages that contain links.","type":"boolean"},"HasEmbeddedPhone":{"description":"Indicates that this SMS campaign will send messages that contain phone numbers.","type":"boolean"},"HelpKeywords":{"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.","items":{"type":"string"},"type":"array"},"HelpMessage":{"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.","type":"string"},"MessageFlow":{"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.","type":"string"},"MessageSamples":{"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.","items":{"type":"string"},"type":"array"},"OptInKeywords":{"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.","items":{"type":"string"},"type":"array"},"OptInMessage":{"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.","type":"string"},"OptOutKeywords":{"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.","items":{"type":"string"},"type":"array"},"OptOutMessage":{"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.","type":"string"},"SubscriberOptIn":{"description":"A boolean that specifies whether campaign has Subscriber Optin or not.","type":"boolean"},"UsAppToPersonUsecase":{"description":"A2P Campaign Use Case. Examples: [ 2FA, EMERGENCY, MARKETING..]","type":"string"}},"required":["BrandRegistrationSid","Description","MessageFlow","MessageSamples","UsAppToPersonUsecase","HasEmbeddedLinks","HasEmbeddedPhone"],"title":"CreateUsAppToPersonRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.service.us_app_to_person"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1UsAppToPerson"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["brand_registration_sid","campaign_status","date_created"],"mountName":"us_app_to_person","parent":"/Services/{Sid}","pathType":"list"}},"/v1/Services/{MessagingServiceSid}/Compliance/Usa2p/Usecases":{"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.","get":{"description":"","operationId":"FetchUsAppToPersonUsecase","parameters":[{"description":"The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from.","in":"path","name":"MessagingServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},{"description":"The unique string to identify the A2P brand.","in":"query","name":"BrandRegistrationSid","schema":{"maxLength":34,"minLength":34,"pattern":"^BN[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.service.us_app_to_person_usecase"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1UsAppToPersonUsecase"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["us_app_to_person_usecases"],"mountName":"us_app_to_person_usecases","parent":"/Services/{Sid}","pathType":"list"}},"/v1/Services/{MessagingServiceSid}/Compliance/Usa2p/{Sid}":{"delete":{"description":"","operationId":"DeleteUsAppToPerson","parameters":[{"description":"The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to delete the resource from.","in":"path","name":"MessagingServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the US A2P Compliance resource to delete `QE2c6890da8086d771620e9b13fadeba0b`.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^QE[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1UsAppToPerson"],"x-maturity":["Beta"]},"description":"A service for (fetch/create/delete) A2P Campaign for a Messaging Service","get":{"description":"","operationId":"FetchUsAppToPerson","parameters":[{"description":"The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/api/service-resource) to fetch the resource from.","in":"path","name":"MessagingServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the US A2P Compliance resource to fetch `QE2c6890da8086d771620e9b13fadeba0b`.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^QE[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.service.us_app_to_person"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1UsAppToPerson"],"x-maturity":["Beta"]},"post":{"description":"","operationId":"UpdateUsAppToPerson","parameters":[{"description":"The SID of the [Messaging Service](https://www.twilio.com/docs/messaging/services/api) to update the resource from.","in":"path","name":"MessagingServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the US A2P Compliance resource to update `QE2c6890da8086d771620e9b13fadeba0b`.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^QE[0-9a-fA-F]{32}$","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"AgeGated":{"description":"A boolean that specifies whether campaign requires age gate for federally legal content.","type":"boolean"},"Description":{"description":"A short description of what this SMS campaign does. Min length: 40 characters. Max length: 4096 characters.","type":"string"},"DirectLending":{"description":"A boolean that specifies whether campaign allows direct lending or not.","type":"boolean"},"HasEmbeddedLinks":{"description":"Indicates that this SMS campaign will send messages that contain links.","type":"boolean"},"HasEmbeddedPhone":{"description":"Indicates that this SMS campaign will send messages that contain phone numbers.","type":"boolean"},"MessageFlow":{"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.","type":"string"},"MessageSamples":{"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.","items":{"type":"string"},"type":"array"}},"required":["HasEmbeddedLinks","HasEmbeddedPhone","MessageSamples","MessageFlow","Description","AgeGated","DirectLending"],"title":"UpdateUsAppToPersonRequest","type":"object"}}}},"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.service.us_app_to_person"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1UsAppToPerson"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["brand_registration_sid","campaign_status","date_created"],"mountName":"us_app_to_person","parent":"/Services/{Sid}","pathType":"instance"}},"/v1/Services/{ServiceSid}/AlphaSenders":{"description":"A Messaging Service resource to add, fetch or remove an Alpha Sender ID from a Messaging Service.","get":{"description":"","operationId":"ListAlphaSender","parameters":[{"description":"The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from.","in":"path","name":"ServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"alpha_senders":{"items":{"$ref":"#/components/schemas/messaging.v1.service.alpha_sender"},"type":"array"},"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","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1AlphaSender"],"x-maturity":["Beta"]},"post":{"description":"","operationId":"CreateAlphaSender","parameters":[{"description":"The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under.","in":"path","name":"ServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"AlphaSender":{"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.","type":"string"}},"required":["AlphaSender"],"title":"CreateAlphaSenderRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.service.alpha_sender"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1AlphaSender"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","alpha_sender"],"parent":"/Services/{Sid}","pathType":"list"}},"/v1/Services/{ServiceSid}/AlphaSenders/{Sid}":{"delete":{"description":"","operationId":"DeleteAlphaSender","parameters":[{"description":"The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from.","in":"path","name":"ServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the AlphaSender resource to delete.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1AlphaSender"],"x-maturity":["Beta"]},"description":"A Messaging Service resource to add, fetch or remove an Alpha Sender ID from a Messaging Service.","get":{"description":"","operationId":"FetchAlphaSender","parameters":[{"description":"The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from.","in":"path","name":"ServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the AlphaSender resource to fetch.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.service.alpha_sender"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1AlphaSender"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","alpha_sender"],"parent":"/Services/{Sid}","pathType":"instance"}},"/v1/Services/{ServiceSid}/PhoneNumbers":{"description":"A Messaging Service resource to add, fetch or remove phone numbers from a Messaging Service.","get":{"description":"","operationId":"ListPhoneNumber","parameters":[{"description":"The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from.","in":"path","name":"ServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"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"},"phone_numbers":{"items":{"$ref":"#/components/schemas/messaging.v1.service.phone_number"},"type":"array"}},"title":"ListPhoneNumberResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1PhoneNumber"],"x-maturity":["Beta"]},"post":{"description":"","operationId":"CreatePhoneNumber","parameters":[{"description":"The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under.","in":"path","name":"ServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"PhoneNumberSid":{"description":"The SID of the Phone Number being added to the Service.","maxLength":34,"minLength":34,"pattern":"^PN[0-9a-fA-F]{32}$","type":"string"}},"required":["PhoneNumberSid"],"title":"CreatePhoneNumberRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.service.phone_number"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1PhoneNumber"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","phone_number","country_code"],"parent":"/Services/{Sid}","pathType":"list"}},"/v1/Services/{ServiceSid}/PhoneNumbers/{Sid}":{"delete":{"description":"","operationId":"DeletePhoneNumber","parameters":[{"description":"The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from.","in":"path","name":"ServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the PhoneNumber resource to delete.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1PhoneNumber"],"x-maturity":["Beta"]},"description":"A Messaging Service resource to add, fetch or remove phone numbers from a Messaging Service.","get":{"description":"","operationId":"FetchPhoneNumber","parameters":[{"description":"The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from.","in":"path","name":"ServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the PhoneNumber resource to fetch.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.service.phone_number"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1PhoneNumber"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","phone_number","country_code"],"parent":"/Services/{Sid}","pathType":"instance"}},"/v1/Services/{ServiceSid}/ShortCodes":{"description":"A Messaging Service resource to add, fetch or remove short code numbers from a Messaging Service.","get":{"description":"","operationId":"ListShortCode","parameters":[{"description":"The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to read the resources from.","in":"path","name":"ServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},{"description":"How many resources to return in each list page. The default is 50, and the maximum is 1000.","in":"query","name":"PageSize","schema":{"maximum":1000,"minimum":1,"type":"integer"}},{"description":"The page index. This value is simply for client state.","in":"query","name":"Page","schema":{"minimum":0,"type":"integer"}},{"description":"The page token. This is provided by the API.","in":"query","name":"PageToken","schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"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"},"short_codes":{"items":{"$ref":"#/components/schemas/messaging.v1.service.short_code"},"type":"array"}},"title":"ListShortCodeResponse","type":"object"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1ShortCode"],"x-maturity":["Beta"]},"post":{"description":"","operationId":"CreateShortCode","parameters":[{"description":"The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to create the resource under.","in":"path","name":"ServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"ShortCodeSid":{"description":"The SID of the ShortCode resource being added to the Service.","maxLength":34,"minLength":34,"pattern":"^SC[0-9a-fA-F]{32}$","type":"string"}},"required":["ShortCodeSid"],"title":"CreateShortCodeRequest","type":"object"}}}},"responses":{"201":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.service.short_code"}}},"description":"Created"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1ShortCode"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","short_code","country_code"],"parent":"/Services/{Sid}","pathType":"list"}},"/v1/Services/{ServiceSid}/ShortCodes/{Sid}":{"delete":{"description":"","operationId":"DeleteShortCode","parameters":[{"description":"The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to delete the resource from.","in":"path","name":"ServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the ShortCode resource to delete.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1ShortCode"],"x-maturity":["Beta"]},"description":"A Messaging Service resource to add, fetch or remove short code numbers from a Messaging Service.","get":{"description":"","operationId":"FetchShortCode","parameters":[{"description":"The SID of the [Service](https://www.twilio.com/docs/chat/rest/service-resource) to fetch the resource from.","in":"path","name":"ServiceSid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}},{"description":"The SID of the ShortCode resource to fetch.","in":"path","name":"Sid","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/messaging.v1.service.short_code"}}},"description":"OK"}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1ShortCode"],"x-maturity":["Beta"]},"servers":[{"url":"https://messaging.twilio.com"}],"x-twilio":{"defaultOutputProperties":["sid","short_code","country_code"],"parent":"/Services/{Sid}","pathType":"instance"}},"/v1/Services/{Sid}":{"delete":{"description":"","operationId":"DeleteService","parameters":[{"description":"The SID of the Service resource to delete.","in":"path","name":"Sid","required":true,"schema":{"maxLength":34,"minLength":34,"pattern":"^MG[0-9a-fA-F]{32}$","type":"string"}}],"responses":{"204":{"description":"The resource was deleted successfully."}},"security":[{"accountSid_authToken":[]}],"tags":["MessagingV1Service"],"x-maturity":["Beta"]},"description":"A Messaging Service resource to create, fetch, update, delete or add/remove senders from Messaging Services.","get":{"description":"","operationId":"FetchS