Hoiio Open API

What is IVR

Interactive voice responses (IVR) menus allows you to interact with your users through a voice call. You will be able to play a series of voice dialogs and your users will be able to respond via their telephone keypad. A common use case is a Customer Helpline where you might hear:

“For sales enquiry, please press 1. For technical support, please press 2. To speak to our customer service officers, please press 0.”

Hoiio’s IVR API allows developers to easily create IVR menus like the above using RESTful APIs. This can be achieved without the need for technical telecommunication knowledge. Coupled with our Hoiio Numbers and Text-to-Speech (TTS) technology, you can get started instantly without hassle.

Read An Overview

IVR is our most powerful set of APIs, consisting of a couple of simple building blocks.

Building an IVR application will usually use 1 or more of the building blocks, and issuing the API requests one after another. It is not the usual request-and-thats-it-API, hence we want to make sure you read An Overview of IVR first.

Read An Overview Now

Building blocks

Assuming you have already read An Overview of IVR, these are the IVR building blocks that you can use to create your IVR app:

Answer
Answer an incoming call to your Hoiio Number.

Dial
Dial out to a destination number and play your IVR.

Play
Play a voice message in your IVR.

Gather
Gather your user’s response through the keypad.

Record
Record voice messages from the user over the phone.

Monitor
Monitor the IVR by recording all conversations and voice messages.

Hold
Put an IVR session on hold.

Unhold
Resume a held IVR session.

Transfer
Transfer the current session to another destination number or a conference room.

Hangup
Hang up the current session.