If you want to connect your call information with other software tools, even your ownly created software, you can use the Yodel webhooks.
--- Please be aware that webhooks are only available in the Premium Plus Plan. ---
To activate a webhook, go to one of your phone lines in https://manage.yodel.io/endpoints and activate the webhooks option.
All webhooks use the same JSON payload which is then sent via a HTTP POST request to your defined URL. This JSON payload looks like the following:
Key | Type | Null | Description |
event | string | no | The event that caused the webook, one of the following: inbound_call, outbound_call, end_call |
id | string | no | The unique identifier of this call as UUID. |
url | string | no | The URL to this call. |
started_at | date | no | Timestamp when the call has started. |
ended_at | date | yes | Timestamp when the call has ended. |
phone_number | string | no | The Yodel phone number of this call. |
direction | string | no | The direction of the call: inbound or outbound. |
legs | object array | no | |
legs[].phone_number | string | yes | The phone number of this particular leg. |
legs[].name | string | yes | A Yodel contact name associated with this leg. |
legs[].country | string | yes | The country this leg was started from. |
legs[].external | bool | no | Indicates whether this is an external or internal leg. |
tags | string array | no | Unused. |
tag_added | string | yes | Unused. |
tag_removed | string | yes | Unused. |
screening | object | yes | |
screening.text | string | no | The screening of this call. |
recording | object | yes | |
recording.url | string | no | The recording URL. |
recording.text | string | no | The recording text transcribed (currently empty). |
voicemail | object | yes | |
voicemail.url | string | no | The voicemail URL. |
voicemail.text | string | no | The voicemail text transcribed. |
Example:
{
"event": "inbound_call",
"id": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
"url": "https://yodel.io/c/N5L7eAvjq89DfJmGvn2Erh",
"started_at": "2019-01-01T00:00:00",
"ended_at": null,
"phone_number": "4313932050",
"direction": "inbound",
"legs": [
{
"phone_number": "14154830400",
"name": "Yodel US",
"country": "US",
"external": true
}
],
"tags": [],
"tag_removed": null,
"tag_added": null,
"screening": null,
"recording": null,
"voicemail": null
}