Jump to Content

QuickStart Tutorials Documentation Integrations API Reference Pricing Get Started!

Home Documentation API Reference Changelog

QuickStart Tutorials Documentation Integrations API Reference Pricing Get Started!Login Register

AUTHENTICATION

Get authenticated using your application credentialspost

TEXT MESSAGING

Send an SMSpost
- Callback - SMS Delivery reports
- Inbound SMS
Analyse an SMS messagepost
Analyse an SMS message (COPY)post
Send Bulk Messages - Campaignspost
Analyze Bulk Messages - Campaignspost
Track an SMSget
Track multiple messages for a specific bulk send out - campaignget
Track multiple messages with filters for a specific time rangepost
Retrieve the countries that are supported by Quiet Hours featureget
Update a scheduled bulk send out - campaignput
Delete a scheduled bulk send out - campaigndelete
Retrieve details for a bulk send out - campaignget

NUMBERS

View all the available numbersget
View all the available numbers with filterspost
Rent a Numberpost
Update a Numberput
View all your numbersget
Cancel a Numberdelete

POOLS API

Create a Poolpost
Send SMS using a Poolpost
Delete a Pooldelete
Edit a Poolput
Retrieve all the Pools of an accountget
Retrieve info for a specific Poolget
Retrieve the Numbers that belongs to a specific Poolget
Add a Number to a poolput
Delete a number from a pooldelete

VOICE CONVERSATION

Perform a voice conversationpost
Retrieve Conversation by TrackingIdget
Retrieve Conversation dial Trackingget
Retrieve a Conversation Recordingget

ROUTEE DIALPLAN CONTROL VERBS

Dialplans & Verbs
PLAY Verb
SAY Verb
DIAL Verb
PAUSE Verb
COLLECT Verb

VOICE CALL HANDLING

Hangup/reject an active callput
Transfer an active callpost
Start playing an audio file to an active callpost
Stop playing an audio file to an active calldelete
Start playing a text-to-speech message to an active callpost
Stop playing a text-to-speech message to an active calldelete
Start recording an active callpost
Stop recording an active calldelete
Send DTMF tones to an active callpost

VOICE MESSAGING

Send a Voice Campaignpost
Analyze a Voice Campaignpost
Track multiple voice messages with filters for a specific time rangepost
Delete a scheduled Voice campaigndelete
Retrieve Voice Message Trackingget
Retrieve Voice Trackings by Campaignget

VIBER

Send a Viber Campaignpost
Retrieve Viber Trackings by Campaignget
Delete a scheduled Viber campaigndelete
Get all Viber Session Messages by a Phone Numberpost
Get Viber Session Messages by a Session Idget
Send a Viber Single Messagepost
Retrieve Viber Single Message by Tracking Idget

Whatsapp

Send a Whatsapp campaignpost
Retrieve Whatsapp Campaign infoget
Retrieve Whatsapp Campaign historyget
Submit Whatsapp Template for reviewpost
Retrieve Whatsapp template statusget
Setup Webhookpost

FAILOVER

Send a Failover Messagepost
Retrieve Failover trackingsget
Track multiple failover messsages with filters for a specific time rangepost

Email Validator

Perform an Email Validator requestpost
Track an Email Validator requestget
Track multiple Email Validator requests with filters based on specific time rangepost

NUMBER LOOKUP

Perform a Lookup enquiry for a mobile numberpost
Track a Number Lookup requestget
Track multiple Number Lookup requests with filterspost

NUMBER VALIDATION

Validate a phone numberpost

TWO FACTOR AUTHENTICATION

Perform a verificationpost
Retrieve a verification statusget
Cancel a pending verificationdelete
Confirm a verification by its IDpost
Get Statistic Reports for all your account verificationsget
Retrieve Verification Statistics for any of your account applicationsget

IP Whitelisting

IP whitelisting set uppost
Update the IP whitelisting of APIpatch
Delete all IP whitelisting settings for APIdelete
Get whitelisted IP's for an applicationget

URL Services

Perform a URL analysispost

URL Shortener

URL shortenerpost
Get shorten URL info for monitoring purposesget
Get paged analyticsget
Get a list of available domainsget

ACCOUNT

Check your account Balanceget
Get pricing for all Routee Servicesget
Get your account transactionsget

STATISTIC REPORTS

