/* Twilio navbar icon */
#navigation-items a[href="/documentation/integrations/twilio"] svg {
  -webkit-mask-image: url("data:image/svg+xml;utf8,<svg height='50px' width='50px' viewBox='0 0 256 256' version='1.1' xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' preserveAspectRatio='xMidYMid'><g><path d='M128,0 C198.656,0 256,57.344 256,128 C256,198.656 198.656,256 128,256 C57.344,256 0,198.656 0,128 C0,57.344 57.344,0 128,0 Z M128,33.792 C75.776,33.792 33.792,75.776 33.792,128 C33.792,180.224 75.776,222.208 128,222.208 C180.224,222.208 222.208,180.224 222.208,128 C222.208,75.776 180.224,33.792 128,33.792 Z M159.744,133.12 C174.448029,133.12 186.368,145.039971 186.368,159.744 C186.368,174.448029 174.448029,186.368 159.744,186.368 C145.039971,186.368 133.12,174.448029 133.12,159.744 C133.12,145.039971 145.039971,133.12 159.744,133.12 Z M96.256,133.12 C110.960029,133.12 122.88,145.039971 122.88,159.744 C122.88,174.448029 110.960029,186.368 96.256,186.368 C81.5519708,186.368 69.632,174.448029 69.632,159.744 C69.632,145.039971 81.5519708,133.12 96.256,133.12 Z M159.744,69.632 C174.448029,69.632 186.368,81.5519708 186.368,96.256 C186.368,110.960029 174.448029,122.88 159.744,122.88 C145.039971,122.88 133.12,110.960029 133.12,96.256 C133.12,81.5519708 145.039971,69.632 159.744,69.632 Z M96.256,69.632 C110.960029,69.632 122.88,81.5519708 122.88,96.256 C122.88,110.960029 110.960029,122.88 96.256,122.88 C81.5519708,122.88 69.632,110.960029 69.632,96.256 C69.632,81.5519708 81.5519708,69.632 96.256,69.632 Z' fill='%23F12E45'/></g></svg>") !important;
  mask-image: url("data:image/svg+xml;utf8,<svg width='50px' height='50px' viewBox='0 0 256 256' version='1.1' xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink' preserveAspectRatio='xMidYMid'><g><path d='M128,0 C198.656,0 256,57.344 256,128 C256,198.656 198.656,256 128,256 C57.344,256 0,198.656 0,128 C0,57.344 57.344,0 128,0 Z M128,33.792 C75.776,33.792 33.792,75.776 33.792,128 C33.792,180.224 75.776,222.208 128,222.208 C180.224,222.208 222.208,180.224 222.208,128 C222.208,75.776 180.224,33.792 128,33.792 Z M159.744,133.12 C174.448029,133.12 186.368,145.039971 186.368,159.744 C186.368,174.448029 174.448029,186.368 159.744,186.368 C145.039971,186.368 133.12,174.448029 133.12,159.744 C133.12,145.039971 145.039971,133.12 159.744,133.12 Z M96.256,133.12 C110.960029,133.12 122.88,145.039971 122.88,159.744 C122.88,174.448029 110.960029,186.368 96.256,186.368 C81.5519708,186.368 69.632,174.448029 69.632,159.744 C69.632,145.039971 81.5519708,133.12 96.256,133.12 Z M159.744,69.632 C174.448029,69.632 186.368,81.5519708 186.368,96.256 C186.368,110.960029 174.448029,122.88 159.744,122.88 C145.039971,122.88 133.12,110.960029 133.12,96.256 C133.12,81.5519708 145.039971,69.632 159.744,69.632 Z M96.256,69.632 C110.960029,69.632 122.88,81.5519708 122.88,96.256 C122.88,110.960029 110.960029,122.88 96.256,122.88 C81.5519708,122.88 69.632,110.960029 69.632,96.256 C69.632,81.5519708 81.5519708,69.632 96.256,69.632 Z' fill='%23F12E45'/></g></svg>") !important;
  width: 16px;
  height: 16px;
  max-width: none;
  max-height: none;
  -webkit-mask-size: contain;
  mask-size: contain;
  -webkit-mask-position: center;
  mask-position: center;
}

