-
API DOCUMENTATION
GETTING STARTED -
MESSAGES
- POSTSend a Message
-
NUMBER MANAGEMENT
- GETActive Numbers
- GETSearch Numbers
- POSTGet a Number
-
ACCOUNT
- GETGet Balance
-
TEST METHODS
- GETPing
-
CALLBACK EVENTS
- POSTInbound Message
- POSTDelivery Receipt
SMS API Overview
Description
The TextPort API is used to send and receive text messages using standard REST calls. The API is lightweight and designed to be simple and easy to configure.
Capabilities
- Send SMS Messages
- Receive SMS Messages
- Get Delivery Receipts
- Search for new numbers
- Get active numbers
- Purchase numbers
- Get account balance
Receiving Inbound Messages
Inbound messages can be sent to the callback URL (webhook) that you specify. You can set up a callback URL in the API Settings page. Each account may have multiple API applications, and each application can have one or more virtual numbers assigned.
Base API URL
https://api.textport.com/v1/
Security
The API is protected using Basic Authorization over HTTPS. Basic Authorization requires an API Key and password to be Base64-encoded and added to the Authorization HTTP header. Example: Authorization: Basic MS1vcVk0OUNFRzhzOldqTk1ya2t6ZnFLbnQwV2c1bVdk
Credentials
Visit the API Settings page to get your API credentials. TextPort will assign each application an API key and password.
Basic Test
Visit the API Settings page to set up credentials. Test your connectivity using this basic ping test.