Facebook
LinkedIn
YouTube
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
  1. Getting Started
  • Choosing the Right API Version
  • Getting Started
  • Architecture
  • Quick Start
  • Authentication
  • Roles and API Access
  • API Categories
  • API Endpoints Reference
  • Making Your First API Call
  • Working with Encrypted Tokens
  • Code Examples
  • Error Handling
  • Best Practices
  • Troubleshooting
  • Support
  1. Getting Started

Choosing the Right API Version

Quick Decision#

SituationUse
New integration or applicationV3
AI Voice AgentsV3 (V2 unavailable)
Existing V2 integrationV2 until migrated
Maintaining legacy codeV2 while planning migration

V3 — Current Platform (Recommended)#

Base URL: https://platform-api.convirza.com/v3
OAuth: https://platform-oauth.convirza.com
V3 is actively developed and the default choice for all new integrations.
Separate OAuth service with JSON-based authentication
7-day access tokens, 6-month refresh tokens, immediate revocation
Full feature set: AI Voice Agents, SMS Broadcasts, Phone Numbers, Webhooks, Call Flow Recording
Consistent JSON responses with standardized error handling
Authentication:

V2 — Legacy Platform#

Base URL: https://apicfa.convirza.com/v2
OAuth: https://apicfa.convirza.com/oauth/token
V2 is in maintenance mode — bug fixes only, no new features.
Form-encoded authentication (application/x-www-form-urlencoded)
1-hour access tokens, 30-day refresh tokens
No AI Voice Agents or SMS Broadcasts
Still functional for existing integrations
Authentication:

Migrating V2 to V3#

Feature Mapping#

V2 CapabilityV3 Equivalent
Call data retrievalGET /v3/conversations/calls
SMS conversationsGET /v3/conversations/sms
User managementGET /v3/users, POST /v3/users
WebhooksGET /v3/webhooks, POST /v3/webhooks
Campaign dataGET /v3/sms-broadcasts

URL Changes#

ServiceV2V3
OAuthhttps://apicfa.convirza.comhttps://platform-oauth.convirza.com
APIhttps://apicfa.convirza.com/v2https://platform-api.convirza.com/v3

Migration Steps#

1.
Build V3 in parallel — don't touch your existing V2 integration
2.
Update auth — switch from form-encoded to JSON, update token handling for new TTLs
3.
Update base URLs — point to V3 endpoints
4.
Test thoroughly — validate all flows end-to-end
5.
Cut over — deprecate V2 once V3 is confirmed working
Do not expand your V2 footprint — even if full migration isn't immediate, avoid adding new V2 dependencies.

Need Help?#

Contact support@convirza.com for help identifying V3 equivalents for your V2 endpoints or planning your migration.
Modified at 2026-04-03 13:55:46
Next
Getting Started
Built with