Routee

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

Routee Developers Hub

Communication as a Service

Explore our products

Text Messaging

Add global text messaging to your web or mobile application

Voice

Add global Voice coverage to your web or mobile application

Numbers

Instantly provision phone numbers to send or receive text messages and phone calls

Number Lookup

Check any mobile phone's number availability and status

Number Validation

Make a Number Validation request to check a number's type

Two Factor Authentication

Secure all transactions and users of your web or mobile application

Viber Messaging

Extend your communication channels and engage with Viber users using our Viber Messaging service.

Pools

Organize all your Numbers in one place and ensure the deliverability of your messages by using the Pools feature.

Failover

Reach your audience using multiple channels and ensure your message gets through.

HomeDocumentationRecipesAPI ReferenceReferenceChangelogSupportPage Not FoundSearch{{ state.current().meta.title }}API Logs
    HomeDocumentationAPI ReferenceChangelog
discard

QUICKSTART

  • Get Authenticated and make your first API Call
  • Routee 2FA Authentication
  • IP Whitelisting
  • Send your first SMS message
  • Send an SMS message and receive status updates
  • Send Bulk messaging campaigns
  • Send bulk SMS messaging campaigns and get status updates
  • Send a Voice Messaging campaign
  • Send a Viber campaign
  • Perform a Lookup to a mobile number
  • Validate a phone number
  • Email API v.2 - Setting up your account
  • Email API v.2 - Find your SMTP credentials
  • Email API v.2 - Migrate from SendGrid
  • Send a Viber Session

TUTORIALS

  • How to send a personalized SMS campaign
  • Click-To-Call example using the Voice Conversations API
  • How to perform a two step verification
  • How to setup a basic IVR using Conversation API
  • How to send a Voice Survey using Conversation API
  • How to create a communication flow using Coversation API
  • How to accept a pin number using the IVR system
  • How to use a Number with your SMS Campaign
  • How to receive SMS statuses from a webhook
  • How to use a Number to send and receive SMS
  • How to receive SMS inbound messages
  • How to receive inbound Voice calls
  • SMS integration example in Slack
  • How to send a Viber Campaign with Fallback SMS
  • How to record a bridged call
  • How to send SMS using Pools
  • How to use Machine Detection feature
  • How to sent a pin number efficiently using Voice Conversation
  • How to send a Failover message
  • How to correctly set the SMS Service Application Settings for Callbacks
  • How to redirect inbound calls using Routee Web
  • How to set up and use Web Push Notifications

DOCUMENTATION

  • API Introduction
    • Guidelines
    • Error Codes
    • Status Codes
    • Generic Errors
  • Authentication
    • OAuth 2.0
  • Routee applications
    • Creating Applications
    • Adding services
    • Routee Application Settings
  • Text Messaging
    • SMS & Bulk messaging campaigns
    • Message Analysis
    • Encoding & Character Sets
    • Messaging Statuses
    • Callbacks (WebHooks)
    • Other Messaging Concepts
    • Messaging resources overview
  • Voice Messaging
    • Text To Speech
    • Voice Messaging Statuses
    • Other Voice Messaging Concepts
    • Callbacks (WebHooks)
  • Voice Conversations
    • Overview
    • Call flow
    • Numbers
    • Dialplan Verbs
    • DTMF
    • Recording
    • Webhooks (Callbacks)
  • Call Masking
    • Call Masking Scenario
  • Failover
    • General
    • Failover Statuses
    • Callbacks (Webhook)
    • Resource Overview
  • Viber Messaging
    • Viber Messaging Statuses
    • Inbound messages
    • Callback (Webhook)
    • Other Viber Messaging concept
    • Resources Overview
  • Whatsapp Messaging
    • Whatsapp Messaging Statuses
    • Send a Whatsapp Campaign
    • Whatsapp Templates
  • Email Validator
    • Email Validator Statuses
    • Email Validator Resources Overview
  • Number Lookup
    • Number Lookup Statuses
    • Resources overview
  • Number Validation
    • Number validation number types
    • Number Validation resources overview
  • Two Factor Authentication
    • Status
    • Callback URL (WebHook)
    • Templates
    • Resources Overview
  • Numbers
    • Inbound Messages (MO)
    • Inbound Voice Calls
    • Opt-out
    • Resources Overview
  • Pools
    • Introduction
    • General Questions
    • Callback URL (WebHook)
    • Pool settings scenarios - test cases
    • Resources Overview
  • Accounts
    • Account statistics and usage
    • List of mcc/mnc codes
    • Account statistics resources overview
    • Account resources overview
  • Routee Contacts
    • Import Contacts
    • Create Contacts
    • Contact Groups
    • Contacts resources overview
  • E-mail
    • Introduction
    • Email Webhooks
    • Email Error Codes
  • URL shortener
    • Callback (WebHook)

