Routee API Documentation
This is the complete API documentation for connecting to the Routee API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Routee: Routee is a communication platform for SMS, verification, failover, contact, lookup, validation, URL, and account workflows. Keep reading to get started.
Quickstart
Before you run your first Routee request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Routee connection — create or choose one in Connections. Note its
connectionId.
Every Routee action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/routee/latest/actions/{actionSlug}You need a MindCloud API Key and a Routee connection. Then call an action such as Analyse an SMS message:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/routee/latest/actions/analyse-an-sms-message" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Routee account that should run the action. MindCloud stores and refreshes the Routee credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
Routee actions
All 188 published actions for this Routee version. Each page documents the endpoint, arguments, and response controls.
- POSTActivate a sender
- POSTAdd a domain
- PUTAdd a Number to a pool
- POSTAdd a sender
- POSTAdd Contacts to a specified group
- POSTAdd contacts to blacklist
- POSTAdd emails to a mailing list
- GETAnalyse an SMS message
- GETAnalyze a Voice Campaign
- GETAnalyze Bulk Messages - Campaigns
- POSTBlacklisting an email address
- GETCalculate the cost of a campaign carried out by a mailing list
- GETCampaign information
- DELETECancel a campaign
- DELETECancel a Number
- DELETECancel a pending verification
- POSTChange Variable for an Email Contact
- GETCheck Account Balance
- GETCheck Send Ability
- GETCheck the user’s balance
- GETCheck Verification Status
- PUTConfirm a verification by its ID
- GETCountry statistics
- POSTCreate a campaign
- POSTCreate a mailing list
- POSTCreate a new contact
- POSTCreate a new group
- POSTCreate a Pool
- POSTCreate group from difference
- POSTCreate Labels
- DELETEDelete a contact
- DELETEDelete a number from a pool
- DELETEDelete a Pool
- DELETEDelete a scheduled bulk send out - campaign
- DELETEDelete a scheduled Viber campaign
- DELETEDelete a scheduled Voice campaign
- DELETEDelete a sender
- DELETEDelete all IP whitelisting settings for API
- DELETEDelete emails from a mailing list
- DELETEDelete Groups
- DELETEDelete multiple contacts
- GETDetailed balance info
- PUTEdit a mailing list
- PUTEdit a Pool
- PUTEdit planned campaign
- PUTEdit template
- DELETEErase a mailing list
- DELETEErase an email address from all mailing lists
- DELETEErase an email address from the blacklist
- DELETEErase from the unsubscribed list
- POSTEvents data API
- GETFind all contacts in mailing list by value of variable
- GETGet a list of available domains
- GETGet a list of variables for a mailing list
- GETGet all Viber Session Messages by a Phone Number
- GETGet blacklisted contacts for service
- GETGet info about template
- GETGet paged analytics
- GETGet pricing for all Routee Services
- GETGet shorten URL info for monitoring purposes
- GETGet Statistic Reports for all your account verifications
- GETGet total amount of bounces
- GETGet total number of contacts in mailing list
- GETGet Viber Session Messages by a Session Id
- GETGet whitelisted IP's for an application
- GETGet your account transactions
- PUTHangup/reject an active call
- PUTIP whitelisting set up
- POSTMass API
- PUTMerge multiple groups
- GETNew domain verification
- POSTPerform a Lookup enquiry for a mobile number
- POSTPerform a URL analysis
- POSTPerform a verification
- POSTPerform a voice conversation
- POSTPerform an Email Validator request
- GETReceive the activation code at the sender’s email address
- GETReferrals statistics
- DELETERemove a group of contacts from the blacklist
- DELETERemove Contacts from blacklist
- DELETERemove Contacts of a specified group
- POSTRent a Number
- GETRetrieve a Conversation Recording
- GETRetrieve a list of all of the senders
- GETRetrieve a list of all templates in the account
- GETRetrieve a list of allowed domains
- GETRetrieve a list of campaigns created by this book
- GETRetrieve a list of domains
- GETRetrieve a list of emails
- GETRetrieve a list of emails from a mailing list
- GETRetrieve a list of mailing lists
- GETRetrieve a verification status
- GETRetrieve all the contacts
- GETRetrieve all the Pools of an account
- GETRetrieve bounces per 24 hours
- GETRetrieve Conversation by TrackingId
- GETRetrieve Conversation dial Tracking
- GETRetrieve detail information about a specific email address
- GETRetrieve details about a contact
- GETRetrieve details for a bulk send out - campaign
- GETRetrieve Failover trackings
- GETRetrieve general information about bulk of email address
- GETRetrieve general information for a specific email address
- GETRetrieve info for a specific Pool
- GETRetrieve information for a specific email
- GETRetrieve information for a specific email address from a specific campaign
- POSTRetrieve information for list of emails
- GETRetrieve information for specific email address from a mailing list
- GETRetrieve mailing list information
- GETRetrieve one of the account's groups
- GETRetrieve statistics for an email address by campaigns
- POSTRetrieve statistics for email addresses by campaigns and presence in lists
- GETRetrieve the account's contact labels
- GETRetrieve the account's groups
- GETRetrieve the account's groups in paged format
- GETRetrieve the countries that are supported by Quiet Hours feature
- GETRetrieve the details of a Push Notification
- GETRetrieve the list of campaigns
- GETRetrieve the list of unsubscribed
- GETRetrieve the Numbers that belongs to a specific Pool
- GETRetrieve the sender’s IP address
- GETRetrieve total amount of sent emails
- GETRetrieve Verification Statistics for any of your account applications
- GETRetrieve Viber Single Message by Tracking Id
- GETRetrieve Viber Trackings by Campaign
- GETRetrieve Voice Message Tracking
- GETRetrieve Voice Trackings by Campaign
- GETRetrieve Whatsapp Campaign history
- GETRetrieve Whatsapp Campaign info
- GETRetrieve Whatsapp template status
- DELETERevoke Verification Message
- GETSearch failover trackings
- POSTSend a Failover Message
- POSTSend a Single Push Notification
- POSTSend a Viber Campaign
- POSTSend a Viber Single Message
- POSTSend a Viber Verification Message (OTP)
- POSTSend a Voice Campaign
- POSTSend a Whatsapp campaign
- POSTSend an email
- POSTSend an SMS
- POSTSend Bulk Messages - Campaigns
- POSTSend DTMF tones to an active call
- POSTSend SMS using a Pool
- POSTSend Transactional Email
- POSTSend Transactional Email via SendGrid Compatibility Layer
- POSTSend Verification Message
- PUTSetup Webhook
- PUTStart playing a text-to-speech message to an active call
- PUTStart playing an audio file to an active call
- PUTStart recording an active call
- DELETEStop playing a text-to-speech message to an active call
- DELETEStop playing an audio file to an active call
- DELETEStop recording an active call
- POSTSubmit Whatsapp Template for review
- POSTTemplate creation
- GETTrack a Number Lookup request
- GETTrack an Email Validator request
- GETTrack an SMS
- GETTrack multiple Email Validator requests with filters based on specific time range
- GETTrack multiple messages for a specific bulk send out - campaign
- GETTrack multiple messages with filters for a specific time range
- GETTrack multiple Number Lookup requests with filters
- GETTrack multiple voice messages with filters for a specific time range
- PUTTransfer an active call
- GETUnsubscribe contact from the defined mailing list
- POSTUnsubscribing a recipient
- PUTUpdate a contact's details
- PUTUpdate a Number
- PUTUpdate a scheduled bulk send out - campaign
- PUTUpdate the IP whitelisting of API
- POSTURL shortener
- GETValidate a phone number
- GETView all the available numbers
- GETView all the available numbers with filters
- GETView all your numbers
- GETView the blacklist
- GETView the Contacts of a specified group
- GETView Time Summary Analytics for a bulk send out - campaign
- GETView Time Summary Analytics for a country
- GETView Time Summary Analytics for a country and a network
- GETView Time Summary Analytics for a range of Messages
- GETView Volume and Price Analytics for a range of Lookup Records
- GETView Volume and Price Analytics for a range of Messages
- GETView Volume and Price Analytics for a range of Number Validator Records
- GETView Volume and Price Analytics for a specific bulk send out - campaign
- GETView Volume and Price Analytics for a specific country
- GETView Volume and Price Analytics for a specific country and Network
Related apps
More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.