Messaging API Overview
The Programmable Messaging REST API helps you add robust messaging capabilities to your applications.
With the REST API, you can:
Base URLs
Whoosh's APIs are served over HTTPS. To ensure data privacy, unencrypted HTTP is not supported.The following API Resources use
https://api.whoosh.totogi.solutions/2010-04-01
as the base URL:API Resources related to Messaging Services use
https://messaging.whoosh.totogi.solutions/v1
:The Deactivations Resource also uses the
https://messaging.whoosh.totogi.solutions/v1
base URL.Pricing information for Messaging uses the
https://pricing.whoosh.totogi.solutions/v1
base URL.Authentication
HTTP requests to the API use HTTP basic authenticationUse your Whoosh API Key as the username and your API Secret as the password for HTTP basic authentication when sending HTTP requests to Twilio.
The code samples in the API documentation show how and where to put your API Key and Secret if you're using a Helper Library to communicate with Whoosh's API.
To learn more about interacting with Whoosh's REST API, check out the Twilio Usage docs, we are 100% Twilio compatible.
Use the Programmable Messaging API
Send messages
To send an outbound message, send a POST request to the Message Resource.
- To send media messages , use the
MediaUrl
parameter in the request. - To schedule an outbound Message to be sent in the future, use the
ScheduleType
andSendAt
parameters in the request. - To send messages with shortened links , use the
ShortenUrls
parameter in the request.- Note: This feature is available only if you are using Messaging Services .
Looking for information on how to receive and reply to messages? We are 100% Twilio compatible, check out Twilio's Receive and Reply to Messages Guide.
Fetch, list, update, and delete messages
Use the Message Resource to fetch, list, and delete Messages associated with your Account.
Redact messages by updating a Message Resource.
Fetch, list, and delete media
Whoosh creates a Media Subresource when an incoming or outgoing Message Resource contains media.
You can fetch, list, and delete Media Subresources.
Manage your short codes
Fetch, list, and update your Account's short codes with the ShortCode Resource .
Track message feedback
Track user-reported outcomes of Messages with the MessageFeedback Subresource .
Manage your Messaging Services
Create, fetch, read, update, and delete Messaging Services with the Service Resource .
Manage your Messaging Services' senders with:
Check SMS pricing by country
Contact us for details on pricing.Additional Resources
- Send and receive messages in your programming language of choice by using one of Twilio's Helper Libraries. For step-by-step instructions on how to send and receive messages using Whoosh with a Helper Library, check our Code Samples in the language of your choice.
- We are 100% Twilio compatible, check out Twilio Blog for inspiration on how you can build Messaging applications with a variety of languages and tools.
- For help troubleshooting your Programmable Messaging application, check out Twilio docs on Debugging Common Issue. We are 100% Twilio compatible, works same way with Whoosh.