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
API Reference
Login
Register
API Reference
Erasing from the unsubscribed list
Search
JUMP TO
AUTHENTICATION
Get authenticated using your application credentials
post
TEXT MESSAGING
Send an SMS
post
Callback - SMS Delivery reports
Inbound SMS
Analyse an SMS message
post
Send Bulk Messages - Campaigns
post
Analyze Bulk Messages - Campaigns
post
Track an SMS
get
Track multiple messages for a specific bulk send out - campaign
get
Track multiple messages with filters for a specific time range
post
Retrieve the countries that are supported by Quiet Hours feature
get
Update a scheduled bulk send out - campaign
put
Delete a scheduled bulk send out - campaign
delete
Retrieve details for a bulk send out - campaign
get
NUMBERS
View all the available numbers
get
View all the available numbers with filters
post
Rent a Number
post
Update a Number
put
View all your numbers
get
Cancel a Number
delete
POOLS API
Create a Pool
post
Send SMS using a Pool
post
Delete a Pool
delete
Edit a Pool
put
Retrieve all the Pools of an account
get
Retrieve info for a specific Pool
get
Retrieve the Numbers that belongs to a specific Pool
get
Add a Number to a pool
put
Delete a number from a pool
delete
VOICE CONVERSATION
Perform a voice conversation
post
Retrieve Conversation by TrackingId
get
Retrieve Conversation dial Tracking
get
Retrieve a Conversation Recording
get
ROUTEE DIALPLAN CONTROL VERBS
Dialplans & Verbs
PLAY Verb
SAY Verb
DIAL Verb
PAUSE Verb
COLLECT Verb
VOICE CALL HANDLING
Hangup/reject an active call
put
Transfer an active call
post
Start playing an audio file to an active call
post
Stop playing an audio file to an active call
delete
Start playing a text-to-speech message to an active call
post
Stop playing a text-to-speech message to an active call
delete
Start recording an active call
post
Stop recording an active call
delete
Send DTMF tones to an active call
post
VOICE MESSAGING
Send a Voice Campaign
post
Analyze a Voice Campaign
post
Track multiple voice messages with filters for a specific time range
post
Delete a scheduled Voice campaign
delete
Retrieve Voice Message Tracking
get
Retrieve Voice Trackings by Campaign
get
Whatsapp
Send a Whatsapp campaign
post
Retrieve Whatsapp Campaign info
get
Retrieve Whatsapp Campaign history
get
Submit Whatsapp Template for review
post
Retrieve Whatsapp template status
get
Setup Webhook
post
TELEGRAM API
Send Verification Message
post
Check Send Ability
post
Revoke Verification Message
post
Check Verification Status
post
VIBER
Send a Viber Campaign
post
Retrieve Viber Trackings by Campaign
get
Delete a scheduled Viber campaign
delete
Get all Viber Session Messages by a Phone Number
post
Get Viber Session Messages by a Session Id
get
Send a Viber Single Message
post
Retrieve Viber Single Message by Tracking Id
get
Send a Viber Verification Message (OTP)
post
FAILOVER
Send a Failover Message
post
Retrieve Failover trackings
get
Track multiple failover messsages with filters for a specific time range
post
Email Validator
Perform an Email Validator request
post
Track an Email Validator request
get
Track multiple Email Validator requests with filters based on specific time range
post
NUMBER LOOKUP
Perform a Lookup enquiry for a mobile number
post
Track a Number Lookup request
get
Track multiple Number Lookup requests with filters
post
NUMBER VALIDATION
Validate a phone number
post
TWO FACTOR AUTHENTICATION
Perform a verification
post
Retrieve a verification status
get
Cancel a pending verification
delete
Confirm a verification by its ID
post
Get Statistic Reports for all your account verifications
get
Retrieve Verification Statistics for any of your account applications
get
IP Whitelisting
IP whitelisting set up
post
Update the IP whitelisting of API
patch
Delete all IP whitelisting settings for API
delete
Get whitelisted IP's for an application
get
URL Services
Perform a URL analysis
post
URL Shortener
URL shortener
post
Get shorten URL info for monitoring purposes
get
Get paged analytics
get
Get a list of available domains
get
ACCOUNT
Check your account Balance
get
Get pricing for all Routee Services
get
Get your account transactions
get
STATISTIC REPORTS
View Volume and Price Analytics for a range of Messages
get
View Volume and Price Analytics for a specific country
get
View Volume and Price Analytics for a specific country and Network
get
View Volume and Price Analytics for a specific bulk send out - campaign
get
View Time Summary Analytics for a range of Messages
get
View Time Summary Analytics for a country
get
View Time Summary Analytics for a country and a network
get
View Time Summary Analytics for a bulk send out - campaign
get
View Volume and Price Analytics for a range of Lookup Records
get
View Volume and Price Analytics for a range of Number Validator Records
get
CONTACTS
Create a new contact
post
Delete multiple contacts
delete
Retrieve all the contacts
get
Retrieve details about a contact
get
Update a contact's details
put
Delete a contact
delete
Add contacts to blacklist
post
Get blacklisted contacts for service
get
Remove a group of contacts from the blacklist
delete
Remove Contacts from blacklist
delete
Retrieve the account's contact labels
get
Create Labels
post
Retrieve the account's groups
get
Retrieve the account's groups in paged format
get
Retrieve one of the account's groups
get
Create a new group
post
Delete Groups
delete
Merge multiple groups
post
Create group from difference
post
View the Contacts of a specified group
get
Remove Contacts of a specified group
delete
Add Contacts to a specified group
post
Push notifications
Send a Single Push Notification
post
Retrieve the details of a Push Notification
get
Email API v.2
Email API v.2 - Authorization
post
Email API v.2 - Request Fields Summary
Email API v.2 - Sending Transactional Email HTTP API
post
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 Layer
post
Email API v.2 - SMTP Connection Credentials
Email API v.2 - Retrieving a list of domains
get
EMAIL API v.1 - Authorization
Email API v.1 - Authorization
post
EMAIL API v.1 - Mailing Lists
Creating a mailing list
post
Editing a mailing list
put
Retrieving a list of mailing lists
get
Retrieving mailing list information
get
Get a list of variables for a mailing list
get
Retrieving a list of emails from a mailing list
get
Get total number of contacts in mailing list
get
Find all contacts in mailing list by value of variable
get
Adding emails to a mailing list
post
Deleting emails from a mailing list
delete
Retrieving information for specific email address from a mailing list
get
Erasing a mailing list
delete
Calculating the cost of a campaign carried out by a mailing list
get
EMAIL API v.1 - Campaigns/Templates
Template creation
post
Edit template
post
Get info about template
get
Retrieving a list of all templates in the account
get
Creating a campaign
post
Editing planned campaign
patch
Campaign information
get
Retrieving information for a specific email address from a specific campaign
get
Retrieving the list of campaigns
get
Retrieving a list of campaigns created by this book
get
Country statistics
get
Referrals statistics
get
Cancelling a campaign
delete
EMAIL API v.1 - Senders
Retrieving a list of all of the senders
get
Adding a sender
post
Deleting a sender
delete
Activating a sender
post
Receiving the activation code at the sender’s email address
get
EMAIL API v.1 - Addresses
Retrieve general information for a specific email address
get
Retrieve detail information about a specific email address
get
Retrieve general information about bulk of email address
post
Erasing an email address from all mailing lists
delete
Retrieving statistics for an email address by campaigns
get
Retrieving statistics for email addresses by campaigns and presence in lists
post
Changing variable for an email contact
post
EMAIL API v.1 - Blacklist / Balance
Viewing the blacklist
get
Blacklisting an email address
post
Unsubscribe contact from the defined mailing list
get
Erasing an email address from the blacklist
delete
Checking the user’s balance
get
Detailed balance info
get
EMAIL API v.1 - SMTP
Sending an email
post
Retrieving a list of emails
get
Retrieving total amount of sent emails
get
Retrieving information for a specific email
get
Retrieving information for list of emails
post
Retrieving bounces per 24 hours
get
Get total amount of bounces
get
Unsubscribing a recipient
post
Erasing from the unsubscribed list
delete
Retrieving the list of unsubscribed
get
Retrieving the sender’s IP address
get
Retrieving a list of allowed domains
get
Adding a domain
post
New domain verification
get
Waymore API
Mass API
post
Events data API
post
Erasing from the unsubscribed list
delete
https://emailapi.routee.net/smtp/unsubscribe
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
