components: schemas: api.v2010.account: properties: auth_token: description: The authorization token for this account nullable: true type: string date_created: description: The date this account was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The date this account was last updated format: date-time-rfc-2822 nullable: true type: string friendly_name: description: A human readable description of this account nullable: true type: string owner_account_sid: description: The unique 34 character id representing the parent of this account maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string sid: description: A 34 character string that uniquely identifies this resource. maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string status: description: The status of this account enum: - active - suspended - closed nullable: true type: string subresource_uris: description: Account Instance Subresources nullable: true type: object type: description: The type of this account enum: - Trial - Full nullable: true type: string uri: description: The URI for this resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.address: properties: account_sid: description: The SID of the Account that is responsible for the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string city: description: The city in which the address is located nullable: true type: string customer_name: description: The name associated with the address nullable: true type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string emergency_enabled: description: Whether emergency calling has been enabled on this number nullable: true type: boolean friendly_name: description: The string that you assigned to describe the resource nullable: true type: string iso_country: description: The ISO country code of the address nullable: true type: string postal_code: description: The postal code of the address nullable: true type: string region: description: The state or region of the address nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AD[0-9a-fA-F]{32}$ type: string street: description: The number and street address of the address nullable: true type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string validated: description: Whether the address has been validated to comply with local regulation nullable: true type: boolean verified: description: Whether the address has been verified to comply with regulation nullable: true type: boolean type: object api.v2010.account.address.dependent_phone_number: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string address_requirements: description: Whether the phone number requires an Address registered with Twilio enum: - none - any - local - foreign nullable: true type: string api_version: description: The API version used to start a new TwiML session nullable: true type: string capabilities: description: Indicate if a phone can receive calls or messages nullable: true type: object date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string emergency_address_sid: description: The emergency address configuration to use for emergency calling maxLength: 34 minLength: 34 nullable: true pattern: ^AD[0-9a-fA-F]{32}$ type: string emergency_status: description: Whether the phone number is enabled for emergency calling enum: - Active - Inactive nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string phone_number: description: The phone number in E.164 format nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^PN[0-9a-fA-F]{32}$ type: string sms_application_sid: description: The SID of the application that handles SMS messages sent to the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^AP[0-9a-fA-F]{32}$ type: string sms_fallback_method: description: The HTTP method used with sms_fallback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string sms_fallback_url: description: The URL that we call when an error occurs while retrieving or executing the TwiML format: uri nullable: true type: string sms_method: description: The HTTP method to use with sms_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string sms_url: description: The URL we call when the phone number receives an incoming SMS message format: uri nullable: true type: string status_callback: description: The URL to send status information to your application format: uri nullable: true type: string status_callback_method: description: The HTTP method we use to call status_callback enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string trunk_sid: description: The SID of the Trunk that handles calls to the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^TK[0-9a-fA-F]{32}$ type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string voice_application_sid: description: The SID of the application that handles calls to the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^AP[0-9a-fA-F]{32}$ type: string voice_caller_id_lookup: description: Whether to lookup the caller's name nullable: true type: boolean voice_fallback_method: description: The HTTP method used with voice_fallback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string voice_fallback_url: description: The URL we call when an error occurs in TwiML format: uri nullable: true type: string voice_method: description: The HTTP method used with the voice_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string voice_url: description: The URL we call when the phone number receives a call format: uri nullable: true type: string type: object api.v2010.account.application: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to start a new TwiML session nullable: true type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string message_status_callback: description: The URL to send message status information to your application format: uri nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AP[0-9a-fA-F]{32}$ type: string sms_fallback_method: description: The HTTP method used with sms_fallback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string sms_fallback_url: description: The URL that we call when an error occurs while retrieving or executing the TwiML format: uri nullable: true type: string sms_method: description: The HTTP method to use with sms_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string sms_status_callback: description: The URL to send status information to your application format: uri nullable: true type: string sms_url: description: The URL we call when the phone number receives an incoming SMS message format: uri nullable: true type: string status_callback: description: The URL to send status information to your application format: uri nullable: true type: string status_callback_method: description: The HTTP method we use to call status_callback enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string voice_caller_id_lookup: description: Whether to lookup the caller's name nullable: true type: boolean voice_fallback_method: description: The HTTP method used with voice_fallback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string voice_fallback_url: description: The URL we call when a TwiML error occurs format: uri nullable: true type: string voice_method: description: The HTTP method used with the voice_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string voice_url: description: The URL we call when the phone number receives a call format: uri nullable: true type: string type: object api.v2010.account.authorized_connect_app: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string connect_app_company_name: description: The company name set for the Connect App nullable: true type: string connect_app_description: description: A detailed description of the app nullable: true type: string connect_app_friendly_name: description: The name of the Connect App nullable: true type: string connect_app_homepage_url: description: The public URL for the Connect App format: uri nullable: true type: string connect_app_sid: description: The SID that we assigned to the Connect App maxLength: 34 minLength: 34 nullable: true pattern: ^CN[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string permissions: description: Permissions authorized to the app items: enum: - get-all - post-all type: string nullable: true type: array uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.available_phone_number_country: properties: beta: description: Whether all phone numbers available in the country are new to the Twilio platform. nullable: true type: boolean country: description: The name of the country nullable: true type: string country_code: description: The ISO-3166-1 country code of the country. nullable: true type: string subresource_uris: description: A list of related resources identified by their relative URIs nullable: true type: object uri: description: The URI of the Country resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.available_phone_number_country.available_phone_number_local: properties: address_requirements: description: The type of Address resource the phone number requires nullable: true type: string beta: description: Whether the phone number is new to the Twilio platform nullable: true type: boolean capabilities: description: Whether a phone number can receive calls or messages nullable: true properties: fax: type: boolean mms: type: boolean sms: type: boolean voice: type: boolean type: object friendly_name: description: A formatted version of the phone number nullable: true type: string iso_country: description: The ISO country code of this phone number nullable: true type: string lata: description: The LATA of this phone number nullable: true type: string latitude: description: The latitude of this phone number's location nullable: true type: number locality: description: The locality or city of this phone number's location nullable: true type: string longitude: description: The longitude of this phone number's location nullable: true type: number phone_number: description: The phone number in E.164 format nullable: true type: string postal_code: description: The postal or ZIP code of this phone number's location nullable: true type: string rate_center: description: The rate center of this phone number nullable: true type: string region: description: The two-letter state or province abbreviation of this phone number's location nullable: true type: string type: object api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine: properties: address_requirements: description: The type of Address resource the phone number requires nullable: true type: string beta: description: Whether the phone number is new to the Twilio platform nullable: true type: boolean capabilities: description: Whether a phone number can receive calls or messages nullable: true properties: fax: type: boolean mms: type: boolean sms: type: boolean voice: type: boolean type: object friendly_name: description: A formatted version of the phone number nullable: true type: string iso_country: description: The ISO country code of this phone number nullable: true type: string lata: description: The LATA of this phone number nullable: true type: string latitude: description: The latitude of this phone number's location nullable: true type: number locality: description: The locality or city of this phone number's location nullable: true type: string longitude: description: The longitude of this phone number's location nullable: true type: number phone_number: description: The phone number in E.164 format nullable: true type: string postal_code: description: The postal or ZIP code of this phone number's location nullable: true type: string rate_center: description: The rate center of this phone number nullable: true type: string region: description: The two-letter state or province abbreviation of this phone number's location nullable: true type: string type: object api.v2010.account.available_phone_number_country.available_phone_number_mobile: properties: address_requirements: description: The type of Address resource the phone number requires nullable: true type: string beta: description: Whether the phone number is new to the Twilio platform nullable: true type: boolean capabilities: description: Whether a phone number can receive calls or messages nullable: true properties: fax: type: boolean mms: type: boolean sms: type: boolean voice: type: boolean type: object friendly_name: description: A formatted version of the phone number nullable: true type: string iso_country: description: The ISO country code of this phone number nullable: true type: string lata: description: The LATA of this phone number nullable: true type: string latitude: description: The latitude of this phone number's location nullable: true type: number locality: description: The locality or city of this phone number's location nullable: true type: string longitude: description: The longitude of this phone number's location nullable: true type: number phone_number: description: The phone number in E.164 format nullable: true type: string postal_code: description: The postal or ZIP code of this phone number's location nullable: true type: string rate_center: description: The rate center of this phone number nullable: true type: string region: description: The two-letter state or province abbreviation of this phone number's location nullable: true type: string type: object api.v2010.account.available_phone_number_country.available_phone_number_national: properties: address_requirements: description: The type of Address resource the phone number requires nullable: true type: string beta: description: Whether the phone number is new to the Twilio platform nullable: true type: boolean capabilities: description: Whether a phone number can receive calls or messages nullable: true properties: fax: type: boolean mms: type: boolean sms: type: boolean voice: type: boolean type: object friendly_name: description: A formatted version of the phone number nullable: true type: string iso_country: description: The ISO country code of this phone number nullable: true type: string lata: description: The LATA of this phone number nullable: true type: string latitude: description: The latitude of this phone number's location nullable: true type: number locality: description: The locality or city of this phone number's location nullable: true type: string longitude: description: The longitude of this phone number's location nullable: true type: number phone_number: description: The phone number in E.164 format nullable: true type: string postal_code: description: The postal or ZIP code of this phone number's location nullable: true type: string rate_center: description: The rate center of this phone number nullable: true type: string region: description: The two-letter state or province abbreviation of this phone number's location nullable: true type: string type: object api.v2010.account.available_phone_number_country.available_phone_number_shared_cost: properties: address_requirements: description: The type of Address resource the phone number requires nullable: true type: string beta: description: Whether the phone number is new to the Twilio platform nullable: true type: boolean capabilities: description: Whether a phone number can receive calls or messages nullable: true properties: fax: type: boolean mms: type: boolean sms: type: boolean voice: type: boolean type: object friendly_name: description: A formatted version of the phone number nullable: true type: string iso_country: description: The ISO country code of this phone number nullable: true type: string lata: description: The LATA of this phone number nullable: true type: string latitude: description: The latitude of this phone number's location nullable: true type: number locality: description: The locality or city of this phone number's location nullable: true type: string longitude: description: The longitude of this phone number's location nullable: true type: number phone_number: description: The phone number in E.164 format nullable: true type: string postal_code: description: The postal or ZIP code of this phone number's location nullable: true type: string rate_center: description: The rate center of this phone number nullable: true type: string region: description: The two-letter state or province abbreviation of this phone number's location nullable: true type: string type: object api.v2010.account.available_phone_number_country.available_phone_number_toll_free: properties: address_requirements: description: The type of Address resource the phone number requires nullable: true type: string beta: description: Whether the phone number is new to the Twilio platform nullable: true type: boolean capabilities: description: Whether a phone number can receive calls or messages nullable: true properties: fax: type: boolean mms: type: boolean sms: type: boolean voice: type: boolean type: object friendly_name: description: A formatted version of the phone number nullable: true type: string iso_country: description: The ISO country code of this phone number nullable: true type: string lata: description: The LATA of this phone number nullable: true type: string latitude: description: The latitude of this phone number's location nullable: true type: number locality: description: The locality or city of this phone number's location nullable: true type: string longitude: description: The longitude of this phone number's location nullable: true type: number phone_number: description: The phone number in E.164 format nullable: true type: string postal_code: description: The postal or ZIP code of this phone number's location nullable: true type: string rate_center: description: The rate center of this phone number nullable: true type: string region: description: The two-letter state or province abbreviation of this phone number's location nullable: true type: string type: object api.v2010.account.available_phone_number_country.available_phone_number_voip: properties: address_requirements: description: The type of Address resource the phone number requires nullable: true type: string beta: description: Whether the phone number is new to the Twilio platform nullable: true type: boolean capabilities: description: Whether a phone number can receive calls or messages nullable: true properties: fax: type: boolean mms: type: boolean sms: type: boolean voice: type: boolean type: object friendly_name: description: A formatted version of the phone number nullable: true type: string iso_country: description: The ISO country code of this phone number nullable: true type: string lata: description: The LATA of this phone number nullable: true type: string latitude: description: The latitude of this phone number's location nullable: true type: number locality: description: The locality or city of this phone number's location nullable: true type: string longitude: description: The longitude of this phone number's location nullable: true type: number phone_number: description: The phone number in E.164 format nullable: true type: string postal_code: description: The postal or ZIP code of this phone number's location nullable: true type: string rate_center: description: The rate center of this phone number nullable: true type: string region: description: The two-letter state or province abbreviation of this phone number's location nullable: true type: string type: object api.v2010.account.balance: properties: account_sid: description: Account Sid. maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string balance: description: Account balance nullable: true type: string currency: description: Currency units nullable: true type: string type: object api.v2010.account.call: properties: account_sid: description: The SID of the Account that created this resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string annotation: description: The annotation provided for the call nullable: true type: string answered_by: description: Either `human` or `machine` if this call was initiated with answering machine detection. Empty otherwise. nullable: true type: string api_version: description: The API Version used to create the call nullable: true type: string caller_name: description: The caller's name if this call was an incoming call to a phone number with caller ID Lookup enabled. Otherwise, empty. nullable: true type: string date_created: description: The RFC 2822 date and time in GMT that this resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that this resource was last updated format: date-time-rfc-2822 nullable: true 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. nullable: true type: string duration: description: The length of the call in seconds. nullable: true type: string end_time: description: The end time of the call. Null if the call did not complete successfully. format: date-time-rfc-2822 nullable: true type: string forwarded_from: description: The forwarding phone number if this call was an incoming call forwarded from another number (depends on carrier supporting forwarding). Otherwise, empty. nullable: true 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). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. nullable: true type: string from_formatted: description: The calling phone number, SIP address, or Client identifier formatted for display. nullable: true type: string group_sid: description: The Group SID associated with this call. If no Group is associated with the call, the field is empty. maxLength: 34 minLength: 34 nullable: true pattern: ^GP[0-9a-fA-F]{32}$ type: string parent_call_sid: description: The SID that identifies the call that created this leg. maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string phone_number_sid: 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. maxLength: 34 minLength: 34 nullable: true pattern: ^PN[0-9a-fA-F]{32}$ 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. nullable: true type: string price_unit: description: The currency in which `Price` is measured. nullable: true type: string queue_time: description: The wait time in milliseconds before the call is placed. nullable: true type: string sid: description: The unique string that identifies this resource maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string start_time: description: The start time of the call. Null if the call has not yet been dialed. format: date-time-rfc-2822 nullable: true type: string status: description: The status of this call. enum: - queued - ringing - in-progress - completed - busy - failed - no-answer - canceled nullable: true type: string subresource_uris: description: A list of related subresources identified by their relative URIs nullable: true type: object to: description: The phone number, SIP address or Client identifier that received this call. Phone numbers are in E.164 format (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. Client identifiers are formatted `client:name`. nullable: true type: string to_formatted: description: The phone number, SIP address or Client identifier that received this call. Formatted for display. nullable: true type: string trunk_sid: description: The (optional) unique identifier of the trunk resource that was used for this call. maxLength: 34 minLength: 34 nullable: true pattern: ^TK[0-9a-fA-F]{32}$ type: string uri: description: The URI of this resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.call.call_event: properties: request: description: Call Request. nullable: true type: object response: description: Call Response with Events. nullable: true type: object type: object api.v2010.account.call.call_feedback: properties: account_sid: description: The unique sid that identifies this account maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string date_created: description: The date this resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The date this resource was last updated format: date-time-rfc-2822 nullable: true type: string issues: description: Issues experienced during the call items: enum: - audio-latency - digits-not-captured - dropped-call - imperfect-audio - incorrect-caller-id - one-way-audio - post-dial-delay - unsolicited-call type: string nullable: true type: array quality_score: description: 1 to 5 quality score nullable: true type: integer sid: description: A string that uniquely identifies this feedback resource maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string type: object api.v2010.account.call.call_feedback_summary: properties: account_sid: description: The unique sid that identifies this account maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string call_count: description: The total number of calls nullable: true type: integer call_feedback_count: description: The total number of calls with a feedback entry nullable: true type: integer date_created: description: The date this resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The date this resource was last updated format: date-time-rfc-2822 nullable: true type: string end_date: description: The latest feedback entry date in the summary format: date nullable: true type: string include_subaccounts: description: Whether the feedback summary includes subaccounts nullable: true type: boolean issues: description: Issues experienced during the call items: type: object nullable: true type: array quality_score_average: description: The average QualityScore of the feedback entries nullable: true type: number quality_score_median: description: The median QualityScore of the feedback entries nullable: true type: number quality_score_standard_deviation: description: The standard deviation of the quality scores nullable: true type: number sid: description: A string that uniquely identifies this feedback entry maxLength: 34 minLength: 34 nullable: true pattern: ^FS[0-9a-fA-F]{32}$ type: string start_date: description: The earliest feedback entry date in the summary format: date nullable: true type: string status: description: The status of the feedback summary enum: - queued - in-progress - completed - failed nullable: true type: string type: object api.v2010.account.call.call_notification: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to create the Call Notification resource nullable: true type: string call_sid: description: The SID of the Call the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string error_code: description: A unique error code corresponding to the notification nullable: true type: string log: description: An integer log level nullable: true type: string message_date: description: The date the notification was generated format: date-time-rfc-2822 nullable: true type: string message_text: description: The text of the notification nullable: true type: string more_info: description: A URL for more information about the error code format: uri nullable: true type: string request_method: description: HTTP method used with the request url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string request_url: description: URL of the resource that generated the notification format: uri nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^NO[0-9a-fA-F]{32}$ type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.call.call_notification-instance: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to create the Call Notification resource nullable: true type: string call_sid: description: The SID of the Call the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string error_code: description: A unique error code corresponding to the notification nullable: true type: string log: description: An integer log level nullable: true type: string message_date: description: The date the notification was generated format: date-time-rfc-2822 nullable: true type: string message_text: description: The text of the notification nullable: true type: string more_info: description: A URL for more information about the error code format: uri nullable: true type: string request_method: description: HTTP method used with the request url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string request_url: description: URL of the resource that generated the notification format: uri nullable: true type: string request_variables: description: Twilio-generated HTTP variables sent to the server nullable: true type: string response_body: description: The HTTP body returned by your server nullable: true type: string response_headers: description: The HTTP headers returned by your server nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^NO[0-9a-fA-F]{32}$ type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.call.call_recording: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to make the recording nullable: true type: string call_sid: description: The SID of the Call the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string channels: description: The number of channels in the final recording file nullable: true type: integer conference_sid: description: The Conference SID that identifies the conference associated with the recording maxLength: 34 minLength: 34 nullable: true pattern: ^CF[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string duration: description: The length of the recording in seconds nullable: true type: string encryption_details: description: How to decrypt the recording. nullable: true type: object error_code: description: More information about why the recording is missing, if status is `absent`. nullable: true type: integer price: description: The one-time cost of creating the recording. nullable: true type: number price_unit: description: The currency used in the price property. nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^RE[0-9a-fA-F]{32}$ type: string source: description: How the recording was created enum: - DialVerb - Conference - OutboundAPI - Trunking - RecordVerb - StartCallRecordingAPI - StartConferenceRecordingAPI nullable: true type: string start_time: description: The start time of the recording, given in RFC 2822 format format: date-time-rfc-2822 nullable: true type: string status: description: The status of the recording enum: - in-progress - paused - stopped - processing - completed - absent nullable: true type: string track: description: 'The recorded track. Can be: `inbound`, `outbound`, or `both`.' nullable: true type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.call.payments: properties: account_sid: description: The SID of the Account that created the Payments resource. maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string call_sid: description: The SID of the Call the resource is associated with. maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string sid: description: The SID of the Payments resource. maxLength: 34 minLength: 34 nullable: true pattern: ^PK[0-9a-fA-F]{32}$ type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.call.siprec: properties: account_sid: description: The SID of the Account that created this resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string call_sid: description: The SID of the Call the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string date_updated: description: The RFC 2822 date and time in GMT that this resource was last updated format: date-time-rfc-2822 nullable: true type: string name: description: The name of this resource nullable: true type: string sid: description: The SID of the Siprec resource. maxLength: 34 minLength: 34 nullable: true pattern: ^SR[0-9a-fA-F]{32}$ type: string status: description: The status - one of `stopped`, `in-progress` enum: - in-progress - stopped nullable: true type: string type: object api.v2010.account.conference: properties: account_sid: description: The SID of the Account that created this resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to create this conference nullable: true type: string call_sid_ending_conference: description: The call SID that caused the conference to end maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that this resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that this resource was last updated format: date-time-rfc-2822 nullable: true type: string friendly_name: description: A string that you assigned to describe this conference room nullable: true type: string reason_conference_ended: description: The reason why a conference ended. enum: - conference-ended-via-api - participant-with-end-conference-on-exit-left - participant-with-end-conference-on-exit-kicked - last-participant-kicked - last-participant-left nullable: true type: string region: description: A string that represents the Twilio Region where the conference was mixed nullable: true type: string sid: description: The unique string that identifies this resource maxLength: 34 minLength: 34 nullable: true pattern: ^CF[0-9a-fA-F]{32}$ type: string status: description: The status of this conference enum: - init - in-progress - completed nullable: true type: string subresource_uris: description: A list of related resources identified by their relative URIs nullable: true type: object uri: description: The URI of this resource, relative to `https://api.twilio.com` nullable: true type: string type: object api.v2010.account.conference.conference_recording: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to create the recording nullable: true type: string call_sid: description: The SID of the Call the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string channels: description: The number of channels in the final recording file as an integer nullable: true type: integer conference_sid: description: The Conference SID that identifies the conference associated with the recording maxLength: 34 minLength: 34 nullable: true pattern: ^CF[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string duration: description: The length of the recording in seconds nullable: true type: string encryption_details: description: How to decrypt the recording. nullable: true type: object error_code: description: More information about why the recording is missing, if status is `absent`. nullable: true type: integer price: description: The one-time cost of creating the recording. nullable: true type: string price_unit: description: The currency used in the price property. nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^RE[0-9a-fA-F]{32}$ type: string source: description: How the recording was created enum: - DialVerb - Conference - OutboundAPI - Trunking - RecordVerb - StartCallRecordingAPI - StartConferenceRecordingAPI nullable: true type: string start_time: description: The start time of the recording, given in RFC 2822 format format: date-time-rfc-2822 nullable: true type: string status: description: The status of the recording enum: - in-progress - paused - stopped - processing - completed - absent nullable: true type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` nullable: true type: string type: object api.v2010.account.conference.participant: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string call_sid: description: The SID of the Call the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string call_sid_to_coach: description: The SID of the participant who is being `coached` maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string coaching: description: Indicates if the participant changed to coach nullable: true type: boolean conference_sid: description: The SID of the conference the participant is in maxLength: 34 minLength: 34 nullable: true pattern: ^CF[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string end_conference_on_exit: description: Whether the conference ends when the participant leaves nullable: true type: boolean hold: description: Whether the participant is on hold nullable: true type: boolean label: description: The label of this participant nullable: true type: string muted: description: Whether the participant is muted nullable: true type: boolean start_conference_on_enter: description: Whether the conference starts when the participant joins the conference nullable: true type: boolean status: description: The status of the participant's call in a session enum: - queued - connecting - ringing - connected - complete - failed nullable: true type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` nullable: true type: string type: object api.v2010.account.connect_app: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string authorize_redirect_url: description: The URL to redirect the user to after authorization format: uri nullable: true type: string company_name: description: The company name set for the Connect App nullable: true type: string deauthorize_callback_method: description: The HTTP method we use to call deauthorize_callback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string deauthorize_callback_url: description: The URL we call to de-authorize the Connect App format: uri nullable: true type: string description: description: The description of the Connect App nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string homepage_url: description: The URL users can obtain more information format: uri nullable: true type: string permissions: description: The set of permissions that your ConnectApp requests items: enum: - get-all - post-all type: string nullable: true type: array sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^CN[0-9a-fA-F]{32}$ type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.incoming_phone_number: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string address_requirements: description: Whether the phone number requires an Address registered with Twilio. enum: - none - any - local - foreign nullable: true type: string address_sid: description: The SID of the Address resource associated with the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^AD[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to start a new TwiML session nullable: true type: string beta: description: Whether the phone number is new to the Twilio platform nullable: true type: boolean bundle_sid: description: The SID of the Bundle resource associated with number maxLength: 34 minLength: 34 nullable: true pattern: ^BU[0-9a-fA-F]{32}$ type: string capabilities: description: Indicate if a phone can receive calls or messages nullable: true properties: fax: type: boolean mms: type: boolean sms: type: boolean voice: type: boolean type: object date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string emergency_address_sid: description: The emergency address configuration to use for emergency calling maxLength: 34 minLength: 34 nullable: true pattern: ^AD[0-9a-fA-F]{32}$ type: string emergency_address_status: description: State of the emergency address configuration for the phone number enum: - registered - unregistered - pending-registration - registration-failure - pending-unregistration - unregistration-failure nullable: true type: string emergency_status: description: Displays if emergency calling is enabled for this number. enum: - Active - Inactive nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string identity_sid: description: The SID of the Identity resource associated with number maxLength: 34 minLength: 34 nullable: true pattern: ^RI[0-9a-fA-F]{32}$ type: string origin: description: The phone number's origin. Can be twilio or hosted. nullable: true type: string phone_number: description: The phone number in E.164 format nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^PN[0-9a-fA-F]{32}$ type: string sms_application_sid: description: The SID of the application that handles SMS messages sent to the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^AP[0-9a-fA-F]{32}$ type: string sms_fallback_method: description: The HTTP method used with sms_fallback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string sms_fallback_url: description: The URL that we call when an error occurs while retrieving or executing the TwiML format: uri nullable: true type: string sms_method: description: The HTTP method to use with sms_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string sms_url: description: The URL we call when the phone number receives an incoming SMS message format: uri nullable: true type: string status: nullable: true type: string status_callback: description: The URL to send status information to your application format: uri nullable: true type: string status_callback_method: description: The HTTP method we use to call status_callback enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string trunk_sid: description: The SID of the Trunk that handles calls to the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^TK[0-9a-fA-F]{32}$ type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string voice_application_sid: description: The SID of the application that handles calls to the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^AP[0-9a-fA-F]{32}$ type: string voice_caller_id_lookup: description: Whether to lookup the caller's name nullable: true type: boolean voice_fallback_method: description: The HTTP method used with voice_fallback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string voice_fallback_url: description: The URL we call when an error occurs in TwiML format: uri nullable: true type: string voice_method: description: The HTTP method used with the voice_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string voice_receive_mode: enum: - voice - fax nullable: true type: string voice_url: description: The URL we call when the phone number receives a call format: uri nullable: true type: string type: object api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string configuration: description: A JSON string that represents the current configuration nullable: true type: object date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string description: description: A short description of the Add-on functionality nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string resource_sid: description: The SID of the Phone Number that installed this Add-on maxLength: 34 minLength: 34 nullable: true pattern: ^PN[0-9a-fA-F]{32}$ type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^XE[0-9a-fA-F]{32}$ type: string subresource_uris: description: A list of related resources identified by their relative URIs nullable: true type: object unique_name: description: An application-defined string that uniquely identifies the resource nullable: true type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object ? api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension : properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string assigned_add_on_sid: description: The SID that uniquely identifies the assigned Add-on installation maxLength: 34 minLength: 34 nullable: true pattern: ^XE[0-9a-fA-F]{32}$ type: string enabled: description: Whether the Extension will be invoked nullable: true type: boolean friendly_name: description: The string that you assigned to describe the resource nullable: true type: string product_name: description: A string that you assigned to describe the Product this Extension is used within nullable: true type: string resource_sid: description: The SID of the Phone Number to which the Add-on is assigned maxLength: 34 minLength: 34 nullable: true pattern: ^PN[0-9a-fA-F]{32}$ type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^XF[0-9a-fA-F]{32}$ type: string unique_name: description: An application-defined string that uniquely identifies the resource nullable: true type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.incoming_phone_number.incoming_phone_number_local: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string address_requirements: description: Whether the phone number requires an Address registered with Twilio. enum: - none - any - local - foreign nullable: true type: string address_sid: description: The SID of the Address resource associated with the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^AD[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to start a new TwiML session nullable: true type: string beta: description: Whether the phone number is new to the Twilio platform nullable: true type: boolean bundle_sid: description: The SID of the Bundle resource associated with number maxLength: 34 minLength: 34 nullable: true pattern: ^BU[0-9a-fA-F]{32}$ type: string capabilities: description: Indicate if a phone can receive calls or messages nullable: true properties: fax: type: boolean mms: type: boolean sms: type: boolean voice: type: boolean type: object date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string emergency_address_sid: description: The emergency address configuration to use for emergency calling maxLength: 34 minLength: 34 nullable: true pattern: ^AD[0-9a-fA-F]{32}$ type: string emergency_address_status: description: State of the emergency address configuration for the phone number enum: - registered - unregistered - pending-registration - registration-failure - pending-unregistration - unregistration-failure nullable: true type: string emergency_status: description: Displays if emergency calling is enabled for this number. enum: - Active - Inactive nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string identity_sid: description: The SID of the Identity resource associated with number maxLength: 34 minLength: 34 nullable: true pattern: ^RI[0-9a-fA-F]{32}$ type: string origin: description: The phone number's origin. Can be twilio or hosted. nullable: true type: string phone_number: description: The phone number in E.164 format nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^PN[0-9a-fA-F]{32}$ type: string sms_application_sid: description: The SID of the Application resource to handle SMS messages maxLength: 34 minLength: 34 nullable: true pattern: ^AP[0-9a-fA-F]{32}$ type: string sms_fallback_method: description: The HTTP method used with sms_fallback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string sms_fallback_url: description: The URL that we call when an error occurs while retrieving or executing the TwiML format: uri nullable: true type: string sms_method: description: The HTTP method to use with sms_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string sms_url: description: The URL we call when the phone number receives an incoming SMS message format: uri nullable: true type: string status: nullable: true type: string status_callback: description: The URL to send status information to your application format: uri nullable: true type: string status_callback_method: description: The HTTP method we use to call status_callback enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string trunk_sid: description: The SID of the Trunk that handles calls to the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^TK[0-9a-fA-F]{32}$ type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string voice_application_sid: description: The SID of the application that handles calls to the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^AP[0-9a-fA-F]{32}$ type: string voice_caller_id_lookup: description: Whether to lookup the caller's name nullable: true type: boolean voice_fallback_method: description: The HTTP method used with voice_fallback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string voice_fallback_url: description: The URL we call when an error occurs in TwiML format: uri nullable: true type: string voice_method: description: The HTTP method used with the voice_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string voice_receive_mode: enum: - voice - fax nullable: true type: string voice_url: description: The URL we call when this phone number receives a call format: uri nullable: true type: string type: object api.v2010.account.incoming_phone_number.incoming_phone_number_mobile: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string address_requirements: description: Whether the phone number requires an Address registered with Twilio. enum: - none - any - local - foreign nullable: true type: string address_sid: description: The SID of the Address resource associated with the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^AD[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to start a new TwiML session nullable: true type: string beta: description: Whether the phone number is new to the Twilio platform nullable: true type: boolean bundle_sid: description: The SID of the Bundle resource associated with number maxLength: 34 minLength: 34 nullable: true pattern: ^BU[0-9a-fA-F]{32}$ type: string capabilities: description: Indicate if a phone can receive calls or messages nullable: true properties: fax: type: boolean mms: type: boolean sms: type: boolean voice: type: boolean type: object date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string emergency_address_sid: description: The emergency address configuration to use for emergency calling maxLength: 34 minLength: 34 nullable: true pattern: ^AD[0-9a-fA-F]{32}$ type: string emergency_address_status: description: State of the emergency address configuration for the phone number enum: - registered - unregistered - pending-registration - registration-failure - pending-unregistration - unregistration-failure nullable: true type: string emergency_status: description: Displays if emergency calling is enabled for this number. enum: - Active - Inactive nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string identity_sid: description: The SID of the Identity resource associated with number maxLength: 34 minLength: 34 nullable: true pattern: ^RI[0-9a-fA-F]{32}$ type: string origin: description: The phone number's origin. Can be twilio or hosted. nullable: true type: string phone_number: description: The phone number in E.164 format nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^PN[0-9a-fA-F]{32}$ type: string sms_application_sid: description: The SID of the application that handles SMS messages sent to the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^AP[0-9a-fA-F]{32}$ type: string sms_fallback_method: description: The HTTP method used with sms_fallback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string sms_fallback_url: description: The URL that we call when an error occurs while retrieving or executing the TwiML format: uri nullable: true type: string sms_method: description: The HTTP method to use with sms_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string sms_url: description: The URL we call when the phone number receives an incoming SMS message format: uri nullable: true type: string status: nullable: true type: string status_callback: description: The URL to send status information to your application format: uri nullable: true type: string status_callback_method: description: The HTTP method we use to call status_callback enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string trunk_sid: description: The SID of the Trunk that handles calls to the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^TK[0-9a-fA-F]{32}$ type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string voice_application_sid: description: The SID of the application that handles calls to the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^AP[0-9a-fA-F]{32}$ type: string voice_caller_id_lookup: description: Whether to lookup the caller's name nullable: true type: boolean voice_fallback_method: description: The HTTP method used with voice_fallback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string voice_fallback_url: description: The URL we call when an error occurs in TwiML format: uri nullable: true type: string voice_method: description: The HTTP method used with the voice_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string voice_receive_mode: enum: - voice - fax nullable: true type: string voice_url: description: The URL we call when the phone number receives a call format: uri nullable: true type: string type: object api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string address_requirements: description: Whether the phone number requires an Address registered with Twilio. enum: - none - any - local - foreign nullable: true type: string address_sid: description: The SID of the Address resource associated with the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^AD[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to start a new TwiML session nullable: true type: string beta: description: Whether the phone number is new to the Twilio platform nullable: true type: boolean bundle_sid: description: The SID of the Bundle resource associated with number maxLength: 34 minLength: 34 nullable: true pattern: ^BU[0-9a-fA-F]{32}$ type: string capabilities: description: Indicate if a phone can receive calls or messages nullable: true properties: fax: type: boolean mms: type: boolean sms: type: boolean voice: type: boolean type: object date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string emergency_address_sid: description: The emergency address configuration to use for emergency calling maxLength: 34 minLength: 34 nullable: true pattern: ^AD[0-9a-fA-F]{32}$ type: string emergency_address_status: description: State of the emergency address configuration for the phone number enum: - registered - unregistered - pending-registration - registration-failure - pending-unregistration - unregistration-failure nullable: true type: string emergency_status: description: Displays if emergency calling is enabled for this number. enum: - Active - Inactive nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string identity_sid: description: The SID of the Identity resource associated with number maxLength: 34 minLength: 34 nullable: true pattern: ^RI[0-9a-fA-F]{32}$ type: string origin: description: The phone number's origin. Can be twilio or hosted. nullable: true type: string phone_number: description: The phone number in E.164 format nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^PN[0-9a-fA-F]{32}$ type: string sms_application_sid: description: The SID of the application that handles SMS messages sent to the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^AP[0-9a-fA-F]{32}$ type: string sms_fallback_method: description: The HTTP method used with sms_fallback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string sms_fallback_url: description: The URL that we call when an error occurs while retrieving or executing the TwiML format: uri nullable: true type: string sms_method: description: The HTTP method to use with sms_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string sms_url: description: The URL we call when the phone number receives an incoming SMS message format: uri nullable: true type: string status: nullable: true type: string status_callback: description: The URL to send status information to your application format: uri nullable: true type: string status_callback_method: description: The HTTP method we use to call status_callback enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string trunk_sid: description: The SID of the Trunk that handles calls to the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^TK[0-9a-fA-F]{32}$ type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string voice_application_sid: description: The SID of the application that handles calls to the phone number maxLength: 34 minLength: 34 nullable: true pattern: ^AP[0-9a-fA-F]{32}$ type: string voice_caller_id_lookup: description: Whether to lookup the caller's name nullable: true type: boolean voice_fallback_method: description: The HTTP method used with voice_fallback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string voice_fallback_url: description: The URL we call when an error occurs in TwiML format: uri nullable: true type: string voice_method: description: The HTTP method used with the voice_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string voice_receive_mode: enum: - voice - fax nullable: true type: string voice_url: description: The URL we call when the phone number receives a call format: uri nullable: true type: string type: object api.v2010.account.key: properties: date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^SK[0-9a-fA-F]{32}$ type: string type: object api.v2010.account.message: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to process the message nullable: true type: string body: description: The message text nullable: true type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_sent: description: The RFC 2822 date and time in GMT when the message was sent format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string direction: description: The direction of the message enum: - inbound - outbound-api - outbound-call - outbound-reply nullable: true type: string error_code: description: The error code associated with the message nullable: true type: integer error_message: description: The description of the error_code nullable: true type: string from: description: The phone number that initiated the message nullable: true type: string messaging_service_sid: description: The SID of the Messaging Service used with the message. maxLength: 34 minLength: 34 nullable: true pattern: ^MG[0-9a-fA-F]{32}$ type: string num_media: description: The number of media files associated with the message nullable: true type: string num_segments: description: The number of messages used to deliver the message body nullable: true type: string price: description: The amount billed for the message nullable: true type: string price_unit: description: The currency in which price is measured nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^(SM|MM)[0-9a-fA-F]{32}$ type: string status: description: The status of the message enum: - queued - sending - sent - failed - delivered - undelivered - receiving - received - accepted - scheduled - read - partially_delivered - canceled nullable: true type: string subresource_uris: description: A list of related resources identified by their relative URIs nullable: true type: object to: description: The phone number that received the message nullable: true type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` nullable: true type: string type: object api.v2010.account.message.media: properties: account_sid: description: The SID of the Account that created this resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string content_type: description: The default mime-type of the media nullable: true type: string date_created: description: The RFC 2822 date and time in GMT that this resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that this resource was last updated format: date-time-rfc-2822 nullable: true type: string parent_sid: description: The SID of the resource that created the media maxLength: 34 minLength: 34 nullable: true pattern: ^(SM|MM)[0-9a-fA-F]{32}$ type: string sid: description: The unique string that identifies this resource maxLength: 34 minLength: 34 nullable: true pattern: ^ME[0-9a-fA-F]{32}$ type: string uri: description: The URI of this resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.message.message_feedback: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string message_sid: description: The SID of the Message resource for which the feedback was provided maxLength: 34 minLength: 34 nullable: true pattern: ^(SM|MM)[0-9a-fA-F]{32}$ type: string outcome: description: Whether the feedback has arrived enum: - confirmed - unconfirmed nullable: true type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` nullable: true type: string type: object api.v2010.account.new_key: properties: date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string secret: description: The secret your application uses to sign Access Tokens and to authenticate to the REST API. nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^SK[0-9a-fA-F]{32}$ type: string type: object api.v2010.account.new_signing_key: properties: date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string secret: description: The secret your application uses to sign Access Tokens and to authenticate to the REST API. nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^SK[0-9a-fA-F]{32}$ type: string type: object api.v2010.account.notification: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to generate the notification nullable: true type: string call_sid: description: The SID of the Call the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string error_code: description: A unique error code corresponding to the notification nullable: true type: string log: description: An integer log level nullable: true type: string message_date: description: The date the notification was generated format: date-time-rfc-2822 nullable: true type: string message_text: description: The text of the notification nullable: true type: string more_info: description: A URL for more information about the error code format: uri nullable: true type: string request_method: description: HTTP method used with the request url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string request_url: description: URL of the resource that generated the notification format: uri nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^NO[0-9a-fA-F]{32}$ type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.notification-instance: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to generate the notification nullable: true type: string call_sid: description: The SID of the Call the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string error_code: description: A unique error code corresponding to the notification nullable: true type: string log: description: An integer log level nullable: true type: string message_date: description: The date the notification was generated format: date-time-rfc-2822 nullable: true type: string message_text: description: The text of the notification nullable: true type: string more_info: description: A URL for more information about the error code format: uri nullable: true type: string request_method: description: HTTP method used with the request url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string request_url: description: URL of the resource that generated the notification format: uri nullable: true type: string request_variables: description: Twilio-generated HTTP variables sent to the server nullable: true type: string response_body: description: The HTTP body returned by your server nullable: true type: string response_headers: description: The HTTP headers returned by your server nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^NO[0-9a-fA-F]{32}$ type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.outgoing_caller_id: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string phone_number: description: The phone number in E.164 format nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^PN[0-9a-fA-F]{32}$ type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.queue: properties: account_sid: description: The SID of the Account that created this resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string average_wait_time: description: Average wait time of members in the queue nullable: true type: integer current_size: description: The number of calls currently in the queue. nullable: true type: integer date_created: description: The RFC 2822 date and time in GMT that this resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that this resource was last updated format: date-time-rfc-2822 nullable: true type: string friendly_name: description: A string that you assigned to describe this resource nullable: true type: string max_size: description: The max number of calls allowed in the queue nullable: true type: integer sid: description: The unique string that identifies this resource maxLength: 34 minLength: 34 nullable: true pattern: ^QU[0-9a-fA-F]{32}$ type: string uri: description: The URI of this resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.queue.member: properties: call_sid: description: The SID of the Call the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string date_enqueued: description: The date the member was enqueued format: date-time-rfc-2822 nullable: true type: string position: description: This member's current position in the queue. nullable: true type: integer queue_sid: description: The SID of the Queue the member is in maxLength: 34 minLength: 34 nullable: true pattern: ^QU[0-9a-fA-F]{32}$ type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string wait_time: description: The number of seconds the member has been in the queue. nullable: true type: integer type: object api.v2010.account.recording: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used during the recording. nullable: true type: string call_sid: description: The SID of the Call the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string channels: description: The number of channels in the final recording file as an integer. nullable: true type: integer conference_sid: description: The unique ID for the conference associated with the recording. maxLength: 34 minLength: 34 nullable: true pattern: ^CF[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string duration: description: The length of the recording in seconds. nullable: true type: string encryption_details: description: How to decrypt the recording. nullable: true type: object error_code: description: More information about why the recording is missing, if status is `absent`. nullable: true type: integer price: description: The one-time cost of creating the recording. nullable: true type: string price_unit: description: The currency used in the price property. nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^RE[0-9a-fA-F]{32}$ type: string source: description: How the recording was created enum: - DialVerb - Conference - OutboundAPI - Trunking - RecordVerb - StartCallRecordingAPI - StartConferenceRecordingAPI nullable: true type: string start_time: description: The start time of the recording, given in RFC 2822 format format: date-time-rfc-2822 nullable: true type: string status: description: The status of the recording. enum: - in-progress - paused - stopped - processing - completed - absent nullable: true type: string subresource_uris: description: A list of related resources identified by their relative URIs nullable: true type: object uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.recording.recording_add_on_result: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string add_on_configuration_sid: description: The SID of the Add-on configuration maxLength: 34 minLength: 34 nullable: true pattern: ^XE[0-9a-fA-F]{32}$ type: string add_on_sid: description: The SID of the Add-on to which the result belongs maxLength: 34 minLength: 34 nullable: true pattern: ^XB[0-9a-fA-F]{32}$ type: string date_completed: description: The date and time in GMT that the result was completed format: date-time-rfc-2822 nullable: true type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string reference_sid: description: The SID of the recording to which the AddOnResult resource belongs maxLength: 34 minLength: 34 nullable: true pattern: ^RE[0-9a-fA-F]{32}$ type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^XR[0-9a-fA-F]{32}$ type: string status: description: The status of the result enum: - canceled - completed - deleted - failed - in-progress - init - processing - queued nullable: true type: string subresource_uris: description: A list of related resources identified by their relative URIs nullable: true type: object type: object api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string add_on_configuration_sid: description: The SID of the Add-on configuration maxLength: 34 minLength: 34 nullable: true pattern: ^XE[0-9a-fA-F]{32}$ type: string add_on_result_sid: description: The SID of the AddOnResult to which the payload belongs maxLength: 34 minLength: 34 nullable: true pattern: ^XR[0-9a-fA-F]{32}$ type: string add_on_sid: description: The SID of the Add-on to which the result belongs maxLength: 34 minLength: 34 nullable: true pattern: ^XB[0-9a-fA-F]{32}$ type: string content_type: description: The MIME type of the payload nullable: true type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string label: description: The string that describes the payload nullable: true type: string reference_sid: description: The SID of the recording to which the AddOnResult resource that contains the payload belongs maxLength: 34 minLength: 34 nullable: true pattern: ^RE[0-9a-fA-F]{32}$ type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^XH[0-9a-fA-F]{32}$ type: string subresource_uris: description: A list of related resources identified by their relative URIs nullable: true type: object type: object api.v2010.account.recording.recording_transcription: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to create the transcription nullable: true type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string duration: description: The duration of the transcribed audio in seconds. nullable: true type: string price: description: The charge for the transcription nullable: true type: number price_unit: description: The currency in which price is measured nullable: true type: string recording_sid: description: The SID that identifies the transcription's recording maxLength: 34 minLength: 34 nullable: true pattern: ^RE[0-9a-fA-F]{32}$ type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^TR[0-9a-fA-F]{32}$ type: string status: description: The status of the transcription enum: - in-progress - completed - failed nullable: true type: string transcription_text: description: The text content of the transcription. nullable: true type: string type: description: The transcription type nullable: true type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.short_code: properties: account_sid: description: The SID of the Account that created this resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to start a new TwiML session nullable: true type: string date_created: description: The RFC 2822 date and time in GMT that this resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that this resource was last updated format: date-time-rfc-2822 nullable: true type: string friendly_name: description: A string that you assigned to describe this resource nullable: true type: string short_code: description: The short code. e.g., 894546. nullable: true type: string sid: description: The unique string that identifies this resource maxLength: 34 minLength: 34 nullable: true pattern: ^SC[0-9a-fA-F]{32}$ type: string sms_fallback_method: description: HTTP method we use to call the sms_fallback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string sms_fallback_url: description: URL Twilio will request if an error occurs in executing TwiML format: uri nullable: true type: string sms_method: description: HTTP method to use when requesting the sms url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string sms_url: description: URL we call when receiving an incoming SMS message to this short code format: uri nullable: true type: string uri: description: The URI of this resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.signing_key: properties: date_created: format: date-time-rfc-2822 nullable: true type: string date_updated: format: date-time-rfc-2822 nullable: true type: string friendly_name: nullable: true type: string sid: maxLength: 34 minLength: 34 nullable: true pattern: ^SK[0-9a-fA-F]{32}$ type: string type: object api.v2010.account.sip: properties: {} type: object api.v2010.account.sip.sip_credential_list: properties: account_sid: description: The unique sid that identifies this account maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string date_created: description: The date this resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The date this resource was last updated format: date-time-rfc-2822 nullable: true type: string friendly_name: description: Human readable descriptive text nullable: true type: string sid: description: A string that uniquely identifies this credential maxLength: 34 minLength: 34 nullable: true pattern: ^CL[0-9a-fA-F]{32}$ type: string subresource_uris: description: The list of credentials associated with this credential list. nullable: true type: object uri: description: The URI for this resource format: uri nullable: true type: string type: object api.v2010.account.sip.sip_credential_list.sip_credential: properties: account_sid: description: The unique id of the Account that is responsible for this resource. maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string credential_list_sid: description: The unique id that identifies the credential list that includes this credential maxLength: 34 minLength: 34 nullable: true pattern: ^CL[0-9a-fA-F]{32}$ type: string date_created: description: The date that this resource was created, given as GMT in RFC 2822 format. format: date-time-rfc-2822 nullable: true type: string date_updated: description: The date that this resource was last updated, given as GMT in RFC 2822 format. format: date-time-rfc-2822 nullable: true type: string sid: description: A 34 character string that uniquely identifies this resource. maxLength: 34 minLength: 34 nullable: true pattern: ^CR[0-9a-fA-F]{32}$ type: string uri: description: The URI for this resource, relative to https://api.twilio.com format: uri nullable: true type: string username: description: The username for this credential. nullable: true type: string type: object api.v2010.account.sip.sip_domain: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to process the call nullable: true type: string auth_type: description: The types of authentication mapped to the domain nullable: true type: string byoc_trunk_sid: description: The SID of the BYOC Trunk resource. maxLength: 34 minLength: 34 nullable: true pattern: ^BY[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string domain_name: description: The unique address on Twilio to route SIP traffic nullable: true type: string emergency_caller_sid: description: Whether an emergency caller sid is configured for the domain. maxLength: 34 minLength: 34 nullable: true pattern: ^PN[0-9a-fA-F]{32}$ type: string emergency_calling_enabled: description: Whether emergency calling is enabled for the domain. nullable: true type: boolean friendly_name: description: The string that you assigned to describe the resource nullable: true type: string secure: description: Whether secure SIP is enabled for the domain nullable: true type: boolean sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^SD[0-9a-fA-F]{32}$ type: string sip_registration: description: Whether SIP registration is allowed nullable: true type: boolean subresource_uris: description: A list mapping resources associated with the SIP Domain resource nullable: true type: object uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string voice_fallback_method: description: The HTTP method used with voice_fallback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string voice_fallback_url: description: The URL we call when an error occurs while executing TwiML format: uri nullable: true type: string voice_method: description: The HTTP method to use with voice_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string voice_status_callback_method: description: The HTTP method we use to call voice_status_callback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string voice_status_callback_url: description: The URL that we call with status updates format: uri nullable: true type: string voice_url: description: The URL we call when receiving a call format: uri nullable: true type: string type: object api.v2010.account.sip.sip_domain.sip_auth: properties: {} type: object api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls: properties: {} type: object api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^CL[0-9a-fA-F]{32}$ type: string type: object api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AL[0-9a-fA-F]{32}$ type: string type: object api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations: properties: {} type: object api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^CL[0-9a-fA-F]{32}$ type: string type: object api.v2010.account.sip.sip_domain.sip_credential_list_mapping: properties: account_sid: description: The unique id of the Account that is responsible for this resource. maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string date_created: description: The date that this resource was created, given as GMT in RFC 2822 format. format: date-time-rfc-2822 nullable: true type: string date_updated: description: The date that this resource was last updated, given as GMT in RFC 2822 format. format: date-time-rfc-2822 nullable: true type: string domain_sid: description: The unique string that identifies the SipDomain resource. maxLength: 34 minLength: 34 nullable: true pattern: ^SD[0-9a-fA-F]{32}$ type: string friendly_name: description: A human readable descriptive text for this resource, up to 64 characters long. nullable: true type: string sid: description: A 34 character string that uniquely identifies this resource. maxLength: 34 minLength: 34 nullable: true pattern: ^CL[0-9a-fA-F]{32}$ type: string uri: description: The URI for this resource, relative to https://api.twilio.com format: uri nullable: true type: string type: object api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping: properties: account_sid: description: The unique id of the Account that is responsible for this resource. maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string date_created: description: The date that this resource was created, given as GMT in RFC 2822 format. format: date-time-rfc-2822 nullable: true type: string date_updated: description: The date that this resource was last updated, given as GMT in RFC 2822 format. format: date-time-rfc-2822 nullable: true type: string domain_sid: description: The unique string that identifies the SipDomain resource. maxLength: 34 minLength: 34 nullable: true pattern: ^SD[0-9a-fA-F]{32}$ type: string friendly_name: description: A human readable descriptive text for this resource, up to 64 characters long. nullable: true type: string sid: description: A 34 character string that uniquely identifies this resource. maxLength: 34 minLength: 34 nullable: true pattern: ^AL[0-9a-fA-F]{32}$ type: string uri: description: The URI for this resource, relative to https://api.twilio.com format: uri nullable: true type: string type: object api.v2010.account.sip.sip_ip_access_control_list: properties: account_sid: description: The unique sid that identifies this account maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string date_created: description: The date this resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The date this resource was last updated format: date-time-rfc-2822 nullable: true type: string friendly_name: description: A human readable description of this resource nullable: true type: string sid: description: A string that uniquely identifies this resource maxLength: 34 minLength: 34 nullable: true pattern: ^AL[0-9a-fA-F]{32}$ type: string subresource_uris: description: The IP addresses associated with this resource. nullable: true type: object uri: description: The URI for this resource format: uri nullable: true type: string type: object api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address: properties: account_sid: description: The unique id of the Account that is responsible for this resource. maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string cidr_prefix_length: description: An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used. nullable: true type: integer date_created: description: The date that this resource was created, given as GMT in RFC 2822 format. format: date-time-rfc-2822 nullable: true type: string date_updated: description: The date that this resource was last updated, given as GMT in RFC 2822 format. format: date-time-rfc-2822 nullable: true type: string friendly_name: description: A human readable descriptive text for this resource, up to 64 characters long. nullable: true type: string ip_access_control_list_sid: description: The unique id of the IpAccessControlList resource that includes this resource. maxLength: 34 minLength: 34 nullable: true pattern: ^AL[0-9a-fA-F]{32}$ type: string ip_address: description: An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today. nullable: true type: string sid: description: A 34 character string that uniquely identifies this resource. maxLength: 34 minLength: 34 nullable: true pattern: ^IP[0-9a-fA-F]{32}$ type: string uri: description: The URI for this resource, relative to https://api.twilio.com format: uri nullable: true type: string type: object api.v2010.account.token: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string ice_servers: description: An array representing the ephemeral credentials items: properties: credential: type: string url: type: string urls: type: string username: type: string type: object nullable: true type: array password: description: The temporary password used for authenticating nullable: true type: string ttl: description: The duration in seconds the credentials are valid nullable: true type: string username: description: The temporary username that uniquely identifies a Token nullable: true type: string type: object api.v2010.account.transcription: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to create the transcription nullable: true type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string duration: description: The duration of the transcribed audio in seconds. nullable: true type: string price: description: The charge for the transcription nullable: true type: number price_unit: description: The currency in which price is measured nullable: true type: string recording_sid: description: The SID that identifies the transcription's recording maxLength: 34 minLength: 34 nullable: true pattern: ^RE[0-9a-fA-F]{32}$ type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^TR[0-9a-fA-F]{32}$ type: string status: description: The status of the transcription enum: - in-progress - completed - failed nullable: true type: string transcription_text: description: The text content of the transcription. nullable: true type: string type: description: The transcription type nullable: true type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string type: object api.v2010.account.usage: properties: {} type: object api.v2010.account.usage.usage_record: properties: account_sid: description: The SID of the Account accrued the usage maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to create the resource nullable: true type: string as_of: description: Usage records up to date as of this timestamp nullable: true type: string category: description: The category of usage enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice nullable: true type: string count: description: The number of usage events nullable: true type: string count_unit: description: The units in which count is measured nullable: true type: string description: description: A plain-language description of the usage category nullable: true type: string end_date: description: The last date for which usage is included in the UsageRecord format: date nullable: true type: string price: description: The total price of the usage nullable: true type: number price_unit: description: The currency in which `price` is measured nullable: true type: string start_date: description: The first date for which usage is included in this UsageRecord format: date nullable: true type: string subresource_uris: description: A list of related resources identified by their relative URIs nullable: true type: object uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string usage: description: The amount of usage nullable: true type: string usage_unit: description: The units in which usage is measured nullable: true type: string type: object api.v2010.account.usage.usage_record.usage_record_all_time: properties: account_sid: description: The SID of the Account accrued the usage maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to create the resource nullable: true type: string as_of: description: Usage records up to date as of this timestamp nullable: true type: string category: description: The category of usage enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice nullable: true type: string count: description: The number of usage events nullable: true type: string count_unit: description: The units in which count is measured nullable: true type: string description: description: A plain-language description of the usage category nullable: true type: string end_date: description: The last date for which usage is included in the UsageRecord format: date nullable: true type: string price: description: The total price of the usage nullable: true type: number price_unit: description: The currency in which `price` is measured nullable: true type: string start_date: description: The first date for which usage is included in this UsageRecord format: date nullable: true type: string subresource_uris: description: A list of related resources identified by their relative URIs nullable: true type: object uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string usage: description: The amount of usage nullable: true type: string usage_unit: description: The units in which usage is measured nullable: true type: string type: object api.v2010.account.usage.usage_record.usage_record_daily: properties: account_sid: description: The SID of the Account accrued the usage maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to create the resource nullable: true type: string as_of: description: Usage records up to date as of this timestamp nullable: true type: string category: description: The category of usage enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice nullable: true type: string count: description: The number of usage events nullable: true type: string count_unit: description: The units in which count is measured nullable: true type: string description: description: A plain-language description of the usage category nullable: true type: string end_date: description: The last date for which usage is included in the UsageRecord format: date nullable: true type: string price: description: The total price of the usage nullable: true type: number price_unit: description: The currency in which `price` is measured nullable: true type: string start_date: description: The first date for which usage is included in this UsageRecord format: date nullable: true type: string subresource_uris: description: A list of related resources identified by their relative URIs nullable: true type: object uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string usage: description: The amount of usage nullable: true type: string usage_unit: description: The units in which usage is measured nullable: true type: string type: object api.v2010.account.usage.usage_record.usage_record_last_month: properties: account_sid: description: The SID of the Account accrued the usage maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to create the resource nullable: true type: string as_of: description: Usage records up to date as of this timestamp nullable: true type: string category: description: The category of usage enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice nullable: true type: string count: description: The number of usage events nullable: true type: string count_unit: description: The units in which count is measured nullable: true type: string description: description: A plain-language description of the usage category nullable: true type: string end_date: description: The last date for which usage is included in the UsageRecord format: date nullable: true type: string price: description: The total price of the usage nullable: true type: number price_unit: description: The currency in which `price` is measured nullable: true type: string start_date: description: The first date for which usage is included in this UsageRecord format: date nullable: true type: string subresource_uris: description: A list of related resources identified by their relative URIs nullable: true type: object uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string usage: description: The amount of usage nullable: true type: string usage_unit: description: The units in which usage is measured nullable: true type: string type: object api.v2010.account.usage.usage_record.usage_record_monthly: properties: account_sid: description: The SID of the Account accrued the usage maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to create the resource nullable: true type: string as_of: description: Usage records up to date as of this timestamp nullable: true type: string category: description: The category of usage enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice nullable: true type: string count: description: The number of usage events nullable: true type: string count_unit: description: The units in which count is measured nullable: true type: string description: description: A plain-language description of the usage category nullable: true type: string end_date: description: The last date for which usage is included in the UsageRecord format: date nullable: true type: string price: description: The total price of the usage nullable: true type: number price_unit: description: The currency in which `price` is measured nullable: true type: string start_date: description: The first date for which usage is included in this UsageRecord format: date nullable: true type: string subresource_uris: description: A list of related resources identified by their relative URIs nullable: true type: object uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string usage: description: The amount of usage nullable: true type: string usage_unit: description: The units in which usage is measured nullable: true type: string type: object api.v2010.account.usage.usage_record.usage_record_this_month: properties: account_sid: description: The SID of the Account accrued the usage maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to create the resource nullable: true type: string as_of: description: Usage records up to date as of this timestamp nullable: true type: string category: description: The category of usage enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice nullable: true type: string count: description: The number of usage events nullable: true type: string count_unit: description: The units in which count is measured nullable: true type: string description: description: A plain-language description of the usage category nullable: true type: string end_date: description: The last date for which usage is included in the UsageRecord format: date nullable: true type: string price: description: The total price of the usage nullable: true type: number price_unit: description: The currency in which `price` is measured nullable: true type: string start_date: description: The first date for which usage is included in this UsageRecord format: date nullable: true type: string subresource_uris: description: A list of related resources identified by their relative URIs nullable: true type: object uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string usage: description: The amount of usage nullable: true type: string usage_unit: description: The units in which usage is measured nullable: true type: string type: object api.v2010.account.usage.usage_record.usage_record_today: properties: account_sid: description: The SID of the Account accrued the usage maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to create the resource nullable: true type: string as_of: description: Usage records up to date as of this timestamp nullable: true type: string category: description: The category of usage enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice nullable: true type: string count: description: The number of usage events nullable: true type: string count_unit: description: The units in which count is measured nullable: true type: string description: description: A plain-language description of the usage category nullable: true type: string end_date: description: The last date for which usage is included in the UsageRecord format: date nullable: true type: string price: description: The total price of the usage nullable: true type: number price_unit: description: The currency in which `price` is measured nullable: true type: string start_date: description: The first date for which usage is included in this UsageRecord format: date nullable: true type: string subresource_uris: description: A list of related resources identified by their relative URIs nullable: true type: object uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string usage: description: The amount of usage nullable: true type: string usage_unit: description: The units in which usage is measured nullable: true type: string type: object api.v2010.account.usage.usage_record.usage_record_yearly: properties: account_sid: description: The SID of the Account accrued the usage maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to create the resource nullable: true type: string as_of: description: Usage records up to date as of this timestamp nullable: true type: string category: description: The category of usage enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice nullable: true type: string count: description: The number of usage events nullable: true type: string count_unit: description: The units in which count is measured nullable: true type: string description: description: A plain-language description of the usage category nullable: true type: string end_date: description: The last date for which usage is included in the UsageRecord format: date nullable: true type: string price: description: The total price of the usage nullable: true type: number price_unit: description: The currency in which `price` is measured nullable: true type: string start_date: description: The first date for which usage is included in this UsageRecord format: date nullable: true type: string subresource_uris: description: A list of related resources identified by their relative URIs nullable: true type: object uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string usage: description: The amount of usage nullable: true type: string usage_unit: description: The units in which usage is measured nullable: true type: string type: object api.v2010.account.usage.usage_record.usage_record_yesterday: properties: account_sid: description: The SID of the Account accrued the usage maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to create the resource nullable: true type: string as_of: description: Usage records up to date as of this timestamp nullable: true type: string category: description: The category of usage enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice nullable: true type: string count: description: The number of usage events nullable: true type: string count_unit: description: The units in which count is measured nullable: true type: string description: description: A plain-language description of the usage category nullable: true type: string end_date: description: The last date for which usage is included in the UsageRecord format: date nullable: true type: string price: description: The total price of the usage nullable: true type: number price_unit: description: The currency in which `price` is measured nullable: true type: string start_date: description: The first date for which usage is included in this UsageRecord format: date nullable: true type: string subresource_uris: description: A list of related resources identified by their relative URIs nullable: true type: object uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string usage: description: The amount of usage nullable: true type: string usage_unit: description: The units in which usage is measured nullable: true type: string type: object api.v2010.account.usage.usage_trigger: properties: account_sid: description: The SID of the Account that this trigger monitors maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string api_version: description: The API version used to create the resource nullable: true type: string callback_method: description: The HTTP method we use to call callback_url enum: - HEAD - GET - POST - PATCH - PUT - DELETE nullable: true type: string callback_url: description: he URL we call when the trigger fires format: uri nullable: true type: string current_value: description: The current value of the field the trigger is watching nullable: true type: string date_created: description: The RFC 2822 date and time in GMT that the resource was created format: date-time-rfc-2822 nullable: true type: string date_fired: description: The RFC 2822 date and time in GMT that the trigger was last fired format: date-time-rfc-2822 nullable: true type: string date_updated: description: The RFC 2822 date and time in GMT that the resource was last updated format: date-time-rfc-2822 nullable: true type: string friendly_name: description: The string that you assigned to describe the trigger nullable: true type: string recurring: description: The frequency of a recurring UsageTrigger enum: - daily - monthly - yearly - alltime nullable: true type: string sid: description: The unique string that identifies the resource maxLength: 34 minLength: 34 nullable: true pattern: ^UT[0-9a-fA-F]{32}$ type: string trigger_by: description: The field in the UsageRecord resource that fires the trigger enum: - count - usage - price nullable: true type: string trigger_value: description: The value at which the trigger will fire nullable: true type: string uri: description: The URI of the resource, relative to `https://api.twilio.com` format: uri nullable: true type: string usage_category: description: The usage category the trigger watches enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice nullable: true type: string usage_record_uri: description: The URI of the UsageRecord resource this trigger watches nullable: true type: string type: object api.v2010.account.validation_request: properties: account_sid: description: The SID of the Account that created the resource maxLength: 34 minLength: 34 nullable: true pattern: ^AC[0-9a-fA-F]{32}$ type: string call_sid: description: The SID of the Call the resource is associated with maxLength: 34 minLength: 34 nullable: true pattern: ^CA[0-9a-fA-F]{32}$ type: string friendly_name: description: The string that you assigned to describe the resource nullable: true type: string phone_number: description: The phone number to verify in E.164 format nullable: true type: string validation_code: description: The 6 digit validation code that someone must enter to validate the Caller ID when `phone_number` is called nullable: true type: string type: object securitySchemes: accountSid_authToken: scheme: basic type: http info: contact: email: support@twilio.com name: Twilio Support url: https://support.twilio.com description: This is the public Twilio REST API. license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html termsOfService: https://www.twilio.com/legal/tos title: Twilio - Api version: 1.23.1 openapi: 3.0.1 paths: /2010-04-01/Accounts.json: description: Twilio accounts (aka Project) or subaccounts get: description: Retrieves a collection of Accounts belonging to the account used to make the request operationId: ListAccount parameters: - description: Only return the Account resources with friendly names that exactly match this name. in: query name: FriendlyName schema: type: string - description: Only return Account resources with the given status. Can be `closed`, `suspended` or `active`. in: query name: Status schema: enum: - active - suspended - closed type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: accounts: items: $ref: '#/components/schemas/api.v2010.account' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListAccountResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a new Twilio Subaccount from the account making the request operationId: CreateAccount requestBody: content: application/x-www-form-urlencoded: schema: properties: FriendlyName: description: A human readable description of the account to create, defaults to `SubAccount Created at {YYYY-MM-DD HH:MM meridian}` type: string title: CreateAccountRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - status pathType: list /2010-04-01/Accounts/{AccountSid}/Addresses.json: description: An Address instance resource represents your or your customer's physical location within a country. Around the world, some local authorities require the name and address of the user to be on file with Twilio to purchase and own a phone number. get: description: '' operationId: ListAddress parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The `customer_name` of the Address resources to read. in: query name: CustomerName schema: type: string - description: The string that identifies the Address resources to read. in: query name: FriendlyName schema: type: string - description: The ISO country code of the Address resources to read. in: query name: IsoCountry schema: type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: addresses: items: $ref: '#/components/schemas/api.v2010.account.address' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListAddressResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateAddress parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will be responsible for the new Address resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: AutoCorrectAddress: description: 'Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won''t alter the address you provide.' type: boolean City: description: The city of the new address. type: string CustomerName: description: The name to associate with the new address. type: string EmergencyEnabled: description: 'Whether to enable emergency calling on the new address. Can be: `true` or `false`.' type: boolean FriendlyName: description: A descriptive string that you create to describe the new address. It can be up to 64 characters long. type: string IsoCountry: description: The ISO country code of the new address. type: string PostalCode: description: The postal code of the new address. type: string Region: description: The state or region of the new address. type: string Street: description: The number and street address of the new address. type: string required: - CustomerName - Street - City - Region - PostalCode - IsoCountry title: CreateAddressRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.address' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - validated - verified pathType: list /2010-04-01/Accounts/{AccountSid}/Addresses/{AddressSid}/DependentPhoneNumbers.json: description: Phone numbers dependent on an Address resource get: description: '' operationId: ListDependentPhoneNumber parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the DependentPhoneNumber resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the Address resource associated with the phone number. in: path name: AddressSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: dependent_phone_numbers: items: $ref: '#/components/schemas/api.v2010.account.address.dependent_phone_number' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListDependentPhoneNumberResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - phone_number - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/Addresses/{Sid}.json: delete: description: '' operationId: DeleteAddress parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Address resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: An Address instance resource represents your or your customer's physical location within a country. Around the world, some local authorities require the name and address of the user to be on file with Twilio to purchase and own a phone number. get: description: '' operationId: FetchAddress parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Address resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.address' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: UpdateAddress parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that is responsible for the Address resource to update. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Address resource to update. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: AutoCorrectAddress: description: 'Whether we should automatically correct the address. Can be: `true` or `false` and the default is `true`. If empty or `true`, we will correct the address you provide if necessary. If `false`, we won''t alter the address you provide.' type: boolean City: description: The city of the address. type: string CustomerName: description: The name to associate with the address. type: string EmergencyEnabled: description: 'Whether to enable emergency calling on the address. Can be: `true` or `false`.' type: boolean FriendlyName: description: A descriptive string that you create to describe the address. It can be up to 64 characters long. type: string PostalCode: description: The postal code of the address. type: string Region: description: The state or region of the address. type: string Street: description: The number and street address of the address. type: string title: UpdateAddressRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.address' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - validated - verified pathType: instance /2010-04-01/Accounts/{AccountSid}/Applications.json: description: An Application instance resource represents an application that you have created with Twilio. An application inside of Twilio is just a set of URLs and other configuration data that tells Twilio how to behave when one of your Twilio numbers receives a call or SMS message. get: description: Retrieve a list of applications representing an application within the requesting account operationId: ListApplication parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The string that identifies the Application resources to read. in: query name: FriendlyName schema: type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: applications: items: $ref: '#/components/schemas/api.v2010.account.application' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListApplicationResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a new application within your account operationId: CreateApplication parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: ApiVersion: description: 'The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`. The default value is the account''s default API version.' type: string FriendlyName: description: A descriptive string that you create to describe the new application. It can be up to 64 characters long. type: string MessageStatusCallback: description: The URL we should call using a POST method to send message status information to your application. format: uri type: string SmsFallbackMethod: description: 'The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string SmsFallbackUrl: description: The URL that we should call when an error occurs while retrieving or executing the TwiML from `sms_url`. format: uri type: string SmsMethod: description: 'The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string SmsStatusCallback: description: The URL we should call using a POST method to send status information about SMS messages sent by the application. format: uri type: string SmsUrl: description: The URL we should call when the phone number receives an incoming SMS message. format: uri type: string StatusCallback: description: The URL we should call using the `status_callback_method` to send status information to your application. format: uri type: string StatusCallbackMethod: description: 'The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceCallerIdLookup: description: 'Whether we should look up the caller''s caller-ID name from the CNAM database (additional charges apply). Can be: `true` or `false`.' type: boolean VoiceFallbackMethod: description: 'The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceFallbackUrl: description: The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. format: uri type: string VoiceMethod: description: 'The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceUrl: description: The URL we should call when the phone number assigned to this application receives a call. format: uri type: string title: CreateApplicationRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.application' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - date_created pathType: list /2010-04-01/Accounts/{AccountSid}/Applications/{Sid}.json: delete: description: Delete the application by the specified application sid operationId: DeleteApplication parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Application resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: An Application instance resource represents an application that you have created with Twilio. An application inside of Twilio is just a set of URLs and other configuration data that tells Twilio how to behave when one of your Twilio numbers receives a call or SMS message. get: description: Fetch the application specified by the provided sid operationId: FetchApplication parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Application resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.application' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Updates the application's properties operationId: UpdateApplication parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Application resources to update. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Application resource to update. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: ApiVersion: description: 'The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`. The default value is your account''s default API version.' type: string FriendlyName: description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. type: string MessageStatusCallback: description: The URL we should call using a POST method to send message status information to your application. format: uri type: string SmsFallbackMethod: description: 'The HTTP method we should use to call `sms_fallback_url`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string SmsFallbackUrl: description: The URL that we should call when an error occurs while retrieving or executing the TwiML from `sms_url`. format: uri type: string SmsMethod: description: 'The HTTP method we should use to call `sms_url`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string SmsStatusCallback: description: 'Same as message_status_callback: The URL we should call using a POST method to send status information about SMS messages sent by the application. Deprecated, included for backwards compatibility.' format: uri type: string SmsUrl: description: The URL we should call when the phone number receives an incoming SMS message. format: uri type: string StatusCallback: description: The URL we should call using the `status_callback_method` to send status information to your application. format: uri type: string StatusCallbackMethod: description: 'The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceCallerIdLookup: description: 'Whether we should look up the caller''s caller-ID name from the CNAM database (additional charges apply). Can be: `true` or `false`.' type: boolean VoiceFallbackMethod: description: 'The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceFallbackUrl: description: The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. format: uri type: string VoiceMethod: description: 'The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceUrl: description: The URL we should call when the phone number assigned to this application receives a call. format: uri type: string title: UpdateApplicationRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.application' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - date_created pathType: instance /2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps.json: description: Authorized Twilio Connect apps get: description: Retrieve a list of authorized-connect-apps belonging to the account used to make the request operationId: ListAuthorizedConnectApp parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AuthorizedConnectApp resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: authorized_connect_apps: items: $ref: '#/components/schemas/api.v2010.account.authorized_connect_app' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListAuthorizedConnectAppResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - connect_app_sid - connect_app_friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/AuthorizedConnectApps/{ConnectAppSid}.json: description: Authorized Twilio Connect apps get: description: Fetch an instance of an authorized-connect-app operationId: FetchAuthorizedConnectApp parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the AuthorizedConnectApp resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the Connect App to fetch. in: path name: ConnectAppSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CN[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.authorized_connect_app' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - connect_app_sid - connect_app_friendly_name pathType: instance /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers.json: description: Country codes with available phone numbers get: description: '' operationId: ListAvailablePhoneNumberCountry parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the available phone number Country resources. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: countries: items: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListAvailablePhoneNumberCountryResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - country_code - country - beta pathType: list /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}.json: description: Country codes with available phone numbers get: description: '' operationId: FetchAvailablePhoneNumberCountry parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the available phone number Country resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country to fetch available phone number information about. in: path name: CountryCode required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - country_code - country - beta pathType: instance /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Local.json: description: Available local phone numbers get: description: '' operationId: ListAvailablePhoneNumberLocal parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers. in: path name: CountryCode required: true schema: type: string - description: The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada. in: query name: AreaCode schema: type: integer - description: The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource?code-sample=code-find-phone-numbers-by-number-pattern) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumberlocal-resource?code-sample=code-find-phone-numbers-by-character-pattern). If specified, this value must have at least two characters. in: query name: Contains schema: type: string - description: 'Whether the phone numbers can receive text messages. Can be: `true` or `false`.' in: query name: SmsEnabled schema: type: boolean - description: 'Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.' in: query name: MmsEnabled schema: type: boolean - description: 'Whether the phone numbers can receive calls. Can be: `true` or `false`.' in: query name: VoiceEnabled schema: type: boolean - description: 'Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeAllAddressRequired schema: type: boolean - description: 'Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeLocalAddressRequired schema: type: boolean - description: 'Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeForeignAddressRequired schema: type: boolean - description: 'Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.' in: query name: Beta schema: type: boolean - description: Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada. in: query name: NearNumber schema: type: string - description: Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada. in: query name: NearLatLong schema: type: string - description: The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada. in: query name: Distance schema: type: integer - description: Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada. in: query name: InPostalCode schema: type: string - description: Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada. in: query name: InRegion schema: type: string - description: Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. in: query name: InRateCenter schema: type: string - description: Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada. in: query name: InLata schema: type: string - description: Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number. in: query name: InLocality schema: type: string - description: 'Whether the phone numbers can receive faxes. Can be: `true` or `false`.' in: query name: FaxEnabled schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: available_phone_numbers: items: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_local' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListAvailablePhoneNumberLocalResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - phone_number - region - beta pathType: list /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/MachineToMachine.json: description: Available machine-to-machine phone numbers get: description: '' operationId: ListAvailablePhoneNumberMachineToMachine parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers. in: path name: CountryCode required: true schema: type: string - description: The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada. in: query name: AreaCode schema: type: integer - description: The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters. in: query name: Contains schema: type: string - description: 'Whether the phone numbers can receive text messages. Can be: `true` or `false`.' in: query name: SmsEnabled schema: type: boolean - description: 'Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.' in: query name: MmsEnabled schema: type: boolean - description: 'Whether the phone numbers can receive calls. Can be: `true` or `false`.' in: query name: VoiceEnabled schema: type: boolean - description: 'Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeAllAddressRequired schema: type: boolean - description: 'Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeLocalAddressRequired schema: type: boolean - description: 'Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeForeignAddressRequired schema: type: boolean - description: 'Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.' in: query name: Beta schema: type: boolean - description: Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada. in: query name: NearNumber schema: type: string - description: Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada. in: query name: NearLatLong schema: type: string - description: The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada. in: query name: Distance schema: type: integer - description: Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada. in: query name: InPostalCode schema: type: string - description: Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada. in: query name: InRegion schema: type: string - description: Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. in: query name: InRateCenter schema: type: string - description: Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada. in: query name: InLata schema: type: string - description: Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number. in: query name: InLocality schema: type: string - description: 'Whether the phone numbers can receive faxes. Can be: `true` or `false`.' in: query name: FaxEnabled schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: available_phone_numbers: items: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_machine_to_machine' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListAvailablePhoneNumberMachineToMachineResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - phone_number - region - beta pathType: list /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Mobile.json: description: Available mobile phone numbers get: description: '' operationId: ListAvailablePhoneNumberMobile parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers. in: path name: CountryCode required: true schema: type: string - description: The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada. in: query name: AreaCode schema: type: integer - description: The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters. in: query name: Contains schema: type: string - description: 'Whether the phone numbers can receive text messages. Can be: `true` or `false`.' in: query name: SmsEnabled schema: type: boolean - description: 'Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.' in: query name: MmsEnabled schema: type: boolean - description: 'Whether the phone numbers can receive calls. Can be: `true` or `false`.' in: query name: VoiceEnabled schema: type: boolean - description: 'Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeAllAddressRequired schema: type: boolean - description: 'Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeLocalAddressRequired schema: type: boolean - description: 'Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeForeignAddressRequired schema: type: boolean - description: 'Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.' in: query name: Beta schema: type: boolean - description: Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada. in: query name: NearNumber schema: type: string - description: Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada. in: query name: NearLatLong schema: type: string - description: The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada. in: query name: Distance schema: type: integer - description: Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada. in: query name: InPostalCode schema: type: string - description: Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada. in: query name: InRegion schema: type: string - description: Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. in: query name: InRateCenter schema: type: string - description: Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada. in: query name: InLata schema: type: string - description: Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number. in: query name: InLocality schema: type: string - description: 'Whether the phone numbers can receive faxes. Can be: `true` or `false`.' in: query name: FaxEnabled schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: available_phone_numbers: items: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_mobile' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListAvailablePhoneNumberMobileResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - phone_number - region - beta pathType: list /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/National.json: description: Available national phone numbers get: description: '' operationId: ListAvailablePhoneNumberNational parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers. in: path name: CountryCode required: true schema: type: string - description: The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada. in: query name: AreaCode schema: type: integer - description: The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters. in: query name: Contains schema: type: string - description: 'Whether the phone numbers can receive text messages. Can be: `true` or `false`.' in: query name: SmsEnabled schema: type: boolean - description: 'Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.' in: query name: MmsEnabled schema: type: boolean - description: 'Whether the phone numbers can receive calls. Can be: `true` or `false`.' in: query name: VoiceEnabled schema: type: boolean - description: 'Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeAllAddressRequired schema: type: boolean - description: 'Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeLocalAddressRequired schema: type: boolean - description: 'Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeForeignAddressRequired schema: type: boolean - description: 'Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.' in: query name: Beta schema: type: boolean - description: Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada. in: query name: NearNumber schema: type: string - description: Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada. in: query name: NearLatLong schema: type: string - description: The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada. in: query name: Distance schema: type: integer - description: Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada. in: query name: InPostalCode schema: type: string - description: Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada. in: query name: InRegion schema: type: string - description: Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. in: query name: InRateCenter schema: type: string - description: Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada. in: query name: InLata schema: type: string - description: Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number. in: query name: InLocality schema: type: string - description: 'Whether the phone numbers can receive faxes. Can be: `true` or `false`.' in: query name: FaxEnabled schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: available_phone_numbers: items: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_national' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListAvailablePhoneNumberNationalResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - phone_number - region - beta pathType: list /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/SharedCost.json: description: Available shared cost numbers get: description: '' operationId: ListAvailablePhoneNumberSharedCost parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers. in: path name: CountryCode required: true schema: type: string - description: The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada. in: query name: AreaCode schema: type: integer - description: The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters. in: query name: Contains schema: type: string - description: 'Whether the phone numbers can receive text messages. Can be: `true` or `false`.' in: query name: SmsEnabled schema: type: boolean - description: 'Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.' in: query name: MmsEnabled schema: type: boolean - description: 'Whether the phone numbers can receive calls. Can be: `true` or `false`.' in: query name: VoiceEnabled schema: type: boolean - description: 'Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeAllAddressRequired schema: type: boolean - description: 'Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeLocalAddressRequired schema: type: boolean - description: 'Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeForeignAddressRequired schema: type: boolean - description: 'Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.' in: query name: Beta schema: type: boolean - description: Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada. in: query name: NearNumber schema: type: string - description: Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada. in: query name: NearLatLong schema: type: string - description: The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada. in: query name: Distance schema: type: integer - description: Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada. in: query name: InPostalCode schema: type: string - description: Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada. in: query name: InRegion schema: type: string - description: Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. in: query name: InRateCenter schema: type: string - description: Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada. in: query name: InLata schema: type: string - description: Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number. in: query name: InLocality schema: type: string - description: 'Whether the phone numbers can receive faxes. Can be: `true` or `false`.' in: query name: FaxEnabled schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: available_phone_numbers: items: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_shared_cost' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListAvailablePhoneNumberSharedCostResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - phone_number - region - beta pathType: list /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/TollFree.json: description: Available toll free phone numbers get: description: '' operationId: ListAvailablePhoneNumberTollFree parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers. in: path name: CountryCode required: true schema: type: string - description: The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada. in: query name: AreaCode schema: type: integer - description: The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters. in: query name: Contains schema: type: string - description: 'Whether the phone numbers can receive text messages. Can be: `true` or `false`.' in: query name: SmsEnabled schema: type: boolean - description: 'Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.' in: query name: MmsEnabled schema: type: boolean - description: 'Whether the phone numbers can receive calls. Can be: `true` or `false`.' in: query name: VoiceEnabled schema: type: boolean - description: 'Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeAllAddressRequired schema: type: boolean - description: 'Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeLocalAddressRequired schema: type: boolean - description: 'Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeForeignAddressRequired schema: type: boolean - description: 'Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.' in: query name: Beta schema: type: boolean - description: Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada. in: query name: NearNumber schema: type: string - description: Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada. in: query name: NearLatLong schema: type: string - description: The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada. in: query name: Distance schema: type: integer - description: Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada. in: query name: InPostalCode schema: type: string - description: Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada. in: query name: InRegion schema: type: string - description: Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. in: query name: InRateCenter schema: type: string - description: Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada. in: query name: InLata schema: type: string - description: Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number. in: query name: InLocality schema: type: string - description: 'Whether the phone numbers can receive faxes. Can be: `true` or `false`.' in: query name: FaxEnabled schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: available_phone_numbers: items: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_toll_free' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListAvailablePhoneNumberTollFreeResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - phone_number - region - beta pathType: list /2010-04-01/Accounts/{AccountSid}/AvailablePhoneNumbers/{CountryCode}/Voip.json: description: Available VoIP phone numbers get: description: '' operationId: ListAvailablePhoneNumberVoip parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) requesting the AvailablePhoneNumber resources. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [ISO-3166-1](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) country code of the country from which to read phone numbers. in: path name: CountryCode required: true schema: type: string - description: The area code of the phone numbers to read. Applies to only phone numbers in the US and Canada. in: query name: AreaCode schema: type: integer - description: The pattern on which to match phone numbers. Valid characters are `*`, `0-9`, `a-z`, and `A-Z`. The `*` character matches any single digit. For examples, see [Example 2](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-2) and [Example 3](https://www.twilio.com/docs/phone-numbers/api/availablephonenumber-resource#local-get-basic-example-3). If specified, this value must have at least two characters. in: query name: Contains schema: type: string - description: 'Whether the phone numbers can receive text messages. Can be: `true` or `false`.' in: query name: SmsEnabled schema: type: boolean - description: 'Whether the phone numbers can receive MMS messages. Can be: `true` or `false`.' in: query name: MmsEnabled schema: type: boolean - description: 'Whether the phone numbers can receive calls. Can be: `true` or `false`.' in: query name: VoiceEnabled schema: type: boolean - description: 'Whether to exclude phone numbers that require an [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeAllAddressRequired schema: type: boolean - description: 'Whether to exclude phone numbers that require a local [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeLocalAddressRequired schema: type: boolean - description: 'Whether to exclude phone numbers that require a foreign [Address](https://www.twilio.com/docs/usage/api/address). Can be: `true` or `false` and the default is `false`.' in: query name: ExcludeForeignAddressRequired schema: type: boolean - description: 'Whether to read phone numbers that are new to the Twilio platform. Can be: `true` or `false` and the default is `true`.' in: query name: Beta schema: type: boolean - description: Given a phone number, find a geographically close number within `distance` miles. Distance defaults to 25 miles. Applies to only phone numbers in the US and Canada. in: query name: NearNumber schema: type: string - description: Given a latitude/longitude pair `lat,long` find geographically close numbers within `distance` miles. Applies to only phone numbers in the US and Canada. in: query name: NearLatLong schema: type: string - description: The search radius, in miles, for a `near_` query. Can be up to `500` and the default is `25`. Applies to only phone numbers in the US and Canada. in: query name: Distance schema: type: integer - description: Limit results to a particular postal code. Given a phone number, search within the same postal code as that number. Applies to only phone numbers in the US and Canada. in: query name: InPostalCode schema: type: string - description: Limit results to a particular region, state, or province. Given a phone number, search within the same region as that number. Applies to only phone numbers in the US and Canada. in: query name: InRegion schema: type: string - description: Limit results to a specific rate center, or given a phone number search within the same rate center as that number. Requires `in_lata` to be set as well. Applies to only phone numbers in the US and Canada. in: query name: InRateCenter schema: type: string - description: Limit results to a specific local access and transport area ([LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area)). Given a phone number, search within the same [LATA](https://en.wikipedia.org/wiki/Local_access_and_transport_area) as that number. Applies to only phone numbers in the US and Canada. in: query name: InLata schema: type: string - description: Limit results to a particular locality or city. Given a phone number, search within the same Locality as that number. in: query name: InLocality schema: type: string - description: 'Whether the phone numbers can receive faxes. Can be: `true` or `false`.' in: query name: FaxEnabled schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: available_phone_numbers: items: $ref: '#/components/schemas/api.v2010.account.available_phone_number_country.available_phone_number_voip' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListAvailablePhoneNumberVoipResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - phone_number - region - beta pathType: list /2010-04-01/Accounts/{AccountSid}/Balance.json: description: Account balance get: description: Fetch the balance for an Account based on Account Sid. Balance changes may not be reflected immediately. Child accounts do not contain balance information operationId: FetchBalance parameters: - description: The unique SID identifier of the Account. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.balance' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - account_sid - balance - currency pathType: list /2010-04-01/Accounts/{AccountSid}/Calls.json: description: A Call is an object that represents a connection between a telephone and Twilio. get: description: Retrieves a collection of calls made to and from your account operationId: ListCall parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call resource(s) to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: Only show calls made to this phone number, SIP address, Client identifier or SIM SID. in: query name: To schema: type: string - description: Only include calls from this phone number, SIP address, Client identifier or SIM SID. in: query name: From schema: type: string - description: Only include calls spawned by calls with this SID. in: query name: ParentCallSid schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string - description: 'The status of the calls to include. Can be: `queued`, `ringing`, `in-progress`, `canceled`, `completed`, `failed`, `busy`, or `no-answer`.' in: query name: Status schema: enum: - queued - ringing - in-progress - completed - busy - failed - no-answer - canceled type: string - description: 'Only include calls that started on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that started on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read calls that started on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read calls that started on or after midnight of this date.' in: query name: StartTime schema: format: date-time type: string - description: 'Only include calls that started on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that started on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read calls that started on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read calls that started on or after midnight of this date.' in: query name: StartTime< schema: format: date-time type: string - description: 'Only include calls that started on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that started on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read calls that started on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read calls that started on or after midnight of this date.' in: query name: StartTime> schema: format: date-time type: string - description: 'Only include calls that ended on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that ended on this date. You can also specify an inequality, such as `EndTime<=YYYY-MM-DD`, to read calls that ended on or before midnight of this date, and `EndTime>=YYYY-MM-DD` to read calls that ended on or after midnight of this date.' in: query name: EndTime schema: format: date-time type: string - description: 'Only include calls that ended on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that ended on this date. You can also specify an inequality, such as `EndTime<=YYYY-MM-DD`, to read calls that ended on or before midnight of this date, and `EndTime>=YYYY-MM-DD` to read calls that ended on or after midnight of this date.' in: query name: EndTime< schema: format: date-time type: string - description: 'Only include calls that ended on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read only calls that ended on this date. You can also specify an inequality, such as `EndTime<=YYYY-MM-DD`, to read calls that ended on or before midnight of this date, and `EndTime>=YYYY-MM-DD` to read calls that ended on or after midnight of this date.' in: query name: EndTime> schema: format: date-time type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: calls: items: $ref: '#/components/schemas/api.v2010.account.call' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListCallResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a new outgoing call to phones, SIP-enabled endpoints or Twilio Client connections operationId: CreateCall parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: ApplicationSid: description: The SID of the Application resource that will handle the call, if the call will be handled by an application. maxLength: 34 minLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ type: string AsyncAmd: description: 'Select whether to perform answering machine detection in the background. Default, blocks the execution of the call until Answering Machine Detection is completed. Can be: `true` or `false`.' type: string AsyncAmdStatusCallback: description: The URL that we should call using the `async_amd_status_callback_method` to notify customer application whether the call was answered by human, machine or fax. format: uri type: string AsyncAmdStatusCallbackMethod: description: 'The HTTP method we should use when calling the `async_amd_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string Byoc: description: The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that `byoc` is only meaningful when `to` is a phone number; it will otherwise be ignored. (Beta) maxLength: 34 minLength: 34 pattern: ^BY[0-9a-fA-F]{32}$ type: string CallReason: description: The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta) type: string CallToken: description: A token string needed to invoke a forwarded call. A call_token is generated when an incoming call is received on a Twilio number. Pass an incoming call's call_token value to a forwarded call via the call_token parameter when creating a new call. A forwarded call should bear the same CallerID of the original incoming call. type: string CallerId: description: The phone number, SIP address, or Client identifier that made this call. Phone numbers are in [E.164 format](https://wwnw.twilio.com/docs/glossary/what-e164) (e.g., +16175551212). SIP addresses are formatted as `name@company.com`. type: string FallbackMethod: description: 'The HTTP method that we should use to request the `fallback_url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string FallbackUrl: description: The URL that we call using the `fallback_method` if an error occurs when requesting or executing the TwiML at `url`. If an `application_sid` parameter is present, this parameter is ignored. format: uri type: string From: description: The phone number or client identifier to use as the caller id. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `From` must also be a phone number. type: string MachineDetection: description: 'Whether to detect if a human, answering machine, or fax has picked up the call. Can be: `Enable` or `DetectMessageEnd`. Use `Enable` if you would like us to return `AnsweredBy` as soon as the called party is identified. Use `DetectMessageEnd`, if you would like to leave a message on an answering machine. If `send_digits` is provided, this parameter is ignored. For more information, see [Answering Machine Detection](https://www.twilio.com/docs/voice/answering-machine-detection).' type: string MachineDetectionSilenceTimeout: description: 'The number of milliseconds of initial silence after which an `unknown` AnsweredBy result will be returned. Possible Values: 2000-10000. Default: 5000.' type: integer MachineDetectionSpeechEndThreshold: description: 'The number of milliseconds of silence after speech activity at which point the speech activity is considered complete. Possible Values: 500-5000. Default: 1200.' type: integer MachineDetectionSpeechThreshold: description: 'The number of milliseconds that is used as the measuring stick for the length of the speech activity, where durations lower than this value will be interpreted as a human and longer than this value as a machine. Possible Values: 1000-6000. Default: 2400.' type: integer MachineDetectionTimeout: description: The number of seconds that we should attempt to detect an answering machine before timing out and sending a voice request with `AnsweredBy` of `unknown`. The default timeout is 30 seconds. type: integer Method: description: 'The HTTP method we should use when calling the `url` parameter''s value. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string Record: description: Whether to record the call. Can be `true` to record the phone call, or `false` to not. The default is `false`. The `recording_url` is sent to the `status_callback` URL. type: boolean RecordingChannels: description: 'The number of channels in the final recording. Can be: `mono` or `dual`. The default is `mono`. `mono` records both legs of the call in a single channel of the recording file. `dual` records each leg to a separate channel of the recording file. The first channel of a dual-channel recording contains the parent call and the second channel contains the child call.' type: string RecordingStatusCallback: description: The URL that we call when the recording is available to be accessed. type: string RecordingStatusCallbackEvent: description: 'The recording status events that will trigger calls to the URL specified in `recording_status_callback`. Can be: `in-progress`, `completed` and `absent`. Defaults to `completed`. Separate multiple values with a space.' items: type: string type: array RecordingStatusCallbackMethod: description: 'The HTTP method we should use when calling the `recording_status_callback` URL. Can be: `GET` or `POST` and the default is `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string RecordingTrack: description: 'The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is generated from Twilio. `both` records the audio that is received and generated by Twilio.' type: string SendDigits: description: 'A string of keys to dial after connecting to the number, maximum of 32 digits. Valid digits in the string include: any digit (`0`-`9`), ''`#`'', ''`*`'' and ''`w`'', to insert a half second pause. For example, if you connected to a company phone number and wanted to pause for one second, and then dial extension 1234 followed by the pound key, the value of this parameter would be `ww1234#`. Remember to URL-encode this string, since the ''`#`'' character has special meaning in a URL. If both `SendDigits` and `MachineDetection` parameters are provided, then `MachineDetection` will be ignored.' type: string SipAuthPassword: description: The password required to authenticate the user account specified in `sip_auth_username`. type: string SipAuthUsername: description: The username used to authenticate the caller making a SIP call. type: string StatusCallback: description: The URL we should call using the `status_callback_method` to send status information to your application. If no `status_callback_event` is specified, we will send the `completed` status. If an `application_sid` parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted). format: uri type: string StatusCallbackEvent: description: 'The call progress events that we will send to the `status_callback` URL. Can be: `initiated`, `ringing`, `answered`, and `completed`. If no event is specified, we send the `completed` status. If you want to receive multiple events, specify each one in a separate `status_callback_event` parameter. See the code sample for [monitoring call progress](https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&code-sdk-version=json). If an `application_sid` is present, this parameter is ignored.' items: type: string type: array StatusCallbackMethod: description: 'The HTTP method we should use when calling the `status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string TimeLimit: description: The maximum duration of the call in seconds. Constraints depend on account and configuration. type: integer Timeout: description: The integer number of seconds that we should allow the phone to ring before assuming there is no answer. The default is `60` seconds and the maximum is `600` seconds. For some call flows, we will add a 5-second buffer to the timeout value you provide. For this reason, a timeout value of 10 seconds could result in an actual timeout closer to 15 seconds. You can set this to a short time, such as `15` seconds, to hang up before reaching an answering machine or voicemail. type: integer To: description: The phone number, SIP address, or client identifier to call. type: string Trim: description: 'Whether to trim any leading and trailing silence from the recording. Can be: `trim-silence` or `do-not-trim` and the default is `trim-silence`.' type: string Twiml: description: TwiML instructions for the call Twilio will use without fetching Twiml from url parameter. If both `twiml` and `url` are provided then `twiml` parameter will be ignored. Max 4000 characters. type: string Url: description: The absolute URL that returns the TwiML instructions for the call. We will call this URL using the `method` when the call connects. For more information, see the [Url Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/docs/voice/make-calls). format: uri type: string required: - To - From title: CreateCallRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - from - to - status - start_time pathType: list /2010-04-01/Accounts/{AccountSid}/Calls/FeedbackSummary.json: description: Call FeedbackSummary resources provide an idea of how your end user's perceive the quality of their calls and the most common issues they have encountered in the context of all your voice traffic during a specific time frame. post: description: Create a FeedbackSummary resource for a call operationId: CreateCallFeedbackSummary parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: EndDate: description: Only include feedback given on or before this date. Format is `YYYY-MM-DD` and specified in UTC. format: date type: string IncludeSubaccounts: description: Whether to also include Feedback resources from all subaccounts. `true` includes feedback from all subaccounts and `false`, the default, includes feedback from only the specified account. type: boolean StartDate: description: Only include feedback given on or after this date. Format is `YYYY-MM-DD` and specified in UTC. format: date type: string StatusCallback: description: The URL that we will request when the feedback summary is complete. format: uri type: string StatusCallbackMethod: description: The HTTP method (`GET` or `POST`) we use to make the request to the `StatusCallback` URL. enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string required: - StartDate - EndDate title: CreateCallFeedbackSummaryRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_feedback_summary' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - call_feedback_count - quality_score_average - start_date pathType: list /2010-04-01/Accounts/{AccountSid}/Calls/FeedbackSummary/{Sid}.json: delete: description: Delete a FeedbackSummary resource from a call operationId: DeleteCallFeedbackSummary parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies this resource. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^FS[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Call FeedbackSummary resources provide an idea of how your end user's perceive the quality of their calls and the most common issues they have encountered in the context of all your voice traffic during a specific time frame. get: description: Fetch a FeedbackSummary resource from a call operationId: FetchCallFeedbackSummary parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies this resource. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^FS[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_feedback_summary' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - call_feedback_count - quality_score_average - start_date pathType: instance /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Events.json: description: 'TODO: Resource-level docs' get: description: Retrieve a list of all events for a call. operationId: ListCallEvent parameters: - description: The unique SID identifier of the Account. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The unique SID identifier of the Call. in: path name: CallSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer events: items: $ref: '#/components/schemas/api.v2010.account.call.call_event' type: array first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListCallEventResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - request - response pathType: list /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Feedback.json: description: The call Feedback subresource describes the quality experienced during a phone call. get: description: Fetch a Feedback resource from a call operationId: FetchCallFeedback parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The call sid that uniquely identifies the call in: path name: CallSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_feedback' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Update a Feedback resource for a call operationId: UpdateCallFeedback parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The call sid that uniquely identifies the call in: path name: CallSid required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Issue: description: 'One or more issues experienced during the call. The issues can be: `imperfect-audio`, `dropped-call`, `incorrect-caller-id`, `post-dial-delay`, `digits-not-captured`, `audio-latency`, `unsolicited-call`, or `one-way-audio`.' items: enum: - audio-latency - digits-not-captured - dropped-call - imperfect-audio - incorrect-caller-id - one-way-audio - post-dial-delay - unsolicited-call type: string type: array QualityScore: description: The call quality expressed as an integer from `1` to `5` where `1` represents very poor call quality and `5` represents a perfect call. type: integer title: UpdateCallFeedbackRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_feedback' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - quality_score - date_created pathType: instance /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications.json: description: Error notifications for calls get: description: '' operationId: ListCallNotification parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call Notification resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the Call Notification resources to read. in: path name: CallSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string - description: 'Only read notifications of the specified log level. Can be: `0` to read only ERROR notifications or `1` to read only WARNING notifications. By default, all notifications are read.' in: query name: Log schema: type: integer - description: Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date. in: query name: MessageDate schema: format: date type: string - description: Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date. in: query name: MessageDate< schema: format: date type: string - description: Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date. in: query name: MessageDate> schema: format: date type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string notifications: items: $ref: '#/components/schemas/api.v2010.account.call.call_notification' type: array page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListCallNotificationResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - call_sid - error_code - message_date pathType: list /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Notifications/{Sid}.json: description: Error notifications for calls get: description: '' operationId: FetchCallNotification parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call Notification resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the Call Notification resource to fetch. in: path name: CallSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Call Notification resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^NO[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_notification-instance' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - call_sid - error_code - message_date pathType: instance /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments.json: description: Twilio enabled secure payments solution for accepting credit and ACH payments over the phone. post: description: create an instance of payments. This will start a new payments session operationId: CreatePayments parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the call that will create the resource. Call leg associated with this sid is expected to provide payment information thru DTMF. in: path name: CallSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: BankAccountType: description: Type of bank account if payment source is ACH. One of `consumer-checking`, `consumer-savings`, or `commercial-checking`. The default value is `consumer-checking`. enum: - consumer-checking - consumer-savings - commercial-checking type: string ChargeAmount: description: A positive decimal value less than 1,000,000 to charge against the credit card or bank account. Default currency can be overwritten with `currency` field. Leave blank or set to 0 to tokenize. type: number Currency: description: The currency of the `charge_amount`, formatted as [ISO 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format. The default value is `USD` and all values allowed from the Connector are accepted. type: string Description: description: The description can be used to provide more details regarding the transaction. This information is submitted along with the payment details to the Payment Connector which are then posted on the transactions. type: string IdempotencyKey: description: A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated. type: string Input: description: A list of inputs that should be accepted. Currently only `dtmf` is supported. All digits captured during a pay session are redacted from the logs. type: string MinPostalCodeLength: description: A positive integer that is used to validate the length of the `PostalCode` inputted by the user. User must enter this many digits. type: integer Parameter: description: A single level JSON string that is required when accepting certain information specific only to ACH payments. The information that has to be included here depends on the Connector. [Read more](https://www.twilio.com/console/voice/pay-connectors). type: object PaymentConnector: description: This is the unique name corresponding to the Payment Gateway Connector installed in the Twilio Add-ons. Learn more about [ Connectors](https://www.twilio.com/console/voice/pay-connectors). The default value is `Default`. type: string PaymentMethod: description: Type of payment being captured. One of `credit-card` or `ach-debit`. The default value is `credit-card`. enum: - credit-card - ach-debit type: string PostalCode: description: Indicates whether the credit card postal code (zip code) is a required piece of payment information that must be provided by the caller. The default is `true`. type: boolean SecurityCode: description: Indicates whether the credit card security code is a required piece of payment information that must be provided by the caller. The default is `true`. type: boolean StatusCallback: description: Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [expected StatusCallback values](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback) format: uri type: string Timeout: description: The number of seconds that should wait for the caller to press a digit between each subsequent digit, after the first one, before moving on to validate the digits captured. The default is `5`, maximum is `600`. type: integer TokenType: description: Indicates whether the payment method should be tokenized as a `one-time` or `reusable` token. The default value is `reusable`. Do not enter a charge amount when tokenizing. If a charge amount is entered, the payment method will be charged and not tokenized. enum: - one-time - reusable type: string ValidCardTypes: description: Credit card types separated by space that Pay should accept. The default value is `visa mastercard amex` type: string required: - IdempotencyKey - StatusCallback title: CreatePaymentsRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.payments' description: Created security: - accountSid_authToken: [] x-maturity: - Preview servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid pathType: list /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments/{Sid}.json: description: Twilio enabled secure payments solution for accepting credit and ACH payments over the phone. post: description: update an instance of payments with different phases of payment flows. operationId: UpdatePayments parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will update the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the call that will update the resource. This should be the same call sid that was used to create payments resource. in: path name: CallSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string - description: The SID of Payments session that needs to be updated. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^PK[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Capture: description: The piece of payment information that you wish the caller to enter. Must be one of `payment-card-number`, `expiration-date`, `security-code`, `postal-code`, `bank-routing-number`, or `bank-account-number`. enum: - payment-card-number - expiration-date - security-code - postal-code - bank-routing-number - bank-account-number type: string IdempotencyKey: description: A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated. type: string Status: description: Indicates whether the current payment session should be cancelled or completed. When `cancel` the payment session is cancelled. When `complete`, Twilio sends the payment information to the selected connector for processing. enum: - complete - cancel type: string StatusCallback: description: Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [Update](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-update) and [Complete/Cancel](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete) POST requests. format: uri type: string required: - IdempotencyKey - StatusCallback title: UpdatePaymentsRequest type: object responses: '202': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.payments' description: Accepted security: - accountSid_authToken: [] x-maturity: - Preview servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid pathType: instance /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings.json: description: A Recording resource represents the recording associated with a voice call, conference, or SIP Trunk. get: description: Retrieve a list of recordings belonging to the call used to make the request operationId: ListCallRecording parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to read. in: path name: CallSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string - description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.' in: query name: DateCreated schema: format: date type: string - description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.' in: query name: DateCreated< schema: format: date type: string - description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.' in: query name: DateCreated> schema: format: date type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string recordings: items: $ref: '#/components/schemas/api.v2010.account.call.call_recording' type: array start: type: integer uri: format: uri type: string title: ListCallRecordingResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a recording for the call operationId: CreateCallRecording parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) to associate the resource with. in: path name: CallSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: RecordingChannels: description: 'The number of channels used in the recording. Can be: `mono` or `dual` and the default is `mono`. `mono` records all parties of the call into one channel. `dual` records each party of a 2-party call into separate channels.' type: string RecordingStatusCallback: description: The URL we should call using the `recording_status_callback_method` on each recording event specified in `recording_status_callback_event`. For more information, see [RecordingStatusCallback parameters](https://www.twilio.com/docs/voice/api/recording#recordingstatuscallback). format: uri type: string RecordingStatusCallbackEvent: description: 'The recording status events on which we should call the `recording_status_callback` URL. Can be: `in-progress`, `completed` and `absent` and the default is `completed`. Separate multiple event values with a space.' items: type: string type: array RecordingStatusCallbackMethod: description: 'The HTTP method we should use to call `recording_status_callback`. Can be: `GET` or `POST` and the default is `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string RecordingTrack: description: 'The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is generated from Twilio. `both` records the audio that is received and generated by Twilio.' type: string Trim: description: 'Whether to trim any leading and trailing silence in the recording. Can be: `trim-silence` or `do-not-trim` and the default is `do-not-trim`. `trim-silence` trims the silence from the beginning and end of the recording and `do-not-trim` does not.' type: string title: CreateCallRecordingRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_recording' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - call_sid - status - start_time - duration pathType: list /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Recordings/{Sid}.json: delete: description: Delete a recording from your account operationId: DeleteCallRecording parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to delete. in: path name: CallSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Recording resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: A Recording resource represents the recording associated with a voice call, conference, or SIP Trunk. get: description: Fetch an instance of a recording for a call operationId: FetchCallRecording parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource to fetch. in: path name: CallSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Recording resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_recording' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: 'Changes the status of the recording to paused, stopped, or in-progress. Note: Pass `Twilio.CURRENT` instead of recording sid to reference current active recording.' operationId: UpdateCallRecording parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resource to update. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource to update. in: path name: CallSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Recording resource to update. in: path name: Sid required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: PauseBehavior: description: 'Whether to record during a pause. Can be: `skip` or `silence` and the default is `silence`. `skip` does not record during the pause period, while `silence` will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting `status` is set to `paused`.' type: string Status: description: 'The new status of the recording. Can be: `stopped`, `paused`, `in-progress`.' enum: - in-progress - paused - stopped - processing - completed - absent type: string required: - Status title: UpdateCallRecordingRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.call_recording' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - call_sid - status - start_time - duration pathType: instance /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Siprec.json: description: 'TODO: Resource-level docs' post: description: Create a Siprec operationId: CreateSiprec parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this Siprec resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Siprec resource is associated with. in: path name: CallSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: ConnectorName: description: Unique name used when configuring the connector via Marketplace Add-on. type: string Name: description: The user-specified name of this Siprec, if one was given when the Siprec was created. This may be used to stop the Siprec. type: string Parameter1.Name: description: Parameter name type: string Parameter1.Value: description: Parameter value type: string Parameter10.Name: description: Parameter name type: string Parameter10.Value: description: Parameter value type: string Parameter11.Name: description: Parameter name type: string Parameter11.Value: description: Parameter value type: string Parameter12.Name: description: Parameter name type: string Parameter12.Value: description: Parameter value type: string Parameter13.Name: description: Parameter name type: string Parameter13.Value: description: Parameter value type: string Parameter14.Name: description: Parameter name type: string Parameter14.Value: description: Parameter value type: string Parameter15.Name: description: Parameter name type: string Parameter15.Value: description: Parameter value type: string Parameter16.Name: description: Parameter name type: string Parameter16.Value: description: Parameter value type: string Parameter17.Name: description: Parameter name type: string Parameter17.Value: description: Parameter value type: string Parameter18.Name: description: Parameter name type: string Parameter18.Value: description: Parameter value type: string Parameter19.Name: description: Parameter name type: string Parameter19.Value: description: Parameter value type: string Parameter2.Name: description: Parameter name type: string Parameter2.Value: description: Parameter value type: string Parameter20.Name: description: Parameter name type: string Parameter20.Value: description: Parameter value type: string Parameter21.Name: description: Parameter name type: string Parameter21.Value: description: Parameter value type: string Parameter22.Name: description: Parameter name type: string Parameter22.Value: description: Parameter value type: string Parameter23.Name: description: Parameter name type: string Parameter23.Value: description: Parameter value type: string Parameter24.Name: description: Parameter name type: string Parameter24.Value: description: Parameter value type: string Parameter25.Name: description: Parameter name type: string Parameter25.Value: description: Parameter value type: string Parameter26.Name: description: Parameter name type: string Parameter26.Value: description: Parameter value type: string Parameter27.Name: description: Parameter name type: string Parameter27.Value: description: Parameter value type: string Parameter28.Name: description: Parameter name type: string Parameter28.Value: description: Parameter value type: string Parameter29.Name: description: Parameter name type: string Parameter29.Value: description: Parameter value type: string Parameter3.Name: description: Parameter name type: string Parameter3.Value: description: Parameter value type: string Parameter30.Name: description: Parameter name type: string Parameter30.Value: description: Parameter value type: string Parameter31.Name: description: Parameter name type: string Parameter31.Value: description: Parameter value type: string Parameter32.Name: description: Parameter name type: string Parameter32.Value: description: Parameter value type: string Parameter33.Name: description: Parameter name type: string Parameter33.Value: description: Parameter value type: string Parameter34.Name: description: Parameter name type: string Parameter34.Value: description: Parameter value type: string Parameter35.Name: description: Parameter name type: string Parameter35.Value: description: Parameter value type: string Parameter36.Name: description: Parameter name type: string Parameter36.Value: description: Parameter value type: string Parameter37.Name: description: Parameter name type: string Parameter37.Value: description: Parameter value type: string Parameter38.Name: description: Parameter name type: string Parameter38.Value: description: Parameter value type: string Parameter39.Name: description: Parameter name type: string Parameter39.Value: description: Parameter value type: string Parameter4.Name: description: Parameter name type: string Parameter4.Value: description: Parameter value type: string Parameter40.Name: description: Parameter name type: string Parameter40.Value: description: Parameter value type: string Parameter41.Name: description: Parameter name type: string Parameter41.Value: description: Parameter value type: string Parameter42.Name: description: Parameter name type: string Parameter42.Value: description: Parameter value type: string Parameter43.Name: description: Parameter name type: string Parameter43.Value: description: Parameter value type: string Parameter44.Name: description: Parameter name type: string Parameter44.Value: description: Parameter value type: string Parameter45.Name: description: Parameter name type: string Parameter45.Value: description: Parameter value type: string Parameter46.Name: description: Parameter name type: string Parameter46.Value: description: Parameter value type: string Parameter47.Name: description: Parameter name type: string Parameter47.Value: description: Parameter value type: string Parameter48.Name: description: Parameter name type: string Parameter48.Value: description: Parameter value type: string Parameter49.Name: description: Parameter name type: string Parameter49.Value: description: Parameter value type: string Parameter5.Name: description: Parameter name type: string Parameter5.Value: description: Parameter value type: string Parameter50.Name: description: Parameter name type: string Parameter50.Value: description: Parameter value type: string Parameter51.Name: description: Parameter name type: string Parameter51.Value: description: Parameter value type: string Parameter52.Name: description: Parameter name type: string Parameter52.Value: description: Parameter value type: string Parameter53.Name: description: Parameter name type: string Parameter53.Value: description: Parameter value type: string Parameter54.Name: description: Parameter name type: string Parameter54.Value: description: Parameter value type: string Parameter55.Name: description: Parameter name type: string Parameter55.Value: description: Parameter value type: string Parameter56.Name: description: Parameter name type: string Parameter56.Value: description: Parameter value type: string Parameter57.Name: description: Parameter name type: string Parameter57.Value: description: Parameter value type: string Parameter58.Name: description: Parameter name type: string Parameter58.Value: description: Parameter value type: string Parameter59.Name: description: Parameter name type: string Parameter59.Value: description: Parameter value type: string Parameter6.Name: description: Parameter name type: string Parameter6.Value: description: Parameter value type: string Parameter60.Name: description: Parameter name type: string Parameter60.Value: description: Parameter value type: string Parameter61.Name: description: Parameter name type: string Parameter61.Value: description: Parameter value type: string Parameter62.Name: description: Parameter name type: string Parameter62.Value: description: Parameter value type: string Parameter63.Name: description: Parameter name type: string Parameter63.Value: description: Parameter value type: string Parameter64.Name: description: Parameter name type: string Parameter64.Value: description: Parameter value type: string Parameter65.Name: description: Parameter name type: string Parameter65.Value: description: Parameter value type: string Parameter66.Name: description: Parameter name type: string Parameter66.Value: description: Parameter value type: string Parameter67.Name: description: Parameter name type: string Parameter67.Value: description: Parameter value type: string Parameter68.Name: description: Parameter name type: string Parameter68.Value: description: Parameter value type: string Parameter69.Name: description: Parameter name type: string Parameter69.Value: description: Parameter value type: string Parameter7.Name: description: Parameter name type: string Parameter7.Value: description: Parameter value type: string Parameter70.Name: description: Parameter name type: string Parameter70.Value: description: Parameter value type: string Parameter71.Name: description: Parameter name type: string Parameter71.Value: description: Parameter value type: string Parameter72.Name: description: Parameter name type: string Parameter72.Value: description: Parameter value type: string Parameter73.Name: description: Parameter name type: string Parameter73.Value: description: Parameter value type: string Parameter74.Name: description: Parameter name type: string Parameter74.Value: description: Parameter value type: string Parameter75.Name: description: Parameter name type: string Parameter75.Value: description: Parameter value type: string Parameter76.Name: description: Parameter name type: string Parameter76.Value: description: Parameter value type: string Parameter77.Name: description: Parameter name type: string Parameter77.Value: description: Parameter value type: string Parameter78.Name: description: Parameter name type: string Parameter78.Value: description: Parameter value type: string Parameter79.Name: description: Parameter name type: string Parameter79.Value: description: Parameter value type: string Parameter8.Name: description: Parameter name type: string Parameter8.Value: description: Parameter value type: string Parameter80.Name: description: Parameter name type: string Parameter80.Value: description: Parameter value type: string Parameter81.Name: description: Parameter name type: string Parameter81.Value: description: Parameter value type: string Parameter82.Name: description: Parameter name type: string Parameter82.Value: description: Parameter value type: string Parameter83.Name: description: Parameter name type: string Parameter83.Value: description: Parameter value type: string Parameter84.Name: description: Parameter name type: string Parameter84.Value: description: Parameter value type: string Parameter85.Name: description: Parameter name type: string Parameter85.Value: description: Parameter value type: string Parameter86.Name: description: Parameter name type: string Parameter86.Value: description: Parameter value type: string Parameter87.Name: description: Parameter name type: string Parameter87.Value: description: Parameter value type: string Parameter88.Name: description: Parameter name type: string Parameter88.Value: description: Parameter value type: string Parameter89.Name: description: Parameter name type: string Parameter89.Value: description: Parameter value type: string Parameter9.Name: description: Parameter name type: string Parameter9.Value: description: Parameter value type: string Parameter90.Name: description: Parameter name type: string Parameter90.Value: description: Parameter value type: string Parameter91.Name: description: Parameter name type: string Parameter91.Value: description: Parameter value type: string Parameter92.Name: description: Parameter name type: string Parameter92.Value: description: Parameter value type: string Parameter93.Name: description: Parameter name type: string Parameter93.Value: description: Parameter value type: string Parameter94.Name: description: Parameter name type: string Parameter94.Value: description: Parameter value type: string Parameter95.Name: description: Parameter name type: string Parameter95.Value: description: Parameter value type: string Parameter96.Name: description: Parameter name type: string Parameter96.Value: description: Parameter value type: string Parameter97.Name: description: Parameter name type: string Parameter97.Value: description: Parameter value type: string Parameter98.Name: description: Parameter name type: string Parameter98.Value: description: Parameter value type: string Parameter99.Name: description: Parameter name type: string Parameter99.Value: description: Parameter value type: string StatusCallback: description: Absolute URL of the status callback. format: uri type: string StatusCallbackMethod: description: The http method for the status_callback (one of GET, POST). enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string Track: description: One of `inbound_track`, `outbound_track`, `both_tracks`. enum: - inbound_track - outbound_track - both_tracks type: string title: CreateSiprecRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.siprec' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - call_sid - name pathType: list /2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Siprec/{Sid}.json: description: 'TODO: Resource-level docs' post: description: Stop a Siprec using either the SID of the Siprec resource or the `name` used when creating the resource operationId: UpdateSiprec parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created this Siprec resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Siprec resource is associated with. in: path name: CallSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string - description: The SID of the Siprec resource, or the `name` used when creating the resource in: path name: Sid required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Status: description: The status. Must have the value `stopped` enum: - stopped type: string required: - Status title: UpdateSiprecRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call.siprec' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - call_sid - name pathType: instance /2010-04-01/Accounts/{AccountSid}/Calls/{Sid}.json: delete: description: Delete a Call record from your account. Once the record is deleted, it will no longer appear in the API and Account Portal logs. operationId: DeleteCall parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call resource(s) to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided Call SID that uniquely identifies the Call resource to delete in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: A Call is an object that represents a connection between a telephone and Twilio. get: description: Fetch the call specified by the provided Call SID operationId: FetchCall parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call resource(s) to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the Call resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Initiates a call redirect or terminates a call operationId: UpdateCall parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Call resource(s) to update. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Call resource to update in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: FallbackMethod: description: 'The HTTP method that we should use to request the `fallback_url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string FallbackUrl: description: The URL that we call using the `fallback_method` if an error occurs when requesting or executing the TwiML at `url`. If an `application_sid` parameter is present, this parameter is ignored. format: uri type: string Method: description: 'The HTTP method we should use when calling the `url`. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string Status: description: 'The new status of the resource. Can be: `canceled` or `completed`. Specifying `canceled` will attempt to hang up calls that are queued or ringing; however, it will not affect calls already in progress. Specifying `completed` will attempt to hang up a call even if it''s already in progress.' enum: - canceled - completed type: string StatusCallback: description: The URL we should call using the `status_callback_method` to send status information to your application. If no `status_callback_event` is specified, we will send the `completed` status. If an `application_sid` parameter is present, this parameter is ignored. URLs must contain a valid hostname (underscores are not permitted). format: uri type: string StatusCallbackMethod: description: 'The HTTP method we should use when requesting the `status_callback` URL. Can be: `GET` or `POST` and the default is `POST`. If an `application_sid` parameter is present, this parameter is ignored.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string TimeLimit: description: The maximum duration of the call in seconds. Constraints depend on account and configuration. type: integer Twiml: description: TwiML instructions for the call Twilio will use without fetching Twiml from url. Twiml and url parameters are mutually exclusive type: string Url: description: The absolute URL that returns the TwiML instructions for the call. We will call this URL using the `method` when the call connects. For more information, see the [Url Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/docs/voice/make-calls). format: uri type: string title: UpdateCallRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.call' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - from - to - status - start_time pathType: instance /2010-04-01/Accounts/{AccountSid}/Conferences.json: description: Voice call conferences get: description: Retrieve a list of conferences belonging to the account used to make the request operationId: ListConference parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference resource(s) to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that started on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that started on or after midnight on a date, use `>=YYYY-MM-DD`. in: query name: DateCreated schema: format: date type: string - description: The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that started on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that started on or after midnight on a date, use `>=YYYY-MM-DD`. in: query name: DateCreated< schema: format: date type: string - description: The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that started on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that started on or after midnight on a date, use `>=YYYY-MM-DD`. in: query name: DateCreated> schema: format: date type: string - description: The `date_updated` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that were last updated on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that were last updated on or after midnight on a given date, use `>=YYYY-MM-DD`. in: query name: DateUpdated schema: format: date type: string - description: The `date_updated` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that were last updated on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that were last updated on or after midnight on a given date, use `>=YYYY-MM-DD`. in: query name: DateUpdated< schema: format: date type: string - description: The `date_updated` value, specified as `YYYY-MM-DD`, of the resources to read. To read conferences that were last updated on or before midnight on a date, use `<=YYYY-MM-DD`, and to specify conferences that were last updated on or after midnight on a given date, use `>=YYYY-MM-DD`. in: query name: DateUpdated> schema: format: date type: string - description: The string that identifies the Conference resources to read. in: query name: FriendlyName schema: type: string - description: 'The status of the resources to read. Can be: `init`, `in-progress`, or `completed`.' in: query name: Status schema: enum: - init - in-progress - completed type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: conferences: items: $ref: '#/components/schemas/api.v2010.account.conference' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListConferenceResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - status pathType: list /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants.json: description: Conference participants get: description: Retrieve a list of participants belonging to the account used to make the request operationId: ListParticipant parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the conference with the participants to read. in: path name: ConferenceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CF[0-9a-fA-F]{32}$ type: string - description: 'Whether to return only participants that are muted. Can be: `true` or `false`.' in: query name: Muted schema: type: boolean - description: 'Whether to return only participants that are on hold. Can be: `true` or `false`.' in: query name: Hold schema: type: boolean - description: 'Whether to return only participants who are coaching another call. Can be: `true` or `false`.' in: query name: Coaching schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer participants: items: $ref: '#/components/schemas/api.v2010.account.conference.participant' type: array previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListParticipantResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateParticipant parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the participant's conference. in: path name: ConferenceSid required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Beep: description: 'Whether to play a notification beep to the conference when the participant joins. Can be: `true`, `false`, `onEnter`, or `onExit`. The default value is `true`.' type: string Byoc: description: The SID of a BYOC (Bring Your Own Carrier) trunk to route this call with. Note that `byoc` is only meaningful when `to` is a phone number; it will otherwise be ignored. (Beta) maxLength: 34 minLength: 34 pattern: ^BY[0-9a-fA-F]{32}$ type: string CallReason: description: The Reason for the outgoing call. Use it to specify the purpose of the call that is presented on the called party's phone. (Branded Calls Beta) type: string CallSidToCoach: description: The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`. maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string CallerId: description: The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). Client identifiers are formatted `client:name`. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `callerId` must also be a phone number. If `to` is sip address, this value of `callerId` should be a username portion to be used to populate the From header that is passed to the SIP endpoint. type: string Coaching: description: 'Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.' type: boolean ConferenceRecord: description: 'Whether to record the conference the participant is joining. Can be: `true`, `false`, `record-from-start`, and `do-not-record`. The default value is `false`.' type: string ConferenceRecordingStatusCallback: description: The URL we should call using the `conference_recording_status_callback_method` when the conference recording is available. format: uri type: string ConferenceRecordingStatusCallbackEvent: description: 'The conference recording state changes that generate a call to `conference_recording_status_callback`. Can be: `in-progress`, `completed`, `failed`, and `absent`. Separate multiple values with a space, ex: `''in-progress completed failed''`' items: type: string type: array ConferenceRecordingStatusCallbackMethod: description: 'The HTTP method we should use to call `conference_recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string ConferenceStatusCallback: description: The URL we should call using the `conference_status_callback_method` when the conference events in `conference_status_callback_event` occur. Only the value set by the first participant to join the conference is used. Subsequent `conference_status_callback` values are ignored. format: uri type: string ConferenceStatusCallbackEvent: description: 'The conference state changes that should generate a call to `conference_status_callback`. Can be: `start`, `end`, `join`, `leave`, `mute`, `hold`, `modify`, `speaker`, and `announcement`. Separate multiple values with a space. Defaults to `start end`.' items: type: string type: array ConferenceStatusCallbackMethod: description: 'The HTTP method we should use to call `conference_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string ConferenceTrim: description: 'Whether to trim leading and trailing silence from your recorded conference audio files. Can be: `trim-silence` or `do-not-trim` and defaults to `trim-silence`.' type: string EarlyMedia: description: 'Whether to allow an agent to hear the state of the outbound call, including ringing or disconnect messages. Can be: `true` or `false` and defaults to `true`.' type: boolean EndConferenceOnExit: description: 'Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`.' type: boolean From: description: The phone number, Client identifier, or username portion of SIP address that made this call. Phone numbers are in [E.164](https://www.twilio.com/docs/glossary/what-e164) format (e.g., +16175551212). Client identifiers are formatted `client:name`. If using a phone number, it must be a Twilio number or a Verified [outgoing caller id](https://www.twilio.com/docs/voice/api/outgoing-caller-ids) for your account. If the `to` parameter is a phone number, `from` must also be a phone number. If `to` is sip address, this value of `from` should be a username portion to be used to populate the P-Asserted-Identity header that is passed to the SIP endpoint. type: string JitterBufferSize: description: 'Jitter buffer size for the connecting participant. Twilio will use this setting to apply Jitter Buffer before participant''s audio is mixed into the conference. Can be: `off`, `small`, `medium`, and `large`. Default to `large`.' type: string Label: description: A label for this participant. If one is supplied, it may subsequently be used to fetch, update or delete the participant. type: string MaxParticipants: description: The maximum number of participants in the conference. Can be a positive integer from `2` to `250`. The default value is `250`. type: integer Muted: description: Whether the agent is muted in the conference. Can be `true` or `false` and the default is `false`. type: boolean Record: description: Whether to record the participant and their conferences, including the time between conferences. Can be `true` or `false` and the default is `false`. type: boolean RecordingChannels: description: 'The recording channels for the final recording. Can be: `mono` or `dual` and the default is `mono`.' type: string RecordingStatusCallback: description: The URL that we should call using the `recording_status_callback_method` when the recording status changes. format: uri type: string RecordingStatusCallbackEvent: description: 'The recording state changes that should generate a call to `recording_status_callback`. Can be: `started`, `in-progress`, `paused`, `resumed`, `stopped`, `completed`, `failed`, and `absent`. Separate multiple values with a space, ex: `''in-progress completed failed''`.' items: type: string type: array RecordingStatusCallbackMethod: description: 'The HTTP method we should use when we call `recording_status_callback`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string RecordingTrack: description: 'The audio track to record for the call. Can be: `inbound`, `outbound` or `both`. The default is `both`. `inbound` records the audio that is received by Twilio. `outbound` records the audio that is sent from Twilio. `both` records the audio that is received and sent by Twilio.' type: string Region: description: The [region](https://support.twilio.com/hc/en-us/articles/223132167-How-global-low-latency-routing-and-region-selection-work-for-conferences-and-Client-calls) where we should mix the recorded audio. Can be:`us1`, `ie1`, `de1`, `sg1`, `br1`, `au1`, or `jp1`. type: string SipAuthPassword: description: The SIP password for authentication. type: string SipAuthUsername: description: The SIP username used for authentication. type: string StartConferenceOnEnter: description: 'Whether to start the conference when the participant joins, if it has not already started. Can be: `true` or `false` and the default is `true`. If `false` and the conference has not started, the participant is muted and hears background music until another participant starts the conference.' type: boolean StatusCallback: description: The URL we should call using the `status_callback_method` to send status information to your application. format: uri type: string StatusCallbackEvent: description: 'The conference state changes that should generate a call to `status_callback`. Can be: `initiated`, `ringing`, `answered`, and `completed`. Separate multiple values with a space. The default value is `completed`.' items: type: string type: array StatusCallbackMethod: description: 'The HTTP method we should use to call `status_callback`. Can be: `GET` and `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string TimeLimit: description: The maximum duration of the call in seconds. Constraints depend on account and configuration. type: integer Timeout: description: The number of seconds that we should allow the phone to ring before assuming there is no answer. Can be an integer between `5` and `600`, inclusive. The default value is `60`. We always add a 5-second timeout buffer to outgoing calls, so value of 10 would result in an actual timeout that was closer to 15 seconds. type: integer To: description: The phone number, SIP address, or Client identifier 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 `sip:name@company.com`. Client identifiers are formatted `client:name`. [Custom parameters](https://www.twilio.com/docs/voice/api/conference-participant-resource#custom-parameters) may also be specified. type: string WaitMethod: description: The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file. enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string WaitUrl: description: The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic). format: uri type: string required: - From - To title: CreateParticipantRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference.participant' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - call_sid - label - status - muted - hold pathType: list /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Participants/{CallSid}.json: delete: description: Kick a participant from a given conference operationId: DeleteParticipant parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the conference with the participants to delete. in: path name: ConferenceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CF[0-9a-fA-F]{32}$ type: string - description: The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to delete. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20. in: path name: CallSid required: true schema: type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Conference participants get: description: Fetch an instance of a participant operationId: FetchParticipant parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the conference with the participant to fetch. in: path name: ConferenceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CF[0-9a-fA-F]{32}$ type: string - description: The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to fetch. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20. in: path name: CallSid required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference.participant' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Update the properties of the participant operationId: UpdateParticipant parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Participant resources to update. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the conference with the participant to update. in: path name: ConferenceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CF[0-9a-fA-F]{32}$ type: string - description: The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID or label of the participant to update. Non URL safe characters in a label must be percent encoded, for example, a space character is represented as %20. in: path name: CallSid required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: AnnounceMethod: description: 'The HTTP method we should use to call `announce_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string AnnounceUrl: description: The URL we call using the `announce_method` for an announcement to the participant. The URL must return an MP3 file, a WAV file, or a TwiML document that contains `` or `` commands. format: uri type: string BeepOnExit: description: 'Whether to play a notification beep to the conference when the participant exits. Can be: `true` or `false`.' type: boolean CallSidToCoach: description: The SID of the participant who is being `coached`. The participant being coached is the only participant who can hear the participant who is `coaching`. maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string Coaching: description: 'Whether the participant is coaching another call. Can be: `true` or `false`. If not present, defaults to `false` unless `call_sid_to_coach` is defined. If `true`, `call_sid_to_coach` must be defined.' type: boolean EndConferenceOnExit: description: 'Whether to end the conference when the participant leaves. Can be: `true` or `false` and defaults to `false`.' type: boolean Hold: description: 'Whether the participant should be on hold. Can be: `true` or `false`. `true` puts the participant on hold, and `false` lets them rejoin the conference.' type: boolean HoldMethod: description: 'The HTTP method we should use to call `hold_url`. Can be: `GET` or `POST` and the default is `GET`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string HoldUrl: description: The URL we call using the `hold_method` for music that plays when the participant is on hold. The URL may return an MP3 file, a WAV file, or a TwiML document that contains the ``, `` or `` commands. format: uri type: string Muted: description: Whether the participant should be muted. Can be `true` or `false`. `true` will mute the participant, and `false` will un-mute them. Anything value other than `true` or `false` is interpreted as `false`. type: boolean WaitMethod: description: The HTTP method we should use to call `wait_url`. Can be `GET` or `POST` and the default is `POST`. When using a static audio file, this should be `GET` so that we can cache the file. enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string WaitUrl: description: The URL we should call using the `wait_method` for the music to play while participants are waiting for the conference to start. The default value is the URL of our standard hold music. [Learn more about hold music](https://www.twilio.com/labs/twimlets/holdmusic). format: uri type: string title: UpdateParticipantRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference.participant' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - call_sid - label - status - muted - hold pathType: instance /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings.json: description: Recordings of conferences get: description: Retrieve a list of recordings belonging to the call used to make the request operationId: ListConferenceRecording parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference Recording resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Conference SID that identifies the conference associated with the recording to read. in: path name: ConferenceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CF[0-9a-fA-F]{32}$ type: string - description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.' in: query name: DateCreated schema: format: date type: string - description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.' in: query name: DateCreated< schema: format: date type: string - description: 'The `date_created` value, specified as `YYYY-MM-DD`, of the resources to read. You can also specify inequality: `DateCreated<=YYYY-MM-DD` will return recordings generated at or before midnight on a given date, and `DateCreated>=YYYY-MM-DD` returns recordings generated at or after midnight on a date.' in: query name: DateCreated> schema: format: date type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string recordings: items: $ref: '#/components/schemas/api.v2010.account.conference.conference_recording' type: array start: type: integer uri: format: uri type: string title: ListConferenceRecordingResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - conference_sid - status - start_time - duration pathType: list /2010-04-01/Accounts/{AccountSid}/Conferences/{ConferenceSid}/Recordings/{Sid}.json: delete: description: Delete a recording from your account operationId: DeleteConferenceRecording parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference Recording resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Conference SID that identifies the conference associated with the recording to delete. in: path name: ConferenceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CF[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Conference Recording resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Recordings of conferences get: description: Fetch an instance of a recording for a call operationId: FetchConferenceRecording parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference Recording resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Conference SID that identifies the conference associated with the recording to fetch. in: path name: ConferenceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CF[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Conference Recording resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference.conference_recording' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: 'Changes the status of the recording to paused, stopped, or in-progress. Note: To use `Twilio.CURRENT`, pass it as recording sid.' operationId: UpdateConferenceRecording parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference Recording resource to update. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Conference SID that identifies the conference associated with the recording to update. in: path name: ConferenceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CF[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Conference Recording resource to update. Use `Twilio.CURRENT` to reference the current active recording. in: path name: Sid required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: PauseBehavior: description: 'Whether to record during a pause. Can be: `skip` or `silence` and the default is `silence`. `skip` does not record during the pause period, while `silence` will replace the actual audio of the call with silence during the pause period. This parameter only applies when setting `status` is set to `paused`.' type: string Status: description: 'The new status of the recording. Can be: `stopped`, `paused`, `in-progress`.' enum: - in-progress - paused - stopped - processing - completed - absent type: string required: - Status title: UpdateConferenceRecordingRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference.conference_recording' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - conference_sid - status - start_time - duration pathType: instance /2010-04-01/Accounts/{AccountSid}/Conferences/{Sid}.json: description: Voice call conferences get: description: Fetch an instance of a conference operationId: FetchConference parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference resource(s) to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Conference resource to fetch in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CF[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: UpdateConference parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Conference resource(s) to update. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Conference resource to update in: path name: Sid required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: AnnounceMethod: description: 'The HTTP method used to call `announce_url`. Can be: `GET` or `POST` and the default is `POST`' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string AnnounceUrl: description: The URL we should call to announce something into the conference. The URL can return an MP3, a WAV, or a TwiML document with `` or ``. format: uri type: string Status: description: 'The new status of the resource. Can be: Can be: `init`, `in-progress`, or `completed`. Specifying `completed` will end the conference and hang up all participants' enum: - completed type: string title: UpdateConferenceRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.conference' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - status pathType: instance /2010-04-01/Accounts/{AccountSid}/ConnectApps.json: description: Twilio Connect apps get: description: Retrieve a list of connect-apps belonging to the account used to make the request operationId: ListConnectApp parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ConnectApp resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: connect_apps: items: $ref: '#/components/schemas/api.v2010.account.connect_app' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListConnectAppResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/ConnectApps/{Sid}.json: delete: description: Delete an instance of a connect-app operationId: DeleteConnectApp parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ConnectApp resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the ConnectApp resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CN[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Twilio Connect apps get: description: Fetch an instance of a connect-app operationId: FetchConnectApp parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ConnectApp resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the ConnectApp resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CN[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.connect_app' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Update a connect-app with the specified parameters operationId: UpdateConnectApp parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ConnectApp resources to update. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the ConnectApp resource to update. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CN[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: AuthorizeRedirectUrl: description: The URL to redirect the user to after we authenticate the user and obtain authorization to access the Connect App. format: uri type: string CompanyName: description: The company name to set for the Connect App. type: string DeauthorizeCallbackMethod: description: The HTTP method to use when calling `deauthorize_callback_url`. enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string DeauthorizeCallbackUrl: description: The URL to call using the `deauthorize_callback_method` to de-authorize the Connect App. format: uri type: string Description: description: A description of the Connect App. type: string FriendlyName: description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. type: string HomepageUrl: description: A public URL where users can obtain more information about this Connect App. format: uri type: string Permissions: description: 'A comma-separated list of the permissions you will request from the users of this ConnectApp. Can include: `get-all` and `post-all`.' items: enum: - get-all - post-all type: string type: array title: UpdateConnectAppRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.connect_app' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: instance /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers.json: description: Incoming phone numbers on a Twilio account/project get: description: Retrieve a list of incoming-phone-numbers belonging to the account used to make the request. operationId: ListIncomingPhoneNumber parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: 'Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.' in: query name: Beta schema: type: boolean - description: A string that identifies the IncomingPhoneNumber resources to read. in: query name: FriendlyName schema: type: string - description: The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit. in: query name: PhoneNumber schema: type: string - description: 'Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.' in: query name: Origin schema: type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string incoming_phone_numbers: items: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number' type: array next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListIncomingPhoneNumberResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Purchase a phone-number for the account. operationId: CreateIncomingPhoneNumber parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: AddressSid: description: The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations. maxLength: 34 minLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ type: string ApiVersion: description: The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`. type: string AreaCode: description: The desired area code for your new incoming phone number. Can be any three-digit, US or Canada area code. We will provision an available phone number within this area code for you. **You must provide an `area_code` or a `phone_number`.** (US and Canada only). type: string BundleSid: description: The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations. maxLength: 34 minLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ type: string EmergencyAddressSid: description: The SID of the emergency address configuration to use for emergency calling from the new phone number. maxLength: 34 minLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ type: string EmergencyStatus: description: The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country. enum: - Active - Inactive type: string FriendlyName: description: A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the new phone number. type: string IdentitySid: description: The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations. maxLength: 34 minLength: 34 pattern: ^RI[0-9a-fA-F]{32}$ type: string PhoneNumber: description: The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234. type: string SmsApplicationSid: description: The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application. maxLength: 34 minLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ type: string SmsFallbackMethod: description: 'The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string SmsFallbackUrl: description: The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`. format: uri type: string SmsMethod: description: 'The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string SmsUrl: description: The URL we should call when the new phone number receives an incoming SMS message. format: uri type: string StatusCallback: description: The URL we should call using the `status_callback_method` to send status information to your application. format: uri type: string StatusCallbackMethod: description: 'The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string TrunkSid: description: The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa. maxLength: 34 minLength: 34 pattern: ^TK[0-9a-fA-F]{32}$ type: string VoiceApplicationSid: description: The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa. maxLength: 34 minLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ type: string VoiceCallerIdLookup: description: 'Whether to lookup the caller''s name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.' type: boolean VoiceFallbackMethod: description: 'The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceFallbackUrl: description: The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. format: uri type: string VoiceMethod: description: 'The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceReceiveMode: description: 'The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.' enum: - voice - fax type: string VoiceUrl: description: The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set. format: uri type: string title: CreateIncomingPhoneNumberRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - phone_number - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Local.json: description: Incoming local phone numbers on a Twilio account/project get: description: '' operationId: ListIncomingPhoneNumberLocal parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: 'Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.' in: query name: Beta schema: type: boolean - description: A string that identifies the resources to read. in: query name: FriendlyName schema: type: string - description: The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit. in: query name: PhoneNumber schema: type: string - description: 'Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.' in: query name: Origin schema: type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string incoming_phone_numbers: items: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local' type: array next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListIncomingPhoneNumberLocalResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateIncomingPhoneNumberLocal parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: AddressSid: description: The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations. maxLength: 34 minLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ type: string ApiVersion: description: The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`. type: string BundleSid: description: The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations. maxLength: 34 minLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ type: string EmergencyAddressSid: description: The SID of the emergency address configuration to use for emergency calling from the new phone number. maxLength: 34 minLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ type: string EmergencyStatus: description: The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country. enum: - Active - Inactive type: string FriendlyName: description: A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number. type: string IdentitySid: description: The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations. maxLength: 34 minLength: 34 pattern: ^RI[0-9a-fA-F]{32}$ type: string PhoneNumber: description: The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234. type: string SmsApplicationSid: description: The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application. maxLength: 34 minLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ type: string SmsFallbackMethod: description: 'The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string SmsFallbackUrl: description: The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`. format: uri type: string SmsMethod: description: 'The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string SmsUrl: description: The URL we should call when the new phone number receives an incoming SMS message. format: uri type: string StatusCallback: description: The URL we should call using the `status_callback_method` to send status information to your application. format: uri type: string StatusCallbackMethod: description: 'The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string TrunkSid: description: The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa. maxLength: 34 minLength: 34 pattern: ^TK[0-9a-fA-F]{32}$ type: string VoiceApplicationSid: description: The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa. maxLength: 34 minLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ type: string VoiceCallerIdLookup: description: 'Whether to lookup the caller''s name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.' type: boolean VoiceFallbackMethod: description: 'The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceFallbackUrl: description: The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. format: uri type: string VoiceMethod: description: 'The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceReceiveMode: description: 'The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.' enum: - voice - fax type: string VoiceUrl: description: The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set. format: uri type: string required: - PhoneNumber title: CreateIncomingPhoneNumberLocalRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_local' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - phone_number - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/Mobile.json: description: Incoming mobile phone numbers on a Twilio account/project get: description: '' operationId: ListIncomingPhoneNumberMobile parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: 'Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.' in: query name: Beta schema: type: boolean - description: A string that identifies the resources to read. in: query name: FriendlyName schema: type: string - description: The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit. in: query name: PhoneNumber schema: type: string - description: 'Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.' in: query name: Origin schema: type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string incoming_phone_numbers: items: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile' type: array next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListIncomingPhoneNumberMobileResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateIncomingPhoneNumberMobile parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: AddressSid: description: The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations. maxLength: 34 minLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ type: string ApiVersion: description: The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`. type: string BundleSid: description: The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations. maxLength: 34 minLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ type: string EmergencyAddressSid: description: The SID of the emergency address configuration to use for emergency calling from the new phone number. maxLength: 34 minLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ type: string EmergencyStatus: description: The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country. enum: - Active - Inactive type: string FriendlyName: description: A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, the is a formatted version of the phone number. type: string IdentitySid: description: The SID of the Identity resource that we should associate with the new phone number. Some regions require an identity to meet local regulations. maxLength: 34 minLength: 34 pattern: ^RI[0-9a-fA-F]{32}$ type: string PhoneNumber: description: The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234. type: string SmsApplicationSid: description: The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those of the application. maxLength: 34 minLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ type: string SmsFallbackMethod: description: 'The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string SmsFallbackUrl: description: The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`. format: uri type: string SmsMethod: description: 'The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string SmsUrl: description: The URL we should call when the new phone number receives an incoming SMS message. format: uri type: string StatusCallback: description: The URL we should call using the `status_callback_method` to send status information to your application. format: uri type: string StatusCallbackMethod: description: 'The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string TrunkSid: description: The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa. maxLength: 34 minLength: 34 pattern: ^TK[0-9a-fA-F]{32}$ type: string VoiceApplicationSid: description: The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa. maxLength: 34 minLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ type: string VoiceCallerIdLookup: description: 'Whether to lookup the caller''s name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.' type: boolean VoiceFallbackMethod: description: 'The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceFallbackUrl: description: The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. format: uri type: string VoiceMethod: description: 'The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceReceiveMode: description: 'The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.' enum: - voice - fax type: string VoiceUrl: description: The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set. format: uri type: string required: - PhoneNumber title: CreateIncomingPhoneNumberMobileRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_mobile' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - phone_number - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/TollFree.json: description: Incoming toll free phone numbers on a Twilio account/project get: description: '' operationId: ListIncomingPhoneNumberTollFree parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: 'Whether to include phone numbers new to the Twilio platform. Can be: `true` or `false` and the default is `true`.' in: query name: Beta schema: type: boolean - description: A string that identifies the resources to read. in: query name: FriendlyName schema: type: string - description: The phone numbers of the IncomingPhoneNumber resources to read. You can specify partial numbers and use '*' as a wildcard for any digit. in: query name: PhoneNumber schema: type: string - description: 'Whether to include phone numbers based on their origin. Can be: `twilio` or `hosted`. By default, phone numbers of all origin are included.' in: query name: Origin schema: type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string incoming_phone_numbers: items: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free' type: array next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListIncomingPhoneNumberTollFreeResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateIncomingPhoneNumberTollFree parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: AddressSid: description: The SID of the Address resource we should associate with the new phone number. Some regions require addresses to meet local regulations. maxLength: 34 minLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ type: string ApiVersion: description: The API version to use for incoming calls made to the new phone number. The default is `2010-04-01`. type: string BundleSid: description: The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations. maxLength: 34 minLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ type: string EmergencyAddressSid: description: The SID of the emergency address configuration to use for emergency calling from the new phone number. maxLength: 34 minLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ type: string EmergencyStatus: description: The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country. enum: - Active - Inactive type: string FriendlyName: description: A descriptive string that you created to describe the new phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number. type: string IdentitySid: description: The SID of the Identity resource that we should associate with the new phone number. Some regions require an Identity to meet local regulations. maxLength: 34 minLength: 34 pattern: ^RI[0-9a-fA-F]{32}$ type: string PhoneNumber: description: The phone number to purchase specified in [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone numbers consist of a + followed by the country code and subscriber number without punctuation characters. For example, +14155551234. type: string SmsApplicationSid: description: The SID of the application that should handle SMS messages sent to the new phone number. If an `sms_application_sid` is present, we ignore all `sms_*_url` values and use those of the application. maxLength: 34 minLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ type: string SmsFallbackMethod: description: 'The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string SmsFallbackUrl: description: The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`. format: uri type: string SmsMethod: description: 'The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string SmsUrl: description: The URL we should call when the new phone number receives an incoming SMS message. format: uri type: string StatusCallback: description: The URL we should call using the `status_callback_method` to send status information to your application. format: uri type: string StatusCallbackMethod: description: 'The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string TrunkSid: description: The SID of the Trunk we should use to handle calls to the new phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa. maxLength: 34 minLength: 34 pattern: ^TK[0-9a-fA-F]{32}$ type: string VoiceApplicationSid: description: The SID of the application we should use to handle calls to the new phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa. maxLength: 34 minLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ type: string VoiceCallerIdLookup: description: 'Whether to lookup the caller''s name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.' type: boolean VoiceFallbackMethod: description: 'The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceFallbackUrl: description: The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. format: uri type: string VoiceMethod: description: 'The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceReceiveMode: description: 'The configuration parameter for the new phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.' enum: - voice - fax type: string VoiceUrl: description: The URL that we should call to answer a call to the new phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set. format: uri type: string required: - PhoneNumber title: CreateIncomingPhoneNumberTollFreeRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_toll_free' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - phone_number - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns.json: description: 'TODO: Resource-level docs' get: description: Retrieve a list of Add-on installations currently assigned to this Number. operationId: ListIncomingPhoneNumberAssignedAddOn parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the Phone Number to which the Add-on is assigned. in: path name: ResourceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: assigned_add_ons: items: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListIncomingPhoneNumberAssignedAddOnResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - Beta post: description: Assign an Add-on installation to the Number specified. operationId: CreateIncomingPhoneNumberAssignedAddOn parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the Phone Number to assign the Add-on. in: path name: ResourceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: InstalledAddOnSid: description: The SID that identifies the Add-on installation. maxLength: 34 minLength: 34 pattern: ^XE[0-9a-fA-F]{32}$ type: string required: - InstalledAddOnSid title: CreateIncomingPhoneNumberAssignedAddOnRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on' description: Created security: - accountSid_authToken: [] x-maturity: - Beta servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - description pathType: list /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions.json: description: 'TODO: Resource-level docs' get: description: Retrieve a list of Extensions for the Assigned Add-on. operationId: ListIncomingPhoneNumberAssignedAddOnExtension parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the Phone Number to which the Add-on is assigned. in: path name: ResourceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ type: string - description: The SID that uniquely identifies the assigned Add-on installation. in: path name: AssignedAddOnSid required: true schema: maxLength: 34 minLength: 34 pattern: ^XE[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer extensions: items: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension' type: array first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListIncomingPhoneNumberAssignedAddOnExtensionResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - Beta servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - product_name pathType: list ? /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{AssignedAddOnSid}/Extensions/{Sid}.json : description: 'TODO: Resource-level docs' get: description: Fetch an instance of an Extension for the Assigned Add-on. operationId: FetchIncomingPhoneNumberAssignedAddOnExtension parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the Phone Number to which the Add-on is assigned. in: path name: ResourceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ type: string - description: The SID that uniquely identifies the assigned Add-on installation. in: path name: AssignedAddOnSid required: true schema: maxLength: 34 minLength: 34 pattern: ^XE[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^XF[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on.incoming_phone_number_assigned_add_on_extension' description: OK security: - accountSid_authToken: [] x-maturity: - Beta servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - product_name pathType: instance /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{ResourceSid}/AssignedAddOns/{Sid}.json: delete: description: Remove the assignment of an Add-on installation from the Number specified. operationId: DeleteIncomingPhoneNumberAssignedAddOn parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the Phone Number to which the Add-on is assigned. in: path name: ResourceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^XE[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - Beta description: 'TODO: Resource-level docs' get: description: Fetch an instance of an Add-on installation currently assigned to this Number. operationId: FetchIncomingPhoneNumberAssignedAddOn parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the Phone Number to which the Add-on is assigned. in: path name: ResourceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^XE[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number.incoming_phone_number_assigned_add_on' description: OK security: - accountSid_authToken: [] x-maturity: - Beta servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - unique_name - friendly_name - description pathType: instance /2010-04-01/Accounts/{AccountSid}/IncomingPhoneNumbers/{Sid}.json: delete: description: Delete a phone-numbers belonging to the account used to make the request. operationId: DeleteIncomingPhoneNumber parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Incoming phone numbers on a Twilio account/project get: description: Fetch an incoming-phone-number belonging to the account used to make the request. operationId: FetchIncomingPhoneNumber parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Update an incoming-phone-number instance. operationId: UpdateIncomingPhoneNumber parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to update. For more information, see [Exchanging Numbers Between Subaccounts](https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers). in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the IncomingPhoneNumber resource to update. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: AccountSid: description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IncomingPhoneNumber resource to update. For more information, see [Exchanging Numbers Between Subaccounts](https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers). maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string AddressSid: description: The SID of the Address resource we should associate with the phone number. Some regions require addresses to meet local regulations. maxLength: 34 minLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ type: string ApiVersion: description: The API version to use for incoming calls made to the phone number. The default is `2010-04-01`. type: string BundleSid: description: The SID of the Bundle resource that you associate with the phone number. Some regions require a Bundle to meet local Regulations. maxLength: 34 minLength: 34 pattern: ^BU[0-9a-fA-F]{32}$ type: string EmergencyAddressSid: description: The SID of the emergency address configuration to use for emergency calling from this phone number. maxLength: 34 minLength: 34 pattern: ^AD[0-9a-fA-F]{32}$ type: string EmergencyStatus: description: The parameter displays if emergency calling is enabled for this number. Active numbers may place emergency calls by dialing valid emergency numbers for the country. enum: - Active - Inactive type: string FriendlyName: description: A descriptive string that you created to describe this phone number. It can be up to 64 characters long. By default, this is a formatted version of the phone number. type: string IdentitySid: description: The SID of the Identity resource that we should associate with the phone number. Some regions require an identity to meet local regulations. maxLength: 34 minLength: 34 pattern: ^RI[0-9a-fA-F]{32}$ type: string SmsApplicationSid: description: The SID of the application that should handle SMS messages sent to the number. If an `sms_application_sid` is present, we ignore all of the `sms_*_url` urls and use those set on the application. maxLength: 34 minLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ type: string SmsFallbackMethod: description: 'The HTTP method that we should use to call `sms_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string SmsFallbackUrl: description: The URL that we should call when an error occurs while requesting or executing the TwiML defined by `sms_url`. format: uri type: string SmsMethod: description: 'The HTTP method that we should use to call `sms_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string SmsUrl: description: The URL we should call when the phone number receives an incoming SMS message. format: uri type: string StatusCallback: description: The URL we should call using the `status_callback_method` to send status information to your application. format: uri type: string StatusCallbackMethod: description: 'The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string TrunkSid: description: The SID of the Trunk we should use to handle phone calls to the phone number. If a `trunk_sid` is present, we ignore all of the voice urls and voice applications and use only those set on the Trunk. Setting a `trunk_sid` will automatically delete your `voice_application_sid` and vice versa. maxLength: 34 minLength: 34 pattern: ^TK[0-9a-fA-F]{32}$ type: string VoiceApplicationSid: description: The SID of the application we should use to handle phone calls to the phone number. If a `voice_application_sid` is present, we ignore all of the voice urls and use only those set on the application. Setting a `voice_application_sid` will automatically delete your `trunk_sid` and vice versa. maxLength: 34 minLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ type: string VoiceCallerIdLookup: description: 'Whether to lookup the caller''s name from the CNAM database and post it to your app. Can be: `true` or `false` and defaults to `false`.' type: boolean VoiceFallbackMethod: description: 'The HTTP method that we should use to call `voice_fallback_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceFallbackUrl: description: The URL that we should call when an error occurs retrieving or executing the TwiML requested by `url`. format: uri type: string VoiceMethod: description: 'The HTTP method that we should use to call `voice_url`. Can be: `GET` or `POST` and defaults to `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceReceiveMode: description: 'The configuration parameter for the phone number to receive incoming voice calls or faxes. Can be: `fax` or `voice` and defaults to `voice`.' enum: - voice - fax type: string VoiceUrl: description: The URL that we should call to answer a call to the phone number. The `voice_url` will not be called if a `voice_application_sid` or a `trunk_sid` is set. format: uri type: string title: UpdateIncomingPhoneNumberRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.incoming_phone_number' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - phone_number - friendly_name pathType: instance /2010-04-01/Accounts/{AccountSid}/Keys.json: description: API keys get: description: '' operationId: ListKey parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Key resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string keys: items: $ref: '#/components/schemas/api.v2010.account.key' type: array next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListKeyResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateNewKey parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will be responsible for the new Key resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: FriendlyName: description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. type: string title: CreateNewKeyRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.new_key' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - date_created pathType: list /2010-04-01/Accounts/{AccountSid}/Keys/{Sid}.json: delete: description: '' operationId: DeleteKey parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Key resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Key resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^SK[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: API keys get: description: '' operationId: FetchKey parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Key resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Key resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^SK[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.key' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: UpdateKey parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Key resources to update. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Key resource to update. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^SK[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: FriendlyName: description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. type: string title: UpdateKeyRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.key' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - date_created pathType: instance /2010-04-01/Accounts/{AccountSid}/Messages.json: description: A Message resource represents an inbound or outbound message. get: description: Retrieve a list of messages belonging to the account used to make the request operationId: ListMessage parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: Read messages sent to only this phone number. in: query name: To schema: type: string - description: Read messages sent from only this phone number or alphanumeric sender ID. in: query name: From schema: type: string - description: 'The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.' in: query name: DateSent schema: format: date-time type: string - description: 'The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.' in: query name: DateSent< schema: format: date-time type: string - description: 'The date of the messages to show. Specify a date as `YYYY-MM-DD` in GMT to read only messages sent on this date. For example: `2009-07-06`. You can also specify an inequality, such as `DateSent<=YYYY-MM-DD`, to read messages sent on or before midnight on a date, and `DateSent>=YYYY-MM-DD` to read messages sent on or after midnight on a date.' in: query name: DateSent> schema: format: date-time type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string messages: items: $ref: '#/components/schemas/api.v2010.account.message' type: array next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListMessageResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Send a message from the account used to make the request operationId: CreateMessage parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: AddressRetention: description: Determines if the address can be stored or obfuscated based on privacy settings enum: - retain type: string ApplicationSid: description: The SID of the application that should receive message status. We POST a `message_sid` parameter and a `message_status` parameter with a value of `sent` or `failed` to the [application](https://www.twilio.com/docs/usage/api/applications)'s `message_status_callback`. If a `status_callback` parameter is also passed, it will be ignored and the application's `message_status_callback` parameter will be used. maxLength: 34 minLength: 34 pattern: ^AP[0-9a-fA-F]{32}$ type: string Attempt: description: Total number of attempts made ( including this ) to send out the message regardless of the provider used type: integer Body: description: The text of the message you want to send. Can be up to 1,600 characters in length. type: string ContentRetention: description: Determines if the message content can be stored or redacted based on privacy settings enum: - retain type: string ForceDelivery: description: Reserved type: boolean From: description: A Twilio phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, an [alphanumeric sender ID](https://www.twilio.com/docs/sms/send-messages#use-an-alphanumeric-sender-id), or a [Channel Endpoint address](https://www.twilio.com/docs/sms/channels#channel-addresses) that is enabled for the type of message you want to send. Phone numbers or [short codes](https://www.twilio.com/docs/sms/api/short-code) purchased from Twilio also work here. You cannot, for example, spoof messages from a private cell phone number. If you are using `messaging_service_sid`, this parameter must be empty. type: string MaxPrice: description: The maximum total price in US dollars that you will pay for the message to be delivered. Can be a decimal value that has up to 4 decimal places. All messages are queued for delivery and the message cost is checked before the message is sent. If the cost exceeds `max_price`, the message will fail and a status of `Failed` is sent to the status callback. If `MaxPrice` is not set, the message cost is not checked. type: number MediaUrl: description: The URL of the media to send with the message. The media can be of type `gif`, `png`, and `jpeg` and will be formatted correctly on the recipient's device. The media size limit is 5MB for supported file types (JPEG, PNG, GIF) and 500KB for [other types](https://www.twilio.com/docs/sms/accepted-mime-types) of accepted media. To send more than one image in the message body, provide multiple `media_url` parameters in the POST request. You can include up to 10 `media_url` parameters per message. You can send images in an SMS message in only the US and Canada. items: format: uri type: string type: array MessagingServiceSid: description: The SID of the [Messaging Service](https://www.twilio.com/docs/sms/services#send-a-message-with-copilot) you want to associate with the Message. Set this parameter to use the [Messaging Service Settings and Copilot Features](https://www.twilio.com/console/sms/services) you have configured and leave the `from` parameter empty. When only this parameter is set, Twilio will use your enabled Copilot Features to select the `from` phone number for delivery. maxLength: 34 minLength: 34 pattern: ^MG[0-9a-fA-F]{32}$ type: string PersistentAction: description: Rich actions for Channels Messages. items: type: string type: array ProvideFeedback: description: Whether to confirm delivery of the message. Set this value to `true` if you are sending messages that have a trackable user action and you intend to confirm delivery of the message using the [Message Feedback API](https://www.twilio.com/docs/sms/api/message-feedback-resource). This parameter is `false` by default. type: boolean SmartEncoded: description: 'Whether to detect Unicode characters that have a similar GSM-7 character and replace them. Can be: `true` or `false`.' type: boolean StatusCallback: description: 'The URL we should call using the `status_callback_method` to send status information to your application. If specified, we POST these message status changes to the URL: `queued`, `failed`, `sent`, `delivered`, or `undelivered`. Twilio will POST its [standard request parameters](https://www.twilio.com/docs/sms/twiml#request-parameters) as well as some additional parameters including `MessageSid`, `MessageStatus`, and `ErrorCode`. If you include this parameter with the `messaging_service_sid`, we use this URL instead of the Status Callback URL of the [Messaging Service](https://www.twilio.com/docs/sms/services/api). URLs must contain a valid hostname and underscores are not allowed.' format: uri type: string To: description: The destination phone number in [E.164](https://www.twilio.com/docs/glossary/what-e164) format for SMS/MMS or [Channel user address](https://www.twilio.com/docs/sms/channels#channel-addresses) for other 3rd-party channels. type: string ValidityPeriod: description: How long in seconds the message can remain in our outgoing message queue. After this period elapses, the message fails and we call your status callback. Can be between 1 and the default value of 14,400 seconds. After a message has been accepted by a carrier, however, we cannot guarantee that the message will not be queued after this period. We recommend that this value be at least 5 seconds. type: integer required: - To title: CreateMessageRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.message' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - from - to - status - direction - date_sent pathType: list /2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Feedback.json: description: Customer-provided feedback on delivery confirmation post: description: '' operationId: CreateMessageFeedback parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the Message resource for which the feedback was provided. in: path name: MessageSid required: true schema: maxLength: 34 minLength: 34 pattern: ^(SM|MM)[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Outcome: description: 'Whether the feedback has arrived. Can be: `unconfirmed` or `confirmed`. If `provide_feedback`=`true` in [the initial HTTP POST](https://www.twilio.com/docs/sms/api/message-resource#create-a-message-resource), the initial value of this property is `unconfirmed`. After the message arrives, update the value to `confirmed`.' enum: - confirmed - unconfirmed type: string title: CreateMessageFeedbackRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.message.message_feedback' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - message_sid - outcome - date_created pathType: list /2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media.json: description: The Media resource represents a piece of media, such as an image, that is associated with a message. get: description: Retrieve a list of Media resources belonging to the account used to make the request operationId: ListMedia parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Media resource(s) to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the Message resource that this Media resource belongs to. in: path name: MessageSid required: true schema: maxLength: 34 minLength: 34 pattern: ^(SM|MM)[0-9a-fA-F]{32}$ type: string - description: 'Only include media that was created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read media that was created on or after midnight of this date.' in: query name: DateCreated schema: format: date-time type: string - description: 'Only include media that was created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read media that was created on or after midnight of this date.' in: query name: DateCreated< schema: format: date-time type: string - description: 'Only include media that was created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read media that was created on this date. You can also specify an inequality, such as `StartTime<=YYYY-MM-DD`, to read media that was created on or before midnight of this date, and `StartTime>=YYYY-MM-DD` to read media that was created on or after midnight of this date.' in: query name: DateCreated> schema: format: date-time type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string media_list: items: $ref: '#/components/schemas/api.v2010.account.message.media' type: array next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListMediaResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - parent_sid - content_type pathType: list /2010-04-01/Accounts/{AccountSid}/Messages/{MessageSid}/Media/{Sid}.json: delete: description: Delete media from your account. Once delete, you will no longer be billed operationId: DeleteMedia parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Media resource(s) to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the Message resource that this Media resource belongs to. in: path name: MessageSid required: true schema: maxLength: 34 minLength: 34 pattern: ^(SM|MM)[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Media resource to delete in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^ME[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: The Media resource represents a piece of media, such as an image, that is associated with a message. get: description: Fetch a single media instance belonging to the account used to make the request operationId: FetchMedia parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Media resource(s) to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the Message resource that this Media resource belongs to. in: path name: MessageSid required: true schema: maxLength: 34 minLength: 34 pattern: ^(SM|MM)[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Media resource to fetch in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^ME[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.message.media' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - parent_sid - content_type pathType: instance /2010-04-01/Accounts/{AccountSid}/Messages/{Sid}.json: delete: description: Deletes a message record from your account operationId: DeleteMessage parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Message resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^(SM|MM)[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: A Message resource represents an inbound or outbound message. get: description: Fetch a message belonging to the account used to make the request operationId: FetchMessage parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Message resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^(SM|MM)[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.message' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: To redact a message-body from a post-flight message record, post to the message instance resource with an empty body operationId: UpdateMessage parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Message resources to update. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Message resource to update. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^(SM|MM)[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Body: description: The text of the message you want to send. Can be up to 1,600 characters long. type: string title: UpdateMessageRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.message' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - from - to - status - direction - date_sent pathType: instance /2010-04-01/Accounts/{AccountSid}/Notifications.json: description: '[DEPRECATED] Log entries' get: description: Retrieve a list of notifications belonging to the account used to make the request operationId: ListNotification parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Notification resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: 'Only read notifications of the specified log level. Can be: `0` to read only ERROR notifications or `1` to read only WARNING notifications. By default, all notifications are read.' in: query name: Log schema: type: integer - description: Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date. in: query name: MessageDate schema: format: date type: string - description: Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date. in: query name: MessageDate< schema: format: date type: string - description: Only show notifications for the specified date, formatted as `YYYY-MM-DD`. You can also specify an inequality, such as `<=YYYY-MM-DD` for messages logged at or before midnight on a date, or `>=YYYY-MM-DD` for messages logged at or after midnight on a date. in: query name: MessageDate> schema: format: date type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string notifications: items: $ref: '#/components/schemas/api.v2010.account.notification' type: array page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListNotificationResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - call_sid - error_code - message_date pathType: list /2010-04-01/Accounts/{AccountSid}/Notifications/{Sid}.json: description: '[DEPRECATED] Log entries' get: description: Fetch a notification belonging to the account used to make the request operationId: FetchNotification parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Notification resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Notification resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^NO[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.notification-instance' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - call_sid - error_code - message_date pathType: instance /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds.json: description: An OutgoingCallerId resource represents a single verified number that may be used as a caller ID when making outgoing calls via the REST API and within the TwiML verb. get: description: Retrieve a list of outgoing-caller-ids belonging to the account used to make the request operationId: ListOutgoingCallerId parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The phone number of the OutgoingCallerId resources to read. in: query name: PhoneNumber schema: type: string - description: The string that identifies the OutgoingCallerId resources to read. in: query name: FriendlyName schema: type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string outgoing_caller_ids: items: $ref: '#/components/schemas/api.v2010.account.outgoing_caller_id' type: array page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListOutgoingCallerIdResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: CreateValidationRequest parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for the new caller ID resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: CallDelay: description: The number of seconds to delay before initiating the verification call. Can be an integer between `0` and `60`, inclusive. The default is `0`. type: integer Extension: description: The digits to dial after connecting the verification call. type: string FriendlyName: description: A descriptive string that you create to describe the new caller ID resource. It can be up to 64 characters long. The default value is a formatted version of the phone number. type: string PhoneNumber: description: The phone number to verify in [E.164](https://www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number. type: string StatusCallback: description: The URL we should call using the `status_callback_method` to send status information about the verification process to your application. format: uri type: string StatusCallbackMethod: description: 'The HTTP method we should use to call `status_callback`. Can be: `GET` or `POST`, and the default is `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string required: - PhoneNumber title: CreateValidationRequestRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.validation_request' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - phone_number - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/OutgoingCallerIds/{Sid}.json: delete: description: Delete the caller-id specified from the account operationId: DeleteOutgoingCallerId parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: An OutgoingCallerId resource represents a single verified number that may be used as a caller ID when making outgoing calls via the REST API and within the TwiML verb. get: description: Fetch an outgoing-caller-id belonging to the account used to make the request operationId: FetchOutgoingCallerId parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.outgoing_caller_id' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Updates the caller-id operationId: UpdateOutgoingCallerId parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the OutgoingCallerId resources to update. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the OutgoingCallerId resource to update. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: FriendlyName: description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. type: string title: UpdateOutgoingCallerIdRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.outgoing_caller_id' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - phone_number - friendly_name pathType: instance /2010-04-01/Accounts/{AccountSid}/Queues.json: description: Queues of calls get: description: Retrieve a list of queues belonging to the account used to make the request operationId: ListQueue parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string queues: items: $ref: '#/components/schemas/api.v2010.account.queue' type: array start: type: integer uri: format: uri type: string title: ListQueueResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a queue operationId: CreateQueue parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: FriendlyName: description: A descriptive string that you created to describe this resource. It can be up to 64 characters long. type: string MaxSize: description: The maximum number of calls allowed to be in the queue. The default is 100. The maximum is 5000. type: integer required: - FriendlyName title: CreateQueueRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.queue' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - current_size - average_wait_time pathType: list /2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members.json: description: Calls in a call queue get: description: Retrieve the members of the queue operationId: ListMember parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Member resource(s) to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the Queue in which to find the members in: path name: QueueSid required: true schema: maxLength: 34 minLength: 34 pattern: ^QU[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string queue_members: items: $ref: '#/components/schemas/api.v2010.account.queue.member' type: array start: type: integer uri: format: uri type: string title: ListMemberResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - call_sid - date_enqueued - position - wait_time pathType: list /2010-04-01/Accounts/{AccountSid}/Queues/{QueueSid}/Members/{CallSid}.json: description: Calls in a call queue get: description: Fetch a specific member from the queue operationId: FetchMember parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Member resource(s) to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the Queue in which to find the members to fetch. in: path name: QueueSid required: true schema: maxLength: 34 minLength: 34 pattern: ^QU[0-9a-fA-F]{32}$ type: string - description: The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource(s) to fetch. in: path name: CallSid required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.queue.member' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Dequeue a member from a queue and have the member's call begin executing the TwiML document at that URL operationId: UpdateMember parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Member resource(s) to update. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the Queue in which to find the members to update. in: path name: QueueSid required: true schema: maxLength: 34 minLength: 34 pattern: ^QU[0-9a-fA-F]{32}$ type: string - description: The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resource(s) to update. in: path name: CallSid required: true schema: type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Method: description: How to pass the update request data. Can be `GET` or `POST` and the default is `POST`. `POST` sends the data as encoded form data and `GET` sends the data as query parameters. enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string Url: description: The absolute URL of the Queue resource. format: uri type: string required: - Url title: UpdateMemberRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.queue.member' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - call_sid - date_enqueued - position - wait_time pathType: instance /2010-04-01/Accounts/{AccountSid}/Queues/{Sid}.json: delete: description: Remove an empty queue operationId: DeleteQueue parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resource to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Queue resource to delete in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^QU[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Queues of calls get: description: Fetch an instance of a queue identified by the QueueSid operationId: FetchQueue parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Queue resource to fetch in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^QU[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.queue' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Update the queue with the new parameters operationId: UpdateQueue parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Queue resource to update. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Queue resource to update in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^QU[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: FriendlyName: description: A descriptive string that you created to describe this resource. It can be up to 64 characters long. type: string MaxSize: description: The maximum number of calls allowed to be in the queue. The default is 100. The maximum is 5000. type: integer title: UpdateQueueRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.queue' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - current_size - average_wait_time pathType: instance /2010-04-01/Accounts/{AccountSid}/Recordings.json: description: Recordings of phone calls get: description: Retrieve a list of recordings belonging to the account used to make the request operationId: ListRecording parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: 'Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date.' in: query name: DateCreated schema: format: date-time type: string - description: 'Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date.' in: query name: DateCreated< schema: format: date-time type: string - description: 'Only include recordings that were created on this date. Specify a date as `YYYY-MM-DD` in GMT, for example: `2009-07-06`, to read recordings that were created on this date. You can also specify an inequality, such as `DateCreated<=YYYY-MM-DD`, to read recordings that were created on or before midnight of this date, and `DateCreated>=YYYY-MM-DD` to read recordings that were created on or after midnight of this date.' in: query name: DateCreated> schema: format: date-time type: string - description: The [Call](https://www.twilio.com/docs/voice/api/call-resource) SID of the resources to read. in: query name: CallSid schema: maxLength: 34 minLength: 34 pattern: ^CA[0-9a-fA-F]{32}$ type: string - description: The Conference SID that identifies the conference associated with the recording to read. in: query name: ConferenceSid schema: maxLength: 34 minLength: 34 pattern: ^CF[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string recordings: items: $ref: '#/components/schemas/api.v2010.account.recording' type: array start: type: integer uri: format: uri type: string title: ListRecordingResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - call_sid - status - start_time - duration pathType: list /2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions.json: description: References to text transcriptions of call recordings get: description: '' operationId: ListRecordingTranscription parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) that created the transcriptions to read. in: path name: RecordingSid required: true schema: maxLength: 34 minLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer transcriptions: items: $ref: '#/components/schemas/api.v2010.account.recording.recording_transcription' type: array uri: format: uri type: string title: ListRecordingTranscriptionResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - type - status - duration pathType: list /2010-04-01/Accounts/{AccountSid}/Recordings/{RecordingSid}/Transcriptions/{Sid}.json: delete: description: '' operationId: DeleteRecordingTranscription parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) that created the transcription to delete. in: path name: RecordingSid required: true schema: maxLength: 34 minLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Transcription resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^TR[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: References to text transcriptions of call recordings get: description: '' operationId: FetchRecordingTranscription parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the [Recording](https://www.twilio.com/docs/voice/api/recording) that created the transcription to fetch. in: path name: RecordingSid required: true schema: maxLength: 34 minLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Transcription resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^TR[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.recording.recording_transcription' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - type - status - duration pathType: instance /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults.json: description: The results of an Add-on API call get: description: Retrieve a list of results belonging to the recording operationId: ListRecordingAddOnResult parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the recording to which the result to read belongs. in: path name: ReferenceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: add_on_results: items: $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListRecordingAddOnResultResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - status - add_on_sid - date_created pathType: list /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads.json: description: A single Add-on results' payload get: description: Retrieve a list of payloads belonging to the AddOnResult operationId: ListRecordingAddOnResultPayload parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the recording to which the AddOnResult resource that contains the payloads to read belongs. in: path name: ReferenceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ type: string - description: The SID of the AddOnResult to which the payloads to read belongs. in: path name: AddOnResultSid required: true schema: maxLength: 34 minLength: 34 pattern: ^XR[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer payloads: items: $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload' type: array previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListRecordingAddOnResultPayloadResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - label - content_type pathType: list /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{AddOnResultSid}/Payloads/{Sid}.json: delete: description: Delete a payload from the result along with all associated Data operationId: DeleteRecordingAddOnResultPayload parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the recording to which the AddOnResult resource that contains the payloads to delete belongs. in: path name: ReferenceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ type: string - description: The SID of the AddOnResult to which the payloads to delete belongs. in: path name: AddOnResultSid required: true schema: maxLength: 34 minLength: 34 pattern: ^XR[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^XH[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: A single Add-on results' payload get: description: Fetch an instance of a result payload operationId: FetchRecordingAddOnResultPayload parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult Payload resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the recording to which the AddOnResult resource that contains the payload to fetch belongs. in: path name: ReferenceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ type: string - description: The SID of the AddOnResult to which the payload to fetch belongs. in: path name: AddOnResultSid required: true schema: maxLength: 34 minLength: 34 pattern: ^XR[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Recording AddOnResult Payload resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^XH[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result.recording_add_on_result_payload' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - label - content_type pathType: instance /2010-04-01/Accounts/{AccountSid}/Recordings/{ReferenceSid}/AddOnResults/{Sid}.json: delete: description: Delete a result and purge all associated Payloads operationId: DeleteRecordingAddOnResult parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the recording to which the result to delete belongs. in: path name: ReferenceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^XR[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: The results of an Add-on API call get: description: Fetch an instance of an AddOnResult operationId: FetchRecordingAddOnResult parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording AddOnResult resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the recording to which the result to fetch belongs. in: path name: ReferenceSid required: true schema: maxLength: 34 minLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Recording AddOnResult resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^XR[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.recording.recording_add_on_result' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - status - add_on_sid - date_created pathType: instance /2010-04-01/Accounts/{AccountSid}/Recordings/{Sid}.json: delete: description: Delete a recording from your account operationId: DeleteRecording parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Recording resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Recordings of phone calls get: description: Fetch an instance of a recording operationId: FetchRecording parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Recording resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Recording resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^RE[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.recording' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - call_sid - status - start_time - duration pathType: instance /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists.json: description: Lists of SIP credentials get: description: Get All Credential Lists operationId: ListSipCredentialList parameters: - description: The unique id of the Account that is responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: credential_lists: items: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListSipCredentialListResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a Credential List operationId: CreateSipCredentialList parameters: - description: The unique id of the Account that is responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: FriendlyName: description: A human readable descriptive text that describes the CredentialList, up to 64 characters long. type: string required: - FriendlyName title: CreateSipCredentialListRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials.json: description: Username and password information for SIP Domains get: description: Retrieve a list of credentials. operationId: ListSipCredential parameters: - description: The unique id of the Account that is responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The unique id that identifies the credential list that contains the desired credentials. in: path name: CredentialListSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: credentials: items: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListSipCredentialResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a new credential resource. operationId: CreateSipCredential parameters: - description: The unique id of the Account that is responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The unique id that identifies the credential list to include the created credential. in: path name: CredentialListSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Password: description: The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`) type: string Username: description: The username that will be passed when authenticating SIP requests. The username should be sent in response to Twilio's challenge of the initial INVITE. It can be up to 32 characters long. type: string required: - Username - Password title: CreateSipCredentialRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - username - credential_list_sid pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{CredentialListSid}/Credentials/{Sid}.json: delete: description: Delete a credential resource. operationId: DeleteSipCredential parameters: - description: The unique id of the Account that is responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The unique id that identifies the credential list that contains the desired credentials. in: path name: CredentialListSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string - description: The unique id that identifies the resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Username and password information for SIP Domains get: description: Fetch a single credential. operationId: FetchSipCredential parameters: - description: The unique id of the Account that is responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The unique id that identifies the credential list that contains the desired credential. in: path name: CredentialListSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string - description: The unique id that identifies the resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Update a credential resource. operationId: UpdateSipCredential parameters: - description: The unique id of the Account that is responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The unique id that identifies the credential list that includes this credential. in: path name: CredentialListSid required: true schema: maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string - description: The unique id that identifies the resource to update. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CR[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Password: description: The password that the username will use when authenticating SIP requests. The password must be a minimum of 12 characters, contain at least 1 digit, and have mixed case. (eg `IWasAtSignal2018`) type: string title: UpdateSipCredentialRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list.sip_credential' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - username - credential_list_sid pathType: instance /2010-04-01/Accounts/{AccountSid}/SIP/CredentialLists/{Sid}.json: delete: description: Delete a Credential List operationId: DeleteSipCredentialList parameters: - description: The unique id of the Account that is responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The credential list Sid that uniquely identifies this resource in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Lists of SIP credentials get: description: Get a Credential List operationId: FetchSipCredentialList parameters: - description: The unique id of the Account that is responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The credential list Sid that uniquely identifies this resource in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Update a Credential List operationId: UpdateSipCredentialList parameters: - description: The unique id of the Account that is responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The credential list Sid that uniquely identifies this resource in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: FriendlyName: description: A human readable descriptive text for a CredentialList, up to 64 characters long. type: string required: - FriendlyName title: UpdateSipCredentialListRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_credential_list' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: instance /2010-04-01/Accounts/{AccountSid}/SIP/Domains.json: description: Custom DNS hostnames that can accept SIP traffic get: description: Retrieve a list of domains belonging to the account used to make the request operationId: ListSipDomain parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: domains: items: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListSipDomainResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a new Domain operationId: CreateSipDomain parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: ByocTrunkSid: description: The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with. maxLength: 34 minLength: 34 pattern: ^BY[0-9a-fA-F]{32}$ type: string DomainName: description: The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and "-" and must end with `sip.twilio.com`. type: string EmergencyCallerSid: description: Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call. maxLength: 34 minLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ type: string EmergencyCallingEnabled: description: Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses. type: boolean FriendlyName: description: A descriptive string that you created to describe the resource. It can be up to 64 characters long. type: string Secure: description: Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain. type: boolean SipRegistration: description: Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not. type: boolean VoiceFallbackMethod: description: 'The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceFallbackUrl: description: The URL that we should call when an error occurs while retrieving or executing the TwiML from `voice_url`. format: uri type: string VoiceMethod: description: 'The HTTP method we should use to call `voice_url`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceStatusCallbackMethod: description: 'The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceStatusCallbackUrl: description: The URL that we should call to pass status parameters (such as call ended) to your application. format: uri type: string VoiceUrl: description: The URL we should when the domain receives a call. format: uri type: string required: - DomainName title: CreateSipDomainRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - domain_name - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings.json: description: Credential lists for SIP calls get: description: Retrieve a list of credential list mappings belonging to the domain used in the request operationId: ListSipAuthCallsCredentialListMapping parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the SIP domain that contains the resources to read. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: contents: items: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListSipAuthCallsCredentialListMappingResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a new credential list mapping resource operationId: CreateSipAuthCallsCredentialListMapping parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the SIP domain that will contain the new resource. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: CredentialListSid: description: The SID of the CredentialList resource to map to the SIP domain. maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string required: - CredentialListSid title: CreateSipAuthCallsCredentialListMappingRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/CredentialListMappings/{Sid}.json: delete: description: Delete a credential list mapping from the requested domain operationId: DeleteSipAuthCallsCredentialListMapping parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the SIP domain that contains the resource to delete. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the CredentialListMapping resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Credential lists for SIP calls get: description: Fetch a specific instance of a credential list mapping operationId: FetchSipAuthCallsCredentialListMapping parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the SIP domain that contains the resource to fetch. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the CredentialListMapping resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_credential_list_mapping' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: instance /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings.json: description: IP address lists for SIP calls get: description: Retrieve a list of IP Access Control List mappings belonging to the domain used in the request operationId: ListSipAuthCallsIpAccessControlListMapping parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IpAccessControlListMapping resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the SIP domain that contains the resources to read. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: contents: items: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListSipAuthCallsIpAccessControlListMappingResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a new IP Access Control List mapping operationId: CreateSipAuthCallsIpAccessControlListMapping parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the SIP domain that will contain the new resource. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: IpAccessControlListSid: description: The SID of the IpAccessControlList resource to map to the SIP domain. maxLength: 34 minLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ type: string required: - IpAccessControlListSid title: CreateSipAuthCallsIpAccessControlListMappingRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Calls/IpAccessControlListMappings/{Sid}.json: delete: description: Delete an IP Access Control List mapping from the requested domain operationId: DeleteSipAuthCallsIpAccessControlListMapping parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IpAccessControlListMapping resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the SIP domain that contains the resources to delete. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the IpAccessControlListMapping resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: IP address lists for SIP calls get: description: Fetch a specific instance of an IP Access Control List mapping operationId: FetchSipAuthCallsIpAccessControlListMapping parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the IpAccessControlListMapping resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the SIP domain that contains the resource to fetch. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the IpAccessControlListMapping resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_calls.sip_auth_calls_ip_access_control_list_mapping' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: instance /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings.json: description: Credential lists for SIP registrations get: description: Retrieve a list of credential list mappings belonging to the domain used in the request operationId: ListSipAuthRegistrationsCredentialListMapping parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the SIP domain that contains the resources to read. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: contents: items: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListSipAuthRegistrationsCredentialListMappingResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a new credential list mapping resource operationId: CreateSipAuthRegistrationsCredentialListMapping parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the SIP domain that will contain the new resource. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: CredentialListSid: description: The SID of the CredentialList resource to map to the SIP domain. maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string required: - CredentialListSid title: CreateSipAuthRegistrationsCredentialListMappingRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/Auth/Registrations/CredentialListMappings/{Sid}.json: delete: description: Delete a credential list mapping from the requested domain operationId: DeleteSipAuthRegistrationsCredentialListMapping parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the SIP domain that contains the resources to delete. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the CredentialListMapping resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Credential lists for SIP registrations get: description: Fetch a specific instance of a credential list mapping operationId: FetchSipAuthRegistrationsCredentialListMapping parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the CredentialListMapping resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The SID of the SIP domain that contains the resource to fetch. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the CredentialListMapping resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_auth.sip_auth_registrations.sip_auth_registrations_credential_list_mapping' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: instance /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings.json: description: Credential lists associated with a SIP Domain get: description: Read multiple CredentialListMapping resources from an account. operationId: ListSipCredentialListMapping parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the SIP Domain that includes the resource to read. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: credential_list_mappings: items: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping' type: array end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListSipCredentialListMappingResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a CredentialListMapping resource for an account. operationId: CreateSipCredentialListMapping parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the SIP Domain for which the CredentialList resource will be mapped. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: CredentialListSid: description: A 34 character string that uniquely identifies the CredentialList resource to map to the SIP domain. maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string required: - CredentialListSid title: CreateSipCredentialListMappingRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/CredentialListMappings/{Sid}.json: delete: description: Delete a CredentialListMapping resource from an account. operationId: DeleteSipCredentialListMapping parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the SIP Domain that includes the resource to delete. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Credential lists associated with a SIP Domain get: description: Fetch a single CredentialListMapping resource from an account. operationId: FetchSipCredentialListMapping parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the SIP Domain that includes the resource to fetch. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^CL[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_credential_list_mapping' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: instance /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings.json: description: Access control lists associated with a SIP Domain get: description: Retrieve a list of IpAccessControlListMapping resources. operationId: ListSipIpAccessControlListMapping parameters: - description: The unique id of the Account that is responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the SIP domain. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string ip_access_control_list_mappings: items: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping' type: array next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListSipIpAccessControlListMappingResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a new IpAccessControlListMapping resource. operationId: CreateSipIpAccessControlListMapping parameters: - description: The unique id of the Account that is responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the SIP domain. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: IpAccessControlListSid: description: The unique id of the IP access control list to map to the SIP domain. maxLength: 34 minLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ type: string required: - IpAccessControlListSid title: CreateSipIpAccessControlListMappingRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{DomainSid}/IpAccessControlListMappings/{Sid}.json: delete: description: Delete an IpAccessControlListMapping resource. operationId: DeleteSipIpAccessControlListMapping parameters: - description: The unique id of the Account that is responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the SIP domain. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Access control lists associated with a SIP Domain get: description: Fetch an IpAccessControlListMapping resource. operationId: FetchSipIpAccessControlListMapping parameters: - description: The unique id of the Account that is responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the SIP domain. in: path name: DomainSid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain.sip_ip_access_control_list_mapping' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: instance /2010-04-01/Accounts/{AccountSid}/SIP/Domains/{Sid}.json: delete: description: Delete an instance of a Domain operationId: DeleteSipDomain parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the SipDomain resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Custom DNS hostnames that can accept SIP traffic get: description: Fetch an instance of a Domain operationId: FetchSipDomain parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the SipDomain resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Update the attributes of a domain operationId: UpdateSipDomain parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the SipDomain resource to update. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the SipDomain resource to update. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^SD[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: ByocTrunkSid: description: The SID of the BYOC Trunk(Bring Your Own Carrier) resource that the Sip Domain will be associated with. maxLength: 34 minLength: 34 pattern: ^BY[0-9a-fA-F]{32}$ type: string DomainName: description: The unique address you reserve on Twilio to which you route your SIP traffic. Domain names can contain letters, digits, and "-" and must end with `sip.twilio.com`. type: string EmergencyCallerSid: description: Whether an emergency caller sid is configured for the domain. If present, this phone number will be used as the callback for the emergency call. maxLength: 34 minLength: 34 pattern: ^PN[0-9a-fA-F]{32}$ type: string EmergencyCallingEnabled: description: Whether emergency calling is enabled for the domain. If enabled, allows emergency calls on the domain from phone numbers with validated addresses. type: boolean FriendlyName: description: A descriptive string that you created to describe the resource. It can be up to 64 characters long. type: string Secure: description: Whether secure SIP is enabled for the domain. If enabled, TLS will be enforced and SRTP will be negotiated on all incoming calls to this sip domain. type: boolean SipRegistration: description: Whether to allow SIP Endpoints to register with the domain to receive calls. Can be `true` or `false`. `true` allows SIP Endpoints to register with the domain to receive calls, `false` does not. type: boolean VoiceFallbackMethod: description: 'The HTTP method we should use to call `voice_fallback_url`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceFallbackUrl: description: The URL that we should call when an error occurs while retrieving or executing the TwiML requested by `voice_url`. format: uri type: string VoiceMethod: description: The HTTP method we should use to call `voice_url` enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceStatusCallbackMethod: description: 'The HTTP method we should use to call `voice_status_callback_url`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string VoiceStatusCallbackUrl: description: The URL that we should call to pass status parameters (such as call ended) to your application. format: uri type: string VoiceUrl: description: The URL we should call when the domain receives a call. format: uri type: string title: UpdateSipDomainRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_domain' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - domain_name - friendly_name pathType: instance /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists.json: description: Access control lists of IP address resources get: description: Retrieve a list of IpAccessControlLists that belong to the account used to make the request operationId: ListSipIpAccessControlList parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string ip_access_control_lists: items: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list' type: array next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListSipIpAccessControlListResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a new IpAccessControlList resource operationId: CreateSipIpAccessControlList parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: FriendlyName: description: A human readable descriptive text that describes the IpAccessControlList, up to 64 characters long. type: string required: - FriendlyName title: CreateSipIpAccessControlListRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses.json: description: IP addresses that have access to a SIP Domain get: description: Read multiple IpAddress resources. operationId: ListSipIpAddress parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The IpAccessControlList Sid that identifies the IpAddress resources to read. in: path name: IpAccessControlListSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string ip_addresses: items: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address' type: array next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string title: ListSipIpAddressResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a new IpAddress resource. operationId: CreateSipIpAddress parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The IpAccessControlList Sid with which to associate the created IpAddress resource. in: path name: IpAccessControlListSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: CidrPrefixLength: description: An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used. type: integer FriendlyName: description: A human readable descriptive text for this resource, up to 64 characters long. type: string IpAddress: description: An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today. type: string required: - FriendlyName - IpAddress title: CreateSipIpAddressRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - ip_address - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{IpAccessControlListSid}/IpAddresses/{Sid}.json: delete: description: Delete an IpAddress resource. operationId: DeleteSipIpAddress parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The IpAccessControlList Sid that identifies the IpAddress resources to delete. in: path name: IpAccessControlListSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^IP[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: IP addresses that have access to a SIP Domain get: description: Read one IpAddress resource. operationId: FetchSipIpAddress parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The IpAccessControlList Sid that identifies the IpAddress resources to fetch. in: path name: IpAccessControlListSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the IpAddress resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^IP[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Update an IpAddress resource. operationId: UpdateSipIpAddress parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The IpAccessControlList Sid that identifies the IpAddress resources to update. in: path name: IpAccessControlListSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ type: string - description: A 34 character string that identifies the IpAddress resource to update. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^IP[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: CidrPrefixLength: description: An integer representing the length of the CIDR prefix to use with this IP address when accepting traffic. By default the entire IP address is used. type: integer FriendlyName: description: A human readable descriptive text for this resource, up to 64 characters long. type: string IpAddress: description: An IP address in dotted decimal notation from which you want to accept traffic. Any SIP requests from this IP address will be allowed by Twilio. IPv4 only supported today. type: string title: UpdateSipIpAddressRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list.sip_ip_address' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - ip_address - friendly_name pathType: instance /2010-04-01/Accounts/{AccountSid}/SIP/IpAccessControlLists/{Sid}.json: delete: description: Delete an IpAccessControlList from the requested account operationId: DeleteSipIpAccessControlList parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Access control lists of IP address resources get: description: Fetch a specific instance of an IpAccessControlList operationId: FetchSipIpAccessControlList parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Rename an IpAccessControlList operationId: UpdateSipIpAccessControlList parameters: - description: The unique id of the [Account](https://www.twilio.com/docs/iam/api/account) responsible for this resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: A 34 character string that uniquely identifies the resource to udpate. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^AL[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: FriendlyName: description: A human readable descriptive text, up to 64 characters long. type: string required: - FriendlyName title: UpdateSipIpAccessControlListRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.sip.sip_ip_access_control_list' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: instance /2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes.json: description: Messaging short codes get: description: Retrieve a list of short-codes belonging to the account used to make the request operationId: ListShortCode parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ShortCode resource(s) to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The string that identifies the ShortCode resources to read. in: query name: FriendlyName schema: type: string - description: Only show the ShortCode resources that match this pattern. You can specify partial numbers and use '*' as a wildcard for any digit. in: query name: ShortCode schema: type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string short_codes: items: $ref: '#/components/schemas/api.v2010.account.short_code' type: array start: type: integer uri: format: uri type: string title: ListShortCodeResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - short_code - friendly_name pathType: list /2010-04-01/Accounts/{AccountSid}/SMS/ShortCodes/{Sid}.json: description: Messaging short codes get: description: Fetch an instance of a short code operationId: FetchShortCode parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ShortCode resource(s) to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the ShortCode resource to fetch in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^SC[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.short_code' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Update a short code with the following parameters operationId: UpdateShortCode parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the ShortCode resource(s) to update. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the ShortCode resource to update in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^SC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: ApiVersion: description: 'The API version to use to start a new TwiML session. Can be: `2010-04-01` or `2008-08-01`.' type: string FriendlyName: description: A descriptive string that you created to describe this resource. It can be up to 64 characters long. By default, the `FriendlyName` is the short code. type: string SmsFallbackMethod: description: 'The HTTP method that we should use to call the `sms_fallback_url`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string SmsFallbackUrl: description: The URL that we should call if an error occurs while retrieving or executing the TwiML from `sms_url`. format: uri type: string SmsMethod: description: 'The HTTP method we should use when calling the `sms_url`. Can be: `GET` or `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string SmsUrl: description: The URL we should call when receiving an incoming SMS message to this short code. format: uri type: string title: UpdateShortCodeRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.short_code' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - short_code - friendly_name pathType: instance /2010-04-01/Accounts/{AccountSid}/SigningKeys.json: description: Create a new signing key get: description: '' operationId: ListSigningKey parameters: - description: '' in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string signing_keys: items: $ref: '#/components/schemas/api.v2010.account.signing_key' type: array start: type: integer uri: format: uri type: string title: ListSigningKeyResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a new Signing Key for the account making the request. operationId: CreateNewSigningKey parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will be responsible for the new Key resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: FriendlyName: description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. type: string title: CreateNewSigningKeyRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.new_signing_key' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - secret pathType: list /2010-04-01/Accounts/{AccountSid}/SigningKeys/{Sid}.json: delete: description: '' operationId: DeleteSigningKey parameters: - description: '' in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: '' in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^SK[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: 'TODO: Resource-level docs' get: description: '' operationId: FetchSigningKey parameters: - description: '' in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: '' in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^SK[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.signing_key' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: '' operationId: UpdateSigningKey parameters: - description: '' in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: '' in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^SK[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: FriendlyName: description: '' type: string title: UpdateSigningKeyRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.signing_key' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name pathType: instance /2010-04-01/Accounts/{AccountSid}/Tokens.json: description: Credentials for ICE servers post: description: Create a new token for ICE servers operationId: CreateToken parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: Ttl: description: The duration in seconds for which the generated credentials are valid. The default value is 86400 (24 hours). type: integer title: CreateTokenRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.token' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - username - ice_servers pathType: list /2010-04-01/Accounts/{AccountSid}/Transcriptions.json: description: Text transcriptions of call recordings get: description: Retrieve a list of transcriptions belonging to the account used to make the request operationId: ListTranscription parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer transcriptions: items: $ref: '#/components/schemas/api.v2010.account.transcription' type: array uri: format: uri type: string title: ListTranscriptionResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - type - status - duration pathType: list /2010-04-01/Accounts/{AccountSid}/Transcriptions/{Sid}.json: delete: description: Delete a transcription from the account used to make the request operationId: DeleteTranscription parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Transcription resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^TR[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Text transcriptions of call recordings get: description: Fetch an instance of a Transcription operationId: FetchTranscription parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Transcription resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the Transcription resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^TR[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.transcription' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - type - status - duration pathType: instance /2010-04-01/Accounts/{AccountSid}/Usage/Records.json: description: Twilio account usage records get: description: Retrieve a list of usage-records belonging to the account used to make the request operationId: ListUsageRecord parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. in: query name: Category schema: enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice type: string - description: 'Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.' in: query name: StartDate schema: format: date type: string - description: 'Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.' in: query name: EndDate schema: format: date type: string - description: 'Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.' in: query name: IncludeSubaccounts schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string usage_records: items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record' type: array title: ListUsageRecordResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - category - start_date - end_date - count - count_unit pathType: list /2010-04-01/Accounts/{AccountSid}/Usage/Records/AllTime.json: description: Usage records for all time get: description: '' operationId: ListUsageRecordAllTime parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. in: query name: Category schema: enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice type: string - description: 'Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.' in: query name: StartDate schema: format: date type: string - description: 'Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.' in: query name: EndDate schema: format: date type: string - description: 'Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.' in: query name: IncludeSubaccounts schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string usage_records: items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_all_time' type: array title: ListUsageRecordAllTimeResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - category - start_date - end_date - count - count_unit pathType: list /2010-04-01/Accounts/{AccountSid}/Usage/Records/Daily.json: description: Usage records summarized by day get: description: '' operationId: ListUsageRecordDaily parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. in: query name: Category schema: enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice type: string - description: 'Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.' in: query name: StartDate schema: format: date type: string - description: 'Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.' in: query name: EndDate schema: format: date type: string - description: 'Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.' in: query name: IncludeSubaccounts schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string usage_records: items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_daily' type: array title: ListUsageRecordDailyResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - category - start_date - end_date - count - count_unit pathType: list /2010-04-01/Accounts/{AccountSid}/Usage/Records/LastMonth.json: description: Usage records for last month get: description: '' operationId: ListUsageRecordLastMonth parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. in: query name: Category schema: enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice type: string - description: 'Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.' in: query name: StartDate schema: format: date type: string - description: 'Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.' in: query name: EndDate schema: format: date type: string - description: 'Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.' in: query name: IncludeSubaccounts schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string usage_records: items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_last_month' type: array title: ListUsageRecordLastMonthResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - category - start_date - end_date - count - count_unit pathType: list /2010-04-01/Accounts/{AccountSid}/Usage/Records/Monthly.json: description: Usage records summarized by month get: description: '' operationId: ListUsageRecordMonthly parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. in: query name: Category schema: enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice type: string - description: 'Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.' in: query name: StartDate schema: format: date type: string - description: 'Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.' in: query name: EndDate schema: format: date type: string - description: 'Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.' in: query name: IncludeSubaccounts schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string usage_records: items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_monthly' type: array title: ListUsageRecordMonthlyResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - category - start_date - end_date - count - count_unit pathType: list /2010-04-01/Accounts/{AccountSid}/Usage/Records/ThisMonth.json: description: Usage records for this month get: description: '' operationId: ListUsageRecordThisMonth parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. in: query name: Category schema: enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice type: string - description: 'Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.' in: query name: StartDate schema: format: date type: string - description: 'Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.' in: query name: EndDate schema: format: date type: string - description: 'Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.' in: query name: IncludeSubaccounts schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string usage_records: items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_this_month' type: array title: ListUsageRecordThisMonthResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - category - start_date - end_date - count - count_unit pathType: list /2010-04-01/Accounts/{AccountSid}/Usage/Records/Today.json: description: Usage records for today get: description: '' operationId: ListUsageRecordToday parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. in: query name: Category schema: enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice type: string - description: 'Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.' in: query name: StartDate schema: format: date type: string - description: 'Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.' in: query name: EndDate schema: format: date type: string - description: 'Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.' in: query name: IncludeSubaccounts schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string usage_records: items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_today' type: array title: ListUsageRecordTodayResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - category - start_date - end_date - count - count_unit pathType: list /2010-04-01/Accounts/{AccountSid}/Usage/Records/Yearly.json: description: Usage records summarized by year get: description: '' operationId: ListUsageRecordYearly parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. in: query name: Category schema: enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice type: string - description: 'Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.' in: query name: StartDate schema: format: date type: string - description: 'Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.' in: query name: EndDate schema: format: date type: string - description: 'Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.' in: query name: IncludeSubaccounts schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string usage_records: items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yearly' type: array title: ListUsageRecordYearlyResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - category - start_date - end_date - count - count_unit pathType: list /2010-04-01/Accounts/{AccountSid}/Usage/Records/Yesterday.json: description: Usage records for yesterday get: description: '' operationId: ListUsageRecordYesterday parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageRecord resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The [usage category](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) of the UsageRecord resources to read. Only UsageRecord resources in the specified category are retrieved. in: query name: Category schema: enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice type: string - description: 'Only include usage that has occurred on or after this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `-30days`, which will set the start date to be 30 days before the current date.' in: query name: StartDate schema: format: date type: string - description: 'Only include usage that occurred on or before this date. Specify the date in GMT and format as `YYYY-MM-DD`. You can also specify offsets from the current date, such as: `+30days`, which will set the end date to 30 days from the current date.' in: query name: EndDate schema: format: date type: string - description: 'Whether to include usage from the master account and all its subaccounts. Can be: `true` (the default) to include usage from the master account and all subaccounts or `false` to retrieve usage from only the specified account.' in: query name: IncludeSubaccounts schema: type: boolean - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string usage_records: items: $ref: '#/components/schemas/api.v2010.account.usage.usage_record.usage_record_yesterday' type: array title: ListUsageRecordYesterdayResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - category - start_date - end_date - count - count_unit pathType: list /2010-04-01/Accounts/{AccountSid}/Usage/Triggers.json: description: Webhooks that notify you of usage thresholds get: description: Retrieve a list of usage-triggers belonging to the account used to make the request operationId: ListUsageTrigger parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageTrigger resources to read. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: 'The frequency of recurring UsageTriggers to read. Can be: `daily`, `monthly`, or `yearly` to read recurring UsageTriggers. An empty value or a value of `alltime` reads non-recurring UsageTriggers.' in: query name: Recurring schema: enum: - daily - monthly - yearly - alltime type: string - description: 'The trigger field of the UsageTriggers to read. Can be: `count`, `usage`, or `price` as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price).' in: query name: TriggerBy schema: enum: - count - usage - price type: string - description: The usage category of the UsageTriggers to read. Must be a supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories). in: query name: UsageCategory schema: enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice type: string - description: How many resources to return in each list page. The default is 50, and the maximum is 1000. in: query name: PageSize schema: maximum: 1000 minimum: 1 type: integer responses: '200': content: application/json: schema: properties: end: type: integer first_page_uri: format: uri type: string next_page_uri: format: uri type: string page: type: integer page_size: type: integer previous_page_uri: format: uri type: string start: type: integer uri: format: uri type: string usage_triggers: items: $ref: '#/components/schemas/api.v2010.account.usage.usage_trigger' type: array title: ListUsageTriggerResponse type: object description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Create a new UsageTrigger operationId: CreateUsageTrigger parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: CallbackMethod: description: 'The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string CallbackUrl: description: The URL we should call using `callback_method` when the trigger fires. format: uri type: string FriendlyName: description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. type: string Recurring: description: 'The frequency of a recurring UsageTrigger. Can be: `daily`, `monthly`, or `yearly` for recurring triggers or empty for non-recurring triggers. A trigger will only fire once during each period. Recurring times are in GMT.' enum: - daily - monthly - yearly - alltime type: string TriggerBy: description: 'The field in the [UsageRecord](https://www.twilio.com/docs/usage/api/usage-record) resource that should fire the trigger. Can be: `count`, `usage`, or `price` as described in the [UsageRecords documentation](https://www.twilio.com/docs/usage/api/usage-record#usage-count-price). The default is `usage`.' enum: - count - usage - price type: string TriggerValue: description: The usage value at which the trigger should fire. For convenience, you can use an offset value such as `+30` to specify a trigger_value that is 30 units more than the current usage value. Be sure to urlencode a `+` as `%2B`. type: string UsageCategory: description: The usage category that the trigger should watch. Use one of the supported [usage categories](https://www.twilio.com/docs/usage/api/usage-record#usage-categories) for this value. enum: - agent-conference - answering-machine-detection - authy-authentications - authy-calls-outbound - authy-monthly-fees - authy-phone-intelligence - authy-phone-verifications - authy-sms-outbound - call-progess-events - calleridlookups - calls - calls-client - calls-globalconference - calls-inbound - calls-inbound-local - calls-inbound-mobile - calls-inbound-tollfree - calls-outbound - calls-pay-verb-transactions - calls-recordings - calls-sip - calls-sip-inbound - calls-sip-outbound - calls-transfers - carrier-lookups - conversations - conversations-api-requests - conversations-conversation-events - conversations-endpoint-connectivity - conversations-events - conversations-participant-events - conversations-participants - cps - flex-usage - fraud-lookups - group-rooms - group-rooms-data-track - group-rooms-encrypted-media-recorded - group-rooms-media-downloaded - group-rooms-media-recorded - group-rooms-media-routed - group-rooms-media-stored - group-rooms-participant-minutes - group-rooms-recorded-minutes - imp-v1-usage - lookups - marketplace - marketplace-algorithmia-named-entity-recognition - marketplace-cadence-transcription - marketplace-cadence-translation - marketplace-capio-speech-to-text - marketplace-convriza-ababa - marketplace-deepgram-phrase-detector - marketplace-digital-segment-business-info - marketplace-facebook-offline-conversions - marketplace-google-speech-to-text - marketplace-ibm-watson-message-insights - marketplace-ibm-watson-message-sentiment - marketplace-ibm-watson-recording-analysis - marketplace-ibm-watson-tone-analyzer - marketplace-icehook-systems-scout - marketplace-infogroup-dataaxle-bizinfo - marketplace-keen-io-contact-center-analytics - marketplace-marchex-cleancall - marketplace-marchex-sentiment-analysis-for-sms - marketplace-marketplace-nextcaller-social-id - marketplace-mobile-commons-opt-out-classifier - marketplace-nexiwave-voicemail-to-text - marketplace-nextcaller-advanced-caller-identification - marketplace-nomorobo-spam-score - marketplace-payfone-tcpa-compliance - marketplace-remeeting-automatic-speech-recognition - marketplace-tcpa-defense-solutions-blacklist-feed - marketplace-telo-opencnam - marketplace-truecnam-true-spam - marketplace-twilio-caller-name-lookup-us - marketplace-twilio-carrier-information-lookup - marketplace-voicebase-pci - marketplace-voicebase-transcription - marketplace-voicebase-transcription-custom-vocabulary - marketplace-whitepages-pro-caller-identification - marketplace-whitepages-pro-phone-intelligence - marketplace-whitepages-pro-phone-reputation - marketplace-wolfarm-spoken-results - marketplace-wolfram-short-answer - marketplace-ytica-contact-center-reporting-analytics - mediastorage - mms - mms-inbound - mms-inbound-longcode - mms-inbound-shortcode - mms-messages-carrierfees - mms-outbound - mms-outbound-longcode - mms-outbound-shortcode - monitor-reads - monitor-storage - monitor-writes - notify - notify-actions-attempts - notify-channels - number-format-lookups - pchat - pchat-users - peer-to-peer-rooms-participant-minutes - pfax - pfax-minutes - pfax-minutes-inbound - pfax-minutes-outbound - pfax-pages - phonenumbers - phonenumbers-cps - phonenumbers-emergency - phonenumbers-local - phonenumbers-mobile - phonenumbers-setups - phonenumbers-tollfree - premiumsupport - proxy - proxy-active-sessions - pstnconnectivity - pv - pv-composition-media-downloaded - pv-composition-media-encrypted - pv-composition-media-stored - pv-composition-minutes - pv-recording-compositions - pv-room-participants - pv-room-participants-au1 - pv-room-participants-br1 - pv-room-participants-ie1 - pv-room-participants-jp1 - pv-room-participants-sg1 - pv-room-participants-us1 - pv-room-participants-us2 - pv-rooms - pv-sip-endpoint-registrations - recordings - recordingstorage - rooms-group-bandwidth - rooms-group-minutes - rooms-peer-to-peer-minutes - shortcodes - shortcodes-customerowned - shortcodes-mms-enablement - shortcodes-mps - shortcodes-random - shortcodes-uk - shortcodes-vanity - small-group-rooms - small-group-rooms-data-track - small-group-rooms-participant-minutes - sms - sms-inbound - sms-inbound-longcode - sms-inbound-shortcode - sms-messages-carrierfees - sms-messages-features - sms-messages-features-senderid - sms-outbound - sms-outbound-content-inspection - sms-outbound-longcode - sms-outbound-shortcode - speech-recognition - studio-engagements - sync - sync-actions - sync-endpoint-hours - sync-endpoint-hours-above-daily-cap - taskrouter-tasks - totalprice - transcriptions - trunking-cps - trunking-emergency-calls - trunking-origination - trunking-origination-local - trunking-origination-mobile - trunking-origination-tollfree - trunking-recordings - trunking-secure - trunking-termination - turnmegabytes - turnmegabytes-australia - turnmegabytes-brasil - turnmegabytes-germany - turnmegabytes-india - turnmegabytes-ireland - turnmegabytes-japan - turnmegabytes-singapore - turnmegabytes-useast - turnmegabytes-uswest - twilio-interconnect - verify-push - video-recordings - voice-insights - voice-insights-client-insights-on-demand-minute - voice-insights-ptsn-insights-on-demand-minute - voice-insights-sip-interface-insights-on-demand-minute - voice-insights-sip-trunking-insights-on-demand-minute - wireless - wireless-orders - wireless-orders-artwork - wireless-orders-bulk - wireless-orders-esim - wireless-orders-starter - wireless-usage - wireless-usage-commands - wireless-usage-commands-africa - wireless-usage-commands-asia - wireless-usage-commands-centralandsouthamerica - wireless-usage-commands-europe - wireless-usage-commands-home - wireless-usage-commands-northamerica - wireless-usage-commands-oceania - wireless-usage-commands-roaming - wireless-usage-data - wireless-usage-data-africa - wireless-usage-data-asia - wireless-usage-data-centralandsouthamerica - wireless-usage-data-custom-additionalmb - wireless-usage-data-custom-first5mb - wireless-usage-data-domestic-roaming - wireless-usage-data-europe - wireless-usage-data-individual-additionalgb - wireless-usage-data-individual-firstgb - wireless-usage-data-international-roaming-canada - wireless-usage-data-international-roaming-india - wireless-usage-data-international-roaming-mexico - wireless-usage-data-northamerica - wireless-usage-data-oceania - wireless-usage-data-pooled - wireless-usage-data-pooled-downlink - wireless-usage-data-pooled-uplink - wireless-usage-mrc - wireless-usage-mrc-custom - wireless-usage-mrc-individual - wireless-usage-mrc-pooled - wireless-usage-mrc-suspended - wireless-usage-sms - wireless-usage-voice type: string required: - CallbackUrl - TriggerValue - UsageCategory title: CreateUsageTriggerRequest type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.usage.usage_trigger' description: Created security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - usage_category - trigger_by pathType: list /2010-04-01/Accounts/{AccountSid}/Usage/Triggers/{Sid}.json: delete: description: '' operationId: DeleteUsageTrigger parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageTrigger resources to delete. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the UsageTrigger resource to delete. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^UT[0-9a-fA-F]{32}$ type: string responses: '204': description: The resource was deleted successfully. security: - accountSid_authToken: [] x-maturity: - GA description: Webhooks that notify you of usage thresholds get: description: Fetch and instance of a usage-trigger operationId: FetchUsageTrigger parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageTrigger resource to fetch. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the UsageTrigger resource to fetch. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^UT[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.usage.usage_trigger' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Update an instance of a usage trigger operationId: UpdateUsageTrigger parameters: - description: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the UsageTrigger resources to update. in: path name: AccountSid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string - description: The Twilio-provided string that uniquely identifies the UsageTrigger resource to update. in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^UT[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: CallbackMethod: description: 'The HTTP method we should use to call `callback_url`. Can be: `GET` or `POST` and the default is `POST`.' enum: - HEAD - GET - POST - PATCH - PUT - DELETE type: string CallbackUrl: description: The URL we should call using `callback_method` when the trigger fires. format: uri type: string FriendlyName: description: A descriptive string that you create to describe the resource. It can be up to 64 characters long. type: string title: UpdateUsageTriggerRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account.usage.usage_trigger' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - usage_category - trigger_by pathType: instance /2010-04-01/Accounts/{Sid}.json: description: Twilio accounts (aka Project) or subaccounts get: description: Fetch the account specified by the provided Account Sid operationId: FetchAccount parameters: - description: The Account Sid that uniquely identifies the account to fetch in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account' description: OK security: - accountSid_authToken: [] x-maturity: - GA post: description: Modify the properties of a given Account operationId: UpdateAccount parameters: - description: The Account Sid that uniquely identifies the account to update in: path name: Sid required: true schema: maxLength: 34 minLength: 34 pattern: ^AC[0-9a-fA-F]{32}$ type: string requestBody: content: application/x-www-form-urlencoded: schema: properties: FriendlyName: description: Update the human-readable description of this Account type: string Status: description: 'Alter the status of this account: use `closed` to irreversibly close this account, `suspended` to temporarily suspend it, or `active` to reactivate it.' enum: - active - suspended - closed type: string title: UpdateAccountRequest type: object responses: '200': content: application/json: schema: $ref: '#/components/schemas/api.v2010.account' description: OK security: - accountSid_authToken: [] x-maturity: - GA servers: - url: https://api.twilio.com x-twilio: defaultOutputProperties: - sid - friendly_name - status pathType: instance servers: - url: https://api.twilio.com x-maturity: - description: This product is Generally Available. name: GA - description: PLEASE NOTE that this is a Beta product that is subject to change. Use it with caution. name: Beta - description: PLEASE NOTE that this is a Preview product that is subject to change. Use it with caution. If you currently do not have developer preview access, please contact help@twilio.com. name: Preview