Twilio

Twilio Numbers v2

This is the public Twilio REST API.

Communication#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

This is the public Twilio REST API.

Endpoints 47

NumbersV2AuthorizationDocument

  • GETFetch a specific AuthorizationDocument./v2/HostedNumber/AuthorizationDocuments/:SidFetch a specific AuthorizationDocument.
  • DELETECancel the AuthorizationDocument request./v2/HostedNumber/AuthorizationDocuments/:SidCancel the AuthorizationDocument request.
  • GETRetrieve a list of AuthorizationDocuments belonging to the account initiating the request./v2/HostedNumber/AuthorizationDocuments?Email=test+hosted@twilio.com&Status=signed&PageSize=1&Page=0&PageToken=stringRetrieve a list of AuthorizationDocuments belonging to the account initiating the request.
  • POSTCreate an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform./v2/HostedNumber/AuthorizationDocumentsCreate an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.

NumbersV2BulkHostedNumberOrder

  • GETFetch a specific BulkHostedNumberOrder./v2/HostedNumber/Orders/Bulk/:BulkHostingSid?OrderStatus=stringFetch a specific BulkHostedNumberOrder.
  • POSTHost multiple phone numbers on Twilio's platform./v2/HostedNumber/Orders/BulkHost multiple phone numbers on Twilio's platform.

NumbersV2Bundle

  • GETRetrieve a list of all Bundles for an account./v2/RegulatoryCompliance/Bundles?Status=draft&BundleSids=string&FriendlyName=friendly_name&RegulationSid=RNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&IsoCountry=US&NumberType=mobile&EndUserType=business&HasValidUntilDate=true&SortBy=valid-until&SortDirection=ASC&ValidUntilDate=2024-01-01T00:00:00Z&ValidUntilDate<=2022-11-29T23:59:59Z&ValidUntilDate>=2022-01-01T00:00:00Z&PageSize=1&Page=0&PageToken=stringRetrieve a list of all Bundles for an account.
  • POSTCreate a new Bundle./v2/RegulatoryCompliance/BundlesCreate a new Bundle.
  • GETFetch a specific Bundle instance./v2/RegulatoryCompliance/Bundles/:SidFetch a specific Bundle instance.
  • POSTUpdates a Bundle in an account./v2/RegulatoryCompliance/Bundles/:SidUpdates a Bundle in an account.
  • DELETEDelete a specific Bundle./v2/RegulatoryCompliance/Bundles/:SidDelete a specific Bundle.

NumbersV2BundleClone

  • POSTCreates a new clone of the Bundle in target Account. It will internally create clones of all the bundle items (identities and documents) of the original bundle/v2/RegulatoryCompliance/Bundles/:BundleSid/ClonesCreates a new clone of the Bundle in target Account. It will internally create clones of all the bundle items (identities and documents) of the original bundle

NumbersV2BundleCopy

  • GETRetrieve a list of all Bundles Copies for a Bundle./v2/RegulatoryCompliance/Bundles/:BundleSid/Copies?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Bundles Copies for a Bundle.
  • POSTCreates a new copy of a Bundle. It will internally create copies of all the bundle items (identities and documents) of the original bundle/v2/RegulatoryCompliance/Bundles/:BundleSid/CopiesCreates a new copy of a Bundle. It will internally create copies of all the bundle items (identities and documents) of the original bundle

NumbersV2DependentHostedNumberOrder

  • GETRetrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument./v2/HostedNumber/AuthorizationDocuments/:SigningDocumentSid/DependentHostedNumberOrders?Status=completed&PhoneNumber=+19193608000&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=example&PageSize=1&Page=0&PageToken=stringRetrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.

NumbersV2EndUser

  • GETRetrieve a list of all End User for an account./v2/RegulatoryCompliance/EndUsers?PageSize=1&Page=0&PageToken=stringRetrieve a list of all End User for an account.
  • POSTCreate a new End User./v2/RegulatoryCompliance/EndUsersCreate a new End User.
  • GETFetch specific End User Instance./v2/RegulatoryCompliance/EndUsers/:SidFetch specific End User Instance.
  • POSTUpdate an existing End User./v2/RegulatoryCompliance/EndUsers/:SidUpdate an existing End User.
  • DELETEDelete a specific End User./v2/RegulatoryCompliance/EndUsers/:SidDelete a specific End User.

NumbersV2EndUserType

  • GETRetrieve a list of all End-User Types./v2/RegulatoryCompliance/EndUserTypes?PageSize=1&Page=0&PageToken=stringRetrieve a list of all End-User Types.
  • GETFetch a specific End-User Type Instance./v2/RegulatoryCompliance/EndUserTypes/:SidFetch a specific End-User Type Instance.

NumbersV2Evaluation

  • GETRetrieve a list of Evaluations associated to the Bundle resource./v2/RegulatoryCompliance/Bundles/:BundleSid/Evaluations?PageSize=1&Page=0&PageToken=stringRetrieve a list of Evaluations associated to the Bundle resource.
  • POSTCreates an evaluation for a bundle/v2/RegulatoryCompliance/Bundles/:BundleSid/EvaluationsCreates an evaluation for a bundle
  • GETFetch specific Evaluation Instance./v2/RegulatoryCompliance/Bundles/:BundleSid/Evaluations/:SidFetch specific Evaluation Instance.