View Volume and Price Analytics for a range of Messagesget
View Volume and Price Analytics for a specific countryget
View Volume and Price Analytics for a specific country and Networkget
View Volume and Price Analytics for a specific bulk send out - campaignget
View Time Summary Analytics for a range of Messagesget
View Time Summary Analytics for a countryget
View Time Summary Analytics for a country and a networkget
View Time Summary Analytics for a bulk send out - campaignget
View Volume and Price Analytics for a range of Lookup Recordsget
View Volume and Price Analytics for a range of Number Validator Recordsget

CONTACTS

Create a new contactpost
Delete multiple contactsdelete
Retrieve all the contactsget
Retrieve details about a contactget
Update a contact's detailsput
Delete a contactdelete
Add contacts to blacklistpost
Get blacklisted contacts for serviceget
Remove a group of contacts from the blacklistdelete
Remove Contacts from blacklistdelete
Retrieve the account's contact labelsget
Create Labelspost
Retrieve the account's groupsget
Retrieve the account's groups in paged formatget
Retrieve one of the account's groupsget
Create a new grouppost
Delete Groupsdelete
Merge multiple groupspost
Create group from differencepost
View the Contacts of a specified groupget
Remove Contacts of a specified groupdelete
Add Contacts to a specified grouppost

Push notifications

Send a Single Push Notificationpost
Retrieve the details of a Push Notificationget

Email API v.2

Email API v.2 - Authorizationpost
Email API v.2 - Request Fields Summary
Email API v.2 - Sending Transactional Email HTTP APIpost
Email API v.2 - From Object Explained
Email API v.2 - To Object Explained
Email API v.2 - CC Object Explained
Email API v.2 - BCC Object Explained
Email API v.2 - Reply To Object Explained
Email API v.2 - Subject property Explained
Email API v.2 -Content Object Explained
Email API v.2 - Attachments Object Explained
Email API v.2 - Footer Object Explained
Email API v.2 - Custom headers Object Explained
Email API v.2 - Responses Summary
Email API v.2 - Callback Object Explained
Email API v.2 - DSN Object Explained
Email API v.2 - emailAddress Object Explained
Email API v.2 - SendGrid facade - compatibility Layerpost
Email API v.2 - SMTP Connection Credentials
Email API v.2 - Retrieving a list of domainsget

EMAIL API v.1 - Authorization

Email API v.1 - Authorizationpost

EMAIL API v.1 - Mailing Lists

Creating a mailing listpost
Editing a mailing listput
Retrieving a list of mailing listsget
Retrieving mailing list informationget
Get a list of variables for a mailing listget
Retrieving a list of emails from a mailing listget
Get total number of contacts in mailing listget
Find all contacts in mailing list by value of variableget
Adding emails to a mailing listpost
Deleting emails from a mailing listdelete
Retrieving information for specific email address from a mailing listget
Erasing a mailing listdelete
Calculating the cost of a campaign carried out by a mailing listget

EMAIL API v.1 - Campaigns/Templates

Template creationpost
Edit templatepost
Get info about templateget
Retrieving a list of all templates in the accountget
Creating a campaignpost
Editing planned campaignpatch
Campaign informationget
Retrieving information for a specific email address from a specific campaignget
Retrieving the list of campaignsget
Retrieving a list of campaigns created by this bookget
Country statisticsget
Referrals statisticsget
Cancelling a campaigndelete

EMAIL API v.1 - Senders

Retrieving a list of all of the sendersget
Adding a senderpost
Deleting a senderdelete
Activating a senderpost
Receiving the activation code at the sender’s email addressget

EMAIL API v.1 - Addresses

Retrieve general information for a specific email addressget
Retrieve detail information about a specific email addressget
Retrieve general information about bulk of email addresspost
Erasing an email address from all mailing listsdelete
Retrieving statistics for an email address by campaignsget
Retrieving statistics for email addresses by campaigns and presence in listspost
Changing variable for an email contactpost

EMAIL API v.1 - Blacklist / Balance

Viewing the blacklistget
Blacklisting an email addresspost
Unsubscribe contact from the defined mailing listget
Erasing an email address from the blacklistdelete
Checking the user’s balanceget
Detailed balance infoget

EMAIL API v.1 - SMTP

Sending an emailpost
Retrieving a list of emailsget
Retrieving total amount of sent emailsget
Retrieving information for a specific emailget
Retrieving information for list of emailspost
Retrieving bounces per 24 hoursget
Get total amount of bouncesget
Unsubscribing a recipientpost
Erasing from the unsubscribed listdelete
Retrieving the list of unsubscribedget
Retrieving the sender’s IP addressget
Retrieving a list of allowed domainsget
Adding a domainpost
New domain verificationget

Waymore API

Mass APIpost
Events data APIpost

AUTHENTICATION

Get authenticated using your application credentialspost

TEXT MESSAGING

Send an SMSpost
- Callback - SMS Delivery reports
- Inbound SMS
Analyse an SMS messagepost
Analyse an SMS message (COPY)post
Send Bulk Messages - Campaignspost
Analyze Bulk Messages - Campaignspost
Track an SMSget
Track multiple messages for a specific bulk send out - campaignget
Track multiple messages with filters for a specific time rangepost
Retrieve the countries that are supported by Quiet Hours featureget
Update a scheduled bulk send out - campaignput
Delete a scheduled bulk send out - campaigndelete
Retrieve details for a bulk send out - campaignget

NUMBERS

View all the available numbersget
View all the available numbers with filterspost
Rent a Numberpost
Update a Numberput
View all your numbersget
Cancel a Numberdelete

POOLS API

Create a Poolpost
Send SMS using a Poolpost
Delete a Pooldelete
Edit a Poolput
Retrieve all the Pools of an accountget
Retrieve info for a specific Poolget
Retrieve the Numbers that belongs to a specific Poolget
Add a Number to a poolput
Delete a number from a pooldelete

VOICE CONVERSATION

Perform a voice conversationpost
Retrieve Conversation by TrackingIdget
Retrieve Conversation dial Trackingget
Retrieve a Conversation Recordingget

ROUTEE DIALPLAN CONTROL VERBS

Dialplans & Verbs
PLAY Verb
SAY Verb
DIAL Verb
PAUSE Verb
COLLECT Verb

VOICE CALL HANDLING

Hangup/reject an active callput
Transfer an active callpost
Start playing an audio file to an active callpost
Stop playing an audio file to an active calldelete
Start playing a text-to-speech message to an active callpost
Stop playing a text-to-speech message to an active calldelete
Start recording an active callpost
Stop recording an active calldelete
Send DTMF tones to an active callpost

VOICE MESSAGING

Send a Voice Campaignpost
Analyze a Voice Campaignpost
Track multiple voice messages with filters for a specific time rangepost
Delete a scheduled Voice campaigndelete
Retrieve Voice Message Trackingget
Retrieve Voice Trackings by Campaignget

VIBER

Send a Viber Campaignpost
Retrieve Viber Trackings by Campaignget
Delete a scheduled Viber campaigndelete
Get all Viber Session Messages by a Phone Numberpost
Get Viber Session Messages by a Session Idget
Send a Viber Single Messagepost
Retrieve Viber Single Message by Tracking Idget

Whatsapp

Send a Whatsapp campaignpost
Retrieve Whatsapp Campaign infoget
Retrieve Whatsapp Campaign historyget
Submit Whatsapp Template for reviewpost
Retrieve Whatsapp template statusget
Setup Webhookpost

FAILOVER

Send a Failover Messagepost
Retrieve Failover trackingsget
Track multiple failover messsages with filters for a specific time rangepost

Email Validator

Perform an Email Validator requestpost
Track an Email Validator requestget
Track multiple Email Validator requests with filters based on specific time rangepost

NUMBER LOOKUP

Perform a Lookup enquiry for a mobile numberpost
Track a Number Lookup requestget
Track multiple Number Lookup requests with filterspost

NUMBER VALIDATION

Validate a phone numberpost

TWO FACTOR AUTHENTICATION

Perform a verificationpost
Retrieve a verification statusget
Cancel a pending verificationdelete
Confirm a verification by its IDpost
Get Statistic Reports for all your account verificationsget
Retrieve Verification Statistics for any of your account applicationsget

IP Whitelisting

IP whitelisting set uppost
Update the IP whitelisting of APIpatch
Delete all IP whitelisting settings for APIdelete
Get whitelisted IP's for an applicationget

URL Services

Perform a URL analysispost

URL Shortener

URL shortenerpost
Get shorten URL info for monitoring purposesget
Get paged analyticsget
Get a list of available domainsget

ACCOUNT

Check your account Balanceget
Get pricing for all Routee Servicesget
Get your account transactionsget

STATISTIC REPORTS

View Volume and Price Analytics for a range of Messagesget
View Volume and Price Analytics for a specific countryget
View Volume and Price Analytics for a specific country and Networkget
View Volume and Price Analytics for a specific bulk send out - campaignget
View Time Summary Analytics for a range of Messagesget
View Time Summary Analytics for a countryget
View Time Summary Analytics for a country and a networkget
View Time Summary Analytics for a bulk send out - campaignget
View Volume and Price Analytics for a range of Lookup Recordsget
View Volume and Price Analytics for a range of Number Validator Recordsget

