Who should read this article: API Developers
This article contains a list of common questions with answers that link to articles where the information is documented.
For technical issues, see the Troubleshooting section.
APIs
Q: How do I trigger Click-to-Call from my CRM?
A: Call the Click-to-Call Start call endpoint; use the returned call_id to track the session.
See: Developers – Start call
Q: How do I hang up a Click-to-Call session programmatically?
A: Call the Stop call endpoint for the active session (use the call_id retrieved using the Start call endpoint).
See: Developers – Stop call and Developers – Start call.
Q: How can my app check if an agent is available before starting a call?
A: Call the Agent status endpoint (pull) or subscribe to the agent-status events webhook (push).
See: Developers – Agent status and Developers – Agent status webhooks
Q: How do I fully automate Dialer campaigns (create, add leads, assign agents, start/stop)?
A: Use the Campaigns API to create and update a campaign, add and update contacts, assign agents and teams, then change status (start, pause, stop). Check out these endpoints:
- Create campaign: configure strategy (e.g.,
simple,predictive_ai), dialing level, caller IDs, etc. See: Developers – Create Campaign - Update campaign: modify settings as needed. See: Developers – Update Campaign
- Update campaign agents and teams: assign agents and teams. See: Developers – Update campaign agents and teams
- Add contacts / Update contacts: push or adjust leads while the campaign is live. See: Developers – Add contacts and Developers – Update contacts.
- Change campaign status: programmatically
start,pause, orstop. See: Developers – Change campaign status. - List campaigns: obtain a list of all your active campaigns and their current settings and statuses. See:
Developers – List campaigns
Q: How do I pull messages (and later transcripts) for a digital conversation?
A: Use Get conversation messages (WhatsApp, Webchat, Telegram, Viber) and correlate with CDR for analytics.
See: Developers – Get conversation messages
Q: What’s the API to export Call Detail Records (CDR) to my data warehouse?
A: Use List CDRs with date/agent/queue/campaign filters and paginate through results.
See: Developers – List CDRs
If you use Amazon Web Services Simple Queue Service, you can use the Raw Data Streaming to SQS integration to replicate your CDR data to AWS SQS. See: Raw Data Streaming to SQS
Q: Can Voiso push events to my app instead of polling?
A: Yes. Subscribe to Webhooks (call events, digital interactions, agent status, recordings, analytics). Use retrigger to redeliver failed events.
See: Developers – Webhooks overview, Developers – Webhook failures, and Developers – Webhook Retrigger.
Q: How do I send SMS messages programmatically?
A: Use the Send SMS endpoint for text messages. You can also retrieve a list of available SMS templates to ensure the content you send is permitted by your organization.
See: Developers – Send SMS and Developers – SMS templates.
Q: How do I send WhatsApp messages programmatically?
A: Use the Send WhatsApp messages endpoint for WhatsApp messages. Note: (templates must be used). To retrieve a list of available templates, use the List WhatsApp templates endpoint.
See: Developers – Send WhatsApp messages and Developers – List WhatsApp templates.
Q: Where do I find error codes and response schemas?
A: In the developer portal per-endpoint, or download/import the OpenAPI YAML into Postman/Swagger for a consolidated view.
See: Developers – Error Codes and Developers – Downloading the Contact Center API YAML file
Q: How can I check my organization’s current balance via API?
A: Call the Get balance endpoint using a contact-center–scoped API key.
See: Developers – Get balance
Q: What base URL should I call, and which key should I use?
A: Use your cluster base URL https://{cluster_id}.voiso.com with a contact-center API key for admin-scoped operations.
See: Developers – Base endpoint and Developers – Authentication.
Webhooks
Q: How can I trigger external workflows or sync data when calls are completed?
A: Voiso supports Webhooks, which let you send real-time event data—such as call completions, transcript availability, or agent actions—to your own systems or services. You can configure endpoints and subscribe to specific event types under Administration > Webhooks.
This is ideal for automating workflows, syncing CRM records, or feeding call data into analytics platforms.
See: Webhooks
See also: Webhooks Overview (Developer)
Q: What happens if a webhook fails to deliver?
A: If a webhook event fails to deliver (e.g., due to a timeout or error response), Voiso retries the event automatically using a backoff strategy. You can view failed events and re-trigger them manually using the Webhook Retry API.
See: Webhooks
See also: Webhook Retry API
Q: How can I get notified when Speech Analytics data is ready?
A: Subscribe to the call.analytics.available webhook event to receive real-time notifications when transcripts, scores, and summaries are available for a recorded call. This is useful for triggering post-call workflows or syncing analytics to external systems.
See: Webhooks
See also: Webhooks Overview (Developer)
Still have questions? Contact support or explore our other FAQ topics.