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

Architecture

Convirza V3 uses a distributed microservices architecture with separate OAuth and business logic services.

Backend Services#

ServiceBase URL (Production)Purpose
OAuthhttps://platform-oauth.convirza.comAuthentication — login, refresh, revoke
Public APIshttps://platform-api.convirza.com/v3All business logic endpoints

Token Architecture#

Convirza uses encrypted session tokens:
1.
Call POST /oauth/token with your credentials to receive an encrypted access_token and refresh_token
2.
Tokens are opaque identifiers that cannot be decoded client-side — always use them as-is
3.
Include the token in the Authorization: Bearer <token> header on every API request
4.
Revoke tokens immediately by calling POST /oauth/revoke-token
Token TTLs:
Access token: 7 days
Refresh token: 6 months

Authentication Endpoints#

EndpointMethodDescription
/oauth/tokenPOSTLogin — returns access_token + refresh_token
/oauth/refresh-tokenPOSTExchange refresh token for new access token
/oauth/revoke-tokenPOSTRevoke a token immediately

API Structure#

All business logic endpoints are under https://platform-api.convirza.com/v3:
/v3/
├── auth/profile            — Authenticated user profile
├── users/                  — User management
├── groups/                 — Organization hierarchy
├── webhooks/               — Event subscriptions
├── media-prompts/          — Audio file uploads
├── ai-voice-agents/        — AI voice agent management
├── broadcast/              — SMS broadcast campaigns
├── phone-numbers/          — Number search, order, release
├── conversations/
│   ├── calls               — Call history and transcriptions
│   └── sms                 — SMS conversation threads
├── provisioned-routes/     — Call routing rules
├── industry                — Industry reference list
├── ad-source               — Ad source reference list
└── tag/                    — Tag management
Modified at 2026-04-13 06:15:41
Previous
Getting Started
Next
Quick Start
Built with