CONTACTS

Create a new contactpost
Delete multiple contactsdelete
Retrieve all the contactsget
Retrieve details about a contactget
Update a contact's detailsput
Delete a contactdelete
Add contacts to blacklistpost
Get blacklisted contacts for serviceget
Remove a group of contacts from the blacklistdelete
Remove Contacts from blacklistdelete
Retrieve the account's contact labelsget
Create Labelspost
Retrieve the account's groupsget
Retrieve the account's groups in paged formatget
Retrieve one of the account's groupsget
Create a new grouppost
Delete Groupsdelete
Merge multiple groupspost
Create group from differencepost
View the Contacts of a specified groupget
Remove Contacts of a specified groupdelete
Add Contacts to a specified grouppost

Push notifications

Send a Single Push Notificationpost
Retrieve the details of a Push Notificationget

Email API v.2

Email API v.2 - Authorizationpost
Email API v.2 - Request Fields Summary
Email API v.2 - Sending Transactional Email HTTP APIpost
Email API v.2 - From Object Explained
Email API v.2 - To Object Explained
Email API v.2 - CC Object Explained
Email API v.2 - BCC Object Explained
Email API v.2 - Reply To Object Explained
Email API v.2 - Subject property Explained
Email API v.2 -Content Object Explained
Email API v.2 - Attachments Object Explained
Email API v.2 - Footer Object Explained
Email API v.2 - Custom headers Object Explained
Email API v.2 - Responses Summary
Email API v.2 - Callback Object Explained
Email API v.2 - DSN Object Explained
Email API v.2 - emailAddress Object Explained
Email API v.2 - SendGrid facade - compatibility Layerpost
Email API v.2 - SMTP Connection Credentials
Email API v.2 - Retrieving a list of domainsget

EMAIL API v.1 - Authorization

Email API v.1 - Authorizationpost

EMAIL API v.1 - Mailing Lists

Creating a mailing listpost
Editing a mailing listput
Retrieving a list of mailing listsget
Retrieving mailing list informationget
Get a list of variables for a mailing listget
Retrieving a list of emails from a mailing listget
Get total number of contacts in mailing listget
Find all contacts in mailing list by value of variableget
Adding emails to a mailing listpost
Deleting emails from a mailing listdelete
Retrieving information for specific email address from a mailing listget
Erasing a mailing listdelete
Calculating the cost of a campaign carried out by a mailing listget

EMAIL API v.1 - Campaigns/Templates

Template creationpost
Edit templatepost
Get info about templateget
Retrieving a list of all templates in the accountget
Creating a campaignpost
Editing planned campaignpatch
Campaign informationget
Retrieving information for a specific email address from a specific campaignget
Retrieving the list of campaignsget
Retrieving a list of campaigns created by this bookget
Country statisticsget
Referrals statisticsget
Cancelling a campaigndelete

EMAIL API v.1 - Senders

Retrieving a list of all of the sendersget
Adding a senderpost
Deleting a senderdelete
Activating a senderpost
Receiving the activation code at the sender’s email addressget

EMAIL API v.1 - Addresses

Retrieve general information for a specific email addressget
Retrieve detail information about a specific email addressget
Retrieve general information about bulk of email addresspost
Erasing an email address from all mailing listsdelete
Retrieving statistics for an email address by campaignsget
Retrieving statistics for email addresses by campaigns and presence in listspost
Changing variable for an email contactpost

EMAIL API v.1 - Blacklist / Balance

Viewing the blacklistget
Blacklisting an email addresspost
Unsubscribe contact from the defined mailing listget
Erasing an email address from the blacklistdelete
Checking the user’s balanceget
Detailed balance infoget

EMAIL API v.1 - SMTP

Sending an emailpost
Retrieving a list of emailsget
Retrieving total amount of sent emailsget
Retrieving information for a specific emailget
Retrieving information for list of emailspost
Retrieving bounces per 24 hoursget
Get total amount of bouncesget
Unsubscribing a recipientpost
Erasing from the unsubscribed listdelete
Retrieving the list of unsubscribedget
Retrieving the sender’s IP addressget
Retrieving a list of allowed domainsget
Adding a domainpost
New domain verificationget

Waymore API

Mass APIpost
Events data APIpost

Retrieving the list of unsubscribed

get https://emailapi.routee.net/smtp/unsubscribe

Retrieve all unsubscribers (bounces)

Language

Click Try It! to start a request and see the response here!