/* Zapier navbar icon */
#navigation-items a[href="/documentation/integrations/zapier"] svg {
  -webkit-mask-image: url("data:image/svg+xml;utf8,<svg width='50px' height='50px' viewBox='-20 -10 280 280' version='1.1' xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink'>preserveAspectRatio='xMidYMid'> <g> <path d='M128.080089,-0.000183105 C135.311053,0.0131003068 142.422517,0.624138494 149.335663,1.77979593 L149.335663,1.77979593 L149.335663,76.2997796 L202.166953,23.6044907 C208.002065,27.7488446 213.460883,32.3582023 218.507811,37.3926715 C223.557281,42.4271407 228.192318,47.8867213 232.346817,53.7047992 L232.346817,53.7047992 L179.512985,106.400063 L254.227854,106.400063 C255.387249,113.29414 256,120.36111 256,127.587243 L256,127.587243 L256,127.759881 C256,134.986013 255.387249,142.066204 254.227854,148.960282 L254.227854,148.960282 L179.500273,148.960282 L232.346817,201.642324 C228.192318,207.460402 223.557281,212.919983 218.523066,217.954452 L218.523066,217.954452 L218.507811,217.954452 C213.460883,222.988921 208.002065,227.6115 202.182208,231.742607 L202.182208,231.742607 L149.335663,179.04709 L149.335663,253.5672 C142.435229,254.723036 135.323765,255.333244 128.092802,255.348499 L128.092802,255.348499 L127.907197,255.348499 C120.673691,255.333244 113.590195,254.723036 106.677048,253.5672 L106.677048,253.5672 L106.677048,179.04709 L53.8457596,231.742607 C42.1780766,223.466917 31.977435,213.278734 23.6658953,201.642324 L23.6658953,201.642324 L76.4997269,148.960282 L1.78485803,148.960282 C0.612750404,142.052729 0,134.946095 0,127.719963 L0,127.719963 L0,127.349037 C0.0121454869,125.473817 0.134939797,123.182933 0.311311815,120.812834 L0.36577283,120.099764 C0.887996182,113.428547 1.78485803,106.400063 1.78485803,106.400063 L1.78485803,106.400063 L76.4997269,106.400063 L23.6658953,53.7047992 C27.8076812,47.8867213 32.4300059,42.4403618 37.4769335,37.4193681 L37.4769335,37.4193681 L37.5023588,37.3926715 C42.5391163,32.3582023 48.0106469,27.7488446 53.8457596,23.6044907 L53.8457596,23.6044907 L106.677048,76.2997796 L106.677048,1.77979593 C113.590195,0.624138494 120.688946,0.0131003068 127.932622,-0.000183105 L127.932622,-0.000183105 L128.080089,-0.000183105 Z M128.067377,95.7600714 L127.945335,95.7600714 C118.436262,95.7600714 109.32891,97.5001809 100.910584,100.661566 C97.7553011,109.043534 96.0085811,118.129275 95.9958684,127.613685 L95.9958684,127.733184 C96.0085811,137.217594 97.7553011,146.303589 100.923296,154.685303 C109.32891,157.846943 118.436262,159.587052 127.945335,159.587052 L128.067377,159.587052 C137.576449,159.587052 146.683802,157.846943 155.089415,154.685303 C158.257411,146.290368 160.004131,137.217594 160.004131,127.733184 L160.004131,127.613685 C160.004131,118.129275 158.257411,109.043534 155.089415,100.661566 C146.683802,97.5001809 137.576449,95.7600714 128.067377,95.7600714 Z' fill='%23F12E45'></path></g></svg>") !important;
  mask-image: url("data:image/svg+xml;utf8,<svg width='50px' height='50px' viewBox='-20 -10 280 280' version='1.1' xmlns='http://www.w3.org/2000/svg' xmlns:xlink='http://www.w3.org/1999/xlink'>preserveAspectRatio='xMidYMid'> <g> <path d='M128.080089,-0.000183105 C135.311053,0.0131003068 142.422517,0.624138494 149.335663,1.77979593 L149.335663,1.77979593 L149.335663,76.2997796 L202.166953,23.6044907 C208.002065,27.7488446 213.460883,32.3582023 218.507811,37.3926715 C223.557281,42.4271407 228.192318,47.8867213 232.346817,53.7047992 L232.346817,53.7047992 L179.512985,106.400063 L254.227854,106.400063 C255.387249,113.29414 256,120.36111 256,127.587243 L256,127.587243 L256,127.759881 C256,134.986013 255.387249,142.066204 254.227854,148.960282 L254.227854,148.960282 L179.500273,148.960282 L232.346817,201.642324 C228.192318,207.460402 223.557281,212.919983 218.523066,217.954452 L218.523066,217.954452 L218.507811,217.954452 C213.460883,222.988921 208.002065,227.6115 202.182208,231.742607 L202.182208,231.742607 L149.335663,179.04709 L149.335663,253.5672 C142.435229,254.723036 135.323765,255.333244 128.092802,255.348499 L128.092802,255.348499 L127.907197,255.348499 C120.673691,255.333244 113.590195,254.723036 106.677048,253.5672 L106.677048,253.5672 L106.677048,179.04709 L53.8457596,231.742607 C42.1780766,223.466917 31.977435,213.278734 23.6658953,201.642324 L23.6658953,201.642324 L76.4997269,148.960282 L1.78485803,148.960282 C0.612750404,142.052729 0,134.946095 0,127.719963 L0,127.719963 L0,127.349037 C0.0121454869,125.473817 0.134939797,123.182933 0.311311815,120.812834 L0.36577283,120.099764 C0.887996182,113.428547 1.78485803,106.400063 1.78485803,106.400063 L1.78485803,106.400063 L76.4997269,106.400063 L23.6658953,53.7047992 C27.8076812,47.8867213 32.4300059,42.4403618 37.4769335,37.4193681 L37.4769335,37.4193681 L37.5023588,37.3926715 C42.5391163,32.3582023 48.0106469,27.7488446 53.8457596,23.6044907 L53.8457596,23.6044907 L106.677048,76.2997796 L106.677048,1.77979593 C113.590195,0.624138494 120.688946,0.0131003068 127.932622,-0.000183105 L127.932622,-0.000183105 L128.080089,-0.000183105 Z M128.067377,95.7600714 L127.945335,95.7600714 C118.436262,95.7600714 109.32891,97.5001809 100.910584,100.661566 C97.7553011,109.043534 96.0085811,118.129275 95.9958684,127.613685 L95.9958684,127.733184 C96.0085811,137.217594 97.7553011,146.303589 100.923296,154.685303 C109.32891,157.846943 118.436262,159.587052 127.945335,159.587052 L128.067377,159.587052 C137.576449,159.587052 146.683802,157.846943 155.089415,154.685303 C158.257411,146.290368 160.004131,137.217594 160.004131,127.733184 L160.004131,127.613685 C160.004131,118.129275 158.257411,109.043534 155.089415,100.661566 C146.683802,97.5001809 137.576449,95.7600714 128.067377,95.7600714 Z' fill='%23F12E45'></path></g></svg>") !important;
  width: 16px;
  height: 16px;
  max-width: none;
  max-height: none;
  -webkit-mask-size: contain;
  mask-size: contain;
  -webkit-mask-position: center;
  mask-position: center;
}

