To receive information after the call, add a Webhook URL to your campaign.

​
Configure a Webhook

  1. Navigate to the Settings of the specific campaign you want to configure.
  2. Scroll to the bottom of the settings window.
  3. Click on ‘Add Webhook URL’.
  4. Enter the URL where you want the Webhook data to be sent.
  5. Select the call statuses where on which the webhook will be triggered.
  6. Click on ‘Save changes’ located at the top right of the window

​
Possible Event triggers

​
Webhook Response Example

webhook.json
{
  "callStatus": "COMPLETED",
  "createdAt": "2024-03-11T14:56:41.642Z",
  "phoneFrom": "+15555551234",
  "status": "INTERESTED",
  "postProcessStatus": "INTERESTED",
  "hangUpReason": "CALL_FINISHED",
  "duration": 128,
  "totalDuration": 150,
  "contactStatus": {
    "callMeLater": false,
    "doNotCall": false,
    "wrongNumber": false
  },
  "conversationFlow": [
    ],
  "summary": {
    "Inquiry Asked": {
      "description": "Interested in learning more about our services",
      "options": [
      ],
      "order": new NumberInt("1"),
      "type": "YES_NO",
      "value": false
    }
  },
  "campaign": {
    "id": "{campaignId}",
    "name": "{campaignName}"
  },
  "id": "{callId}",
  "contact": {
    "id": "{contactId}",
    "name": "John",
    "phoneNumber": "+1234567890",
    "data": {
      "email": "[email protected]",
      "position": "Product Manager",
      "company": "Voxia"
    }
  },
  "twilio": {
    "accountSid": "{accountSid}",
    "callSessionId": "{callSessionId}"
  },
  "organizationId": "{organizationId}",
  "transcript": [
    {
      "content": "Hello, this is Voxia. How can I assist you today?",
      "role": "Voxia"
    },
    {
      "content": "Hi, can you tell me more about your services?",
      "role": "user"
    },
    {
      "content": "Certainly! We offer personalized AI calling services. Would you like to schedule a demo?",
      "role": "Voxia"
    },
    {
      "content": "Yes, that sounds great. Thank you!",
      "role": "user"
    },
    {
      "content": "You're welcome! I'll set that up and send you a confirmation. Have a great day!",
      "role": "Voxia"
    }
  ],
  "interested": {
    "description": "The caller showed interest in scheduling a demo, indicating a positive engagement.",
    "reached": true
  },
  "events": [
    {
      "type": "SMS",
      "data": {
        "sent": true,
        "status": "queued",
        "sentAt": "2024-11-28T22:37:01.000Z",
        "sentTo": "+1999999999",
        "uri": "{uri}",
        "smsSid": "{smsSid}",
        "sentFrom": "+1999999999",
        "text": "{smsTemplateText}"
      }
    },
    {
      "type": "FORWARD",
      "data": {
        "phoneNumber": "+1999999999",
        "contactAsCallerId": true
      }
    }
  ],
  "webhookUrl": "{webhookUrl}",
  "webhookEvent": "CONNECTED",
  "webhookEvents": [
        "HANG_UP",
        "CONNECTED",
        "POST_PROCESSING_FINISHED:NOT_INTERESTED",
        "POST_PROCESSING_FINISHED:CALL_ME_LATER",
        "POST_PROCESSING_FINISHED:INTERESTED",
        "POST_PROCESSING_FINISHED:VOICE_MAIL"
    ],
    "webhookStatuses": [
        "INTERESTED",
        "NOT_INTERESTED",
        "CALL_ME_LATER",
        "WRONG_NUMBER",
        "DO_NOT_CALL",
        "COMPLETED",
        "FAILED",
        "VOICE_MAIL",
        "BUSY",
        "NO_ANSWER"
    ],
  "isTestCall": false,
  "sessionId": "{sessionId}",
  "slackUrl": "{salckUrl}"
}

​
Webhook Fields Description

FieldDescription
createdAtTimestamp when the call was initiated in ISO 8601 format.
phoneFromPhone number from which the call originated.
status

Composite status of a call. It includes the call status, the reason for call hang up, and the candidate status.

Call progress status:

  • NEW
  • IN_PROGRESS
  • BUSY
  • NO_ANSWER
  • VOICE_MAIL
  • FAILED

