Getting Started

Convirza is a call tracking and analytics platform. Its V3 API is a distributed, RESTful JSON platform built on NestJS with separate OAuth and business logic services.

What You Can Do with the API

Domain	Capabilities
Users & Groups	Manage users, roles, and organizational units
Calls & SMS	Retrieve conversation history, transcriptions, indicators
Phone Numbers	Search, order, assign, and release tracking numbers
Provisioned Routes	Configure call routing rules and forwarding
Webhooks	Subscribe to real-time call and SMS events
AI Voice Agents	Create and manage AI-powered voice agents
SMS Broadcasts	Run outbound SMS campaigns
Media Prompts	Upload audio prompts, whispers, voicemails, surveys

Services at a Glance

Service	Base URL	Purpose
OAuth	`https://platform-oauth.convirza.com`	Authentication — get and refresh tokens
Public APIs	`https://platform-api.convirza.com/v3`	All business logic endpoints

Authentication Summary

POST /oauth/token with email and password → receive access_token + refresh_token

Pass Authorization: Bearer <access_token> on every API request

Tokens are encrypted opaque strings — use as-is, do not decode

Access tokens expire after 7 days; refresh tokens after 6 months

Need Help?

Email support@convirza.com with your request ID (returned in every error response).

Getting Started

What You Can Do with the API#

Services at a Glance#

Authentication Summary#

Need Help?#

What You Can Do with the API

Services at a Glance

Authentication Summary

Need Help?