--- title: "Developer's portal and APIs" slug: "developers-portal-and-apis" description: "user api developer documentation aws s3" tags: ["user api", "CDR", "calling list", "Developer", "messages", "click-to-call", "campaigns", "aws", "S3", "click2call", "API", "WhatsApp", "live campaign", "CRM", "click to call", "SMS"] updated: 2026-03-27T10:50:08Z published: 2026-03-27T10:50:08Z canonical: "docs.voiso.com/developers-portal-and-apis" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.voiso.com/llms.txt > Use this file to discover all available pages before exploring further. # Developer Portal and APIs **Who should read this article**: API Developers Developers can use the Voiso APIs to support integration with CRMs and other platforms and services such as web applications and middleware. Note If your contact center uses legacy Voiso API endpoints from v1, v2, or v3, review the [migration information](/v1/docs/developers-portal-and-apis#migrate-from-legacy-variablebrandname-apis-to-v4) before creating or updating an integration. Legacy endpoints will be supported until **March 31, 2027**. ## Introduction The **[Voiso Developer Portal](https://developers.voiso.com/reference/contact-center-api-documentation)** documents how to use the Voiso APIs to enable your applications and CRMs to exchange information with your Voiso contact center. ### Generate scoped API keys To use the Voiso v4 API, an admin must first create an API key on the **API keys** page in the Voiso application and assign the scopes required for the integration. The API key is then used by your developers or integration provider to authenticate requests to the Voiso API. Because each key can be limited to specific functional scopes, you can control which parts of the API an integration is allowed to access. Refer to [API keys](/v1/docs/api-keys) for more information. ### Download the Voiso API as a JSON File Click [here](https://developers.voiso.com/openapi) to download the latest version of Voiso’s OpenAPI as a JSON specification. #### Tips for Usage - **Postman**: Import the YAML file directly to access pre-defined endpoints and try out requests. - **Swagger UI**: Use the file in a local or hosted Swagger UI instance for interactive API documentation. - **Automation**: Use the file in CI/CD pipelines or for auto-generating client SDKs. If you need help getting started with the API, refer to our [Voiso API documentation](https://developers.voiso.com). ## API Overview API v4 endpoints are organized by functional areas. ### Reporting Retrieve interaction records and supporting details for audits and analytics: - Call Detail Records (CDRs) - CDR events - Speech Analytics ### Messaging Work with digital conversations and messaging assets: - Conversations and messages - Channel profiles - Canned messages - WhatsApp templates - SMS ### Routing and users Retrieve routing and identity objects used across the platform: - Queues, skills - Users, teams and assignments ### Campaigns Manage Dialer campaigns, control campaign lifecycle, and manage leads. ### Tasks Manage webhook configuration and monitor webhook delivery failures. ### Billing Retrieve billing balance information for the contact center. ## Webhooks The Voiso webhooks enable real-time information delivery from Voiso to external applications. The Voiso Webhooks are designed to send notifications whenever events occur in your contact center, enabling you to create automated tasks tailored to your business needs. - [Webhooks overview](https://developers.voiso.com/reference/webhooks-overview) - [Outbound call events](https://developers.voiso.com/reference/outbound-call-events) - [Inbound call events](https://developers.voiso.com/reference/inbound-call-events) - [Dialer call events](https://developers.voiso.com/reference/dialer-call-events) - [Call recording events](https://developers.voiso.com/reference/call-recording) - [Digital interaction events](https://developers.voiso.com/reference/digital-interaction-events) - [Speech Analytics events](https://developers.voiso.com/reference/speech-analytics-events) ## Data Transfer Services The Voiso data transfer services are powered by Amazon Web Services (AWS). They use Simple Query Service (Amazon SQS) and Simple Storage Service (Amazon S3) for processing and storage. Use the Voiso pre-built configuration to transfer your contact center data to your AWS instance automatically. - [Raw Data Streaming to SQS](https://developers.voiso.com/reference/raw-data-streaming-to-sqs): Stream Call Detail Records (CDRs) to AWS for further processing. - [Security Log Streaming to SQS](https://developers.voiso.com/reference/security-log-streaming-to-sqs): Stream security event information to AWS for further processing. - [Call Recordings Replication to S3](https://developers.voiso.com/reference/call-recordings-replication-to-s3): Replicate your call recordings to AWS for storage and further processing. Visit the **Voiso Developer Portal** to view the APIs here: [https://developers.voiso.com](https://developers.voiso.com/reference/api-documentation-introduction) Visit the [Authentication page](https://developers.voiso.com/reference/authentication) for information about API authentication. ## Integrating Omnichannel Agent Workspace into your applications The Voiso Omnichannel Workspace provides a unified platform for agents to seamlessly manage customer interactions across various communication channels. You can integrate the Omnichannel Agent Workspace into your application using an iframe. This guide will help you integrate the Voiso Omnichannel Agent Workspace into your CRM applications using Voiso's iframe, API, and webhook capabilities. [Embedded object](https://cdn.document360.io/44ae307a-3737-4fbf-98e0-9b888deb90dc/Images/Documentation/Omnichannel%20Integration%20Guide%20v1.1.pdf) ## Migrate from legacy Voiso APIs to v4 If your contact center already uses legacy Voiso API endpoints from v1, v2, or v3, you should plan to migrate your integrations to v4. Voiso API v4 introduces a more consistent API structure, standardized Bearer token authentication, and scoped API keys generated in the Voiso application. Legacy endpoints will continue to be supported until **March 31, 2027**, but all new API development should use v4. Admins should review which existing integrations use legacy endpoints, confirm which functional scopes each integration needs, and generate new [API keys](/v1/docs/api-keys) for v4 as required. Your developers or integration provider can then update the integration to use the new v4 endpoints and authentication model. For endpoint mappings, authentication changes, and migration guidance, refer to the [migration article](https://developers.voiso.com/reference/migrating-to-v4) in the *Voiso Developer's Guide*. Application Programming Interface. A set of functions and procedures allowing developers to create applications that access the features or data of an operating system, application, or other service. Customer Relationship Management. A service for managing all your organization's relationships and interactions with customers (contacts) and potential customers. It that provides real-time agent access to customer data and previous interaction information to further personalize the customer experience. CRM integration in a contact center can lead to more personalized service, increased customer retention, and more revenue.