Get all calls by campaign ID. Returns an array of CallPublicDto. Supports pagination.

Get all calls by campaign ID

The id of the campaign. string representation of a ObjectId.

Id of the contact within the system. String representation of a ObjectId.

The datetime the call object was created in ISO string format.

The scripted events that successfully occurred during the call.

The id of the call. string representation of a ObjectId.

This boolean value indicates the call direction: true for incoming calls and false for outgoing calls.

The id of the organization. string representation of a ObjectId.

The id of the session. string representation of a ObjectId.

The datetime the call was updated last time in ISO string format.

The status of the goal. Was it reached or not.

The unique identifier of the message within the transcript.

Authorization

Voxia

Getting Started with Voxia

Voxia efficiently manages both inbound and outbound calls. Follow this step-by-step guide to create a new campaign.

Starting a New Campaign

This guide provides an overview of how to create a versatile and effective campaign script within the Voxia platform.Tailor the conversation flow to meet the unique needs of your campaign, whether it's for inbound or outbound calls.

Campaign Script

This guide provides detailed instructions on how to personalize the dialogue and questions in each node of your campaign script within the Voxia platform.

Campaign Steps

This page helps you manage specific questions or situations that might come up during a call, ensuring that the agent can handle them effectively.

Campaign Scenarios

The Campaign Setup allows you to configure essential details for your campaign, including the campaign name, company information, phone numbers, and various settings. A proper setup ensures that your campaign runs smoothly and effectively aligns with your business goals.

Campaign Setup