Call connection status:

  • USER_REQUESTED_HANGUP
  • ADMIN_MANUAL_HANGUP
  • VOICE_MAIL_DETECTED
  • SILENCE_DETECTED
  • USER_MANUAL_HANGUP
  • CONVERSATION_LLM_TECHNICAL_ISSUES
  • OTHER_TECHNICAL_ISSUES
  • CALL_FINISHED
  • CALL_FORWARDED
  • UNKNOWN
  • SOCKET_DISCONNECTED

Contact response to call:

  • INTERESTED: The contact expressed interest in the purpose of the call.
  • NOT_INTERESTED: The contact is not interested in the purpose of the call.
  • CALL_ME_LATER: The contact requested a follow-up call at a later time.
  • PENDING: The contact has been returned to the call queue for further attempts.
  • WRONG_NUMBER: The number dialed did not correspond to the intended contact.
  • DO_NOT_CALL: The contact requested not to receive future calls.

callStatus

Call status:

  • NEW
  • IN_PROGRESS
  • FAILED
  • COMPLETED: The user answered and the call ended successfully.
  • NO_ANSWER
  • BUSY
  • VOICE_MAIL
  • DO_NOT_CALL_REGISTRY_MATCHED
postProcessStatus

Candidate status for that call:

  • INTERESTED
  • NOT_INTERESTED
  • CALL_ME_LATER
  • WRONG_NUMBER
  • DO_NOT_CALL
events

Details about specific call events:

  • SMS

    • Data regarding origin, destination and content
  • FORWARDED CALL

  • MEETING

    • Data regarding slot booked, date sent and destination email.
webhookUrlURL to which the Webhook data is sent post-call.
webhookEvent

Event related to the webhook trigger:

  • DIALING
  • CONNECTED
  • FAILED
  • COULD_NOT_CONNECT:BUSY
  • COULD_NOT_CONNECT:NO_ANSWER
  • FORWARDED
  • HANG_UP
  • POST_PROCESSING_FINISHED:VOICE_MAIL
  • POST_PROCESSING_FINISHED:INTERESTED
  • POST_PROCESSING_FINISHED:NOT_INTERESTED
  • POST_PROCESSING_FINISHED:WRONG_NUMBER
  • POST_PROCESSING_FINISHED:CALL_ME_LATER
  • POST_PROCESSING_FINISHED:DO_NOT_CALL
  • FORWARDED_CALL_FINISHED
webhookEventsList of selected events for triggering the webhook.
hangUpReason

Reason for the call termination:

  • USER_REQUESTED_HANGUP: User asked to hang up.
  • ADMIN_MANUAL_HANGUP: Call ended by an admin.
  • USER_MANUAL_HANGUP: User manually ended the call.
  • CALL_FINISHED: Call ended after the completion of all interactions.
  • CALL_FORWARDED: Call transferred to a designated phone number.
durationDuration of the call with Voxia’s agent in seconds.
totalDurationTotal duration of the call including the forwarded call duration in seconds.
contactStatus

Object indicating the contact’s preferences:

  • callMeLater: Boolean indicating if the contact requested a callback later.
  • doNotCall: Boolean indicating if the contact requested not to be called again.
  • wrongNumber: Boolean indicating if the contact reported this as a wrong number.
summaryObject summarizing the Key Questions made during the call.
campaign

Information about the campaign associated with the call:

  • id: Campaign id.
  • name: Name of the campaign.
idUnique identifier for the call.
contact

Details about the person contacted:

  • id: Contact’s identifier.
  • name: Contact’s name.
  • phoneNumber: Contact’s phone number.
  • data: Contains additional properties that can be used as variables in the script during the call
twilio

Twilio information:

  • accountSid: Unique identifier for the Twilio account.
  • callSessionId: Unique session identifier for the call.
organizationIdUnique identifier for the organization.
transcriptArray of dialogue exchanges during the call, with each entry detailing the content spoken and the role of the speaker.
interested

Object detailing whether the caller expressed interest in the services:

  • description: The Interest Criteria defined by the user for the campaign.
  • reached: Boolean indicating whether the Interest Criteria was reached.
isTestCallBoolean indicating if the call was a test call.
slackUrlWebhook Url if the account is integrated with Slack