URL services

  • URL analyzer

INTEGRATIONS

  • Routee integrations on Zapier
  • SMS integration in Slack

WayMore

  • Integration - Custom software

QUICKSTART

  • Get Authenticated and make your first API Call
  • Routee 2FA Authentication
  • IP Whitelisting
  • Send your first SMS message
  • Send an SMS message and receive status updates
  • Send Bulk messaging campaigns
  • Send bulk SMS messaging campaigns and get status updates
  • Send a Voice Messaging campaign
  • Send a Viber campaign
  • Perform a Lookup to a mobile number
  • Validate a phone number
  • Email API v.2 - Setting up your account
  • Email API v.2 - Find your SMTP credentials
  • Email API v.2 - Migrate from SendGrid
  • Send a Viber Session

TUTORIALS

  • How to send a personalized SMS campaign
  • Click-To-Call example using the Voice Conversations API
  • How to perform a two step verification
  • How to setup a basic IVR using Conversation API
  • How to send a Voice Survey using Conversation API
  • How to create a communication flow using Coversation API
  • How to accept a pin number using the IVR system
  • How to use a Number with your SMS Campaign
  • How to receive SMS statuses from a webhook
  • How to use a Number to send and receive SMS
  • How to receive SMS inbound messages
  • How to receive inbound Voice calls
  • SMS integration example in Slack
  • How to send a Viber Campaign with Fallback SMS
  • How to record a bridged call
  • How to send SMS using Pools
  • How to use Machine Detection feature
  • How to sent a pin number efficiently using Voice Conversation
  • How to send a Failover message
  • How to correctly set the SMS Service Application Settings for Callbacks
  • How to redirect inbound calls using Routee Web
  • How to set up and use Web Push Notifications

DOCUMENTATION

  • API Introduction
    • Guidelines
    • Error Codes
    • Status Codes
    • Generic Errors
  • Authentication
    • OAuth 2.0
  • Routee applications
    • Creating Applications
    • Adding services
    • Routee Application Settings
  • Text Messaging
    • SMS & Bulk messaging campaigns
    • Message Analysis
    • Encoding & Character Sets
    • Messaging Statuses
    • Callbacks (WebHooks)
    • Other Messaging Concepts
    • Messaging resources overview
  • Voice Messaging
    • Text To Speech
    • Voice Messaging Statuses
    • Other Voice Messaging Concepts
    • Callbacks (WebHooks)
  • Voice Conversations
    • Overview
    • Call flow
    • Numbers
    • Dialplan Verbs
    • DTMF
    • Recording
    • Webhooks (Callbacks)
  • Call Masking
    • Call Masking Scenario
  • Failover
    • General
    • Failover Statuses
    • Callbacks (Webhook)
    • Resource Overview
  • Viber Messaging
    • Viber Messaging Statuses
    • Inbound messages
    • Callback (Webhook)
    • Other Viber Messaging concept
    • Resources Overview
  • Whatsapp Messaging
    • Whatsapp Messaging Statuses
    • Send a Whatsapp Campaign
    • Whatsapp Templates
  • Email Validator
    • Email Validator Statuses
    • Email Validator Resources Overview
  • Number Lookup
    • Number Lookup Statuses
    • Resources overview
  • Number Validation
    • Number validation number types
    • Number Validation resources overview
  • Two Factor Authentication
    • Status
    • Callback URL (WebHook)
    • Templates
    • Resources Overview
  • Numbers
    • Inbound Messages (MO)
    • Inbound Voice Calls
    • Opt-out
    • Resources Overview
  • Pools
    • Introduction
    • General Questions
    • Callback URL (WebHook)
    • Pool settings scenarios - test cases
    • Resources Overview
  • Accounts
    • Account statistics and usage
    • List of mcc/mnc codes
    • Account statistics resources overview
    • Account resources overview
  • Routee Contacts
    • Import Contacts
    • Create Contacts
    • Contact Groups
    • Contacts resources overview
  • E-mail
    • Introduction
    • Email Webhooks
    • Email Error Codes
  • URL shortener
    • Callback (WebHook)

URL services

  • URL analyzer

INTEGRATIONS

  • Routee integrations on Zapier
  • SMS integration in Slack

WayMore

  • Integration - Custom software

AUTHENTICATION

  • post
    Get authenticated using your application credentials

TEXT MESSAGING

  • post
    Send an SMS
    • Callback - SMS Delivery reports
    • Inbound SMS
  • post
    Analyse an SMS message
  • post
    Send Bulk Messages - Campaigns
  • post
    Analyze Bulk Messages - Campaigns
  • get
    Track an SMS
  • get
    Track multiple messages for a specific bulk send out - campaign
  • post
    Track multiple messages with filters for a specific time range
  • get
    Retrieve the countries that are supported by Quiet Hours feature
  • put
    Update a scheduled bulk send out - campaign
  • delete
    Delete a scheduled bulk send out - campaign
  • get
    Retrieve details for a bulk send out - campaign

NUMBERS

  • get
    View all the available numbers
  • post
    View all the available numbers with filters
  • post
    Rent a Number
  • put
    Update a Number
  • get
    View all your numbers
  • delete
    Cancel a Number

POOLS API

  • post
    Create a Pool
  • post
    Send SMS using a Pool
  • delete
    Delete a Pool
  • put
    Edit a Pool
  • get
    Retrieve all the Pools of an account
  • get
    Retrieve info for a specific Pool
  • get
    Retrieve the Numbers that belongs to a specific Pool
  • put
    Add a Number to a pool
  • delete
    Delete a number from a pool

VOICE CONVERSATION

  • post
    Perform a voice conversation
  • get
    Retrieve Conversation by TrackingId
  • get
    Retrieve Conversation dial Tracking
  • get
    Retrieve a Conversation Recording

ROUTEE DIALPLAN CONTROL VERBS

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

VOICE CALL HANDLING

  • put
    Hangup/reject an active call
  • post
    Transfer an active call
  • post
    Start playing an audio file to an active call
  • delete
    Stop playing an audio file to an active call
  • post
    Start playing a text-to-speech message to an active call
  • delete
    Stop playing a text-to-speech message to an active call
  • post
    Start recording an active call
  • delete
    Stop recording an active call
  • post
    Send DTMF tones to an active call

VOICE MESSAGING

  • post
    Send a Voice Campaign
  • post
    Analyze a Voice Campaign
  • post
    Track multiple voice messages with filters for a specific time range
  • delete
    Delete a scheduled Voice campaign
  • get
    Retrieve Voice Message Tracking
  • get
    Retrieve Voice Trackings by Campaign

VIBER

  • post
    Send a Viber Campaign
  • get
    Retrieve Viber Trackings by Campaign
  • delete
    Delete a scheduled Viber campaign
  • post
    Get all Viber Session Messages by a Phone Number
  • get
    Get Viber Session Messages by a Session Id
  • post
    Send a Viber Single Message
  • get
    Retrieve Viber Single Message by Tracking Id

Whatsapp

  • post
    Send a Whatsapp campaign
  • get
    Retrieve Whatsapp Campaign info
  • get
    Retrieve Whatsapp Campaign history
  • post
    Submit Whatsapp Template for review
  • get
    Retrieve Whatsapp template status
  • post
    Setup Webhook

FAILOVER

  • post
    Send a Failover Message
  • get
    Retrieve Failover trackings
  • post
    Track multiple failover messsages with filters for a specific time range

Email Validator

  • post
    Perform an Email Validator request
  • get
    Track an Email Validator request
  • post
    Track multiple Email Validator requests with filters based on specific time range

NUMBER LOOKUP

  • post
    Perform a Lookup enquiry for a mobile number
  • get
    Track a Number Lookup request
  • post
    Track multiple Number Lookup requests with filters

NUMBER VALIDATION

  • post
    Validate a phone number

TWO FACTOR AUTHENTICATION

  • post
    Perform a verification
  • get
    Retrieve a verification status
  • delete
    Cancel a pending verification
  • post
    Confirm a verification by its ID
  • get
    Get Statistic Reports for all your account verifications
  • get
    Retrieve Verification Statistics for any of your account applications

