Permalink
Switch branches/tags
Nothing to show
Find file Copy path
0dfd7df Sep 9, 2016
2 contributors

Users who have contributed to this file

@todda48 @benbusse
2033 lines (2032 sloc) 52.7 KB
{
"swagger": "2.0",
"info": {
"title": "Twilio Account API",
"description": "Twilio is a cloud communications Infrastructure as a Service(IaaS) company based in San Francisco, California. Twilio allows software developers to programmatically make and receive phone calls and send and receive text messages using its web service APIs. Twilio's services are accessed over HTTP and are billed based on usage.",
"termsOfService": "https://www.twilio.com/legal/tos",
"version": "2010-04-01"
},
"host": "api.twilio.com",
"basePath": "2010-04-01",
"schemes": [
"https"
],
"produces": [
"application/json"
],
"consumes": [
"application/json"
],
"paths": {
"/Accounts/{AccountSid}{mediaTypeExtension}": {
"get": {
"summary": "Get Account",
"description": "Returns a representation of an account.",
"operationId": "returns-a-representation-of-an-account",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"description": "A 34 character string that uniquely identifies this account.",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"account"
]
},
"post": {
"summary": "Add Account",
"description": "Allows you to modify the properties of an account.",
"operationId": "allows-you-to-modify-the-properties-of-an-account",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"description": "A 34 character string that uniquely identifies this account.",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"account"
]
},
"put": {
"summary": "Update Account",
"description": "Allows you to modify the properties of an account.",
"operationId": "allows-you-to-modify-the-properties-of-an-account",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"description": "A 34 character string that uniquely identifies this account.",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"account"
]
}
},
"/Accounts{mediaTypeExtension}": {
"get": {
"summary": "Get Account",
"description": "Retrieve a list of the Account resources belonging to the account used to make the API request. This list will include that Account as well.n",
"operationId": "retrieve-a-list-of-the-account-resources-belonging-to-the-account-used-to-make-theapi-request-this-l",
"parameters": [
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"account"
]
},
"post": {
"summary": "Add Account",
"description": "Create a new Account instance resource as a subaccount of the one used to make the request. SeenCreating Subaccounts for more information.n",
"operationId": "create-a-new-account-instance-resource-as-a-subaccount-of-the-one-used-to-make-the-request-seecreati",
"parameters": [
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"account"
]
}
},
"/{AccountSid}.{format}": {
"get": {
"summary": "Get Account",
"description": "GetAccount",
"operationId": "getaccount",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"account"
]
},
"post": {
"summary": "Add Friendly Name",
"description": "UpdateFriendlyName (POST)",
"operationId": "updatefriendlyname-post",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"account"
]
},
"put": {
"summary": "Update Friendly Name",
"description": "UpdateFriendlyName (PUT)",
"operationId": "updatefriendlyname-put",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"account"
]
}
},
"/Accounts/{AccountSid}/Applications/{ApplicationSid}{mediaTypeExtension}": {
"delete": {
"summary": "Delete Application",
"description": "Delete this application.",
"operationId": "delete-this-application",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "ApplicationSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"applications"
]
},
"get": {
"summary": "Get Application",
"description": "Get application instance resource.",
"operationId": "get-application-instance-resource",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "ApplicationSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"applications"
]
},
"post": {
"summary": "Add Application",
"description": "Tries to update the applications properties, and returns the updatednresource representation if successful. The returned response is identicalnto that returned above when making a GET request.n",
"operationId": "tries-to-update-the-applications-properties-and-returns-the-updatedresource-representation-if-succes",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "ApplicationSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"applications"
]
}
},
"/Accounts/{AccountSid}/Applications{mediaTypeExtension}": {
"get": {
"summary": "Get Applications",
"description": "Returns a list of Application resource representations, each representingnan application within your account. The list includes paging information.n",
"operationId": "returns-a-list-of-application-resource-representations-each-representingan-application-within-your-a",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"applications"
]
},
"post": {
"summary": "Add Applications",
"description": "Creates a new application within your account.",
"operationId": "creates-a-new-application-within-your-account",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"applications"
]
}
},
"/Accounts/{AccountSid}/AuthorizedConnectApps/{ConnectAppSid}{mediaTypeExtension}": {
"get": {
"summary": "Get Authorized Connected App",
"description": "Get the properties of the authorized application.",
"operationId": "get-the-properties-of-the-authorized-application",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "ConnectAppSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"applications"
]
}
},
"/Accounts/{AccountSid}/AuthorizedConnectApps{mediaTypeExtension}": {
"get": {
"summary": "Get Authorized Connected Apps",
"description": "Returns a list of Connect App resource representations, each representing anConnect App youve authorized to access your account. The list includesnpaging information.n",
"operationId": "returns-a-list-of-connect-app-resource-representations-each-representing-aconnect-app-youve-authoriz",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"applications"
]
}
},
"/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/Local{mediaTypeExtension}": {
"get": {
"summary": "Get Available Local Phone Numbers",
"description": "Returns a list of local AvailablePhoneNumber resource representationsnthat match the specified filters, each representing a phone number thanis currently available for provisioning within your account.n",
"operationId": "returns-a-list-of-local-availablephonenumber-resource-representationsthat-match-the-specified-filter",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "IsoCountryCode",
"description": "ISO 3166-1 alpha-2.",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"phone numbers"
]
}
},
"/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/Mobile{mediaTypeExtension}": {
"get": {
"summary": "Get Available Mobile Phone Numbers",
"description": "Returns a list of mobile AvailablePhoneNumber resource representations that match the specified filters, each representing a phone number that is currently available for provisioning within your account.",
"operationId": "returns-a-list-of-mobile-availablephonenumber-resource-representations-that-match-the-specified-filt",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "IsoCountryCode",
"description": "ISO 3166-1 alpha-2.",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"phone numbers"
]
}
},
"/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/TollFree{mediaTypeExtension}": {
"get": {
"summary": "Get Available Toll Free Phone Numbers",
"description": "Returns a list of toll-free AvailablePhoneNumber elements that match thenspecified filters, each representing a phone number that is currentlynavailable for provisioning within your account. To provision an availablenphone number, POST the number to the IncomingPhoneNumbers resource.n",
"operationId": "returns-a-list-of-tollfree-availablephonenumber-elements-that-match-thespecified-filters-each-repres",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "IsoCountryCode",
"description": "ISO 3166-1 alpha-2.",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"phone numbers"
]
}
},
"/Accounts/{AccountSid}/AvailablePhoneNumbers{mediaTypeExtension}": {
"get": {
"summary": "Get Available Phone Numbers",
"description": "Returns a list of all AvailablePhoneNumber subresources for your account by ISO Country. For full information about our phone number support, see our Phone Number CSV (http://www.twilio.com/resources/rates/international-phone-number-rates.csv).",
"operationId": "returns-a-list-of-all-availablephonenumber-subresources-for-your-account-by-iso-country-for-full-inf",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"phone numbers"
]
}
},
"/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/Local.{format}": {
"get": {
"summary": "Get Available Local Phone Numbers By Country",
"description": "GetAvailableLocalPhoneNumberList",
"operationId": "getavailablelocalphonenumberlist",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
},
{
"in": "path",
"name": "IsoCountryCode",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"phone numbers"
]
}
},
"/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/TollFree.{format}": {
"get": {
"summary": "Get Available Toll Free Phone Numbers By Country",
"description": "GetAvailableTollFreePhoneNumberList",
"operationId": "getavailabletollfreephonenumberlist",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
},
{
"in": "path",
"name": "IsoCountryCode",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"phone numbers"
]
}
},
"/Accounts/{AccountSid}/Messages/{MessageSid}/Media/{MediaSid}{mediaTypeExtension}": {
"get": {
"summary": "Get Message Media",
"description": "Without an extension, the media is returned using the mime-type provided when the media was generated.",
"operationId": "without-an-extension-the-media-is-returned-using-the-mimetype-provided-when-the-media-was-generated",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "MediaSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "MessageSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Messaging",
" SMS"
]
}
},
"/Accounts/{AccountSid}/Messages/{MessageSid}/Media{mediaTypeExtension}": {
"get": {
"summary": "Get Message Media",
"description": "Returns a list of media associated with your message.",
"operationId": "returns-a-list-of-media-associated-with-your-message",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "MessageSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Messaging",
" SMS"
]
}
},
"/Accounts/{AccountSid}/Messages/{MessageSid}{mediaTypeExtension}": {
"get": {
"summary": "Get Message Media",
"description": "Returns a single message specified by the provided {MessageSid}.n",
"operationId": "returns-a-single-message-specified-by-the-provided-messagesid",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "MessageSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Messaging",
" SMS"
]
}
},
"/Accounts/{AccountSid}/Messages{mediaTypeExtension}": {
"get": {
"summary": "Get Message Media",
"description": "Returns a list of messages associated with your account. The list includes paging information.",
"operationId": "returns-a-list-of-messages-associated-with-your-account-the-list-includes-paging-information",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Messaging",
" SMS"
]
},
"post": {
"summary": "Add Message Media",
"description": "To send a new outgoing message, make an HTTP POST to your Messages list resource URI",
"operationId": "to-send-a-new-outgoing-message-make-an-http-post-to-your-messages-list-resource-uri",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Messaging",
" SMS"
]
}
},
"/Messages/": {
"post": {
"summary": "Add Message",
"description": "A Message instance resource represents an inbound or outbound message. When you send an SMS or MMS message via the REST API, use the <Message> verb in TwiML, or someone sends a message to one of your Twilio numbers Twilio creates a Message instance resource.",
"operationId": "",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"description": "Account ID",
"type": "string",
"format": "string"
},
{
"in": "query",
"name": "ApplicationSid",
"description": "Twilio will POST MessageSid as well as MessageStatus=sent or MessageStatus=failed to the URL in the MessageStatusCallback property of this Application. If the StatusCallback parameter above is also passed, the Applications MessageStatusCallback parameter will take precedence.",
"type": "string",
"format": "string"
},
{
"in": "query",
"name": "Body",
"description": "The text of the message you want to send, limited to 1600 characters.",
"type": "string",
"format": "string"
},
{
"in": "query",
"name": "From",
"description": "A Twilio phone number enabled for the type of message you wish to send. Only phone numbers or short codes purchased from Twilio work here; you cannot (for example) spoof messages from your own cell phone number.",
"type": "string",
"format": "string"
},
{
"in": "query",
"name": "MediaUrl",
"description": "The URL of the media you wish to send out with the message. gif , png and jpeg content is currently supported and will be formatted correctly on the recipients device. Other types are also accepted by the API. The media size limit is 5MB. If you wish to send more than one image in the message body, please provide multiple MediaUrls values in the POST request. You may include up to 10 MediaUrls per message.",
"type": "string",
"format": "string"
},
{
"in": "query",
"name": "StatusCallback",
"description": "A URL that Twilio will POST to each time your message status changes to one of the following: failed, sent, delivered, or undelivered. Twilio will POST the MessageSid along with the other standard request parameters as well as MessageStatus and ErrorCode.",
"type": "string",
"format": "string"
},
{
"in": "query",
"name": "To",
"description": "The destination phone number. Format with a + and country code e.g., +16175551212 (E.164 format). For To numbers without a +, Twilio will use the same country code as the From number. Twilio will also attempt to handle locally formatted numbers for that country code (e.g. (415) 555-1212 for US, 07400123456 for GB). If you are sending to a different country than the From number, you must include a + and the country code to ensure proper delivery.",
"type": "string",
"format": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Messaging",
" SMS"
]
}
},
"/Messages/{MessageSid}/": {
"get": {
"summary": "Get Message",
"description": "This resource represents an individual SMS or MMS message.",
"operationId": "",
"parameters": [
{
"in": "path",
"name": "MessageSid",
"description": "The message ID.",
"type": "string",
"format": "string"
},
{
"in": "path",
"name": "This resource represents an individual SMS or MMS message.",
"description": "The account ID.",
"type": "string",
"format": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Messaging",
" SMS"
]
}
},
"/Accounts/{AccountSid}/OutgoingCallerIds/{OutgoingCallerIdSid}{mediaTypeExtension}": {
"delete": {
"summary": "Delete Outgoing Caller Id",
"description": "Deletes the caller ID from the account. Returns an HTTP 204 response ifnsuccessful, with no body.n",
"operationId": "deletes-the-caller-id-from-the-account-returns-an-http-204-response-ifsuccessful-with-no-body",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "OutgoingCallerIdSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Caller Ids"
]
},
"get": {
"summary": "Get Outgoing Caller Ids",
"description": "Get the set of an accounts verified phone numbers.",
"operationId": "get-the-set-of-an-accounts-verified-phone-numbers",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "OutgoingCallerIdSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Caller Ids"
]
},
"post": {
"summary": "Add Outgoing Caller Id",
"description": "Updates the caller id, and returns the updated resource if successful.",
"operationId": "updates-the-caller-id-and-returns-the-updated-resource-if-successful",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "OutgoingCallerIdSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Caller Ids"
]
},
"put": {
"summary": "Update Outgoing Caller Id",
"description": "Updates the caller id, and returns the updated resource if successful.",
"operationId": "updates-the-caller-id-and-returns-the-updated-resource-if-successful",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "OutgoingCallerIdSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Caller Ids"
]
}
},
"/Accounts/{AccountSid}/OutgoingCallerIds{mediaTypeExtension}": {
"get": {
"summary": "Get Outgoing Caller Ids",
"description": "Returns a list of OutgoingCallerId resource representations, each representingna Caller ID number valid for an account. The list includes paging information.n",
"operationId": "returns-a-list-of-outgoingcallerid-resource-representations-each-representinga-caller-id-number-vali",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Caller Ids"
]
},
"post": {
"summary": "Add Outgoing Caller Id",
"description": "Adds a new CallerID to your account.",
"operationId": "adds-a-new-callerid-to-your-account",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Caller Ids"
]
}
},
"/{AccountSid}/OutgoingCallerIds.{format}": {
"get": {
"summary": "GetOutgoingCallerIdList",
"description": "GetOutgoingCallerIdList",
"operationId": "getoutgoingcalleridlist",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Caller Ids"
]
},
"post": {
"summary": "AddOutgoingCallerId",
"description": "AddOutgoingCallerId",
"operationId": "addoutgoingcallerid",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Caller Ids"
]
}
},
"/{AccountSid}/OutgoingCallerIds/{OutgoingCallerIdSid}.{format}": {
"delete": {
"summary": "DeleteOutgoingCallerId",
"description": "DeleteOutgoingCallerId",
"operationId": "deleteoutgoingcallerid",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
},
{
"in": "path",
"name": "OutgoingCallerIdSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Caller Ids"
]
},
"get": {
"summary": "GetOutgoingCallerId",
"description": "GetOutgoingCallerId",
"operationId": "getoutgoingcallerid",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
},
{
"in": "path",
"name": "OutgoingCallerIdSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Caller Ids"
]
},
"post": {
"summary": "UpdateOutgoingCallerId (POST)",
"description": "UpdateOutgoingCallerId (POST)",
"operationId": "updateoutgoingcallerid-post",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
},
{
"in": "path",
"name": "OutgoingCallerIdSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Caller Ids"
]
},
"put": {
"summary": "UpdateOutgoingCallerId (PUT)",
"description": "UpdateOutgoingCallerId (PUT)",
"operationId": "updateoutgoingcallerid-put",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
},
{
"in": "path",
"name": "OutgoingCallerIdSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Caller Ids"
]
}
},
"/Accounts/{AccountSid}/Queues/{QueueSid}/Members/Front{mediaTypeExtension}": {
"get": {
"summary": "Get Queue Members In Front",
"description": "Get a front member.",
"operationId": "get-a-front-member",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "QueueSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"queues"
]
},
"post": {
"summary": "Update Queue Members In Front",
"description": "Posting a URL and Method to a Queue instance will dequeue a member from anqueue and have the members call begin executing the TwiML document at that URLnWhen dequeuing the Front of the queue, the next call in the queue will be redirected.n",
"operationId": "posting-a-url-and-method-to-a-queue-instance-will-dequeue-a-member-from-aqueue-and-have-the-members-",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "QueueSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"queues"
]
}
},
"/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}{mediaTypeExtension}": {
"get": {
"summary": "Get Queue Members",
"description": "Get a specific member.",
"operationId": "get-a-specific-member",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "CallSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "QueueSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"queues"
]
},
"post": {
"summary": "Update Queue Members",
"description": "Posting a URL and Method to a Queue instance will dequeue a member from anqueue and have the members call begin executing the TwiML document at that URLnWhen redirecting a member of a queue addressed by CallSid, only the first requestnwill succeed and return a 200 response code. A second request will fail andnreturn an appropriate 400 response code.n",
"operationId": "posting-a-url-and-method-to-a-queue-instance-will-dequeue-a-member-from-aqueue-and-have-the-members-",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "CallSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "QueueSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"queues"
]
}
},
"/Accounts/{AccountSid}/Queues/{QueueSid}/Members{mediaTypeExtension}": {
"get": {
"summary": "Get Queue Members",
"description": "Returns the list of members in the queue identified by {QueueSid}.",
"operationId": "returns-the-list-of-members-in-the-queue-identified-by-queuesid",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "QueueSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"queues"
]
}
},
"/Accounts/{AccountSid}/Queues/{QueueSid}{mediaTypeExtension}": {
"delete": {
"summary": "Delete Queue Members",
"description": "The DELETE method allows you to remove a Queue. Only empty queues arendeletable.n",
"operationId": "the-delete-method-allows-you-to-remove-a-queue-only-empty-queues-aredeletable",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "QueueSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"queues"
]
},
"get": {
"summary": "Get Queue Members",
"description": "Get resources individual Queue instance.n",
"operationId": "get-resources-individual-queue-instance",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "QueueSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"queues"
]
},
"post": {
"summary": "Add Queue Members",
"description": "This POST request allows you to change the FriendlyName or MaxSize.n",
"operationId": "this-post-request-allows-you-to-change-the-friendlyname-or-maxsize",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "QueueSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"queues"
]
}
},
"/Accounts/{AccountSid}/Queues{mediaTypeExtension}": {
"get": {
"summary": "Get Queues",
"description": "Returns a list of queues within an account. The list includes pagingninformation.n",
"operationId": "returns-a-list-of-queues-within-an-account-the-list-includes-paginginformation",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"queues"
]
},
"post": {
"summary": "Add Queue",
"description": "Create a new Queue resource.n",
"operationId": "create-a-new-queue-resource",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"queues"
]
}
},
"/{AccountSid}/Sandbox.{format}": {
"get": {
"summary": "GetSandbox",
"description": "GetSandbox",
"operationId": "getsandbox",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"sandbox"
]
},
"post": {
"summary": "UpdateSandbox",
"description": "UpdateSandbox (POST)",
"operationId": "updatesandbox-post",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"sandbox"
]
},
"put": {
"summary": "UpdateSandbox",
"description": "UpdateSandbox (PUT)",
"operationId": "updatesandbox-put",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"sandbox"
]
}
},
"/Accounts/{AccountSid}/SMS/ShortCodes/{ShortCodeSid}{mediaTypeExtension}": {
"get": {
"summary": "Get SMS Short Code Media",
"description": "Get a single message.",
"operationId": "get-a-single-message",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "ShortCodeSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"SMS"
]
},
"post": {
"summary": "Add SMS Short Code Media",
"description": "Tries to update the shortcodes properties, and returns the updatednresource representation if successful.n",
"operationId": "tries-to-update-the-shortcodes-properties-and-returns-the-updatedresource-representation-if-successf",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "ShortCodeSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"SMS"
]
}
},
"/Accounts/{AccountSid}/SMS/ShortCodes{mediaTypeExtension}": {
"get": {
"summary": "Get SMS Short Code Media",
"description": "Returns a list of ShortCode resource representations, each representing anshort code within your account. The list includes paging information.n",
"operationId": "returns-a-list-of-shortcode-resource-representations-each-representing-ashort-code-within-your-accou",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"SMS"
]
}
},
"/{AccountSid}/SMS/Messages.{format}": {
"get": {
"summary": "GetSMSList",
"description": "GetSMSList",
"operationId": "getsmslist",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"SMS"
]
},
"post": {
"summary": "SendSMS",
"description": "SendSMS",
"operationId": "sendsms",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"SMS"
]
}
},
"/{AccountSid}/SMS/Messages/{SMSMessageSid}.{format}": {
"get": {
"summary": "GetSMS",
"description": "GetSMS",
"operationId": "getsms",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "format",
"type": "string"
},
{
"in": "path",
"name": "SMSMessageSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"SMS"
]
}
},
"/Accounts/{AccountSid}/Usage/Records/{Subresource}{mediaTypeExtension}": {
"get": {
"summary": "Get Account Usage Record Sub Resource",
"description": "Returns UsageRecords for all usage categories for a specified period.n",
"operationId": "returns-usagerecords-for-all-usage-categories-for-a-specified-period",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "Subresource",
"description": "|Subresource|Description|n|---|---|n|Daily|Return multiple UsageRecords for each usage category, each representing usage over a daily time-interval.|n|Monthly|Return multiple UsageRecords for each usage category, each representing usage over a monthly time-interval.|n|Yearly|Return multple UsageRecords for each usage category, each representing usage over a yearly time-interval.|n|AllTime| Return a single UsageRecord for each usage category, each representing usage over the date-range specified. This is the same as the root /Usage/Records.|n|Today|Return a single UsageRecord per usage category, for todays usage only.|n||Yesterday|Return a single UsageRecord per usage category, for yesterdays usage only.|n|ThisMonth|Return a single UsageRecord per usage category, for this months usage only.|n|LastMonth|Return a single UsageRecord per usage category, for last months usage only.|n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Usage"
]
}
},
"/Accounts/{AccountSid}/Usage/Records{mediaTypeExtension}": {
"get": {
"summary": "Get Account Usage Record",
"description": "Returns UsageRecords for all usage categories. The list includes pagingninformation.nBy default, the UsageRecords resource will return one UsageRecord forneach Category, representing all usage accrued all-time for the account.nYou can filter the usage Category or change the date-range over which usagenis counted using optional GET query parameters.n",
"operationId": "returns-usagerecords-for-all-usage-categories-the-list-includes-paginginformationby-default-the-usag",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Usage"
]
}
},
"/Accounts/{AccountSid}/Usage/Triggers/{UsageTriggerSid}{mediaTypeExtension}": {
"delete": {
"summary": "Delete Account Usage Trigger",
"description": "Delete this UsageTrigger.",
"operationId": "delete-this-usagetrigger",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "UsageTriggerSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Usage"
]
},
"get": {
"summary": "Get Account Usage Trigger",
"description": "Returns a repesentation of the UsageTrigger.",
"operationId": "returns-a-repesentation-of-the-usagetrigger",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "UsageTriggerSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Usage"
]
},
"post": {
"summary": "Add Account Usage Trigger",
"description": "Tries to update the UsageTriggers properties, and returns the updatednresource representation if successful.n",
"operationId": "tries-to-update-the-usagetriggers-properties-and-returns-the-updatedresource-representation-if-succe",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
},
{
"in": "path",
"name": "UsageTriggerSid",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Usage"
]
}
},
"/Accounts/{AccountSid}/Usage/Triggers{mediaTypeExtension}": {
"get": {
"summary": "Get Account Usage Triggers",
"description": "Returns a list of UsageTrigger resource representations. The list includesnpaging information.nBy default, all UsageTriggers are returned. You can filter the list bynspecifying one or more query parameters. Note that the query parameters arencase-sensitiven",
"operationId": "returns-a-list-of-usagetrigger-resource-representations-the-list-includespaging-informationby-defaul",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK",
"type": "string"
}
},
"tags": [
"Usage"
]
},
"post": {
"summary": "Add Account Usage Triggers",
"description": "Creates a new UsageTrigger. Each account can create up to 1,000 UsageTriggers.nCurrently, UsageTriggers that are no longer active are not deleted automatically.nUse DELETE to delete triggers you no longer need.n",
"operationId": "creates-a-new-usagetrigger-each-account-can-create-up-to-1000-usagetriggerscurrently-usagetriggers-t",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"description": "By default, Twilios REST API returns XML. You may obtain CSV, JSON or HTML by appending .csv, .json, or .html.n",
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
},
"tags": [
"Usage"
]
}
}
},
"definitions": []
}