Trigger API calls in real-time during a call to provide agents with instant information or execute custom requests dynamically.

Actions

Uploading Contacts

Key Questions

Gain insights into your organization's calls, statistics, and billing with real-time analytics and detailed reports.

Analytics

Enhance agent capabilities by integrating a knowledge base that allows them to retrieve accurate answers from extensive documentation and data sources.

Knowledge Base

Voxia supports a wide range of languages and is continuously expanding to provide even more options for global communication.

Supported Languages

Inside Your Campaign

If you ever run into any problems during your call, we want to hear about it. Your feedback is invaluable in helping us identify and address issues, ensuring that your experience with our service is smooth and productive. Follow the steps below to let us know, so we can continue to enhance Voxia for all users.

Reporting Call Issues

This guide provides step-by-step instructions on how to generate an API key. Follow these steps to create and access your API key.

Generate API Key

Learn how to securely access Voxia using Single Sign-On (SSO) with your organization's credentials.

Single Sign-On (SSO)

Our Integrations

This document provides a guide on creating a Twilio account, purchasing phone numbers, retrieving your Account SID and Auth Token, and using these credentials in Voxia's app.

Twilio

Seamlessly schedule meetings by integrating Cal.com with Voxia. This integration enables you to leverage Cal.com’s scheduling capabilities directly through Voxia’s voice agents, streamlining the scheduling process and improving efficiency.

Cal.com

Enhance your Voxia experience by integrating it with Slack to receive call details directly in your chosen channels. This integration allows you to effortlessly access summaries and key insights from selected call groups, keeping your team informed and connected.

Slack

Automate your workflows by integrating Zapier with Voxia. This integration lets you trigger actions and streamline processes between Voxia and your favorite apps, saving time and boosting efficiency.

Zapier

Subaccounts allow organizations to manage multiple accounts under one main account, streamlining administration and ensuring centralized control.

Managing Subaccounts

White-labeling allows organizations to rebrand and customize the Voxia platform as their own, providing a seamless experience for clients.

White Label

Webhook Overview

Customize webhook structures to tailor data delivery and seamlessly integrate with your existing workflows.

Advanced Webhook

When integrating with Voxia, it's important to ensure that the webhook payloads you receive are indeed from Voxia. To facilitate this, Voxia signs each payload with a private key.

Validating Webhook Signatures

Track the latest features, improvements, and updates to Voxia

Changelog

Terms of Service

Privacy Policy

Start campaign

Stop campaign

Updates the interest criteria of the specified campaign

Update interest criteria

Get all campaigns by organization ID. Returns an array of CampaignPublicDto.

Get all campaigns by organization ID

Get campaigns

Partially updates the specified campaign fields

Update campaign

Creates a new campaign by duplicating the given campaign. You can optionally provide a new name or a target organization.

Duplicate a campaign

Get all campaign contacts. Returns an array of ContactPublicDto. Supports pagination, status filtering and sorting options.

Get all contacts by campaign ID

Adds new contacts to the specified campaign. Optionally fixes US phone numbers by adding a leading 1 if not present.

Create contacts for a campaign

Archives all contacts associated with a given campaign ID

Archive all campaign contacts

Archive contacts associated with a given contact IDs array

Archive contacts by contact IDs

Get campaign contact. Returns an object with the contact

Get a contact by ID.

Archive contact by contact ID

Archive contact associated with a given contact phone number.

Archive a contact by phone number

Get a report of contacts organized by statuses, with an optional archived filter

Get contacts report by status

Get all calls by campaign id and contact id. Returns an array of PaginatedCallPublicDto. Supports pagination.

Get calls by campaign ID and contact ID

Get a URL for accessing the recording of a call associated with a given campaign

Get call recording URL

Sets the status of the given call of the given campaign

Update call status

Get call webhook payload by campaign ID and call ID

Add a new webhook to the specified campaign.

Subscribe a Webhook

Get information for the organization associated with this API key

Get account information

Creates sub organization under the main organization associated with the API key

Create sub organization

Deletes the specified sub organization under the main organization associated with the API key

Delete sub organization by ID

Create a SIP carrier

Get list of SIP connections

Add a phone number

Sets the retention period in days for call recordings associated with the organization. Optionally applies to subaccounts.

Campaigns

Contacts

Calls

Webhooks

Organizations

Voices

Get all calls by campaign ID

Authorizations

Headers

Path Parameters

Query Parameters

Response