IP Whitelisting

  • post
    IP whitelisting set up
  • patch
    Update the IP whitelisting of API
  • delete
    Delete all IP whitelisting settings for API
  • get
    Get whitelisted IP's for an application

URL Services

  • post
    Perform a URL analysis

URL Shortener

  • post
    URL shortener
  • get
    Get shorten URL info for monitoring purposes
  • get
    Get paged analytics
  • get
    Get a list of available domains

ACCOUNT

  • get
    Check your account Balance
  • get
    Get pricing for all Routee Services
  • get
    Get your account transactions

STATISTIC REPORTS

  • get
    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

CONTACTS

  • post
    Create a new contact
  • delete
    Delete multiple contacts
  • get
    Retrieve all the contacts
  • get
    Retrieve details about a contact
  • put
    Update a contact's details
  • delete
    Delete a contact
  • post
    Add contacts to blacklist
  • get
    Get blacklisted contacts for service
  • delete
    Remove a group of contacts from the blacklist
  • delete
    Remove Contacts from blacklist
  • get
    Retrieve the account's contact labels
  • post
    Create Labels
  • get
    Retrieve the account's groups
  • get
    Retrieve the account's groups in paged format
  • get
    Retrieve one of the account's groups
  • post
    Create a new group
  • delete
    Delete Groups
  • post
    Merge multiple groups
  • post
    Create group from difference
  • get
    View the Contacts of a specified group
  • delete
    Remove Contacts of a specified group
  • post
    Add Contacts to a specified group

Email API v.2

  • post
    Email API v.2 - Authorization
  • Email API v.2 - Request Fields Summary
  • post
    Email API v.2 - Sending Transactional Email HTTP API
  • 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
  • post
    Email API v.2 - SendGrid facade - compatibility Layer
  • Email API v.2 - SMTP Connection Credentials
  • get
    Email API v.2 - Retrieving a list of domains

EMAIL API v.1 - Authorization

  • post
    Email API v.1 - Authorization

EMAIL API v.1 - Mailing Lists

  • post
    Creating a mailing list
  • put
    Editing a mailing list
  • get
    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
  • post
    Adding emails to a mailing list
  • delete
    Deleting emails from a mailing list
  • get
    Retrieving information for specific email address from a mailing list
  • delete
    Erasing a mailing list
  • get
    Calculating the cost of a campaign carried out by a mailing list

EMAIL API v.1 - Campaigns/Templates

  • post
    Template creation
  • post
    Edit template
  • get
    Get info about template
  • get
    Retrieving a list of all templates in the account
  • post
    Creating a campaign
  • patch
    Editing planned campaign
  • get
    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
  • delete
    Cancelling a campaign

EMAIL API v.1 - Senders

  • get
    Retrieving a list of all of the senders
  • post
    Adding a sender
  • delete
    Deleting a sender
  • post
    Activating a sender
  • get
    Receiving the activation code at the sender’s email address

EMAIL API v.1 - Addresses

  • get
    Retrieve general information for a specific email address
  • get
    Retrieve detail information about a specific email address
  • post
    Retrieve general information about bulk of email address
  • delete
    Erasing an email address from all mailing lists
  • get
    Retrieving statistics for an email address by campaigns
  • post
    Retrieving statistics for email addresses by campaigns and presence in lists
  • post
    Changing variable for an email contact

EMAIL API v.1 - Blacklist / Balance

  • get
    Viewing the blacklist
  • post
    Blacklisting an email address
  • get
    Unsubscribe contact from the defined mailing list
  • delete
    Erasing an email address from the blacklist
  • get
    Checking the user’s balance
  • get
    Detailed balance info

EMAIL API v.1 - SMTP

  • post
    Sending an email
  • get
    Retrieving a list of emails
  • get
    Retrieving total amount of sent emails
  • get
    Retrieving information for a specific email
  • post
    Retrieving information for list of emails
  • get
    Retrieving bounces per 24 hours
  • get
    Get total amount of bounces
  • post
    Unsubscribing a recipient
  • delete
    Erasing from the unsubscribed list
  • get
    Retrieving the list of unsubscribed
  • get
    Retrieving the sender’s IP address
  • get
    Retrieving a list of allowed domains
  • post
    Adding a domain
  • get
    New domain verification

Waymore API

  • post
    Mass API
  • post
    Events data API
  • About Us
  • Pricing
  • Changelog
  • routee.net