Skip to content

Instantly share code, notes, and snippets.

@hieumoscow

hieumoscow/twillio openapi json

Created April 17, 2020 09:11
Show Gist options
  • Save hieumoscow/878ba11eb1595f2e83464257a396dadc to your computer and use it in GitHub Desktop.
Save hieumoscow/878ba11eb1595f2e83464257a396dadc to your computer and use it in GitHub Desktop.
Download ZIP
Raw
twillio openapi json
{
"swagger": "2.0",
"schemes": [
"https"
],
"host": "api.twilio.com",
"basePath": "/2010-04-01",
"info": {
"description": "Enabling phones, VoIP, and messaging to be embedded into web, desktop, and mobile software.\n",
"title": "Twilio",
"version": "2010-04-01",
"x-apisguru-categories": [
"telecom",
"messaging"
],
"x-logo": {
"url": "https://static1.twilio.com/marketing/bundles/marketing/img/logos/wordmark-red.svg"
},
"x-origin": [
{
"format": "swagger",
"url": "https://raw.githubusercontent.com/APIs-guru/unofficial_openapi_specs/master/twilio.com/2010-04-01/swagger.yaml",
"version": "2.0"
}
],
"x-providerName": "twilio.com",
"x-unofficialSpec": true
},
"externalDocs": {
"url": "https://www.twilio.com/api"
},
"securityDefinitions": {
"basic": {
"type": "basic"
}
},
"paths": {
"/Accounts/{AccountSid}/Applications/{ApplicationSid}{mediaTypeExtension}": {
"delete": {
"description": "Delete this application.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "ApplicationSid",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Application deleted."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to delete the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't DELETE the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't delete the resource. Please try again."
}
}
},
"get": {
"description": "Get application instance resource.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "ApplicationSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/application"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Tries to update the application's properties, and returns the updated\nresource representation if successful. The returned response is identical\nto that returned above when making a GET request.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "ApplicationSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/application"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/Applications{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns a list of Application resource representations, each representing\nan application within your account. The list includes paging information.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/applications"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Creates a new application within your account.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n"
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/application"
}
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/AuthorizedConnectApps/{ConnectAppSid}{mediaTypeExtension}": {
"get": {
"description": "Get the properties of the authorized application.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "ConnectAppSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/authApp"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/AuthorizedConnectApps{mediaTypeExtension}": {
"get": {
"description": "Returns a list of Connect App resource representations, each representing a\nConnect App you've authorized to access your account. The list includes\npaging information.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/authApps"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/Local{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns a list of local AvailablePhoneNumber resource representations\nthat match the specified filters, each representing a phone number tha\nis currently available for provisioning within your account.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"description": "ISO 3166-1 alpha-2.",
"in": "path",
"maxLength": 2,
"minLength": 2,
"name": "IsoCountryCode",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/availablePhoneNumbers"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/Mobile{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"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.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"description": "ISO 3166-1 alpha-2.",
"in": "path",
"maxLength": 2,
"minLength": 2,
"name": "IsoCountryCode",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/phoneMobileNumbers"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/AvailablePhoneNumbers/{IsoCountryCode}/TollFree{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns a list of toll-free AvailablePhoneNumber elements that match the\nspecified filters, each representing a phone number that is currently\navailable for provisioning within your account. To provision an available\nphone number, POST the number to the IncomingPhoneNumbers resource.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"description": "ISO 3166-1 alpha-2.",
"in": "path",
"maxLength": 2,
"minLength": 2,
"name": "IsoCountryCode",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/phoneTollFreeNumbers"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/AvailablePhoneNumbers{mediaTypeExtension}": {
"get": {
"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).",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/availablePhoneNumbers"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Calls/{CallSid}/Notifications{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns a list of notifications generated for an account. The list includes\npaging information.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CallSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/notifications"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Calls/{CallSid}/Recordings{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns a list of Recording resource representations, each representing a\nrecording generated during the course of a phone call.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CallSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/recordings"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Calls/{CallSid}{mediaTypeExtension}": {
"get": {
"description": "Returns the single Call resource identified by {CallSid}.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CallSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/callInstance"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Modify a phone call.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CallSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/callInstance"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/Calls{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns a list of phone calls made to and from the account identified by {AccountSid}.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/calls"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "To make a call, make an HTTP POST request. Initiate a new phone call.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n"
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/call"
}
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}{mediaTypeExtension}": {
"delete": {
"description": "Kick this participant from the conference.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "ConferenceSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CallSid",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Participant was successfully booted from the conference."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to delete the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't DELETE the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't delete the resource. Please try again."
}
}
},
"get": {
"description": "Returns a representation of this participant.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "ConferenceSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CallSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/participant"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Updates the status of a participant.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "ConferenceSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CallSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/participant"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns the list of participants in the conference identified by\n{ConferenceSid}.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "ConferenceSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/participants"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Conferences/{ConferenceSid}{mediaTypeExtension}": {
"get": {
"description": "Returns a representation of the conference identified by {ConferenceSid}.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "ConferenceSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/conference"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Conferences{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns a list of conferences within an account. The list includes paging\ninformation.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/conferences"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/ConnectApps/{ConnectAppSid}{mediaTypeExtension}": {
"get": {
"description": "Get the properties of a Connect App.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "ConnectAppSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/connectApp"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Tries to update the Connect App's properties, and returns the updated\nresource representation if successful. The returned response is identical\nto that returned above when making a GET request.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "ConnectAppSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/connectApp"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/ConnectApps{mediaTypeExtension}": {
"get": {
"description": "Returns a list of Connect App resource representations, each representing\na Connect App in your account. The list includes paging information.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/connectApps"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/IncomingPhoneNumbers/Local{mediaTypeExtension}": {
"get": {
"description": "Returns a list of local <IncomingPhoneNumber> elements, each representing a local (not toll-free) phone number given to your account, under an <IncomingPhoneNumbers> list element that includes paging information. Works exactly the same as the IncomingPhoneNumber resource, but filters out toll-free numbers.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Adds a new phone number to your account. If a phone number is found for your request, Twilio will add it to your account and bill you for the first month's cost of the phone number. ",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "If Twilio can't find a phone number to match your request, you will receive an HTTP 400 with Twilio error code 21452."
}
}
}
},
"/Accounts/{AccountSid}/IncomingPhoneNumbers/Mobile{mediaTypeExtension}": {
"get": {
"description": "Returns a list of local <IncomingPhoneNumber> elements, each representing a mobile phone number given to your account, under an <IncomingPhoneNumbers> list element that includes paging information. Works exactly the same as the IncomingPhoneNumber resource, but filters out local and toll free numbers.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Adds a new phone number to your account. If a phone number is found for your request, Twilio will add it to your account and bill you for the first month's cost of the phone number.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "If Twilio can't find a phone number to match your request, you will receive an HTTP 400 with Twilio error code 21452."
}
}
}
},
"/Accounts/{AccountSid}/IncomingPhoneNumbers/TollFree{mediaTypeExtension}": {
"get": {
"description": "Returns a list of local <IncomingPhoneNumber> elements, each representing a toll-free phone number given to your account, under an <IncomingPhoneNumbers> list element that includes paging information. Works exactly the same as the IncomingPhoneNumber resource, but filters out all numbers that aren't toll-free.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Adds a new phone number to your account. If a phone number is found for your request, Twilio will add it to your account and bill you for the first month's cost of the phone number. ",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"responses": {
"201": {
"description": "Created"
},
"400": {
"description": "If Twilio can't find a phone number to match your request, you will receive an HTTP 400 with Twilio error code 21452."
}
}
}
},
"/Accounts/{AccountSid}/IncomingPhoneNumbers/{IncomingPhoneNumberSid}{mediaTypeExtension}": {
"delete": {
"description": "Release this phone number from your account. Twilio will no longer answer\ncalls to this number, and you will stop being billed the monthly phone\nnumber fee. The phone number will eventually be recycled and potentially\ngiven to another customer, so use with care. If you make a mistake, contac\nus. We may be able to give you the number back.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "IncomingPhoneNumberSid",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Phone number removed."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to delete the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't DELETE the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't delete the resource. Please try again."
}
}
},
"get": {
"description": "Get info about incoming call's phone number.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "IncomingPhoneNumberSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/incomingCall"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Tries to update the incoming phone number's properties, and returns the\nupdated resource representation if successful. The returned response is\nidentical to that returned above when making a GET request.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "IncomingPhoneNumberSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/incomingCall"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
},
"put": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Tries to update the incoming phone number's properties, and returns the\nupdated resource representation if successful. The returned response is\nidentical to that returned above when making a GET request.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "IncomingPhoneNumberSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/incomingCall"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/IncomingPhoneNumbers{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns a list of IncomingPhoneNumber resource representations, each\nrepresenting a phone number given to your account. The list includes paging\ninformation.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/incomingCalls"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Purchases a new phone number for your account. If a phone number is found\nfor your request, Twilio will add it to your account and bill you for the\nfirst month's cost of the phone number.\nTo find an available phone number to POST, use the subresources of the\nAvailablePhoneNumbers list resource.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n"
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/incomingCall"
}
},
"400": {
"description": "If Twilio cannot find a phone number to match your request, you will receive an HTTP 400 with Twilio error code 21452."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/Messages/{MessageSid}/Media/{MediaSid}{mediaTypeExtension}": {
"get": {
"description": "Without an extension, the media is returned using the mime-type provided when the media was generated.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "MessageSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "MediaSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/media"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Messages/{MessageSid}/Media{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns a list of media associated with your message.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "MessageSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/mediaList"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Messages/{MessageSid}{mediaTypeExtension}": {
"get": {
"description": "Returns a single message specified by the provided {MessageSid}.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "MessageSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/message"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Messages{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns a list of messages associated with your account. The list includes paging information.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/messages"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "To send a new outgoing message, make an HTTP POST to your Messages list resource URI",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"description": "The destination phone number. Format with a '+' and country code e.g., +16175551212 (E.164 format).\n",
"in": "formData",
"name": "To",
"required": true,
"type": "string"
},
{
"description": "A Twilio phone number (in E.164 format) or alphanumeric sender ID enabled for the type of message you wish to send. Phone numbers or short codes purchased from Twilio work here. You cannot (for example) spoof messages from your own cell phone number.\n",
"in": "formData",
"name": "From",
"type": "string"
},
{
"description": "The 34 character unique id of the Messaging Service you want to associate with this Message. Set this parameter to use the Messaging Service Settings and Copilot Features you have configured. When only this parameter is set, Twilio will use your enabled Copilot Features to select the From phone number for delivery.\n",
"in": "formData",
"name": "MessagingServiceSid",
"type": "string"
},
{
"description": "The text of the message you want to send, limited to 1600 characters.\n",
"in": "formData",
"name": "Body",
"type": "string"
},
{
"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 recipient's 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.\n",
"in": "formData",
"name": "MediaUrl",
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n"
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/message"
}
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/Notifications/{NotificationSid}{mediaTypeExtension}": {
"delete": {
"description": "Deletes the notification identified by {NotificationSid} from an account's log.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "NotificationSid",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Notification removed."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to delete the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't DELETE the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't delete the resource. Please try again."
}
}
},
"get": {
"description": "Get a notification entry.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "NotificationSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/notification"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Notifications{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns a list of notifications generated for an account. The list includes\npaging information.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/notifications"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/OutgoingCallerIds/{OutgoingCallerIdSid}{mediaTypeExtension}": {
"delete": {
"description": "Deletes the caller ID from the account. Returns an HTTP 204 response if\nsuccessful, with no body.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "OutgoingCallerIdSid",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Deletion successful."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to delete the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't DELETE the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't delete the resource. Please try again."
}
}
},
"get": {
"description": "Get the set of an account's verified phone numbers.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "OutgoingCallerIdSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/outgoingCallerId"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Updates the caller id, and returns the updated resource if successful.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "OutgoingCallerIdSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/outgoingCallerId"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
},
"put": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Updates the caller id, and returns the updated resource if successful.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "OutgoingCallerIdSid",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n"
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/OutgoingCallerIds{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns a list of OutgoingCallerId resource representations, each representing\na Caller ID number valid for an account. The list includes paging information.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/outCallerIds"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Adds a new CallerID to your account.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n"
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/outCaller"
}
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/Queues/{QueueSid}/Members/Front{mediaTypeExtension}": {
"get": {
"description": "Get a front member.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "QueueSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/member"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Posting a URL and Method to a Queue instance will dequeue a member from a\nqueue and have the member's call begin executing the TwiML document at that URL\nWhen dequeuing the 'Front' of the queue, the next call in the queue will be redirected.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "QueueSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/member"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "Member was already dequed."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}{mediaTypeExtension}": {
"get": {
"description": "Get a specific member.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "QueueSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CallSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/member"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Posting a URL and Method to a Queue instance will dequeue a member from a\nqueue and have the member's call begin executing the TwiML document at that URL\nWhen redirecting a member of a queue addressed by CallSid, only the first request\nwill succeed and return a 200 response code. A second request will fail and\nreturn an appropriate 400 response code.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "QueueSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CallSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/member"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "Member was already dequed."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/Queues/{QueueSid}/Members{mediaTypeExtension}": {
"get": {
"description": "Returns the list of members in the queue identified by {QueueSid}.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "QueueSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/members"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Queues/{QueueSid}{mediaTypeExtension}": {
"delete": {
"description": "The DELETE method allows you to remove a Queue. Only empty queues are\ndeletable.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "QueueSid",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Queue removed."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to delete the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't DELETE the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't delete the resource. Please try again."
}
}
},
"get": {
"description": "Get resource's individual Queue instance.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "QueueSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/queue"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "This POST request allows you to change the FriendlyName or MaxSize.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "QueueSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/queue"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/Queues{mediaTypeExtension}": {
"get": {
"description": "Returns a list of queues within an account. The list includes paging\ninformation.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/queues"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Create a new Queue resource.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n"
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/queue"
}
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions{mediaTypeExtension}": {
"get": {
"description": "Returns a set of Transcription resource representations that includes paging\ninformation.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "RecordingSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/transcriptions"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Recordings/{RecordingSid}{mediaTypeExtension}": {
"delete": {
"description": "Deletes a recording from your account.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".wav",
"description": "",
"enum": [
".xml",
".wav",
".mp3"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "RecordingSid",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Deletion successful."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to delete the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't DELETE the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't delete the resource. Please try again."
}
}
},
"get": {
"description": "Returns one of several representations:\nWithout an extension, or with a \".wav\", a binary WAV audio file is returned\nwith mime-type \"audio/x-wav\".\nAppending \".mp3\" to the URI returns a binary MP3 audio file with mime-type\ntype \"audio/mpeg\".\nAppending \".xml\" to the URI returns a XML representation.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".wav",
"description": "",
"enum": [
".xml",
".wav",
".mp3"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "RecordingSid",
"required": true,
"type": "string"
}
],
"produces": [
"audio/x-wav",
"application/xml",
"audio/mpeg"
],
"responses": {
"200": {
"description": "A binary WAV audio file is returned."
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Recordings{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns a list of Recording resource representations, each representing a\nrecording generated during the course of a phone call.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/recordings"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/SIP/CredentialLists/{CLSid}/Credentials/{CredentialSid}{mediaTypeExtension}": {
"delete": {
"description": "Remove a Credential from a CredentialList.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CLSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CredentialSid",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "The request was successful; the resource was deleted."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to delete the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't DELETE the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't delete the resource. Please try again."
}
}
},
"get": {
"description": "Get a specific Credential in a list. Though a password is stored for each username in your list, the password is not returned to protect your password. If you cannot remember your password, you will need to POST to this resource to update it.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CLSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CredentialSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/credential"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Change the password of a Credential record.\n\nIf the change is successful, Twilio will respond with the Credential record but will not include the password in the response.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CLSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CredentialSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/credential"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/SIP/CredentialLists/{CLSid}/Credentials{mediaTypeExtension}": {
"get": {
"description": "Get the list of Credentials in a CredentialList. The passwords for the Credentials are intentionally not returned so as to protect them.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CLSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/credentials"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Add a Credential to the CredentialList.\n\nWhen creating a Credential, you will POST both a username and password, but only receive the username back in the response. The password is intentionally not returned so as to protect it.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CLSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n"
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/credential"
}
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/SIP/CredentialLists/{CLSid}{mediaTypeExtension}": {
"delete": {
"description": "Delete a CredentialList from your account. It can only be deleted if no domains are mapped to it. If you attempt to delete one that is mapped to a domain, you will receive an error.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CLSid",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "The request was successful; the resource was deleted."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to delete the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't DELETE the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't delete the resource. Please try again."
}
}
},
"get": {
"description": "Get a credential list instance resource",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CLSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/credentialList"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Change the FriendlyName of the list",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CLSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/credentialList"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/SIP/CredentialLists{mediaTypeExtension}": {
"get": {
"description": "Gets a list of Credential Lists for an account",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/credentialLists"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Create a new Credential List.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n"
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/credentialList"
}
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/SIP/Domains/{SipDomainSid}/CredentialListMappings/{CLSid}{mediaTypeExtension}": {
"delete": {
"description": "Remove a CredentialListMapping from a domain",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "SipDomainSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "CLSid",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "The request was successful; the resource was deleted."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to delete the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't DELETE the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't delete the resource. Please try again."
}
}
}
},
"/Accounts/{AccountSid}/SIP/Domains/{SipDomainSid}/CredentialListMappings{mediaTypeExtension}": {
"get": {
"description": "Get the user lists mapped to this domain.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "SipDomainSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/credentialListMappings"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Map a CredentialList to the domain.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "SipDomainSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n"
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/credentialListMapping"
}
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/SIP/Domains/{SipDomainSid}/IpAccessControlListMappings/{ALSid}{mediaTypeExtension}": {
"delete": {
"description": "Remove a mapping from this domain.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "SipDomainSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "ALSid",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "The request was successful; the resource was deleted."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to delete the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't DELETE the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't delete the resource. Please try again."
}
}
},
"get": {
"description": "Return a specific IpAccessControlListMapping instance by Sid.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "SipDomainSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "ALSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/ipAccessControlListMapping"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/SIP/Domains/{SipDomainSid}/IpAccessControlListMappings{mediaTypeExtension}": {
"get": {
"description": "Return the IpAccessControlListMappings that are associated to this domain.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "SipDomainSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Map an IpAccessControlList to this domain.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "SipDomainSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"201": {
"description": "Created"
}
}
}
},
"/Accounts/{AccountSid}/SIP/Domains/{SipDomainSid}{mediaTypeExtension}": {
"delete": {
"description": "Delete a domain. If you have created subdomains of a domain, you will not be able to delete the domain until you first delete all subdomains of it.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "SipDomainSid",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "The request was successful; the resource was deleted."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to delete the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't DELETE the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't delete the resource. Please try again."
}
}
},
"get": {
"description": "Return a specific instance by Sid.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "SipDomainSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/domain"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"description": "Update the attributes of a domain.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "SipDomainSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/domain"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/SIP/Domains{mediaTypeExtension}": {
"get": {
"description": "Returns a paged list of the domains for an account.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/domains"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Creates a new Domain and returns its instance resource. You must pick a unique domain name that ends in \".sip.twilio.com\".\nAfter creating a Domain, you must map it to an authentication method before the domain is ready to receive traffic.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n"
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/domain"
}
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses/{IpAddressSid}{mediaTypeExtension}": {
"delete": {
"description": "Deletes an IP address entry from the list.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "IpAccessControlListSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "IpAddressSid",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "The request was successful; the resource was deleted."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to delete the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't DELETE the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't delete the resource. Please try again."
}
}
},
"get": {
"description": "Return a single IP Address resource.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "IpAccessControlListSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "IpAddressSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/ipAddress"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Change the description or IP address of a given IpAddress instance resource",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "IpAccessControlListSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "IpAddressSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/ipAddress"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses{mediaTypeExtension}": {
"get": {
"description": "List the IP Addresses contained in this list.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "IpAccessControlListSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/ipAddresses"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Add an IP Address to the list with a description.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "IpAccessControlListSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n"
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/ipAddress"
}
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}{mediaTypeExtension}": {
"delete": {
"description": "Delete an IpAccessControlList from your account. It can only be deleted if no domains are mapped to it. If you attempt to delete one that is mapped to a domain, you will receive an error.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "IpAccessControlListSid",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "The request was successful; the resource was deleted."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to delete the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't DELETE the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't delete the resource. Please try again."
}
}
},
"get": {
"description": "Return a specific IpAccessControlList resource.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "IpAccessControlListSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/ipAccessControlListMapping"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Rename an IpAccessControlList.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "IpAccessControlListSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/ipAccessControlListMapping"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/SIP/IpAccessControlLists{mediaTypeExtension}": {
"get": {
"description": "Return a paged list of all IpAccessControlLists under this account.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"responses": {
"200": {
"description": "OK"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Create a new IpAccessControlList resource.\n\nWhen created, the list will contain no IP addresses. You will need to add IP addresses to the list for it to be active. To add IP addresses, you will need to POST to the IpAddresses List subresource.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"201": {
"description": "Created",
"schema": {
"$ref": "#/definitions/ipAccessControlListMapping"
}
}
}
}
},
"/Accounts/{AccountSid}/SMS/ShortCodes/{ShortCodeSid}{mediaTypeExtension}": {
"get": {
"description": "Get a single message.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "ShortCodeSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/shortCode"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Tries to update the shortcode's properties, and returns the updated\nresource representation if successful.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "ShortCodeSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/shortCode"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/SMS/ShortCodes{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns a list of ShortCode resource representations, each representing a\nshort code within your account. The list includes paging information.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/shortCodes"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Transcriptions/{TranscriptionSid}{mediaTypeExtension}": {
"delete": {
"description": "Deletes a transcription from your account.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".json",
".csv",
".html",
".txt",
".xml"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "TranscriptionSid",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "Deletion successful."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to delete the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't DELETE the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't delete the resource. Please try again."
}
}
},
"get": {
"description": "Returns a single Transcription resource representation identified by the\ngiven {TranscriptionSid}. By default Twilio will respond with the XML metadata for the Transcription. If you append \".txt\" to the end of the Transcription resource's URI Twilio will just return you the transcription tex.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".json",
".csv",
".html",
".txt",
".xml"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "TranscriptionSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml",
"application/text"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/transcription"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Transcriptions{mediaTypeExtension}": {
"get": {
"description": "Returns a set of Transcription resource representations that includes paging\ninformation.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/transcriptions"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Usage/Records/{Subresource}{mediaTypeExtension}": {
"get": {
"description": "Returns UsageRecords for all usage categories for a specified period.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"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 today's usage only.|\n||Yesterday|Return a single UsageRecord per usage category, for yesterday's usage only.|\n|ThisMonth|Return a single UsageRecord per usage category, for this month's usage only.|\n|LastMonth|Return a single UsageRecord per usage category, for last month's usage only.|\n",
"enum": [
"Daily",
"Monthly",
"Yearly",
"AllTime",
"Today",
"Yesterday",
"ThisMonth",
"LastMonth"
],
"in": "path",
"name": "Subresource",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/usageRecords"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Usage/Records{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns UsageRecords for all usage categories. The list includes paging\ninformation.\nBy default, the UsageRecords resource will return one UsageRecord for\neach Category, representing all usage accrued all-time for the account.\nYou can filter the usage Category or change the date-range over which usage\nis counted using optional GET query parameters.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/usageRecords"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
}
},
"/Accounts/{AccountSid}/Usage/Triggers/{UsageTriggerSid}{mediaTypeExtension}": {
"delete": {
"description": "Delete this UsageTrigger.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "UsageTriggerSid",
"required": true,
"type": "string"
}
],
"responses": {
"204": {
"description": "UsageTrigger was deleted."
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to delete the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't DELETE the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't delete the resource. Please try again."
}
}
},
"get": {
"description": "Returns a repesentation of the UsageTrigger.",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "UsageTriggerSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/usageTrigger"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Tries to update the UsageTrigger's properties, and returns the updated\nresource representation if successful.\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"in": "path",
"name": "UsageTriggerSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/usageTrigger"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}/Usage/Triggers{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Returns a list of UsageTrigger resource representations. The list includes\npaging information.\nBy default, all UsageTriggers are returned. You can filter the list by\nspecifying one or more query parameters. Note that the query parameters are\ncase-sensitive\n",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/usageTriggers"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"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",
"parameters": [
{
"in": "path",
"name": "AccountSid",
"required": true,
"type": "string"
},
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n"
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/usageTrigger"
}
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts/{AccountSid}{mediaTypeExtension}": {
"get": {
"description": "Returns a representation of an account.",
"parameters": [
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"description": "A 34 character string that uniquely identifies this account.",
"in": "path",
"maxLength": 34,
"minLength": 34,
"name": "AccountSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/account"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Allows you to modify the properties of an account.",
"parameters": [
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"description": "A 34 character string that uniquely identifies this account.",
"in": "path",
"maxLength": 34,
"minLength": 34,
"name": "AccountSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/account"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
},
"put": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Allows you to modify the properties of an account.",
"parameters": [
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
},
{
"description": "A 34 character string that uniquely identifies this account.",
"in": "path",
"maxLength": 34,
"minLength": 34,
"name": "AccountSid",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/account"
}
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n"
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
},
"/Accounts{mediaTypeExtension}": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Retrieve a list of the Account resources belonging to the account used to make the\nAPI request. This list will include that Account as well.\n",
"parameters": [
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful and the response body contains the representation\nrequested.\n",
"schema": {
"$ref": "#/definitions/accounts"
}
},
"302": {
"description": "A common redirect response; you can GET the representation at the URI\nin the Location response header.\n"
},
"304": {
"description": "Your client's cached version of the representation is still up to date.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to access the resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
},
"503": {
"description": "We are temporarily unable to return the representation. Please wait for\na bit and try again.\n"
}
}
},
"post": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Create a new Account instance resource as a subaccount of the one used to make the request. See\nCreating Subaccounts for more information.\n",
"parameters": [
{
"default": ".xml",
"description": "By default, Twilio's REST API returns XML. You may obtain CSV, JSON or HTML by appending \".csv\", \".json\", or \".html\".\n",
"enum": [
".xml",
".json",
".csv",
".html"
],
"in": "path",
"name": "mediaTypeExtension",
"required": true,
"type": "string"
}
],
"produces": [
"application/xml"
],
"responses": {
"200": {
"description": "The request was successful, we updated the resource and the response\nbody contains the representation.\n"
},
"201": {
"description": "The request was successful, we created a new resource and the response\nbody contains the representation.\n",
"schema": {
"$ref": "#/definitions/account"
}
},
"400": {
"description": "The data given in the POST or PUT failed validation. Inspect the response\nbody for details.\n"
},
"401": {
"description": "The supplied credentials, if any, are not sufficient to create or update\nthe resource.\n"
},
"404": {
"description": "NOT FOUND."
},
"405": {
"description": "You can't POST or PUT to the resource."
},
"429": {
"description": "Your application is sending too many simultaneous requests."
},
"500": {
"description": "We couldn't return the representation due to an internal server error.\n"
}
}
}
}
},
"definitions": {
"account": {
"properties": {
"auth_token": {
"type": "string"
},
"date_created": {
"description": "The date that this account was created, in GMT in RFC 2822 format",
"type": "string"
},
"date_updated": {
"description": "The date that this account was last updated, in GMT in RFC 2822 format.",
"type": "string"
},
"friendly_name": {
"description": "A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address.",
"type": "string"
},
"sid": {
"description": "A 34 character string that uniquely identifies this account.",
"type": "string"
},
"status": {
"description": "The status of this account. Usually active, but can be suspended or closed.",
"type": "string"
},
"subresource_uris": {
"type": "object"
},
"type": {
"description": "The type of this account. Either Trial or Full if you've upgraded.",
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"accounts": {
"properties": {
"accounts": {
"items": {
"properties": {
"date_created": {
"description": "The date that this account was created, in GMT in RFC 2822 format",
"type": "string"
},
"date_updated": {
"description": "The date that this account was last updated, in GMT in RFC 2822 format.",
"type": "string"
},
"friendly_name": {
"description": "A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address.",
"type": "string"
},
"sid": {
"description": "A 34 character string that uniquely identifies this account.",
"type": "string"
},
"status": {
"description": "The status of this account. Usually active, but can be suspended or closed.",
"type": "string"
},
"type": {
"description": "The type of this account. Either Trial or Full if you've upgraded.",
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"end": {
"type": "number"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "null"
},
"num_pages": {
"type": "number"
},
"page": {
"type": "number"
},
"page_size": {
"type": "number"
},
"previous_page_uri": {
"type": "null"
},
"start": {
"type": "number"
},
"total": {
"type": "number"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"appResource": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"sid": {
"type": "string"
},
"sms_fallback_method": {
"type": "string"
},
"sms_fallback_url": {
"type": "string"
},
"sms_method": {
"type": "string"
},
"sms_status_callback": {
"type": "string"
},
"sms_url": {
"type": "string"
},
"status_callback": {
"type": "string"
},
"status_callback_method": {
"type": "string"
},
"uri": {
"type": "string"
},
"voice_caller_id_lookup": {
"type": "string"
},
"voice_fallback_method": {
"type": "string"
},
"voice_fallback_url": {
"type": "string"
},
"voice_method": {
"type": "string"
},
"voice_url": {
"type": "string"
}
},
"type": "object"
},
"appResources": {
"properties": {
"applications": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"sid": {
"type": "string"
},
"sms_fallback_method": {
"type": "string"
},
"sms_fallback_url": {
"type": "string"
},
"sms_method": {
"type": "string"
},
"sms_status_callback": {
"type": "string"
},
"sms_url": {
"type": "string"
},
"status_callback": {
"type": "string"
},
"status_callback_method": {
"type": "string"
},
"uri": {
"type": "string"
},
"voice_caller_id_lookup": {
"type": "string"
},
"voice_fallback_method": {
"type": "string"
},
"voice_fallback_url": {
"type": "string"
},
"voice_method": {
"type": "string"
},
"voice_url": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"end": {
"type": "integer"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "string"
},
"num_pages": {
"type": "integer"
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"previous_page_uri": {
"type": "string"
},
"start": {
"type": "integer"
},
"total": {
"type": "integer"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"application": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"sid": {
"type": "string"
},
"sms_fallback_method": {
"type": "string"
},
"sms_fallback_url": {
"type": "object"
},
"sms_method": {
"type": "string"
},
"sms_status_callback": {
"type": "object"
},
"sms_url": {
"type": "object"
},
"status_callback": {
"type": "object"
},
"status_callback_method": {
"type": "object"
},
"uri": {
"type": "string"
},
"voice_caller_id_lookup": {
"type": "object"
},
"voice_fallback_method": {
"type": "string"
},
"voice_fallback_url": {
"type": "object"
},
"voice_method": {
"type": "string"
},
"voice_url": {
"type": "string"
}
},
"type": "object"
},
"applications": {
"properties": {
"applications": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"sid": {
"type": "string"
},
"sms_fallback_method": {
"type": "object"
},
"sms_fallback_url": {
"type": "object"
},
"sms_method": {
"type": "object"
},
"sms_status_callback": {
"type": "object"
},
"sms_url": {
"type": "object"
},
"status_callback": {
"type": "object"
},
"status_callback_method": {
"type": "object"
},
"uri": {
"type": "string"
},
"voice_caller_id_lookup": {
"type": "object"
},
"voice_fallback_method": {
"type": "object"
},
"voice_fallback_url": {
"type": "object"
},
"voice_method": {
"type": "string"
},
"voice_url": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"end": {
"type": "number"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "object"
},
"num_pages": {
"type": "number"
},
"page": {
"type": "number"
},
"page_size": {
"type": "number"
},
"previous_page_uri": {
"type": "object"
},
"start": {
"type": "number"
},
"total": {
"type": "number"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"authApp": {
"properties": {
"account_sid": {
"type": "string"
},
"connect_app_company_name": {
"type": "string"
},
"connect_app_description": {
"type": "string"
},
"connect_app_friendly_name": {
"type": "string"
},
"connect_app_homepage_url": {
"type": "string"
},
"connect_app_sid": {
"type": "string"
},
"permissions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"authApps": {
"properties": {
"authorized_connect_apps": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"connect_app_company_name": {
"type": "string"
},
"connect_app_description": {
"type": "string"
},
"connect_app_friendly_name": {
"type": "string"
},
"connect_app_homepage_url": {
"type": "string"
},
"connect_app_sid": {
"type": "string"
},
"permissions": {
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
},
"end": {
"type": "integer"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "string"
},
"num_pages": {
"type": "integer"
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"previous_page_uri": {
"type": "string"
},
"start": {
"type": "integer"
},
"total": {
"type": "integer"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"availablePhoneNumbers": {
"properties": {
"available_phone_numbers": {
"items": {
"properties": {
"capabilities": {
"properties": {
"MMS": {
"type": "string"
},
"SMS": {
"type": "string"
},
"voice": {
"type": "string"
}
},
"type": "object"
},
"friendly_name": {
"type": "string"
},
"iso_country": {
"type": "string"
},
"lata": {
"type": "string"
},
"latitude": {
"type": "string"
},
"longitude": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"rate_center": {
"type": "string"
},
"region": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"call": {
"properties": {
"account_sid": {
"description": "The unique id of the Account responsible for creating this call.",
"type": "string"
},
"answered_by": {
"type": "string"
},
"api_version": {
"type": "string"
},
"caller_name": {
"type": "string"
},
"date_created": {
"description": "GMT in RFC 2822 format.",
"type": "string"
},
"date_updated": {
"type": "string"
},
"direction": {
"type": "string"
},
"duration": {
"type": "string"
},
"end_time": {
"description": "Given as GMT in RFC 2822 format.",
"type": "string"
},
"formatted_from": {
"type": "string"
},
"formatted_to": {
"type": "string"
},
"forwarded_from": {
"type": "string"
},
"from": {
"description": "The phone number, SIP address or Client identifier that made this call. Phone numbers are in E.164 format (e.g. +16175551212).",
"type": "string"
},
"parent_call_sid": {
"maxLength": 34,
"minLength": 34,
"type": "string"
},
"phone_number_sid": {
"type": "string"
},
"price": {
"type": "string"
},
"sid": {
"maxLength": 34,
"minLength": 34,
"type": "string"
},
"start_time": {
"description": "Given as GMT in RFC 2822 format.",
"type": "string"
},
"status": {
"enum": [
"queued",
"ringing",
"in-progress",
"canceled",
"completed",
"failed",
"busy",
"no-answer"
]
},
"subresource_uris": {
"properties": {
"notifications": {
"type": "string"
},
"recordings": {
"type": "string"
}
},
"type": "object"
},
"to": {
"description": "Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formated as name@company.com. Client identifiers are formatted client:name.",
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"callInstance": {
"properties": {
"account_sid": {
"description": "The unique id of the Account responsible for creating this call.",
"type": "string"
},
"answered_by": {
"description": "If this call was initiated with answering machine detection, either human or machine. Empty otherwise.",
"enum": [
"null",
"human",
"machine"
]
},
"api_version": {
"type": "string"
},
"caller_name": {
"description": "If this call was an incoming call to a phone number with Caller ID Lookup enabled, the caller's name. Empty otherwise.",
"type": "string"
},
"date_created": {
"description": "GMT in RFC 2822 format.",
"type": "string"
},
"date_updated": {
"type": "string"
},
"direction": {
"description": "A string describing the direction of the call. inbound for inbound calls, outbound-api for calls initiated via the REST API or outbound-dial for calls initiated by a <Dial> verb.",
"enum": [
"inbound",
"outbound-api",
"outbound-dial"
]
},
"duration": {
"description": "The length of the call in seconds.",
"type": "string"
},
"end_time": {
"description": "Given as GMT in RFC 2822 format.",
"type": "string"
},
"forwarded_from": {
"description": "If this call was an incoming call forwarded from another number, the forwarding phone number (depends on carrier supporting forwarding). Empty otherwise.",
"type": "string"
},
"from": {
"description": "The phone number, SIP address or Client identifier that made this call. Phone numbers are in E.164 format (e.g. +16175551212).",
"type": "string"
},
"parent_call_sid": {
"maxLength": 34,
"minLength": 34,
"type": "string"
},
"phone_number_sid": {
"description": "If the call was inbound, this is the Sid of the IncomingPhoneNumber that received the call. If the call was outbound, it is the Sid of the OutgoingCallerId from which the call was placed.",
"type": "string"
},
"price": {
"description": "The charge for this call, in the currency associated with the account. Populated after the call is completed. May not be immediately available.",
"type": "string"
},
"price_unit": {
"description": "The currency in which Price is measured, in ISO 4127 format.",
"type": "string"
},
"sid": {
"maxLength": 34,
"minLength": 34,
"type": "string"
},
"start_time": {
"description": "Given as GMT in RFC 2822 format.",
"type": "string"
},
"status": {
"description": "A string representing the status of the call.",
"enum": [
"queued",
"ringing",
"in-progress",
"canceled",
"completed",
"failed",
"busy",
"no-answer"
]
},
"subresource_uris": {
"type": "object"
},
"to": {
"description": "Phone numbers are in E.164 format (e.g. +16175551212). SIP addresses are formated as name@company.com. Client identifiers are formatted client:name.",
"type": "string"
},
"uri": {
"description": "The URI for this resource, relative to https://api.twilio.com",
"type": "string"
}
},
"type": "object"
},
"calls": {
"properties": {
"calls": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"answered_by": {
"type": "object"
},
"api_version": {
"type": "string"
},
"caller_name": {
"type": "object"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"direction": {
"type": "string"
},
"duration": {
"type": "string"
},
"end_time": {
"type": "string"
},
"forwarded_from": {
"type": "object"
},
"from": {
"type": "string"
},
"from_formatted": {
"type": "string"
},
"parent_call_sid": {
"type": "object"
},
"phone_number_sid": {
"type": "string"
},
"price": {
"type": "string"
},
"sid": {
"type": "string"
},
"start_time": {
"type": "string"
},
"status": {
"type": "string"
},
"subresource_uris": {
"properties": {
"notifications": {
"type": "string"
},
"recordings": {
"type": "string"
}
},
"type": "object"
},
"to": {
"type": "string"
},
"to_formatted": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"end": {
"type": "number"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "string"
},
"num_pages": {
"type": "number"
},
"page": {
"type": "number"
},
"page_size": {
"type": "number"
},
"previous_page_uri": {
"type": "object"
},
"start": {
"type": "number"
},
"total": {
"type": "number"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"conference": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"sid": {
"type": "string"
},
"status": {
"enum": [
"init",
"in-progress",
"completed"
]
},
"subresource_uris": {
"properties": {
"participants": {
"type": "string"
}
},
"type": "object"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"conferences": {
"properties": {
"conferences": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"sid": {
"type": "string"
},
"status": {
"type": "string"
},
"subresource_uris": {
"properties": {
"participants": {
"type": "string"
}
},
"type": "object"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"end": {
"type": "integer"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "string"
},
"num_pages": {
"type": "integer"
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"previous_page_uri": {
"type": "string"
},
"start": {
"type": "integer"
},
"total": {
"type": "integer"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"connectApp": {
"properties": {
"account_sid": {
"type": "string"
},
"authorize_redirect_url": {
"type": "string"
},
"company_name": {
"type": "string"
},
"deauthorize_callback_method": {
"type": "string"
},
"deauthorize_callback_url": {
"type": "string"
},
"description": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"homepage_url": {
"type": "string"
},
"permissions": {
"items": {
"type": "string"
},
"type": "array"
},
"sid": {
"type": "string"
}
},
"type": "object"
},
"connectApps": {
"properties": {
"connect_apps": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"authorize_redirect_url": {
"type": "string"
},
"company_name": {
"type": "string"
},
"deauthorize_callback_method": {
"type": "string"
},
"deauthorize_callback_url": {
"type": "string"
},
"description": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"homepage_url": {
"type": "string"
},
"permissions": {
"items": {
"type": "string"
},
"type": "array"
},
"sid": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"end": {
"type": "integer"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "string"
},
"num_pages": {
"type": "integer"
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"previous_page_uri": {
"type": "string"
},
"start": {
"type": "integer"
},
"total": {
"type": "integer"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"credential": {
"properties": {
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"sid": {
"type": "string"
},
"uri": {
"type": "string"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"credentialList": {
"properties": {
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"sid": {
"type": "string"
},
"subresource_uris": {
"properties": {
"credentials": {
"type": "string"
}
},
"type": "object"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"credentialListMapping": {
"properties": {
"account_sid": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"sid": {
"type": "string"
},
"subresource_uris": {
"properties": {
"credentials": {
"type": "string"
}
},
"type": "object"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"credentialListMappings": {
"properties": {
"credential_list_mappings": {
"items": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"sid": {
"type": "string"
},
"subresource_uris": {
"properties": {
"credentials": {
"type": "string"
}
},
"type": "object"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"type": "array"
},
"end": {
"type": "number"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "object"
},
"num_pages": {
"type": "number"
},
"page": {
"type": "number"
},
"page_size": {
"type": "number"
},
"previous_page_uri": {
"type": "object"
},
"start": {
"type": "number"
},
"total": {
"type": "number"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"credentialLists": {
"properties": {
"credential_lists": {
"items": {
"properties": {
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"sid": {
"type": "string"
},
"subresource_uris": {
"properties": {
"credentials": {
"type": "string"
}
},
"type": "object"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"end": {
"type": "number"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "object"
},
"num_pages": {
"type": "number"
},
"page": {
"type": "number"
},
"page_size": {
"type": "number"
},
"previous_page_uri": {
"type": "object"
},
"start": {
"type": "number"
},
"total": {
"type": "number"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"credentials": {
"properties": {
"credentials": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"credential_list_sid": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"sid": {
"type": "string"
},
"uri": {
"type": "string"
},
"username": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"end": {
"type": "number"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "object"
},
"num_pages": {
"type": "number"
},
"page": {
"type": "number"
},
"page_size": {
"type": "number"
},
"previous_page_uri": {
"type": "object"
},
"start": {
"type": "number"
},
"total": {
"type": "number"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"domain": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"auth_type": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"domain_name": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"sid": {
"type": "string"
},
"subresource_uris": {
"properties": {
"credential_list_mappings": {
"type": "string"
},
"ip_access_control_list_mappings": {
"type": "string"
}
},
"type": "object"
},
"uri": {
"type": "string"
},
"voice_fallback_method": {
"type": "string"
},
"voice_fallback_url": {
"type": "object"
},
"voice_method": {
"type": "string"
},
"voice_status_callback_method": {
"type": "string"
},
"voice_status_callback_url": {
"type": "object"
},
"voice_url": {
"type": "string"
}
},
"type": "object"
},
"domains": {
"properties": {
"end": {
"type": "number"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "object"
},
"num_pages": {
"type": "number"
},
"page": {
"type": "number"
},
"page_size": {
"type": "number"
},
"previous_page_uri": {
"type": "object"
},
"sip_domains": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"auth_type": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"domain_name": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"sid": {
"type": "string"
},
"subresource_uris": {
"properties": {
"credential_list_mappings": {
"type": "string"
},
"ip_access_control_list_mappings": {
"type": "string"
}
},
"type": "object"
},
"uri": {
"type": "string"
},
"voice_fallback_method": {
"type": "string"
},
"voice_fallback_url": {
"type": "object"
},
"voice_method": {
"type": "string"
},
"voice_status_callback_method": {
"type": "string"
},
"voice_status_callback_url": {
"type": "object"
},
"voice_url": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"start": {
"type": "number"
},
"total": {
"type": "number"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"incomingCall": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"capabilities": {
"properties": {
"sms": {
"type": "string"
},
"voice": {
"type": "string"
}
},
"type": "object"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"sid": {
"type": "string"
},
"sms_application_sid": {
"type": "string"
},
"sms_fallback_method": {
"type": "string"
},
"sms_fallback_url": {
"type": "string"
},
"sms_method": {
"type": "string"
},
"sms_url": {
"type": "string"
},
"status_callback": {
"type": "string"
},
"status_callback_method": {
"type": "string"
},
"uri": {
"type": "string"
},
"voice_application_sid": {
"type": "string"
},
"voice_caller_id_lookup": {
"type": "string"
},
"voice_fallback_method": {
"type": "string"
},
"voice_fallback_url": {
"type": "string"
},
"voice_method": {
"type": "string"
},
"voice_url": {
"type": "string"
}
},
"type": "object"
},
"incomingCalls": {
"properties": {
"end": {
"type": "number"
},
"first_page_uri": {
"type": "string"
},
"incoming_phone_numbers": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"capabilities": {
"properties": {
"sms": {
"type": "boolean"
},
"voice": {
"type": "boolean"
}
},
"type": "object"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"sid": {
"type": "string"
},
"sms_application_sid": {
"type": "string"
},
"sms_fallback_method": {
"type": "object"
},
"sms_fallback_url": {
"type": "object"
},
"sms_method": {
"type": "object"
},
"sms_url": {
"type": "object"
},
"status_callback": {
"type": "object"
},
"status_callback_method": {
"type": "object"
},
"uri": {
"type": "string"
},
"voice_application_sid": {
"type": "object"
},
"voice_caller_id_lookup": {
"type": "object"
},
"voice_fallback_method": {
"type": "object"
},
"voice_fallback_url": {
"type": "object"
},
"voice_method": {
"type": "string"
},
"voice_url": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "object"
},
"num_pages": {
"type": "number"
},
"page": {
"type": "number"
},
"page_size": {
"type": "number"
},
"previous_page_uri": {
"type": "object"
},
"start": {
"type": "number"
},
"total": {
"type": "number"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"ipAccessControlList": {
"properties": {
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"sid": {
"type": "string"
},
"subresource_uris": {
"properties": {
"addresses": {
"type": "string"
}
},
"type": "object"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"ipAccessControlListMapping": {
"properties": {
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"sid": {
"type": "string"
},
"subresource_uris": {
"properties": {
"addresses": {
"type": "string"
}
},
"type": "object"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"ipAccessControlListMappings": {
"properties": {
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"sid": {
"type": "string"
},
"subresource_uris": {
"properties": {
"addresses": {
"type": "string"
}
},
"type": "object"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"ipAddress": {
"properties": {
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"ip_address": {
"type": "string"
},
"sid": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"ipAddresses": {
"properties": {
"end": {
"type": "number"
},
"first_page_uri": {
"type": "string"
},
"ip_addresses": {
"items": {
"properties": {
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"ip_address": {
"type": "string"
},
"sid": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "object"
},
"num_pages": {
"type": "number"
},
"page": {
"type": "number"
},
"page_size": {
"type": "number"
},
"previous_page_uri": {
"type": "object"
},
"start": {
"type": "number"
},
"total": {
"type": "number"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"media": {
"properties": {
"account_sid": {
"type": "string"
},
"content-type": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"parent_sid": {
"type": "string"
},
"sid": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"mediaList": {
"properties": {
"end": {
"type": "number"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"media_list": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"content_type": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"parent_sid": {
"type": "string"
},
"sid": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"next_page_uri": {
"type": "object"
},
"num_pages": {
"type": "number"
},
"page": {
"type": "number"
},
"page_size": {
"type": "number"
},
"previous_page_uri": {
"type": "object"
},
"start": {
"type": "number"
},
"total": {
"type": "number"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"member": {
"properties": {
"call_sid": {
"type": "string"
},
"date_enqueued": {
"type": "string"
},
"position": {
"type": "integer"
},
"uri": {
"type": "string"
},
"wait_time": {
"type": "integer"
}
},
"type": "object"
},
"members": {
"properties": {
"end": {
"type": "integer"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "string"
},
"num_pages": {
"type": "integer"
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"previous_page_uri": {
"type": "string"
},
"queue_members": {
"items": {
"properties": {
"call_sid": {
"type": "string"
},
"date_enqueued": {
"type": "string"
},
"position": {
"type": "integer"
},
"uri": {
"type": "string"
},
"wait_time": {
"type": "integer"
}
},
"type": "object"
},
"type": "array"
},
"start": {
"type": "integer"
},
"total": {
"type": "integer"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"message": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"body": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_sent": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"direction": {
"type": "string"
},
"from": {
"type": "string"
},
"num_media": {
"type": "string"
},
"num_segments": {
"type": "string"
},
"price": {
"type": "string"
},
"sid": {
"type": "string"
},
"status": {
"type": "string"
},
"to": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"messages": {
"properties": {
"end": {
"type": "number"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"messages": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"body": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_sent": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"direction": {
"type": "string"
},
"from": {
"type": "string"
},
"num_media": {
"type": "string"
},
"num_segments": {
"type": "string"
},
"price": {
"type": "string"
},
"sid": {
"type": "string"
},
"status": {
"type": "string"
},
"to": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"next_page_uri": {
"type": "string"
},
"num_pages": {
"type": "number"
},
"page": {
"type": "number"
},
"page_size": {
"type": "number"
},
"previous_page_uri": {
"type": "object"
},
"start": {
"type": "number"
},
"total": {
"type": "number"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"mobilePhoneNumbers": {
"properties": {
"available_phone_numbers": {
"items": {
"properties": {
"capabilities": {
"properties": {
"MMS": {
"type": "string"
},
"SMS": {
"type": "string"
},
"voice": {
"type": "string"
}
},
"type": "object"
},
"friendly_name": {
"type": "string"
},
"iso_country": {
"type": "string"
},
"lata": {
"type": "object"
},
"latitude": {
"type": "object"
},
"longitude": {
"type": "object"
},
"phone_number": {
"type": "string"
},
"postal_code": {
"type": "object"
},
"rate_center": {
"type": "object"
},
"region": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"notification": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"call_sid": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"error_code": {
"type": "string"
},
"log": {
"type": "string"
},
"message_date": {
"type": "string"
},
"message_text": {
"type": "string"
},
"more_info": {
"type": "string"
},
"request_method": {
"type": "string"
},
"request_url": {
"type": "string"
},
"request_variables": {
"type": "string"
},
"response_body": {
"type": "string"
},
"response_headers": {
"type": "string"
},
"sid": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"notifications": {
"properties": {
"end": {
"type": "integer"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "string"
},
"notifications": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"call_sid": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"error_code": {
"type": "string"
},
"log": {
"type": "string"
},
"message_date": {
"type": "string"
},
"message_text": {
"type": "string"
},
"more_info": {
"type": "string"
},
"request_method": {
"type": "string"
},
"request_url": {
"type": "string"
},
"request_variables": {
"type": "string"
},
"response_body": {
"type": "string"
},
"response_headers": {
"type": "string"
},
"sid": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"num_pages": {
"type": "integer"
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"previous_page_uri": {
"type": "string"
},
"start": {
"type": "integer"
},
"total": {
"type": "integer"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"outCaller": {
"properties": {
"account_sid": {
"type": "string"
},
"call_sid": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"validation_code": {
"type": "integer"
}
},
"type": "object"
},
"outCallerId": {
"properties": {
"account_sid": {
"type": "string"
},
"call_sid": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"validation_code": {
"type": "integer"
}
},
"type": "object"
},
"outCallerIds": {
"properties": {
"end": {
"type": "integer"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "string"
},
"num_pages": {
"type": "integer"
},
"outgoing_caller_ids": {
"properties": {
"account_sid": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"sid": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"previous_page_uri": {
"type": "string"
},
"start": {
"type": "integer"
},
"total": {
"type": "integer"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"outgoingCallerId": {
"properties": {
"account_sid": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"sid": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"participant": {
"properties": {
"account_sid": {
"type": "string"
},
"call_sid": {
"type": "string"
},
"conference_sid": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"end_conference_on_exit": {
"type": "boolean"
},
"muted": {
"type": "boolean"
},
"start_conference_on_enter": {
"type": "boolean"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"participants": {
"properties": {
"end": {
"type": "integer"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "string"
},
"num_pages": {
"type": "integer"
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"participants": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"call_sid": {
"type": "string"
},
"conference_sid": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"end_conference_on_exit": {
"type": "boolean"
},
"muted": {
"type": "boolean"
},
"start_conference_on_enter": {
"type": "boolean"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"previous_page_uri": {
"type": "string"
},
"start": {
"type": "integer"
},
"total": {
"type": "integer"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"phoneLocalNumbers": {
"properties": {
"available_phone_numbers": {
"items": {
"properties": {
"capabilities": {
"properties": {
"MMS": {
"type": "string"
},
"SMS": {
"type": "string"
},
"voice": {
"type": "string"
}
},
"type": "object"
},
"friendly_name": {
"type": "string"
},
"iso_country": {
"type": "string"
},
"lata": {
"type": "string"
},
"latitude": {
"type": "string"
},
"longitude": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"postal_code": {
"type": "string"
},
"rate_center": {
"type": "string"
},
"region": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"phoneMobileNumbers": {
"properties": {
"available_phone_numbers": {
"items": {
"properties": {
"capabilities": {
"properties": {
"MMS": {
"type": "string"
},
"SMS": {
"type": "string"
},
"voice": {
"type": "string"
}
},
"type": "object"
},
"friendly_name": {
"type": "string"
},
"iso_country": {
"type": "string"
},
"lata": {
"type": "object"
},
"latitude": {
"type": "object"
},
"longitude": {
"type": "object"
},
"phone_number": {
"type": "string"
},
"postal_code": {
"type": "object"
},
"rate_center": {
"type": "object"
},
"region": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"phoneNumbers": {
"properties": {
"available_phone_numbers": {
"items": {
"properties": {
"friendly_name": {
"description": "A nicely-formatted version of the phone number.",
"type": "string"
},
"iso_country": {
"description": "The ISO country code of this phone number.",
"type": "string"
},
"lata": {
"description": "The LATA of this phone number.",
"type": "string"
},
"latitude": {
"description": "The latitude coordinate of this phone number.",
"type": "string"
},
"longitude": {
"description": "The longitude coordinate of this phone number.",
"type": "string"
},
"phone_number": {
"description": "The phone number, in E.164 (i.e. '+1') format.",
"type": "string"
},
"postal_code": {
"description": "The postal (zip) code of this phone number.",
"type": "string"
},
"rate_center": {
"description": "The rate center of this phone number.",
"type": "string"
},
"region": {
"description": "The two-letter state or province abbreviation of this phone number.",
"maxLength": 2,
"minLength": 2,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"phoneTollFreeNumbers": {
"properties": {
"available_phone_numbers": {
"items": {
"properties": {
"capabilities": {
"properties": {
"MMS": {
"type": "string"
},
"SMS": {
"type": "string"
},
"voice": {
"type": "string"
}
},
"type": "object"
},
"friendly_name": {
"type": "string"
},
"iso_country": {
"type": "string"
},
"phone_number": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"queue": {
"properties": {
"average_wait_time": {
"type": "integer"
},
"current_size": {
"type": "integer"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"max_size": {
"maximum": 1000,
"type": "integer"
},
"sid": {
"maxLength": 34,
"minLength": 34,
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"queues": {
"properties": {
"end": {
"type": "integer"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "string"
},
"num_pages": {
"type": "integer"
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"previous_page_uri": {
"type": "string"
},
"queues": {
"items": {
"properties": {
"average_wait_time": {
"type": "integer"
},
"current_size": {
"type": "integer"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"max_size": {
"maximum": 1000,
"type": "integer"
},
"sid": {
"maxLength": 34,
"minLength": 34,
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"start": {
"type": "integer"
},
"total": {
"type": "integer"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"recordings": {
"properties": {
"end": {
"type": "integer"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "string"
},
"num_pages": {
"type": "integer"
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"previous_page_uri": {
"type": "string"
},
"recordings": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"call_sid": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"duration": {
"type": "string"
},
"sid": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"start": {
"type": "integer"
},
"total": {
"type": "integer"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"shortCode": {
"properties": {
"account_sid": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"short_code": {
"type": "string"
},
"sid": {
"type": "string"
},
"sms_fallback_method": {
"type": "string"
},
"sms_fallback_url": {
"type": "string"
},
"sms_method": {
"type": "string"
},
"sms_url": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"shortCodes": {
"properties": {
"end": {
"type": "number"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "object"
},
"num_pages": {
"type": "number"
},
"page": {
"type": "number"
},
"page_size": {
"type": "number"
},
"previous_page_uri": {
"type": "object"
},
"short_codes": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"short_code": {
"type": "string"
},
"sid": {
"type": "string"
},
"sms_fallback_method": {
"type": "string"
},
"sms_fallback_url": {
"type": "string"
},
"sms_method": {
"type": "string"
},
"sms_url": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"start": {
"type": "number"
},
"total": {
"type": "number"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"transcription": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"duration": {
"type": "string"
},
"price": {
"type": "string"
},
"recording_sid": {
"type": "string"
},
"sid": {
"type": "string"
},
"status": {
"type": "string"
},
"transcription_text": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"transcriptions": {
"properties": {
"end": {
"type": "number"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "string"
},
"num_pages": {
"type": "number"
},
"page": {
"type": "number"
},
"page_size": {
"type": "number"
},
"previous_page_uri": {
"type": "object"
},
"start": {
"type": "number"
},
"total": {
"type": "number"
},
"transcriptions": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"api_version": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"duration": {
"type": "string"
},
"price": {
"type": "string"
},
"recording_sid": {
"type": "string"
},
"sid": {
"type": "string"
},
"status": {
"type": "string"
},
"transcription_text": {
"type": "string"
},
"type": {
"type": "string"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"usageRecords": {
"properties": {
"end": {
"type": "integer"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "string"
},
"num_pages": {
"type": "integer"
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"previous_page_uri": {
"type": "string"
},
"start": {
"type": "integer"
},
"total": {
"type": "integer"
},
"uri": {
"type": "string"
},
"usage_records": {
"properties": {
"account_sid": {
"type": "string"
},
"category": {
"type": "string"
},
"count": {
"type": "string"
},
"count_unit": {
"type": "string"
},
"description": {
"type": "string"
},
"end_date": {
"type": "string"
},
"price": {
"type": "string"
},
"price_unit": {
"type": "string"
},
"start_date": {
"type": "string"
},
"subresource_uris": {
"type": "string"
},
"uri": {
"type": "string"
},
"usage": {
"type": "string"
},
"usage_unit": {
"type": "string"
}
},
"type": "object"
}
},
"type": "object"
},
"usageTrigger": {
"properties": {
"account_sid": {
"description": "The account this trigger monitors.",
"type": "string"
},
"callback_method": {
"description": "The HTTP method Twilio will use when making a request to the CallbackUrl. GET or POST.",
"enum": [
"GET",
"POST"
]
},
"callback_url": {
"description": "Twilio will make a request to this url when the trigger fires.",
"type": "string"
},
"current_value": {
"description": "The current value of the field the trigger is watching.",
"type": "string"
},
"date_created": {
"description": "The date the trigger was created, given as GMT RFC 2822 format.",
"type": "string"
},
"date_fired": {
"description": "The date the trigger was last fired, given as GMT RFC 2822 format.",
"type": "string"
},
"date_updated": {
"description": "The date the trigger was last updated, given as GMT RFC 2822 format.",
"type": "string"
},
"friendly_name": {
"description": "A user-specified, human-readable name for the trigger.",
"type": "string"
},
"recurring": {
"description": "How this trigger recurs. Empty for non-recurring triggers. One of daily, monthly, or yearly for recurring triggers. A trigger will only fire once during each recurring period. Recurring periods are in GMT.",
"type": "string"
},
"sid": {
"description": "The trigger's unique Sid.",
"type": "string"
},
"trigger_by": {
"description": "The field in the UsageRecord that fires the trigger. One of count, usage, or price.",
"enum": [
"count",
"usage",
"price"
]
},
"trigger_value": {
"description": "The value at which the trigger will fire. Must be a positive numeric value.",
"type": "string"
},
"uri": {
"description": "The URI for this resource, relative to https://api.twilio.com.",
"type": "string"
},
"usage_category": {
"description": "The usage category the trigger watches. One of the supported usage categories.",
"type": "string"
},
"usage_record_uri": {
"description": "The URI of the UsageRecord this trigger is watching, relative to https://api.twilio.com.",
"type": "string"
}
},
"type": "object"
},
"usageTriggers": {
"properties": {
"end": {
"type": "integer"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "string"
},
"num_pages": {
"type": "integer"
},
"page": {
"type": "integer"
},
"page_size": {
"type": "integer"
},
"previous_page_uri": {
"type": "string"
},
"start": {
"type": "integer"
},
"total": {
"type": "integer"
},
"uri": {
"type": "string"
},
"usage_triggers": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"callback_method": {
"enum": [
"GET",
"POST"
]
},
"callback_url": {
"type": "string"
},
"current_value": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_fired": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"recurring": {
"type": "string"
},
"sid": {
"type": "string"
},
"trigger_by": {
"enum": [
"count",
"usage",
"price"
]
},
"trigger_value": {
"type": "string"
},
"uri": {
"type": "string"
},
"usage_category": {
"type": "string"
},
"usage_record_uri": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"userLists": {
"properties": {
"credential_list_mappings": {
"items": {
"properties": {
"account_sid": {
"type": "string"
},
"date_created": {
"type": "string"
},
"date_updated": {
"type": "string"
},
"friendly_name": {
"type": "string"
},
"sid": {
"type": "string"
},
"subresource_uris": {
"properties": {
"credentials": {
"type": "string"
}
},
"type": "object"
},
"uri": {
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"end": {
"type": "number"
},
"first_page_uri": {
"type": "string"
},
"last_page_uri": {
"type": "string"
},
"next_page_uri": {
"type": "object"
},
"num_pages": {
"type": "number"
},
"page": {
"type": "number"
},
"page_size": {
"type": "number"
},
"previous_page_uri": {
"type": "object"
},
"start": {
"type": "number"
},
"total": {
"type": "number"
},
"uri": {
"type": "string"
}
},
"type": "object"
}
}
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment