Overview

Sample Code

Web Hooks

IVR Web Hook SurVo NetGet Custom Audio Prompts Post Call Action Agent Panel Lookup Distributor Form

Call Initiation API

Click-to-Call Click-to-Find Me Click-to-Find Me List Click-to-Virtual Receptionist Click-to-Voice Mail Click-to-SurVo Click-to-IVR Click-to-Agent

Administration API

addonsbroadcastclicktoconferencecostfindmegeneralgrouplocatornumbersrecordingregisterednumbersreportroutingsmssurvoverifymenowvmail

survo.get_recording

Retrieve a recording performed by a SurVo Smart Form. You can select which format (wav or mp3) of the file prior to downloading.

Arguments

access_key (required)
Your Access Key.
secret_access_key (required)
Your Secret Access Key.
format (required)
Audio format of stream. Values: wav, mp3.
survo_id (required)
Building Block ID of SurVo.
unique_id (required)
Respondent ID. This is a unique ID number for a specific caller on a SurVo.
question (required)
The question number of that SurVo. Values: 1,2,3...
sample_rate (optional)
Audio rate of the streaming data, given in Hz. Values: 8000 (default), 11000 (wav only), 22050, 44100.

Example URL

https://secure.ifbyphone.com/ibp_api.php
?access_key=ACCESS_KEY
&secret_access_key=SECRET_ACCESS_KEY
&action=survo.get_recording
&survo_id=307
&unique_id=93451
&format=mp3
&audio_rate=22050
&question=2

Example Response

The result will be an audio stream in the format you requested (MP3) and at the audio rate you requested (22.050 kHz). As a hint to PHP users, the function

curl_setopt($curlObject, CURLOPT_FILE, $aFilehandle);

will cause PHP to accept the stream from the remote source and place it into the file with handle $aFilehandle.

API Test Panel

NOTE: The API Test Panel can be used to try out the various API methods
using the actual data from your account. You must be logged
into your account to make any API calls using the test panel.

 

URL:

XML Result: