Voice Results Webhook

The voice results webhook automatically posts all IVR results upon completion of each call to the URL specified on your engagement call settings. It forwards all data including engagement details, keypresses, spoken responses (URL of mp3), open ended responses, timestamp, etc in JSON format to your server.

For you to set up the voice results webhook, please do the following:

1. First, create your IVR engagement through this link:

https://start.engagespark.com/engagement/create

2. Create your IVR Survery and specify what type of responses you want to receive (keypress, spoken

response, open-ended response).

3. At the bottom of the screen in Step 1 under Settings, click the API tab.

4. Paste the URL of your desired location on your server where you want the IVR engagement results to be forwarded.

Note: The URL on the screenshot is just a sample.

5. Hit “Continue”.

6. On Step 2, you can specify the contact numbers of your target respondents.

7. You can set the end time in Step 3 to “never” so that the engagement will keep running until you decide to stop it.

Note: Make sure to click the dropdown in End time if you wish to set it to “never”.

8. Hit “Launch”.

9. Now, upon completion of each call, the results will be automatically posted on the specified URL in JSON format. Below is a sample result that you will get.

{
“phone_call”: {
“channel”: “voice”,
“first_name”: “Thanks”,
“call_id”: “123”,
“engagement_id”: “123”,
“organization_id”: “123”,
“contact_id”: “123”,
“direction”: “outbound”,
“contact_phone_number”: “12125551234”,
“call_made_time_in_utc”: “2017 – 07 – 18 T10: 21: 14.273 Z”,
“engagement_type”: “IVR poll advanced”,
“last_name”: “”,
“result”: [
{
“events”: [
{
“type”: “playfile_start”,
“audio_url”: “https: //storage-pub.engagespark.com/audio/0/123.mp3”,
“timestamp_utc”: “2017 – 07 – 18 T10: 21: 30.082 Z”,
“language”: “Default Language”,
“audio_filename”: “Are you in -Emma.mp3”
},
{
“type”: “keypress”,
“is_valid”: true,
“value”: “1”,
“timestamp_utc”: “2017 – 07 – 18 T10: 21: 42.686 Z”
}
],
“message”: “123 – 1”
},
{
“events”: [
{
“type”: “playfile_start”,
“audio_url”: “https: //storage-pub.engagespark.com/audio/2/123.mp3”,
“timestamp_utc”: “2017 – 07 – 18 T10: 21: 43.591 Z”,
“language”: “Default Language”,
“audio_filename”: “What type – Emma.mp3”
},
{
“type “: “keypress”,
“is_valid”: true,
“value”: “2”,
“timestamp_utc”: “2017 – 07 – 18 T10: 21: 51.246 Z”
}
],
“message”: “123 – 2”
},
{
“events”: [
{
“type”: “playfile_start”,
“audio_url”: “https: //storage-pub.engagespark.com/audio/d/123.mp3”,
“timestamp_utc”: “2017 – 07 – 18 T10: 21: 52.281 Z”,
“language”: “Default Language”,
“audio_filename”: “In 20 seco – Emma.mp3”
},
{
“type”: “record_audio”,
“audio_url”: “https: //s3-eu-west-1.amazonaws.com/prod-contact-voice-recording/123.mp3”,
“timestamp_utc”: “2017 – 07 – 18 T10: 22: 07.778 Z”
}
],
“message”: “123 – 3”
}
],
“call_answered_time_utc”: “2017 – 07 – 18 T10: 21: 21.457 Z”,
“engagement_name”: “IVR Engagement for engageSPARK – 3”,
“outbound_caller_id”: “12125551234”,
“duration_in_sec”: “51”
}
}

Related Articles

SMS Webhook »
Subscription API – Documentation »
Zapier Integration »

Have questions or need a little extra help?

Get in touch with us via:

Or drop us a message here: