canonical: https://jentic.com/apis/convirza.com/convirza

# Convirza API

Jentic publishes the only available OpenAPI specification for Convirza API, keeping it validated and agent-ready. Convirza provides 80 endpoints for call tracking, recording, transcription, scorecarding, and SMS, plus campaign and call flow management for marketers and contact centres. Operations span call retrieval and tagging, scorecard reporting, blacklist management, dynamic number insertion, and webhook delivery. Authentication is OAuth 2.0 implicit flow with scoped tokens such as read:call, read:campaign, and write:callflow.

## For AI agents

Pull call records, transcriptions, and scorecards from Convirza, manage campaigns and call flows, and run SMS or DNI workflows. Agents authenticate with an OAuth 2.0 token.

## Scope

Does not place outbound calls, host telephony numbers, or replace a CCaaS platform - use for call tracking, scorecarding, transcription, and marketing attribution only.

## Capabilities

- Retrieve call records, transcripts, and scorecard results via the /call endpoints
- Tag and comment on calls with POST `/call/tag` and POST `/call/comment`
- Manage marketing campaigns and their assigned users via /campaign endpoints
- Add, list, and remove blacklisted numbers via /blacklistednumber
- Pull scorecard reports and update call titles through /scorecard endpoints
- Upload audio files with call metadata via POST `/call/upload` for offline tracking
- Send and receive SMS and configure webhooks for call events

## Use cases

### Call Quality Scorecard Reporting

Pull scorecard results for sales and support calls to feed coaching dashboards and quality dashboards. `/scorecard/list` enumerates scorecards while `/scorecard/scoredCallsReport` returns the scored call data tied to specific scorecards. Suited to contact centres running QA programmes that need to surface scorecard data outside the Convirza UI.

Example prompt: List scorecards via GET `/scorecard/list`, then pull GET `/scorecard/scoredCallsReport` for the past 7 days and produce a summary

### Marketing Attribution via Dynamic Number Insertion

Use Convirza's DNI data to attribute inbound calls to the marketing campaign that drove them. `/call/dni` returns the calls with their tracking number, source, and campaign metadata, while /campaign endpoints manage the campaigns themselves. Useful for performance marketers who want call-level ROAS alongside web analytics.

Example prompt: Pull GET `/call/dni` for the last 30 days and aggregate calls by campaign and source

### Compliance Blacklist Enforcement

Maintain a do-not-call list across campaigns by managing blacklisted numbers programmatically. POST /blacklistednumber adds numbers, GET /blacklistednumber lists current entries, and DELETE removes numbers when consent is restored. Useful for compliance teams keeping suppression lists synced with CRM opt-out events.

Example prompt: Add the numbers from today's CRM opt-outs to Convirza via POST /blacklistednumber and confirm with GET /blacklistednumber

### Agent-Driven Call Insight Workflows via Jentic

An AI agent ingests inbound calls, pulls transcripts, and surfaces high-risk conversations through Jentic. The agent searches Jentic for the call retrieval intent, loads the schema, and chains GET `/call/transcription` with `/call/tag` to auto-label calls. Through Jentic the OAuth token is held in the vault so agent loops never expose the credential.

Example prompt: Search Jentic for 'get call transcription', load the Convirza operation, fetch transcripts for yesterday's calls, and tag any with negative sentiment

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/call/list` | List calls with filtering |
| GET | `/call/transcription` | Get calls with transcriptions |
| POST | `/call/tag` | Add tags to calls |
| GET | `/scorecard/scoredCallsReport` | Pull scored calls report |
| POST | `/blacklistednumber` | Add numbers to the blacklist |
| GET | `/campaign/list` | List all campaigns |
| GET | `/call/dni` | Retrieve calls with DNI tracking data |

## Key resources

- **Call** — Retrieve, list, tag, comment on, and upload calls and their transcripts
- **Scorecard** — List scorecards and pull scored-call reports for QA
- **Campaign** — Create, retrieve, and manage marketing campaigns and their users
- **Blacklistednumber** — Manage the do-not-call suppression list
- **Webhook** — Configure webhook delivery for call events

## Why Jentic

- **Setup:** Wiring Convirza by hand means running its OAuth 2.0 flow, carrying the access token, and stitching together the call, scorecard, and campaign reads yourself. Through Jentic you install once, import the Convirza API from the API Directory, store the token once, and your agent calls it.
- **Permission scoping:** Convirza defines OAuth scopes such as read:call, read:campaign, and write:callflow, and its call and scorecard targets travel in the request rather than as a fixed path resource, so scope this by operations: allow the agent the calls it needs, such as listing calls and fetching transcriptions, and leave tagging or blacklisting out unless you add them. Each operation you credit the agent with stays inside that allowed set.
- **Credential handling:** Your Convirza OAuth token is stored once, encrypted, by your own Jentic One instance and injected into the Authorization header at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'get a call transcription' or 'list Convirza calls', and Jentic returns the matching call or scorecard operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Twilio Voice API** — Programmable voice calling with recording and call control, broader telephony scope than Convirza.
- **Twilio Voice Insights API** — Call quality and analytics over Twilio voice traffic, similar reporting scope to Convirza scorecards.
- **Vonage (Nexmo) Voice API** — Voice telephony platform that pairs with Convirza when calls are placed via Vonage and tracked in Convirza.

## FAQ

### Why is there no official OpenAPI spec for Convirza API?

Convirza does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Convirza API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the Convirza API use?

Convirza uses OAuth 2.0 implicit flow with the authorize endpoint at https://apicfa.convirza.com/oauth/authorize. Tokens are scoped (e.g. read:call, read:campaign, write:callflow). Through Jentic the access token is held in the vault and injected at execution time so it never enters the agent's prompt.

### Can I retrieve call transcriptions with the Convirza API?

Yes. GET `/call/transcription` returns calls with their transcripts and GET `/call/transcriptionDetail` returns the granular transcription record. Pair with GET `/call/tag` or POST `/call/tag` to label calls based on transcript content.

### How do I manage a do-not-call suppression list with Convirza?

Use the /blacklistednumber endpoints. POST /blacklistednumber adds one or more numbers, GET /blacklistednumber lists existing entries, and DELETE removes numbers from the suppression list. Sync these with CRM opt-outs to keep suppression in lockstep.

### What scorecard data can I pull from the Convirza API?

GET `/scorecard/list` enumerates available scorecards, and GET `/scorecard/scoredCallsReport` returns scored call data tied to a scorecard for a given period. POST `/scorecard/callField` updates call titles, useful when feeding scorecard outcomes back into reports.

### What are the rate limits for the Convirza API?

Rate limits are not declared in the OpenAPI spec. Treat the call and scorecard endpoints as soft-limited per OAuth token and back off on HTTP 429 responses. Convirza's knowledge base at https://kb.convirza.com/api-request-instructions documents the request rules per plan.

### How do I pull call data through Jentic?

Run jentic search for 'list convirza calls', load the GET `/call/list` operation, then execute it with the desired date range and filters. Jentic injects the OAuth access token from the vault and returns the call records as a structured response.

### Can I limit what my agent is allowed to do with the Convirza API?

Yes. Because you run Jentic One yourself, your own rules decide which Convirza operations and OAuth scopes the agent may use. Convirza carries its call and scorecard targets in the request rather than as fixed paths, so you scope by operation: grant read operations like GET `/call/list`, GET `/call/transcription`, and GET `/scorecard/scoredCallsReport` while leaving write actions such as POST `/call/tag` or POST /blacklistednumber out unless you deliberately add them. Each operation and its scoped token stays inside the allowed set you define, so the agent can only call what you have permitted.