WebhooksCall Event Webhooks

Dialer call events
#

The dialer webhooks are triggered when a Dialer campaign call event occurs.

Subscribe to this webhook on the Administration > Webhooks page. For more information, refer to Webhooks in the Voiso Documentation Portal.

Event	Description
dialer.call.answered	An agent is connected to a Dialer call answered by a contact.
dialer.call.hangup	A Dialer call ends.
dialer.call.ended	A Dialer call is completed.

Call answered
#

The Dialer Call Answered webhook POSTs the following request when a Dialer call is answered. Refer to Webhooks overview for descriptions of the common objects used by this webhook.


 {
  "event": "dialer.call.answered",
  “object: "call",
  "timestamp": "2024-05-24T08:36:39Z",
  “secret”: "45XXYYZZa08",
  "contact_center_id": "187edc75-3008-44e3-8798-aa0bbc12yt703" 
  "data": {
          //call object 
          //agent object 
          //campaign object
          }

Example
#


{
  "event": "dialer.call.answered",
  "object": "call",
  "timestamp": "2024-08-14T09:50:30Z",
  "secret": "12r7t8y89u97t555w",
  "contact_center_id": "12345054-2f06-476d-93a1-abc22bd3b4d7",
  "data": {
    "id": "eb8ec211-3779-4f24-a13c-dadg6b8adc73",
    "type": "dialer",
    "start_time": "2024-08-14T09:50:04Z",
    "agent_start_time": "2024-08-14T09:50:30Z",
    "duration": {
      "total": 26,
      "dialing_time": 27,
      "dialer_waiting": 27
    },
    "calling_number": "888888",
    "called_number": "966551571128",
    "cdr_url": "https://cluster1.voiso.com/cdr/ab8bc211-1234-4f24-a13c-cdad6b8edc73",
    "agent": {
      "id": 6963,
      "name": "Kathy Senger",
      "email": "kathy@example.com",
      "extension": "4422"
    },
    "campaign": {
      "id": 9883,
      "name": "Anniversary Sale",
      "is_live": false
    }
  }
}

Call hangup
#

The Dialer Call Hangup webhook POSTs the following request when a Dialer call is hungup. Refer to Webhooks overview for descriptions of the common objects used by this webhook.


 {
  "event": "dialer.call.hangup",
  “object: "call",
  "timestamp": "2024-05-24T08:36:39Z",
  “secret”: "45XXYYZZa08",
  "contact_center_id": "187edc75-3008-44e3-8798-aa0bbc12yt703" 
  "data": {
          //call object 
          //agent object 
          //campaign object
          }

Example
#


{
  "event": "dialer.call.hangup",
  "object": "call",
  "timestamp": "2024-08-14T09:53:33Z",
  "secret": "abcd7bt8y89ub78y89j9",
  "contact_center_id": "12345054-2f06-476d-93a1-ab22bd3bc4d7",
  "data": {
    "id": "3e58b123-2636-44ce-5555-382abcd3835f",
    "type": "dialer",
    "start_time": "2024-08-14T09:51:42Z",
    "end_time": "2024-08-14T09:53:34Z",
    "duration": {
      "total": 112,
      "dialing_time": 112
    },
    "disposition": "Machine answered",
    "end_reason": "Contact disconnect",
    "calling_number": "888888",
    "called_number": "966507347745",
    "cdr_url": "https://cluster1.voiso.com/cdr/3e12b218-2636-44ab-5555-382ccfc3835f",
    "campaign": {
      "id": 9883,
      "name": "Anniversary Sale",
      "is_live": false
    }
  }
}

Call ended
#

The Dialer Call Ended webhook POSTs the following request when a Dialer call is ended. Refer to Webhooks overview for descriptions of the common objects used by this webhook.


 {
  "event": "dialer.call.ended",
  “object: "call",
  "timestamp": "2024-05-24T08:36:39Z",
  “secret”: "45XXYYZZa08",
  "contact_center_id": "187edc75-3008-44e3-8798-aa0bbc12yt703" 
  "data": {
          //call object 
          //agent object 
          //campaign object
          }

Example
#


{
  "event": "dialer.call.ended",
  "object": "call",
  "timestamp": "2024-08-05T12:16:13Z",
  "secret": "secret1234",
  "contact_center_id": "1a234567-b8c9-012a-3456-b7c8de90abc2",
  "data": {
    "id": "1a234567-3456-012a-b8c9-b7c8de90a1b2",
    "type": "dialer",
    "start_time": "2024-08-05T12:14:21Z",
    "end_time": "2024-08-05T12:16:09Z",
    "agent_start_time": "2024-08-05T12:14:27Z",
    "duration": {
      "total": 108,
      "dialing_time": 7,
      "dialer_waiting": 8,
      "talk_time": 75,
      "hold_time": 26,
      "postcall_time": 5
    },
    "disposition": "Answered",
    "end_reason": "Contact disconnect",
    "calling_number": "1",
    "called_number": "123456789090",
    "wrap_up_code": {
      "code": "1234",
      "description": "Recruited"
    },
    "notes": "Test",
    "cdr_url": "https://cluster1.voiso.com/cdr/1a234567-3456-012a-b8c9-b7c8de90a1b2",
    "agent": {
      "id": 1,
      "name": "Jennifer Wong",
      "email": "jw@example.com",
      "extension": "1234"
    },
    "campaign": {
      "id": 1,
      "name": "Big recruitment",
      "is_live": false
    }
  }
}