Telephony API

IVR API

Create and configure Voice Response applications (IVR) via an API.

The Sonetel API allows you to set up and change IVR applications via an API.

Types of IVR apps that can be created via the API

You can create and manage the following types of Voice Response apps via the API.

  • IVR menu
    Offer you callers a menu, where different things happen dependent on what digit they press.
  • Voicemail
    Take a message and deliver it somewhere.
  • Announcement
    Play a message and then forward the call somewhere or hang up.

 

All creation and management of IVR apps can be done via the Sonetel web app or via the API. There is no difference between IVR apps created in the web app or via the API.

 

How the IVR API works

All of the API documentation for Voice apps can be found here.

Here are some definitions that are good to know before you get started.

  • Voice app
    A voice app can either be a menu or an announcement (“ivr”) or a voicemail box (“mailbox”).
  • Prompt
    Each Voice app has a set of pre-defined prompts to be played to callers. This can be a “greeting message” or “menu” or similar. It is possible to define custom prompts for playing various types of information messages – such as “Opening hours” or “Deal of the week”.
  • Default messages
    All pre-defined Prompts come with a default recordings which will be played until you replace it with your own recording.
  • Voice
    “Voice” is a parameter in each Voice app that defines what language and voice (female or male) to use for the default recordings in the pre-defined prompts. For example: “US English – female”. This setting only has a meaning until you have replaced all default messages with custom messages.
  • Custom message
    A custom message is a recording that you upload and assign to a prompt (either a default prompt or a custom prompt. You can optionally create audio files with the Text to speech API.

 

 

English