NumbersV2HostedNumberOrder

  • GETFetch a specific HostedNumberOrder./v2/HostedNumber/Orders/:SidFetch a specific HostedNumberOrder.
  • POSTUpdates a specific HostedNumberOrder./v2/HostedNumber/Orders/:SidUpdates a specific HostedNumberOrder.
  • DELETECancel the HostedNumberOrder (only available when the status is in `received`)./v2/HostedNumber/Orders/:SidCancel the HostedNumberOrder (only available when the status is in received).
  • GETRetrieve a list of HostedNumberOrders belonging to the account initiating the request./v2/HostedNumber/Orders?Status=completed&SmsCapability=true&PhoneNumber=+19193608000&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=example&PageSize=1&Page=0&PageToken=stringRetrieve a list of HostedNumberOrders belonging to the account initiating the request.
  • POSTHost a phone number's capability on Twilio's platform./v2/HostedNumber/OrdersHost a phone number's capability on Twilio's platform.

NumbersV2ItemAssignment

  • GETRetrieve a list of all Assigned Items for an account./v2/RegulatoryCompliance/Bundles/:BundleSid/ItemAssignments?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Assigned Items for an account.
  • POSTCreate a new Assigned Item./v2/RegulatoryCompliance/Bundles/:BundleSid/ItemAssignmentsCreate a new Assigned Item.
  • GETFetch specific Assigned Item Instance./v2/RegulatoryCompliance/Bundles/:BundleSid/ItemAssignments/:SidFetch specific Assigned Item Instance.
  • DELETERemove an Assignment Item Instance./v2/RegulatoryCompliance/Bundles/:BundleSid/ItemAssignments/:SidRemove an Assignment Item Instance.

NumbersV2Regulation

  • GETRetrieve a list of all Regulations./v2/RegulatoryCompliance/Regulations?EndUserType=business&IsoCountry=US&NumberType=mobile&IncludeConstraints=true&PageSize=1&Page=0&PageToken=stringRetrieve a list of all Regulations.
  • GETFetch specific Regulation Instance./v2/RegulatoryCompliance/Regulations/:Sid?IncludeConstraints=trueFetch specific Regulation Instance.

NumbersV2ReplaceItems

  • POSTReplaces all bundle items in the target bundle (specified in the path) with all the bundle items of the source bundle (specified by the from_bundle_sid body param)/v2/RegulatoryCompliance/Bundles/:BundleSid/ReplaceItemsReplaces all bundle items in the target bundle (specified in the path) with all the bundle items of the source bundle (specified by the from_bundle_sid body…

NumbersV2SupportingDocument

  • GETRetrieve a list of all Supporting Document for an account./v2/RegulatoryCompliance/SupportingDocuments?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Supporting Document for an account.
  • POSTCreate a new Supporting Document./v2/RegulatoryCompliance/SupportingDocumentsCreate a new Supporting Document.
  • GETFetch specific Supporting Document Instance./v2/RegulatoryCompliance/SupportingDocuments/:SidFetch specific Supporting Document Instance.
  • POSTUpdate an existing Supporting Document./v2/RegulatoryCompliance/SupportingDocuments/:SidUpdate an existing Supporting Document.
  • DELETEDelete a specific Supporting Document./v2/RegulatoryCompliance/SupportingDocuments/:SidDelete a specific Supporting Document.

NumbersV2SupportingDocumentType

  • GETRetrieve a list of all Supporting Document Types./v2/RegulatoryCompliance/SupportingDocumentTypes?PageSize=1&Page=0&PageToken=stringRetrieve a list of all Supporting Document Types.
  • GETFetch a specific Supporting Document Type Instance./v2/RegulatoryCompliance/SupportingDocumentTypes/:SidFetch a specific Supporting Document Type Instance.

V2ShortCodeApplications

  • GETList Short Code Applications/v2/ShortCodes/Applications?AccountSid=string&IsoCountry=string&Status=string&FriendlyName=string&Sid=string&PageSize=1&Page=0list of all short code applications for an account
  • POSTCreate a new short code application/v2/ShortCodes/ApplicationsCreate a new short code application for an account
  • GETFetch a specific Short Code Application instance./v2/ShortCodes/Applications/:sidFetch a specific Short Code Application instance.

API details

Base URL
https://numbers.twilio.com
Authentication
HTTP Basic authentication (username and password)
Operations
47 operations on 29 pathsGET 25POST 16DELETE 6
Main resources
NumbersV2Bundle 5NumbersV2EndUser 5NumbersV2HostedNumberOrder 5NumbersV2SupportingDocument 5NumbersV2AuthorizationDocument 4NumbersV2ItemAssignment 4NumbersV2Evaluation 3V2ShortCodeApplications 3NumbersV2BulkHostedNumberOrder 2NumbersV2BundleCopy 2
Response formats
application/json
Description format
OpenAPI 3.0.1, API version 1.0.0

How to test the Twilio Numbers v2 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio Numbers v2 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Fetch a specific AuthorizationDocument.” (GET /v2/HostedNumber/AuthorizationDocuments/:Sid), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the Twilio Numbers v2?

This is the public Twilio REST API. It is listed under Communication and has 47 endpoints.

Who publishes the Twilio Numbers v2?

It is listed from Twilio's public API description (an OpenAPI document), not published by Twilio on Swastik Codes. Anyone who controls twilio.com can claim the profile by adding a DNS TXT record.

What is the base URL of the Twilio Numbers v2?

Requests go to https://numbers.twilio.com. Endpoint paths are added to this base URL.

How do I authenticate with the Twilio Numbers v2?

With HTTP Basic authentication (username and password).

How many endpoints does the Twilio Numbers v2 have?

47 operations on 29 paths (25 GET, 16 POST, 6 DELETE). The largest groups are NumbersV2Bundle, NumbersV2EndUser, NumbersV2HostedNumberOrder, NumbersV2SupportingDocument.

Is forking the Twilio Numbers v2 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.