{
"components": {
"securitySchemes": {
"accountSid_authToken": {
"scheme": "basic",
"type": "http"
}
},
"schemas": {
"api.v2010.account": {
"type": "object",
"properties": {
"auth_token": {
"type": "string",
"nullable": true,
"description": "The authorization token for this account. This token should be kept a secret, so no sharing.",
"x-twilio": {
"pii": {
"handling": "sensitive",
"deleteSla": 30
}
}
},
"date_created": {
"type": "string",
"format": "date-time-rfc-2822",
"nullable": true,
"description": "The date that this account was created, in GMT in RFC 2822 format"
},
"date_updated": {
"type": "string",
"format": "date-time-rfc-2822",
"nullable": true,
"description": "The date that this account was last updated, in GMT in RFC 2822 format."
},
"friendly_name": {
"type": "string",
"nullable": true,
"description": "A human readable description of this account, up to 64 characters long. By default the FriendlyName is your email address.",
"x-twilio": {
"pii": {
"handling": "standard",
"deleteSla": 30
}
}
},
"owner_account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The unique 34 character id that represents the parent of this account. The OwnerAccountSid of a parent account is it's own sid."
},
"sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "A 34 character string that uniquely identifies this resource."
},
"status": {
"$ref": "#/components/schemas/account_enum_status"
},
"subresource_uris": {
"type": "object",
"format": "uri-map",
"nullable": true,
"description": "A Map of various subresources available for the given Account Instance"
},
"type": {
"$ref": "#/components/schemas/account_enum_type"
},
"uri": {
"type": "string",
"nullable": true,
"description": "The URI for this resource, relative to `https://api.twilio.com`"
}
}
},
"account_enum_status": {
"type": "string",
"enum": [
"active",
"suspended",
"closed"
],
"description": "The status of this account. Usually `active`, but can be `suspended` or `closed`."
},
"account_enum_type": {
"type": "string",
"enum": [
"Trial",
"Full"
],
"description": "The type of this account. Either `Trial` or `Full` if it's been upgraded"
},
"api.v2010.account.address": {
"type": "object",
"properties": {
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource."
},
"city": {
"type": "string",
"nullable": true,
"description": "The city in which the address is located."
},
"customer_name": {
"type": "string",
"nullable": true,
"description": "The name associated with the address.This property has a maximum length of 16 4-byte characters, or 21 3-byte characters.",
"x-twilio": {
"pii": {
"handling": "standard",
"deleteSla": 30
}
}
},
"date_created": {
"type": "string",
"format": "date-time-rfc-2822",
"nullable": true,
"description": "The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format."
},
"date_updated": {
"type": "string",
"format": "date-time-rfc-2822",
"nullable": true,
"description": "The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format."
},
"friendly_name": {
"type": "string",
"nullable": true,
"description": "The string that you assigned to describe the resource.",
"x-twilio": {
"pii": {
"handling": "standard",
"deleteSla": 30
}
}
},
"iso_country": {
"type": "string",
"format": "iso-country-code",
"nullable": true,
"description": "The ISO country code of the address."
},
"postal_code": {
"type": "string",
"nullable": true,
"description": "The postal code of the address.",
"x-twilio": {
"pii": {
"handling": "standard",
"deleteSla": 30
}
}
},
"region": {
"type": "string",
"nullable": true,
"description": "The state or region of the address."
},
"sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AD[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The unique string that that we created to identify the Address resource."
},
"street": {
"type": "string",
"nullable": true,
"description": "The number and street address of the address.",
"x-twilio": {
"pii": {
"handling": "standard",
"deleteSla": 30
}
}
},
"uri": {
"type": "string",
"nullable": true,
"description": "The URI of the resource, relative to `https://api.twilio.com`."
},
"emergency_enabled": {
"type": "boolean",
"nullable": true,
"description": "Whether emergency calling has been enabled on this number."
},
"validated": {
"type": "boolean",
"nullable": true,
"description": "Whether the address has been validated to comply with local regulation. In countries that require valid addresses, an invalid address will not be accepted. `true` indicates the Address has been validated. `false` indicate the country doesn't require validation or the Address is not valid."
},
"verified": {
"type": "boolean",
"nullable": true,
"description": "Whether the address has been verified to comply with regulation. In countries that require valid addresses, an invalid address will not be accepted. `true` indicates the Address has been verified. `false` indicate the country doesn't require verified or the Address is not valid."
},
"street_secondary": {
"type": "string",
"nullable": true,
"description": "The additional number and street address of the address.",
"x-twilio": {
"pii": {
"handling": "standard",
"deleteSla": 30
}
}
}
}
},
"api.v2010.account.application": {
"type": "object",
"properties": {
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resource."
},
"api_version": {
"type": "string",
"nullable": true,
"description": "The API version used to start a new TwiML session."
},
"date_created": {
"type": "string",
"format": "date-time-rfc-2822",
"nullable": true,
"description": "The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format."
},
"date_updated": {
"type": "string",
"format": "date-time-rfc-2822",
"nullable": true,
"description": "The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format."
},
"friendly_name": {
"type": "string",
"nullable": true,
"description": "The string that you assigned to describe the resource."
},
"message_status_callback": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The URL we call using a POST method to send message status information to your application."
},
"sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AP[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The unique string that that we created to identify the Application resource."
},
"sms_fallback_method": {
"type": "string",
"format": "http-method",
"enum": [
"GET",
"POST"
],
"nullable": true,
"description": "The HTTP method we use to call `sms_fallback_url`. Can be: `GET` or `POST`."
},
"sms_fallback_url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The URL that we call when an error occurs while retrieving or executing the TwiML from `sms_url`."
},
"sms_method": {
"type": "string",
"format": "http-method",
"enum": [
"GET",
"POST"
],
"nullable": true,
"description": "The HTTP method we use to call `sms_url`. Can be: `GET` or `POST`."
},
"sms_status_callback": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The URL we call using a POST method to send status information to your application about SMS messages that refer to the application."
},
"sms_url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The URL we call when the phone number receives an incoming SMS message."
},
"status_callback": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The URL we call using the `status_callback_method` to send status information to your application."
},
"status_callback_method": {
"type": "string",
"format": "http-method",
"enum": [
"GET",
"POST"
],
"nullable": true,
"description": "The HTTP method we use to call `status_callback`. Can be: `GET` or `POST`."
},
"uri": {
"type": "string",
"nullable": true,
"description": "The URI of the resource, relative to `https://api.twilio.com`."
},
"voice_caller_id_lookup": {
"type": "boolean",
"nullable": true,
"description": "Whether we look up the caller's caller-ID name from the CNAM database (additional charges apply). Can be: `true` or `false`."
},
"voice_fallback_method": {
"type": "string",
"format": "http-method",
"enum": [
"GET",
"POST"
],
"nullable": true,
"description": "The HTTP method we use to call `voice_fallback_url`. Can be: `GET` or `POST`."
},
"voice_fallback_url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The URL that we call when an error occurs retrieving or executing the TwiML requested by `url`."
},
"voice_method": {
"type": "string",
"format": "http-method",
"enum": [
"GET",
"POST"
],
"nullable": true,
"description": "The HTTP method we use to call `voice_url`. Can be: `GET` or `POST`."
},
"voice_url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The URL we call when the phone number assigned to this application receives a call."
},
"public_application_connect_enabled": {
"type": "boolean",
"nullable": true,
"description": "Whether to allow other Twilio accounts to dial this applicaton using Dial verb. Can be: `true` or `false`."
}
}
},
"api.v2010.account.authorized_connect_app": {
"type": "object",
"properties": {
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AuthorizedConnectApp resource."
},
"connect_app_company_name": {
"type": "string",
"nullable": true,
"description": "The company name set for the Connect App."
},
"connect_app_description": {
"type": "string",
"nullable": true,
"description": "A detailed description of the Connect App."
},
"connect_app_friendly_name": {
"type": "string",
"nullable": true,
"description": "The name of the Connect App."
},
"connect_app_homepage_url": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The public URL for the Connect App."
},
"connect_app_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^CN[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID that we assigned to the Connect App."
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/authorized_connect_app_enum_permission"
},
"nullable": true,
"description": "The set of permissions that you authorized for the Connect App. Can be: `get-all` or `post-all`.",
"x-field-extra-annotation": "@JacksonXmlProperty(localName=\"Permission\") @JacksonXmlElementWrapper(localName=\"Permissions\")",
"x-getter-extra-annotation": "@JacksonXmlProperty(localName=\"Permission\") @JacksonXmlElementWrapper(localName=\"Permissions\")"
},
"uri": {
"type": "string",
"nullable": true,
"description": "The URI of the resource, relative to `https://api.twilio.com`."
}
}
},
"authorized_connect_app_enum_permission": {
"type": "string",
"enum": [
"get-all",
"post-all"
]
},
"api.v2010.account.available_phone_number_country": {
"type": "object",
"properties": {
"country_code": {
"type": "string",
"format": "iso-country-code",
"nullable": true,
"description": "The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country."
},
"country": {
"type": "string",
"nullable": true,
"description": "The name of the country."
},
"uri": {
"type": "string",
"format": "uri",
"nullable": true,
"description": "The URI of the Country resource, relative to `https://api.twilio.com`."
},
"beta": {
"type": "boolean",
"nullable": true,
"description": "Whether all phone numbers available in the country are new to the Twilio platform. `true` if they are and `false` if all numbers are not in the Twilio Phone Number Beta program."
},
"subresource_uris": {
"type": "object",
"format": "uri-map",
"nullable": true,
"description": "A list of related AvailablePhoneNumber resources identified by their URIs relative to `https://api.twilio.com`."
}
}
},
"api.v2010.account.available_phone_number_country.available_phone_number_local": {
"type": "object",
"properties": {
"friendly_name": {
"type": "string",
"format": "phone-number",
"nullable": true,
"description": "A formatted version of the phone number."
},
"phone_number": {
"type": "string",
"format": "phone-number",
"nullable": true,
"description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number."
},
"lata": {
"type": "string",
"nullable": true,
"description": "The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) of this phone number. Available for only phone numbers from the US and Canada."
},
"locality": {
"type": "string",
"nullable": true,
"description": "The locality or city of this phone number's location."
},
"rate_center": {
"type": "string",
"nullable": true,
"description": "The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) of this phone number. Available for only phone numbers from the US and Canada."
},
"latitude": {
"type": "number",
"nullable": true,
"description": "The latitude of this phone number's location. Available for only phone numbers from the US and Canada."
},
"longitude": {
"type": "number",
"nullable": true,
"description": "The longitude of this phone number's location. Available for only phone numbers from the US and Canada."
},
"region": {
"type": "string",
"nullable": true,
"description": "The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada."
},
"postal_code": {
"type": "string",
"nullable": true,
"description": "The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada."
},
"iso_country": {
"type": "string",
"format": "iso-country-code",
"nullable": true,
"description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of this phone number."
},
"address_requirements": {
"type": "string",
"nullable": true,
"description": "The type of [Address](https://www.twilio.com/docs/usage/api/address) resource the phone number requires. Can be: `none`, `any`, `local`, or `foreign`. `none` means no address is required. `any` means an address is required, but it can be anywhere in the world. `local` means an address in the phone number's country is required. `foreign` means an address outside of the phone number's country is required."
},
"beta": {
"type": "boolean",
"nullable": true,
"description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`."
},
"capabilities": {
"type": "object",
"format": "phone-number-capabilities",
"x-class-extra-annotation": "@JsonInclude(JsonInclude.Include.NON_NULL)",
"properties": {
"mms": {
"type": "boolean"
},
"sms": {
"type": "boolean"
},
"voice": {
"type": "boolean"
},
"fax": {
"type": "boolean"
}
},
"nullable": true,
"description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`."
}
}
},
"api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine": {
"type": "object",
"properties": {
"friendly_name": {
"type": "string",
"format": "phone-number",
"nullable": true,
"description": "A formatted version of the phone number."
},
"phone_number": {
"type": "string",
"format": "phone-number",
"nullable": true,
"description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number."
},
"lata": {
"type": "string",
"nullable": true,
"description": "The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) of this phone number. Available for only phone numbers from the US and Canada."
},
"locality": {
"type": "string",
"nullable": true,
"description": "The locality or city of this phone number's location."
},
"rate_center": {
"type": "string",
"nullable": true,
"description": "The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) of this phone number. Available for only phone numbers from the US and Canada."
},
"latitude": {
"type": "number",
"nullable": true,
"description": "The latitude of this phone number's location. Available for only phone numbers from the US and Canada."
},
"longitude": {
"type": "number",
"nullable": true,
"description": "The longitude of this phone number's location. Available for only phone numbers from the US and Canada."
},
"region": {
"type": "string",
"nullable": true,
"description": "The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada."
},
"postal_code": {
"type": "string",
"nullable": true,
"description": "The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada."
},
"iso_country": {
"type": "string",
"format": "iso-country-code",
"nullable": true,
"description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of this phone number."
},
"address_requirements": {
"type": "string",
"nullable": true,
"description": "The type of [Address](https://www.twilio.com/docs/usage/api/address) resource the phone number requires. Can be: `none`, `any`, `local`, or `foreign`. `none` means no address is required. `any` means an address is required, but it can be anywhere in the world. `local` means an address in the phone number's country is required. `foreign` means an address outside of the phone number's country is required."
},
"beta": {
"type": "boolean",
"nullable": true,
"description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`."
},
"capabilities": {
"type": "object",
"format": "phone-number-capabilities",
"x-class-extra-annotation": "@JsonInclude(JsonInclude.Include.NON_NULL)",
"properties": {
"mms": {
"type": "boolean"
},
"sms": {
"type": "boolean"
},
"voice": {
"type": "boolean"
},
"fax": {
"type": "boolean"
}
},
"nullable": true,
"description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`."
}
}
},
"api.v2010.account.available_phone_number_country.available_phone_number_mobile": {
"type": "object",
"properties": {
"friendly_name": {
"type": "string",
"format": "phone-number",
"nullable": true,
"description": "A formatted version of the phone number."
},
"phone_number": {
"type": "string",
"format": "phone-number",
"nullable": true,
"description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number."
},
"lata": {
"type": "string",
"nullable": true,
"description": "The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) of this phone number. Available for only phone numbers from the US and Canada."
},
"locality": {
"type": "string",
"nullable": true,
"description": "The locality or city of this phone number's location."
},
"rate_center": {
"type": "string",
"nullable": true,
"description": "The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) of this phone number. Available for only phone numbers from the US and Canada."
},
"latitude": {
"type": "number",
"nullable": true,
"description": "The latitude of this phone number's location. Available for only phone numbers from the US and Canada."
},
"longitude": {
"type": "number",
"nullable": true,
"description": "The longitude of this phone number's location. Available for only phone numbers from the US and Canada."
},
"region": {
"type": "string",
"nullable": true,
"description": "The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada."
},
"postal_code": {
"type": "string",
"nullable": true,
"description": "The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada."
},
"iso_country": {
"type": "string",
"format": "iso-country-code",
"nullable": true,
"description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of this phone number."
},
"address_requirements": {
"type": "string",
"nullable": true,
"description": "The type of [Address](https://www.twilio.com/docs/usage/api/address) resource the phone number requires. Can be: `none`, `any`, `local`, or `foreign`. `none` means no address is required. `any` means an address is required, but it can be anywhere in the world. `local` means an address in the phone number's country is required. `foreign` means an address outside of the phone number's country is required."
},
"beta": {
"type": "boolean",
"nullable": true,
"description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`."
},
"capabilities": {
"type": "object",
"format": "phone-number-capabilities",
"x-class-extra-annotation": "@JsonInclude(JsonInclude.Include.NON_NULL)",
"properties": {
"mms": {
"type": "boolean"
},
"sms": {
"type": "boolean"
},
"voice": {
"type": "boolean"
},
"fax": {
"type": "boolean"
}
},
"nullable": true,
"description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`."
}
}
},
"api.v2010.account.available_phone_number_country.available_phone_number_national": {
"type": "object",
"properties": {
"friendly_name": {
"type": "string",
"format": "phone-number",
"nullable": true,
"description": "A formatted version of the phone number."
},
"phone_number": {
"type": "string",
"format": "phone-number",
"nullable": true,
"description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number."
},
"lata": {
"type": "string",
"nullable": true,
"description": "The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) of this phone number. Available for only phone numbers from the US and Canada."
},
"locality": {
"type": "string",
"nullable": true,
"description": "The locality or city of this phone number's location."
},
"rate_center": {
"type": "string",
"nullable": true,
"description": "The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) of this phone number. Available for only phone numbers from the US and Canada."
},
"latitude": {
"type": "number",
"nullable": true,
"description": "The latitude of this phone number's location. Available for only phone numbers from the US and Canada."
},
"longitude": {
"type": "number",
"nullable": true,
"description": "The longitude of this phone number's location. Available for only phone numbers from the US and Canada."
},
"region": {
"type": "string",
"nullable": true,
"description": "The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada."
},
"postal_code": {
"type": "string",
"nullable": true,
"description": "The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada."
},
"iso_country": {
"type": "string",
"format": "iso-country-code",
"nullable": true,
"description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of this phone number."
},
"address_requirements": {
"type": "string",
"nullable": true,
"description": "The type of [Address](https://www.twilio.com/docs/usage/api/address) resource the phone number requires. Can be: `none`, `any`, `local`, or `foreign`. `none` means no address is required. `any` means an address is required, but it can be anywhere in the world. `local` means an address in the phone number's country is required. `foreign` means an address outside of the phone number's country is required."
},
"beta": {
"type": "boolean",
"nullable": true,
"description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`."
},
"capabilities": {
"type": "object",
"format": "phone-number-capabilities",
"x-class-extra-annotation": "@JsonInclude(JsonInclude.Include.NON_NULL)",
"properties": {
"mms": {
"type": "boolean"
},
"sms": {
"type": "boolean"
},
"voice": {
"type": "boolean"
},
"fax": {
"type": "boolean"
}
},
"nullable": true,
"description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`."
}
}
},
"api.v2010.account.available_phone_number_country.available_phone_number_shared_cost": {
"type": "object",
"properties": {
"friendly_name": {
"type": "string",
"format": "phone-number",
"nullable": true,
"description": "A formatted version of the phone number."
},
"phone_number": {
"type": "string",
"format": "phone-number",
"nullable": true,
"description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number."
},
"lata": {
"type": "string",
"nullable": true,
"description": "The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) of this phone number. Available for only phone numbers from the US and Canada."
},
"locality": {
"type": "string",
"nullable": true,
"description": "The locality or city of this phone number's location."
},
"rate_center": {
"type": "string",
"nullable": true,
"description": "The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) of this phone number. Available for only phone numbers from the US and Canada."
},
"latitude": {
"type": "number",
"nullable": true,
"description": "The latitude of this phone number's location. Available for only phone numbers from the US and Canada."
},
"longitude": {
"type": "number",
"nullable": true,
"description": "The longitude of this phone number's location. Available for only phone numbers from the US and Canada."
},
"region": {
"type": "string",
"nullable": true,
"description": "The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada."
},
"postal_code": {
"type": "string",
"nullable": true,
"description": "The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada."
},
"iso_country": {
"type": "string",
"format": "iso-country-code",
"nullable": true,
"description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of this phone number."
},
"address_requirements": {
"type": "string",
"nullable": true,
"description": "The type of [Address](https://www.twilio.com/docs/usage/api/address) resource the phone number requires. Can be: `none`, `any`, `local`, or `foreign`. `none` means no address is required. `any` means an address is required, but it can be anywhere in the world. `local` means an address in the phone number's country is required. `foreign` means an address outside of the phone number's country is required."
},
"beta": {
"type": "boolean",
"nullable": true,
"description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`."
},
"capabilities": {
"type": "object",
"format": "phone-number-capabilities",
"x-class-extra-annotation": "@JsonInclude(JsonInclude.Include.NON_NULL)",
"properties": {
"mms": {
"type": "boolean"
},
"sms": {
"type": "boolean"
},
"voice": {
"type": "boolean"
},
"fax": {
"type": "boolean"
}
},
"nullable": true,
"description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`."
}
}
},
"api.v2010.account.available_phone_number_country.available_phone_number_toll_free": {
"type": "object",
"properties": {
"friendly_name": {
"type": "string",
"format": "phone-number",
"nullable": true,
"description": "A formatted version of the phone number."
},
"phone_number": {
"type": "string",
"format": "phone-number",
"nullable": true,
"description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number."
},
"lata": {
"type": "string",
"nullable": true,
"description": "The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) of this phone number. Available for only phone numbers from the US and Canada."
},
"locality": {
"type": "string",
"nullable": true,
"description": "The locality or city of this phone number's location."
},
"rate_center": {
"type": "string",
"nullable": true,
"description": "The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) of this phone number. Available for only phone numbers from the US and Canada."
},
"latitude": {
"type": "number",
"nullable": true,
"description": "The latitude of this phone number's location. Available for only phone numbers from the US and Canada."
},
"longitude": {
"type": "number",
"nullable": true,
"description": "The longitude of this phone number's location. Available for only phone numbers from the US and Canada."
},
"region": {
"type": "string",
"nullable": true,
"description": "The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada."
},
"postal_code": {
"type": "string",
"nullable": true,
"description": "The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada."
},
"iso_country": {
"type": "string",
"format": "iso-country-code",
"nullable": true,
"description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of this phone number."
},
"address_requirements": {
"type": "string",
"nullable": true,
"description": "The type of [Address](https://www.twilio.com/docs/usage/api/address) resource the phone number requires. Can be: `none`, `any`, `local`, or `foreign`. `none` means no address is required. `any` means an address is required, but it can be anywhere in the world. `local` means an address in the phone number's country is required. `foreign` means an address outside of the phone number's country is required."
},
"beta": {
"type": "boolean",
"nullable": true,
"description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`."
},
"capabilities": {
"type": "object",
"format": "phone-number-capabilities",
"x-class-extra-annotation": "@JsonInclude(JsonInclude.Include.NON_NULL)",
"properties": {
"mms": {
"type": "boolean"
},
"sms": {
"type": "boolean"
},
"voice": {
"type": "boolean"
},
"fax": {
"type": "boolean"
}
},
"nullable": true,
"description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`."
}
}
},
"api.v2010.account.available_phone_number_country.available_phone_number_voip": {
"type": "object",
"properties": {
"friendly_name": {
"type": "string",
"format": "phone-number",
"nullable": true,
"description": "A formatted version of the phone number."
},
"phone_number": {
"type": "string",
"format": "phone-number",
"nullable": true,
"description": "The phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number."
},
"lata": {
"type": "string",
"nullable": true,
"description": "The [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) of this phone number. Available for only phone numbers from the US and Canada."
},
"locality": {
"type": "string",
"nullable": true,
"description": "The locality or city of this phone number's location."
},
"rate_center": {
"type": "string",
"nullable": true,
"description": "The [rate center](https://en.wikipedia.org/wiki/Telephone_exchange) of this phone number. Available for only phone numbers from the US and Canada."
},
"latitude": {
"type": "number",
"nullable": true,
"description": "The latitude of this phone number's location. Available for only phone numbers from the US and Canada."
},
"longitude": {
"type": "number",
"nullable": true,
"description": "The longitude of this phone number's location. Available for only phone numbers from the US and Canada."
},
"region": {
"type": "string",
"nullable": true,
"description": "The two-letter state or province abbreviation of this phone number's location. Available for only phone numbers from the US and Canada."
},
"postal_code": {
"type": "string",
"nullable": true,
"description": "The postal or ZIP code of this phone number's location. Available for only phone numbers from the US and Canada."
},
"iso_country": {
"type": "string",
"format": "iso-country-code",
"nullable": true,
"description": "The [ISO country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of this phone number."
},
"address_requirements": {
"type": "string",
"nullable": true,
"description": "The type of [Address](https://www.twilio.com/docs/usage/api/address) resource the phone number requires. Can be: `none`, `any`, `local`, or `foreign`. `none` means no address is required. `any` means an address is required, but it can be anywhere in the world. `local` means an address in the phone number's country is required. `foreign` means an address outside of the phone number's country is required."
},
"beta": {
"type": "boolean",
"nullable": true,
"description": "Whether the phone number is new to the Twilio platform. Can be: `true` or `false`."
},
"capabilities": {
"type": "object",
"format": "phone-number-capabilities",
"x-class-extra-annotation": "@JsonInclude(JsonInclude.Include.NON_NULL)",
"properties": {
"mms": {
"type": "boolean"
},
"sms": {
"type": "boolean"
},
"voice": {
"type": "boolean"
},
"fax": {
"type": "boolean"
}
},
"nullable": true,
"description": "The set of Boolean properties that indicate whether a phone number can receive calls or messages. Capabilities are: `Voice`, `SMS`, and `MMS` and each capability can be: `true` or `false`."
}
}
},
"api.v2010.account.balance": {
"type": "object",
"properties": {
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The unique SID identifier of the Account."
},
"balance": {
"type": "string",
"nullable": true,
"description": "The balance of the Account, in units specified by the unit parameter. Balance changes may not be reflected immediately. Child accounts do not contain balance information"
},
"currency": {
"type": "string",
"nullable": true,
"description": "The units of currency for the account balance"
}
}
},
"api.v2010.account.call": {
"type": "object",
"properties": {
"sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^CA[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The unique string that we created to identify this Call resource."
},
"date_created": {
"type": "string",
"format": "date-time-rfc-2822",
"nullable": true,
"description": "The date and time in UTC that this resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format."
},
"date_updated": {
"type": "string",
"format": "date-time-rfc-2822",
"nullable": true,
"description": "The date and time in UTC that this resource was last updated, specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format."
},
"parent_call_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^CA[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID that identifies the call that created this leg."
},
"account_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^AC[0-9a-fA-F]{32}$",
"nullable": true,
"description": "The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this Call resource."
},
"to": {
"type": "string",
"nullable": true,
"description": "The phone number, SIP address, Client identifier or SIM SID that received this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `[email protected]`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`.",
"x-twilio": {
"pii": {
"handling": "standard",
"deleteSla": 120
}
}
},
"to_formatted": {
"type": "string",
"nullable": true,
"description": "The phone number, SIP address or Client identifier that received this call. Formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750).",
"x-twilio": {
"pii": {
"handling": "standard",
"deleteSla": 120
}
}
},
"from": {
"type": "string",
"nullable": true,
"description": "The phone number, SIP address, Client identifier or SIM SID that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). SIP addresses are formatted as `[email protected]`. Client identifiers are formatted `client:name`. SIM SIDs are formatted as `sim:sid`.",
"x-twilio": {
"pii": {
"handling": "standard",
"deleteSla": 120
}
}
},
"from_formatted": {
"type": "string",
"nullable": true,
"description": "The calling phone number, SIP address, or Client identifier formatted for display. Non-North American phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +442071838750).",
"x-twilio": {
"pii": {
"handling": "standard",
"deleteSla": 120
}
}
},
"phone_number_sid": {
"type": "string",
"minLength": 34,
"maxLength": 34,
"pattern": "^PN[0-9a-fA-F]{32}$",
"nullable": true,
"description": "If the call was inbound, this is the SID of the IncomingPhoneNumber resource that received the call. If the call was outbound, it is the SID of the OutgoingCallerId resource from which the call was placed."
},
"status": {
"$ref": "#/components/schemas/call_enum_status"
},
"start_time": {
"type": "string",
"format": "date-time-rfc-2822",
"nullable": true,
"description": "The start time of the call, given as UTC in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format. Empty if the call has not yet been dialed."
},
"end_time": {
"type": "string",
"format": "date-time-rfc-2822",
"nullable": true,
"description": "The time the call ended, given as UTC in [RFC 2822](https://www.php.net/manual/en/class.datetime.php#datetime.constants.rfc2822) format. Empty if the call did not complete successfully."
},
"duration": {
"type": "string",
"nullable": true,
"description": "The length of the call in seconds. This value is empty for busy, failed, unanswered, or ongoing calls."
},
"price": {
"type": "string",
"nullable": true,
"description": "The charge for this call, in the currency associated with the account. Populated after the call is completed. May not be immediately available. The price associated with a call only reflects the charge for connectivity. Charges for other call-related features such as Answering Machine Detection, Text-To-Speech, and SIP REFER are not included in this value."
},
"price_unit": {
"type": "string",
"format": "currency",
"nullable": true,
"description": "The currency in which `Price` is measured, in [ISO 4127](https://www.iso.org/iso/home/standards/currency_codes.htm) format (e.g., `USD`, `EUR`, `JPY`). Always capitalized for calls."
},
"direction": {
"type": "string",
"nullable": true,
"description": "A string describing the direction of the call. Can be: `inbound` for inbound calls, `outbound-api` for calls initiated via the REST API or `outbound-dial` for calls initiated by a `