{ "components": { "securitySchemes": { "accountSid_authToken": { "scheme": "basic", "type": "http" } }, "schemas": { "authorization_document_enum_status": { "type": "string", "enum": [ "opened", "signing", "signed", "canceled", "failed" ] }, "numbers.v1.bulk_eligibility": { "type": "object", "properties": { "request_id": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^EC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the bulk eligibility check that you want to know about." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "This is the url of the request that you're trying to reach out to locate the resource." }, "results": { "type": "array", "items": {}, "nullable": true, "description": "The result set that contains the eligibility check response for each requested number, each result has at least the following attributes: phone_number: The requested phone number ,hosting_account_sid: The account sid where the phone number will be hosted, country: Phone number\u2019s country, eligibility_status: Indicates the eligibility status of the PN (Eligible/Ineligible), eligibility_sub_status: Indicates the sub status of the eligibility , ineligibility_reason: Reason for number's ineligibility (if applicable), next_step: Suggested next step in the hosting process based on the eligibility status." }, "friendly_name": { "type": "string", "nullable": true, "description": "This is the string that you assigned as a friendly name for describing the eligibility check request." }, "status": { "type": "string", "nullable": true, "description": "This is the status of the bulk eligibility check request. (Example: COMPLETE, IN_PROGRESS)" }, "date_created": { "type": "string", "format": "date-time", "nullable": true }, "date_completed": { "type": "string", "format": "date-time", "nullable": true } } }, "bulk_eligibility_enum_eligibility_status": { "type": "string", "enum": [ "ineligible", "eligible" ] }, "bulk_eligibility_enum_eligibility_sub_status": { "type": "string", "enum": [ "country-ineligible", "number-format-ineligible", "number-type-ineligible", "carrier-ineligible", "already-in-twilio", "internal-processing-error", "invalid-phone-number", "invalid-hosting-account-sid", "eligible", "eligible-by-manual-process" ] }, "dependent_order_enum_status": { "type": "string", "enum": [ "twilio-processing", "received", "pending-verification", "verified", "pending-loa", "carrier-processing", "testing", "completed", "failed", "action-required" ] }, "dependent_order_enum_verification_type": { "type": "string", "enum": [ "phone-call", "phone-bill" ] }, "numbers.v1.eligibility": { "type": "object", "properties": { "results": { "type": "array", "items": {}, "nullable": true, "description": "The result set that contains the eligibility check response for the requested number, each result has at least the following attributes: phone_number: The requested phone number ,hosting_account_sid: The account sid where the phone number will be hosted, date_last_checked: Datetime (ISO 8601) when the PN was last checked for eligibility, country: Phone number\u2019s country, eligibility_status: Indicates the eligibility status of the PN (Eligible/Ineligible), eligibility_sub_status: Indicates the sub status of the eligibility , ineligibility_reason: Reason for number's ineligibility (if applicable), next_step: Suggested next step in the hosting process based on the eligibility status." } } }, "eligibility_enum_eligibility_status": { "type": "string", "enum": [ "ineligible", "eligible" ] }, "eligibility_enum_eligibility_sub_status": { "type": "string", "enum": [ "country-ineligible", "number-format-ineligible", "number-type-ineligible", "carrier-ineligible", "already-in-twilio", "internal-processing-error", "invalid-phone-number", "invalid-hosting-account-sid", "eligible" ] }, "hosted_number_order_enum_status": { "type": "string", "enum": [ "twilio-processing", "received", "pending-verification", "verified", "pending-loa", "carrier-processing", "testing", "completed", "failed", "action-required" ] }, "hosted_number_order_enum_verification_type": { "type": "string", "enum": [ "phone-call", "phone-bill" ] }, "numbers.v1.porting_port_in": { "type": "object", "properties": { "port_in_request_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^KW[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Port In request. This is a unique identifier of the port in request." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of this Port In request" }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The Account SID that the numbers will be added to after they are ported into Twilio." }, "notification_emails": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of emails for getting notifications about the LOA signing process. Allowed Max 10 emails." }, "target_port_in_date": { "type": "string", "format": "date", "nullable": true, "description": "Minimum number of days in the future (at least 2 days) needs to be established with the Ops team for validation." }, "target_port_in_time_range_start": { "type": "string", "nullable": true, "description": "Minimum hour in the future needs to be established with the Ops team for validation." }, "target_port_in_time_range_end": { "type": "string", "nullable": true, "description": "Maximum hour in the future needs to be established with the Ops team for validation." }, "port_in_request_status": { "type": "string", "nullable": true, "description": "The status of the port in request. The possible values are: In progress, Completed, Expired, In review, Waiting for Signature, Action Required, and Canceled." }, "losing_carrier_information": { "nullable": true, "description": "The information for the losing carrier. " }, "phone_numbers": { "type": "array", "items": {}, "nullable": true, "description": "The list of phone numbers to Port in. Phone numbers are in E.164 format (e.g. +16175551212)." }, "documents": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "The list of documents SID referencing a utility bills" }, "date_created": { "type": "string", "format": "date", "nullable": true } } }, "numbers.v1.porting_port_in_phone_number": { "type": "object", "properties": { "port_in_request_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^KW[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Port In request. This is a unique identifier of the port in request." }, "phone_number_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PU[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the Port In request phone number. This is a unique identifier of the phone number." }, "url": { "type": "string", "format": "uri", "nullable": true }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the account that the phone number belongs to." }, "phone_number_type": { "type": "string", "nullable": true, "description": "The type of the phone number." }, "date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "The date when the phone number was created." }, "country": { "type": "string", "format": "iso-country-code", "nullable": true, "description": "The country of the phone number." }, "missing_required_fields": { "type": "boolean", "nullable": true, "description": "The phone number is missing required fields." }, "last_updated": { "type": "string", "format": "date-time", "nullable": true, "description": "The timestamp when the status was last updated." }, "phone_number": { "type": "string", "format": "phone-number", "nullable": true, "description": "The phone number." }, "portable": { "type": "boolean", "nullable": true, "description": "The phone number is portable." }, "not_portability_reason": { "type": "string", "nullable": true, "description": "The reason why the phone number is not portable." }, "not_portability_reason_code": { "type": "integer", "nullable": true, "description": "The code of the reason why the phone number is not portable." }, "port_in_phone_number_status": { "type": "string", "nullable": true, "description": "The status of the phone number in the port in request." }, "port_out_pin": { "type": "integer", "nullable": true, "description": "The pin required for the losing carrier to port out the phone number." }, "rejection_reason": { "type": "string", "nullable": true, "description": "The rejection reason returned by the vendor." }, "rejection_reason_code": { "type": "integer", "nullable": true, "description": "The rejection reason code returned by the vendor." } } }, "numbers.v1.porting_portability": { "type": "object", "properties": { "phone_number": { "type": "string", "format": "phone-number", "nullable": true, "description": "The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212)." }, "account_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$", "nullable": true, "description": "The target account sid to which the number will be ported" }, "portable": { "type": "boolean", "nullable": true, "description": "Boolean flag specifying if phone number is portable or not." }, "pin_and_account_number_required": { "type": "boolean", "nullable": true, "description": "Boolean flag specifying if PIN and account number is required for the phone number." }, "not_portable_reason": { "type": "string", "nullable": true, "description": "Reason why the phone number cannot be ported into Twilio, `null` otherwise." }, "not_portable_reason_code": { "type": "integer", "nullable": true, "description": "The Portability Reason Code for the phone number if it cannot be ported into Twilio, `null` otherwise. One of `22131`, `22132`, `22130`, `22133`, `22102` or `22135`." }, "number_type": { "type": "string", "$ref": "#/components/schemas/porting_portability_enum_number_type", "nullable": true, "description": "The type of the requested phone number. One of `LOCAL`, `UNKNOWN`, `MOBILE`, `TOLL-FREE`." }, "country": { "type": "string", "format": "iso-country-code", "nullable": true, "description": "Country the phone number belongs to." }, "url": { "type": "string", "format": "uri", "nullable": true, "description": "This is the url of the request that you're trying to reach out to locate the resource." } } }, "porting_portability_enum_number_type": { "type": "string", "enum": [ "LOCAL", "UNKNOWN", "MOBILE", "TOLL-FREE" ] }, "numbers.v1.porting_webhook_configuration": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of the webhook configuration request" }, "port_in_target_url": { "type": "string", "format": "uri", "nullable": true, "description": "Webhook URL to send a request when a port in request or port in phone number event happens" }, "port_out_target_url": { "type": "string", "format": "uri", "nullable": true, "description": "Webhook URL to send a request when a port out phone number event happens" }, "notifications_of": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of notification events to send a request to the webhook URL" } } }, "numbers.v1.porting_webhook_configuration_delete": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of the webhook configuration request" }, "webhook_type": { "type": "string", "$ref": "#/components/schemas/porting_webhook_configuration_delete_enum_webhook_type", "nullable": true, "description": "The of the webhook type of the configuration to be deleted" } } }, "porting_webhook_configuration_delete_enum_webhook_type": { "type": "string", "enum": [ "PORT_IN", "PORT_OUT" ] }, "numbers.v1.porting_webhook_configuration_fetch": { "type": "object", "properties": { "url": { "type": "string", "format": "uri", "nullable": true, "description": "The URL of the webhook configuration request" }, "port_in_target_url": { "type": "string", "format": "uri", "nullable": true, "description": "Webhook URL to send a request when a port in request or port in phone number event happens" }, "port_out_target_url": { "type": "string", "format": "uri", "nullable": true, "description": "Webhook URL to send a request when a port out phone number event happens" }, "notifications_of": { "type": "array", "items": { "type": "string" }, "nullable": true, "description": "List of notification events to send a request to the webhook URL" }, "port_in_target_date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "Creation date for the port in webhook configuration" }, "port_out_target_date_created": { "type": "string", "format": "date-time", "nullable": true, "description": "Creation date for the port out webhook configuration" } } }, "numbers.v1.signing_request_configuration": { "type": "object", "properties": { "logo_sid": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^RD[0-9a-fA-F]{32}$", "nullable": true, "description": "The SID of the document that includes the logo that will appear in the LOA. To upload documents follow the following guide: https://www.twilio.com/docs/phone-numbers/regulatory/getting-started/create-new-bundle-public-rest-apis#supporting-document-create " }, "friendly_name": { "type": "string", "nullable": true, "description": "This is the string that you assigned as a friendly name for describing the creation of the configuration." }, "product": { "type": "string", "nullable": true, "description": "The product or service for which is requesting the signature." }, "country": { "type": "string", "format": "iso-country-code", "nullable": true, "description": "The country ISO code to apply the configuration." }, "email_subject": { "type": "string", "nullable": true, "description": "Subject of the email that the end client will receive ex: \u201cTwilio Hosting Request\u201d, maximum length of 255 characters." }, "email_message": { "type": "string", "nullable": true, "description": "Content of the email that the end client will receive ex: \u201cThis is a Hosting request from Twilio, please check the document and sign it\u201d, maximum length of 5,000 characters." }, "url_redirection": { "type": "string", "nullable": true, "description": "Url the end client will be redirected after signing a document." }, "url": { "type": "string", "format": "uri", "nullable": true } } } } }, "info": { "title": "Twilio - Numbers", "description": "This is the public Twilio REST API.", "termsOfService": "https://www.twilio.com/legal/tos", "contact": { "name": "Twilio Support", "url": "https://support.twilio.com", "email": "support@twilio.com" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.0" }, "openapi": "3.0.1", "paths": { "/v1/HostedNumber/Eligibility/Bulk": { "servers": [ { "url": "https://numbers.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "mountName": "bulk_eligibilities", "pathType": "list" }, "post": { "description": "Create a bulk eligibility check for a set of numbers that you want to host in Twilio.", "tags": [ "NumbersV1BulkEligibility" ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v1.bulk_eligibility" }, "examples": { "create": { "value": { "friendly_name": "Test", "status": "QUEUED", "date_created": "2023-05-03T03:12:30Z", "date_completed": null, "request_id": "ECaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "results": [], "url": "https://numbers.twilio.com/v1/HostedNumber/Eligibility/Bulk/ECaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Accepted" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateBulkEligibility", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "CreateBulkEligibilityRequest", "properties": {} } } } } } }, "/v1/HostedNumber/Eligibility/Bulk/{RequestId}": { "servers": [ { "url": "https://numbers.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "mountName": "bulk_eligibilities", "pathType": "instance" }, "get": { "description": "Fetch an eligibility bulk check that you requested to host in Twilio.", "tags": [ "NumbersV1BulkEligibility" ], "parameters": [ { "name": "RequestId", "in": "path", "description": "The SID of the bulk eligibility check that you want to know about.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^EC[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v1.bulk_eligibility" }, "examples": { "fetch": { "value": { "friendly_name": "Foo", "status": "SUCCESSFUL", "date_created": "2023-04-24T14:47:04Z", "date_completed": "2023-04-24T14:47:06Z", "results": [ { "phone_number": "+18778894546", "account_sid": "AC93b447ff5bd2abac37f1cbab2a871430", "eligibility_status": "INELIGIBLE", "eligibility_sub_status": "ALREADY_IN_TWILIO", "ineligibility_reason": "ALREADY_IN_TWILIO_BUT_NOT_IN_USE", "next_step": "CONTACT_SUPPORT_INELIGIBLE_INVENTORY_STATUS", "voice_provider": null, "messaging_provider": null, "phone_number_type": "TOLL_FREE", "hosting_order_sid": null, "hosting_order_status": null, "iso_country_code": "US", "inventory_status": "in-testing", "inventory_account_sid": "AC93b447ff5bd2abac37f1cbab2a871430" } ], "url": "https://numbers.twilio.com/v1/HostedNumber/Eligibility/Bulk/ECaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "request_id": "ECaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchBulkEligibility" } }, "/v1/HostedNumber/Eligibility": { "servers": [ { "url": "https://numbers.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "mountName": "eligibilities", "pathType": "list" }, "post": { "description": "Create an eligibility check for a number that you want to host in Twilio.", "tags": [ "NumbersV1Eligibility" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v1.eligibility" }, "examples": { "create": { "value": { "results": [ { "phone_number": "+18778894546", "account_sid": "AC93b447ff5bd2abac37f1cbab2a871430", "eligibility_status": "INELIGIBLE", "eligibility_sub_status": "ALREADY_IN_TWILIO", "ineligibility_reason": "ALREADY_IN_TWILIO_BUT_NOT_IN_USE", "next_step": "CONTACT_SUPPORT_INELIGIBLE_INVENTORY_STATUS", "voice_provider": null, "messaging_provider": null, "phone_number_type": "TOLL_FREE", "hosting_order_sid": null, "hosting_order_status": null, "iso_country_code": "US", "inventory_status": "in-testing", "inventory_account_sid": "AC93b447ff5aa2abac37e3cbab2a871430" }, { "phone_number": "4565433456", "account_sid": null, "eligibility_status": "INELIGIBLE", "eligibility_sub_status": "NUMBER_FORMAT_INELIGIBLE", "ineligibility_reason": "NUMBER_FORMAT_INELIGIBLE", "next_step": "EDIT_INELIGIBLE_NUMBER", "voice_provider": null, "messaging_provider": null, "phone_number_type": null, "hosting_order_sid": null, "hosting_order_status": null, "iso_country_code": null, "inventory_status": null, "inventory_account_sid": null } ] } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateEligibility", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "CreateEligibilityRequest", "properties": {} } } } } } }, "/v1/Porting/PortIn": { "servers": [ { "url": "https://numbers.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "port_in_request_sid" ], "mountName": "porting_port_ins", "pathType": "list" }, "post": { "description": "Allows to create a new port in request", "tags": [ "NumbersV1PortingPortIn" ], "responses": { "202": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v1.porting_port_in" }, "examples": { "create": { "value": { "port_in_request_sid": "KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "notification_emails": [ "user@domain.com" ], "target_port_in_date": "2023-09-10", "target_port_in_time_range_start": "10:00:00+01:00", "target_port_in_time_range_end": "20:00:00+01:00", "port_in_request_status": "pending", "date_created": "2023-09-10", "losing_carrier_information": { "customer_type": "Business/Individual", "customer_name": "Customer name for carrier", "authorized_representative": "John Smith", "authorized_representative_email": "signer@domain.com", "account_number": "123456", "account_telephone_number": "+133232323", "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "address": { "street": "Your Street", "street_2": "Other Street or null", "city": "City", "state": "State", "zip": "000000", "country": "US" } }, "phone_numbers": [ { "phone_number": "+16175551212", "pin": "123456", "portable": true, "not_portability_reason": "string", "port_in_phone_number_sid": "PUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "port_in_phone_number_status": "In Review", "not_portability_reason_code": 0 } ], "documents": [ "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ], "url": "https://numbers.twilio.com/v1/Porting/PortIn/KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Accepted" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreatePortingPortIn", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "CreatePortingPortInRequest", "properties": {} } } } } } }, "/v1/Porting/PortIn/{PortInRequestSid}": { "servers": [ { "url": "https://numbers.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "port_in_request_sid" ], "mountName": "porting_port_ins", "pathType": "instance" }, "delete": { "description": "Allows to cancel a port in request by SID", "tags": [ "NumbersV1PortingPortIn" ], "parameters": [ { "name": "PortInRequestSid", "in": "path", "description": "The SID of the Port In request. This is a unique identifier of the port in request.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^KW[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeletePortingPortIn" }, "get": { "description": "Fetch a port in request by SID", "tags": [ "NumbersV1PortingPortIn" ], "parameters": [ { "name": "PortInRequestSid", "in": "path", "description": "The SID of the Port In request. This is a unique identifier of the port in request.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^KW[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v1.porting_port_in" }, "examples": { "fetch": { "value": { "port_in_request_sid": "KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "url": "https://numbers.twilio.com/v1/Porting/PortIn/KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "notification_emails": [ "user@domain.com" ], "target_port_in_date": "2023-09-10", "target_port_in_time_range_start": "10:00:00+01:00", "target_port_in_time_range_end": "20:00:00+01:00", "port_in_request_status": "pending", "date_created": "2023-09-10", "losing_carrier_information": { "customer_type": "Business/Individual", "customer_name": "Customer name for carrier", "authorized_representative": "John Smith", "authorized_representative_email": "signer@domain.com", "account_number": "123456", "account_telephone_number": "+133232323", "address_sid": "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "address": { "street": "Your Street", "street_2": "Other Street or null", "city": "City", "state": "State", "zip": "000000", "country": "US" } }, "phone_numbers": [ { "phone_number": "+16175551212", "pin": "123456", "portable": true, "not_portability_reason": "string", "not_portability_reason_code": 0, "port_in_phone_number_sid": "PUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "port_in_phone_number_status": "In Review" } ], "documents": [ "ADaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" ] } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchPortingPortIn" } }, "/v1/Porting/PortIn/{PortInRequestSid}/PhoneNumber/{PhoneNumberSid}": { "servers": [ { "url": "https://numbers.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "port_in_request_sid", "phone_number_sid" ], "mountName": "porting_port_in_phone_number", "pathType": "instance" }, "delete": { "description": "Allows to cancel a port in request phone number by SID", "tags": [ "NumbersV1PortingPortInPhoneNumber" ], "parameters": [ { "name": "PortInRequestSid", "in": "path", "description": "The SID of the Port In request. This is a unique identifier of the port in request.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^KW[0-9a-fA-F]{32}$" }, "required": true }, { "name": "PhoneNumberSid", "in": "path", "description": "The SID of the Port In request phone number. This is a unique identifier of the phone number.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PU[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeletePortingPortInPhoneNumber" }, "get": { "description": "Fetch a phone number by port in request SID and phone number SID", "tags": [ "NumbersV1PortingPortInPhoneNumber" ], "parameters": [ { "name": "PortInRequestSid", "in": "path", "description": "The SID of the Port In request. This is a unique identifier of the port in request.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^KW[0-9a-fA-F]{32}$" }, "required": true }, { "name": "PhoneNumberSid", "in": "path", "description": "The SID of the Phone number. This is a unique identifier of the phone number.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^PU[0-9a-fA-F]{32}$" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v1.porting_port_in_phone_number" }, "examples": { "fetch": { "value": { "port_in_request_sid": "KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "phone_number_type": "LOCAL", "date_created": "2024-04-10T06:52:21Z", "country": "US", "missing_required_fields": false, "last_updated": "2024-03-12T06:52:21Z", "phone_number": "+15024953384", "portable": true, "not_portability_reason": "ALREADY_IN_TWILIO_DIFFERENT_OWNER", "not_portability_reason_code": 22132, "port_in_phone_number_status": "in_review", "phone_number_sid": "PUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa", "port_out_pin": 1234, "rejection_reason": null, "rejection_reason_code": null, "url": "https://numbers.twilio.com/v1/Porting/PortIn/KWaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/PhoneNumber/PUaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchPortingPortInPhoneNumber" } }, "/v1/Porting/Portability/PhoneNumber/{PhoneNumber}": { "servers": [ { "url": "https://numbers.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "mountName": "porting_portabilities", "pathType": "instance" }, "get": { "description": "Allows to check if a single phone number can be ported to Twilio or not.", "tags": [ "NumbersV1PortingPortability" ], "parameters": [ { "name": "PhoneNumber", "in": "path", "description": "The phone number which portability is to be checked. Phone numbers are in E.164 format (e.g. +16175551212).", "schema": { "type": "string", "format": "phone-number" }, "required": true }, { "name": "TargetAccountSid", "in": "query", "description": "The SID of the account where the phone number(s) will be ported.", "schema": { "type": "string", "minLength": 34, "maxLength": 34, "pattern": "^AC[0-9a-fA-F]{32}$" }, "examples": { "fetch": { "value": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa02" } } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v1.porting_portability" }, "examples": { "fetch": { "value": { "phone_number": "+18001234567", "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa01", "portable": false, "pin_and_account_number_required": false, "not_portable_reason": "MANUAL_PORTING_AVAILABLE", "not_portable_reason_code": 22133, "number_type": "TOLL-FREE", "country": "US", "url": "https://numbers.twilio.com/v1/Porting/Portability/PhoneNumber/+18001234567" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchPortingPortability" } }, "/v1/Porting/Configuration/Webhook": { "servers": [ { "url": "https://numbers.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "mountName": "porting_webhook_configurations", "pathType": "list" }, "post": { "description": "Allows to create a new webhook configuration", "tags": [ "NumbersV1PortingWebhookConfiguration" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v1.porting_webhook_configuration" }, "examples": { "create": { "value": { "port_in_target_url": "https://www.example.com/port-in", "port_out_target_url": "https://www.example.com/port-out", "notifications_of": [ "PortInWaitingForSignature", "PortInInProgress", "PortInCompleted", "PortInActionRequired", "PortInCanceled", "PortInExpired", "PortInPhoneNumberWaitingForSignature", "PortInPhoneNumberSubmitted", "PortInPhoneNumberPending", "PortInPhoneNumberCompleted", "PortInPhoneNumberRejected", "PortOutPhoneNumberCompleted" ], "url": "https://numbers.twilio.com/v1/Porting/Configuration/Webhook" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreatePortingWebhookConfiguration", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "CreatePortingWebhookConfigurationRequest", "properties": {} } } } } }, "get": { "description": "Allows to fetch the webhook configuration", "tags": [ "NumbersV1PortingWebhookConfigurationFetch" ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v1.porting_webhook_configuration_fetch" }, "examples": { "fetch": { "value": { "port_in_target_url": "https://www.example.com/port-in", "port_out_target_url": "https://www.example.com/port-out", "notifications_of": [ "PortInWaitingForSignature", "PortInInProgress", "PortInCompleted", "PortInActionRequired", "PortInCanceled", "PortInExpired", "PortInPhoneNumberWaitingForSignature", "PortInPhoneNumberSubmitted", "PortInPhoneNumberPending", "PortInPhoneNumberCompleted", "PortInPhoneNumberRejected", "PortOutPhoneNumberCompleted" ], "port_in_target_date_created": "2024-05-14T13:49:04Z", "port_out_target_date_created": "2024-05-14T13:49:07Z", "url": "https://numbers.twilio.com/v1/Porting/Configuration/Webhook" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "OK" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "FetchPortingWebhookConfigurationFetch", "x-twilio": { "mountName": "porting_webhook_configuration_fetch" } } }, "/v1/Porting/Configuration/Webhook/{WebhookType}": { "servers": [ { "url": "https://numbers.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [], "mountName": "porting_webhook_configurations_delete", "className": "porting_webhook_configuration_delete", "pathType": "instance" }, "delete": { "description": "Allows the client to delete a webhook configuration.", "tags": [ "NumbersV1PortingWebhookConfigurationDelete" ], "parameters": [ { "name": "WebhookType", "in": "path", "description": "The of the webhook type of the configuration to be deleted", "schema": { "type": "string", "$ref": "#/components/schemas/porting_webhook_configuration_delete_enum_webhook_type" }, "required": true } ], "responses": { "204": { "description": "The resource was deleted successfully." } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "DeletePortingWebhookConfigurationDelete" } }, "/v1/SigningRequest/Configuration": { "servers": [ { "url": "https://numbers.twilio.com" } ], "description": "", "x-twilio": { "defaultOutputProperties": [ "product", "email_subject", "email_message" ], "mountName": "signing_request_configurations", "pathType": "list" }, "post": { "description": "Synchronous operation to insert or update a configuration for the customer.", "tags": [ "NumbersV1SigningRequestConfiguration" ], "responses": { "201": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/numbers.v1.signing_request_configuration" }, "examples": { "create": { "value": { "logo_sid": "RD00000000000000000000000000000000", "friendly_name": "Configuration", "product": "Porting", "country": "US", "email_subject": "Twilio Porting Request", "email_message": "This is a signature request from Twilio, please check the document and sign it", "url_redirection": "https://www.twilio.com/redirect-url", "url": "https://numbers.twilio.com/v1/SigningRequest/Configuration" } } } } }, "headers": { "Access-Control-Allow-Origin": { "description": "Specify the origin(s) allowed to access the resource", "schema": { "type": "string" }, "example": "*" }, "Access-Control-Allow-Methods": { "description": "Specify the HTTP methods allowed when accessing the resource", "schema": { "type": "string" }, "example": "POST, OPTIONS" }, "Access-Control-Allow-Headers": { "description": "Specify the headers allowed when accessing the resource", "schema": { "type": "string" }, "example": "Content-Type, Authorization" }, "Access-Control-Allow-Credentials": { "description": "Indicates whether the browser should include credentials", "schema": { "type": "boolean" } }, "Access-Control-Expose-Headers": { "description": "Headers exposed to the client", "schema": { "type": "string", "example": "X-Custom-Header1, X-Custom-Header2" } } }, "description": "Created" } }, "security": [ { "accountSid_authToken": [] } ], "operationId": "CreateSigningRequestConfiguration", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "title": "CreateSigningRequestConfigurationRequest", "properties": {} } } } } } } }, "servers": [ { "url": "https://numbers.twilio.com" } ], "tags": [ { "name": "NumbersV1AuthorizationDocument" }, { "name": "NumbersV1BulkEligibility" }, { "name": "NumbersV1DependentOrder" }, { "name": "NumbersV1Documents" }, { "name": "NumbersV1Eligibility" }, { "name": "NumbersV1HostedNumberOrder" }, { "name": "NumbersV1Identity" }, { "name": "NumbersV1PortingPortIn" }, { "name": "NumbersV1PortingPortInPhoneNumber" }, { "name": "NumbersV1PortingPortability" }, { "name": "NumbersV1PortingWebhookConfiguration" }, { "name": "NumbersV1PortingWebhookConfigurationDelete" }, { "name": "NumbersV1PortingWebhookConfigurationFetch" }, { "name": "NumbersV1ProofOfAddress" }, { "name": "NumbersV1SigningRequestConfiguration" } ], "security": [ { "accountSid_authToken": [] } ] }