Twilio Preview
This is the public Twilio REST API.
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 35
PreviewHostedNumbersAuthorizationDocument
- GETFetch a specific AuthorizationDocument.
/HostedNumbers/AuthorizationDocuments/:SidFetch a specific AuthorizationDocument. - POSTUpdates a specific AuthorizationDocument.
/HostedNumbers/AuthorizationDocuments/:SidUpdates a specific AuthorizationDocument. - DELETEDelete the AuthorizationDocument and remove any associations with HostedNumberOrders.
/HostedNumbers/AuthorizationDocuments/:SidDelete the AuthorizationDocument and remove any associations with HostedNumberOrders. - GETRetrieve a list of AuthorizationDocuments belonging to the account initiating the request.
/HostedNumbers/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.
/HostedNumbers/AuthorizationDocumentsCreate an AuthorizationDocument for authorizing the hosting of phone number capabilities on Twilio's platform.
PreviewHostedNumbersDependentHostedNumberOrder
- GETRetrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.
/HostedNumbers/AuthorizationDocuments/:SigningDocumentSid/DependentHostedNumberOrders?Status=completed&PhoneNumber=+19193608000&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=example&UniqueName=something123&PageSize=1&Page=0&PageToken=stringRetrieve a list of dependent HostedNumberOrders belonging to the AuthorizationDocument.
PreviewHostedNumbersHostedNumberOrder
- GETFetch a specific HostedNumberOrder.
/HostedNumbers/HostedNumberOrders/:SidFetch a specific HostedNumberOrder. - POSTUpdates a specific HostedNumberOrder.
/HostedNumbers/HostedNumberOrders/:SidUpdates a specific HostedNumberOrder. - DELETECancel the HostedNumberOrder (only available when the status is in `received`).
/HostedNumbers/HostedNumberOrders/:SidCancel the HostedNumberOrder (only available when the status is in received). - GETRetrieve a list of HostedNumberOrders belonging to the account initiating the request.
/HostedNumbers/HostedNumberOrders?Status=completed&PhoneNumber=+19193608000&IncomingPhoneNumberSid=PNaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa&FriendlyName=example&UniqueName=something123&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.
/HostedNumbers/HostedNumberOrdersHost a phone number's capability on Twilio's platform.
PreviewMarketplaceAvailableAddOn
- GETFetch an instance of an Add-on currently available to be installed.
/marketplace/AvailableAddOns/:SidFetch an instance of an Add-on currently available to be installed. - GETRetrieve a list of Add-ons currently available to be installed.
/marketplace/AvailableAddOns?PageSize=1&Page=0&PageToken=stringRetrieve a list of Add-ons currently available to be installed.
PreviewMarketplaceAvailableAddOnExtension
- GETFetch an instance of an Extension for the Available Add-on.
/marketplace/AvailableAddOns/:AvailableAddOnSid/Extensions/:SidFetch an instance of an Extension for the Available Add-on. - GETRetrieve a list of Extensions for the Available Add-on.
/marketplace/AvailableAddOns/:AvailableAddOnSid/Extensions?PageSize=1&Page=0&PageToken=stringRetrieve a list of Extensions for the Available Add-on.
PreviewMarketplaceInstalledAddOn
- GETRetrieve a list of Add-ons currently installed on this Account.
/marketplace/InstalledAddOns?PageSize=1&Page=0&PageToken=stringRetrieve a list of Add-ons currently installed on this Account. - POSTInstall an Add-on for the Account specified.
/marketplace/InstalledAddOnsInstall an Add-on for the Account specified. - GETFetch an instance of an Add-on currently installed on this Account.
/marketplace/InstalledAddOns/:SidFetch an instance of an Add-on currently installed on this Account. - POSTUpdate an Add-on installation for the Account specified.
/marketplace/InstalledAddOns/:SidUpdate an Add-on installation for the Account specified. - DELETERemove an Add-on installation from your account
/marketplace/InstalledAddOns/:SidRemove an Add-on installation from your account
PreviewMarketplaceInstalledAddOnExtension
- GETFetch an instance of an Extension for the Installed Add-on.
/marketplace/InstalledAddOns/:InstalledAddOnSid/Extensions/:SidFetch an instance of an Extension for the Installed Add-on. - POSTUpdate an Extension for an Add-on installation.
/marketplace/InstalledAddOns/:InstalledAddOnSid/Extensions/:SidUpdate an Extension for an Add-on installation. - GETRetrieve a list of Extensions for the Installed Add-on.
/marketplace/InstalledAddOns/:InstalledAddOnSid/Extensions?PageSize=1&Page=0&PageToken=stringRetrieve a list of Extensions for the Installed Add-on.
PreviewWirelessCommand
- GETFetchWirelessCommand
/wireless/Commands/:Sid - GETListWirelessCommand
/wireless/Commands?Device=device&Sim=sim&Status=status&Direction=direction&PageSize=1&Page=0&PageToken=string - POSTCreateWirelessCommand
/wireless/Commands
PreviewWirelessRatePlan
- GETListWirelessRatePlan
/wireless/RatePlans?PageSize=1&Page=0&PageToken=string - POSTCreateWirelessRatePlan
/wireless/RatePlans - GETFetchWirelessRatePlan
/wireless/RatePlans/:Sid - POSTUpdateWirelessRatePlan
/wireless/RatePlans/:Sid - DELETEDeleteWirelessRatePlan
/wireless/RatePlans/:Sid
PreviewWirelessSim
- GETFetchWirelessSim
/wireless/Sims/:Sid - POSTUpdateWirelessSim
/wireless/Sims/:Sid - GETListWirelessSim
/wireless/Sims?Status=status&Iccid=iccid&RatePlan=rate_plan&EId=string&SimRegistrationCode=string&PageSize=1&Page=0&PageToken=string
PreviewWirelessUsage
- GETFetchWirelessUsage
/wireless/Sims/:SimSid/Usage?End=end&Start=start
API details
- Base URL
https://preview.twilio.com- Authentication
- HTTP Basic authentication (username and password)
- Operations
- 35 operations on 20 pathsGET 20POST 11DELETE 4
- Main resources
- PreviewHostedNumbersAuthorizationDocument 5PreviewHostedNumbersHostedNumberOrder 5PreviewMarketplaceInstalledAddOn 5PreviewWirelessRatePlan 5PreviewMarketplaceInstalledAddOnExtension 3PreviewWirelessCommand 3PreviewWirelessSim 3PreviewMarketplaceAvailableAddOn 2PreviewMarketplaceAvailableAddOnExtension 2PreviewHostedNumbersDependentHostedNumberOrder 1
- Response formats
application/json- Description format
- OpenAPI 3.0.1, API version
1.0.0 - Links
- OpenAPI document · Terms of service · Support
- Listed from
- Twilio's published OpenAPI description (twilio/twilio-oai) (MIT)
How to test the Twilio Preview in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Twilio Preview collection, without the publisher's secrets.
- 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.
- Send a requestPick an endpoint, for example “Fetch a specific AuthorizationDocument.” (GET /HostedNumbers/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 Preview?
This is the public Twilio REST API. It is listed under Communication and has 35 endpoints.
Who publishes the Twilio Preview?
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 Preview?
Requests go to https://preview.twilio.com. Endpoint paths are added to this base URL.
How do I authenticate with the Twilio Preview?
With HTTP Basic authentication (username and password).
How many endpoints does the Twilio Preview have?
35 operations on 20 paths (20 GET, 11 POST, 4 DELETE). The largest groups are PreviewHostedNumbersAuthorizationDocument, PreviewHostedNumbersHostedNumberOrder, PreviewMarketplaceInstalledAddOn, PreviewWirelessRatePlan.
Is forking the Twilio Preview free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.