¶ Overview
Get events from your voice over cloud system into your internal systems via https POST, with the fields passed posted in the query string parameters. A successful 200 response code is required to be received from the system in order to mark the webhook as a success.
¶ Events
¶ Inbound Call Start (inboundCallStart)
This event is triggered when a configured inbound number has webhooks enabled. As soon as the call enters the Voice Over Cloud network the event is triggered.
key | value | type | notes |
|---|---|---|---|
event | inboundCallStart | string | this is the event name |
date | 2024-01-01 19:00 | datetime | current date & time |
inboundNumber | 611800111222 | number | the inbound number/the number the callerid has dialled |
callerid | 61288880000 | number | the phone number of the caller if available, it will be “Anonymous” for any blocked/private numbers |
callid | testcall | string | a string of unique identifier for this call, this id is used throughout the rest of the webhooks to link it back to the original call |
crm_id | usefulid | string | a string of unique identifier for this call, that has been provided to the platform for this call ( usually from click to dial ) |
¶ Inbound Call Ringing (inboundCallRinging)
when an extension is ringing on the inbound call the system triggers the hook.
key | value | type | notes |
|---|---|---|---|
event | inboundCallRinging | string | this is the event name |
date | 2024-01-01 19:00 | datetime | current date & time |
inboundNumber | 611800111222 | number | the inbound number/the number the callerid has dialled |
callerid | 61288880000 | number | the phone number of the caller if available, it will be “Anonymous” for any blocked/private numbers |
callid | testcall | string | a string of unique identifier for this call, this id is used throughout the rest of the webhooks to link it back to the original call |
extension | 280085 | integer | the extension number who answered the call |
crm_id | usefulid | string | a string of unique identifier for this call, that has been provided to the platform for this call ( usually from click to dial ) |
¶ Inbound Call Answered (inboundCallAnswered)
when an extension answers the call the system triggers the hook.
key | value | type | notes |
|---|---|---|---|
event | inboundCallAnswered | string | this is the event name |
date | 2024-01-01 19:00 | datetime | current date & time |
inboundNumber | 611800111222 | number | the inbound number/the number the callerid has dialled |
callerid | 61288880000 | number | the phone number of the caller if available, it will be “Anonymous” for any blocked/private numbers |
callid | testcall | string | a string of unique identifier for this call, this id is used throughout the rest of the webhooks to link it back to the original call |
extension | 280085 | integer | the extension number who answered the call |
crm_id | usefulid | string | a string of unique identifier for this call, that has been provided to the platform for this call ( usually from click to dial ) |
¶ Inbound Call End (inboundCallEnd)
When the call is ended, this could be for a number of reasons, including but not limited to, the call wasn’t answered, it went to voicemail, call was answered and then either party ended the call.
key | value | type | notes |
|---|---|---|---|
event | inboundCallEnd | string | this is the event name |
date | 2024-01-01 19:00 | datetime | current date & time |
inboundNumber | 611800111222 | number | the inbound number/the number the callerid has dialled |
callerid | 61288880000 | number | the phone number of the caller if available, it will be “Anonymous” for any blocked/private numbers |
callid | testcall | string | a string of unique identifier for this call, this id is used throughout the rest of the webhooks to link it back to the original call |
extension | 280085 | integer | if the call was answered it will contain the extension number or null if the call wasn’t answered by an extension ( it could have been answered by an IVR, queue, announcement ) |
duration | 88 | int | the number of seconds the call went on for |
answeredDuration | 77 | int | the number of seconds after the call was answered |
crm_id | usefulid | string | a string of unique identifier for this call, that has been provided to the platform for this call ( usually from click to dial ) |
¶ Outbound Call Start (outboundCallStart)
triggered when an extension makes an outbound call, including extension to extension calls. If the extension has dialled an invalid number or internal system (i.e. voicemail) no webhook is triggered.
key | value | type | notes |
|---|---|---|---|
event | outboundCallStart | string | this is the event name |
date | 2024-01-01 19:00 | datetime | current date & time |
extension | 280085 | integer | the extension number making the call |
destination | 61288880000 | number | the number the extension dialled |
callid | testcall | string | a string of unique identifier for this call, this id is used throughout the rest of the webhooks to link it back to the original call |
crm_id | usefulid | string | a string of unique identifier for this call, that has been provided to the platform for this call ( usually from click to dial ) |
¶ Outbound Call Answered (outboundCallAnswered)
Triggered when the outbound call is answered
key | value | type | notes |
|---|---|---|---|
event | outboundCallAnswered | string | this is the event name |
date | 2024-01-01 19:00 | datetime | current date & time |
extension | 280085 | integer | the extension number making the call |
destination | 61288880000 | number | the number the extension dialled |
callid | testcall | string | a string of unique identifier for this call, this id is used throughout the rest of the webhooks to link it back to the original call |
crm_id | usefulid | string | a string of unique identifier for this call, that has been provided to the platform for this call ( usually from click to dial ) |
¶ Outbound Call End (outboundCallEnd)
key | value | type | notes |
|---|---|---|---|
event | outboundCallEnd | string | this is the event name |
date | 2024-01-01 19:00 | datetime | current date & time |
extension | 280085 | integer | the extension number making the call |
destination | 61288880000 | number | the number the extension dialled |
callid | testcall | string | a string of unique identifier for this call, this id is used throughout the rest of the webhooks to link it back to the original call |
duration | 88 | int | the number of seconds the call went for |
answeredDuration | 77 | int | the number of seconds after the call was answered |
crm_id | usefulid | string | a string of unique identifier for this call, that has been provided to the platform for this call ( usually from click to dial ) |
¶ IVR Item Selected (ivrOption)
Triggered from an IVR when a user presses an option, it doesn’t provide any information as to where the call get’s answered or is completed, only what ivr option they have pressed for a particular IVR
key | value | type | notes |
|---|---|---|---|
event | ivrOption | string | this is the event name |
date | 2024-01-01 19:00 | datetime | current date & time |
inboundNumber | 611800111222 | number | the inbound number/the number the callerid has dialled |
callerid | 61288880000 | number | the phone number of the caller if available, it will be “Anonymous” for any blocked/private numbers |
callid | testcall | string | a string of unique identifier for this call, this id is used throughout the rest of the webhooks to link it back to the original call |
ivrOption | 1 | string | the key press the caller selected possible values are: 0-9,*,# |
crm_id | usefulid | string | a string of unique identifier for this call, that has been provided to the platform for this call ( usually from click to dial ) |
¶ Call Recording Available (callRecordingAvailable)
Triggered when the call recording is now available after the call completes, this is usually within 5 seconds of the call completing
key | value | type | notes |
|---|---|---|---|
event | callRecordingAvailable | string | this is the event name |
date | 2024-01-01 19:00 | datetime | current date & time |
callid | testcall | string | a string of unique identifier for this call, this id is used throughout the rest of the webhooks to link it back to the original call |
crm_id | usefulid | string | a string of unique identifier for this call, that has been provided to the platform for this call ( usually from click to dial ) |
¶ Call Transcription Available (callTranscriptionAvailable)
If VOC AI is enabled this event will trigger when the AI engine has completed the transcription, this is normally within 2 minutes of the call completing.
key | value | type | notes |
|---|---|---|---|
event | callTranscriptionAvailable | string | this is the event name |
date | 2024-01-01 19:00 | datetime | current date & time |
callid | testcall | string | a string of unique identifier for this call, this id is used throughout the rest of the webhooks to link it back to the original call |
crm_id | usefulid | string | a string of unique identifier for this call, that has been provided to the platform for this call ( usually from click to dial ) |
¶ Configuration
Login to your portal account and access the Developer Options under the My Account section. In there we have multiple sections for webhooks, Voice and Incoming SMS. Add the desired URL into the URL field, and then you have the ability to test the webhooks by choosing the event you wish to trigger and then pressing test.
¶ Test Event Data
The values that are listed in each Event above are sent through in the trigger tests. All values are static except for the date and time fields which return the current date and time
¶ Error Handling
A successful 200 return is required from the receiving URL, or the system will try again once immediately and then wait 1 second and try again, if it fails to receive a 200 OK, the webhook is logged as a failure and you will need to review the issue. If you wish to obtain the results programatically then you can use the API to retrieve the webhook failures, alternatively you can get the results from inside Developer Options page. Find the Webhook Logs link, on that page you can filter between successful and failed webhooks, and resend the them if desired.
¶ Definitions
¶ Number Formatting
all numbers will be provided in e164 format without the international + prefix
¶ Date Formatting
all dates will presented in UTC time in the following format YYYY-MM-DD hh:mm:ss e.g. 2024-01-01 12:00:00
¶ Restrictions
only https endpoints are permitted
¶ Firewall Requirements
All Voice Over Cloud webhooks will come from IP address 103.135.87.3