sv
5 min läsning Business

Enterprise-API för samtalsrevision: Endpoints och exempel

Praktisk referens för API v1 för revision: autentisering med organisationsnyckel, skapa revisioner via URL eller uppladdning, agenter, team, manus, analys och HMAC-webhooks.

Praktisk referens för API v1 för samtalsrevision – integrationskanalen för revisionsmodulen med din PABX eller telefonplattform. Kräver en organisation med företagsplan och en organisations-API-nyckel.

Autentisering

Skapa nyckeln på /dashboard/organization/auditorias (OWNER/ADMIN; upp till 10 aktiva nycklar per organisation) och skicka den i varje begäran:

Authorization: Bearer vpt_live_SUA_CHAVE_DA_ORG
  • Hemligheten visas enda en gång vid skapandet – vi sparar bara hashen.
  • Varje nyckel har scope (audits:write, audits:read, usage:read, analytics:read, m.fl.); det som inte beviljats nekas som standard.
  • Rate limit: 60 förfrågningar/minut per nyckel.

Skapa en revision

curl -X POST https://www.vozparatexto.com.br/api/v1/audits \
  -H "Authorization: Bearer vpt_live_SUA_CHAVE_DA_ORG" \
  -H "Content-Type: application/json" \
  -d '{
    "audio_url": "https://pbx.suaempresa.com/gravacoes/8841.mp3",
    "webhook_url": "https://api.suaempresa.com/hooks/auditorias",
    "idempotency_key": "chamada-8841",
    "agent_external_id": "maria.souza",
    "team": "vendas-sp"
  }'

Regler:

  • Accepterar audio_url (endast https, publik) eller upload_id (se nedan).
  • webhook_url är obligatorisk – resultatet kommer via webhook, inte via polling.
  • idempotency_key sparas varaktigt: återsändningar med samma nyckel skapar inte en dubblerad revision.
  • Omedelbart svar: 202 { "audit_id": "...", "status": "queued" }.

Frågor: GET /api/v1/audits (lista) och GET /api/v1/audits/{id} (detalj).

Inspelningar utan offentlig URL

För PABX som inte exponerar en URL, be om en tillfällig uppladdnings-URL:

curl -X POST https://www.vozparatexto.com.br/api/v1/uploads \
  -H "Authorization: Bearer vpt_live_SUA_CHAVE_DA_ORG"

Svaret innehåller en put_url giltig i 1 timme: ladda upp filen med en PUT och använd det returnerade upload_id när du skapar revisionen.

Registrering av verksamhet och mätvärden

EndpointFunktion
GET/POST /api/v1/agentsAgenter (med extern identifierare från ditt system)
GET/POST /api/v1/teamsTeam
GET/POST /api/v1/scripts + POST /api/v1/scripts/{id}/versionsManus och versioner
GET /api/v1/usageFörbrukning för perioden
GET /api/v1/analytics/summaryAnalytisk sammanfattning av verksamheten
GET /api/v1/analytics/agents/{external_id}Mätvärden per agent

Webhooks och garantier

  • Leveranser signerade med HMAC-SHA256 (X-VPT-Signature + X-VPT-Event); validera innan du bearbetar.
  • Timeout på 15 s per försök, upp till 6 försök med backoff från 5 min till 24 h.
  • Fastnade jobb försvinner inte: en kö som står stilla i >10 min läggs tillbaka i kön; bearbetning som fastnat i >60 min blir ett fel med fel-webhook. Varje skickad ljudfil genererar en slutlig callback.

Mer information i Webhooks och notifieringar.

FAQ

Kan jag använda min personliga API-nyckel här?

Nej – revisions-API:t använder organisationsnycklar, skapade av OWNER/ADMIN i revisionspanelen, med egna scope.

Enviei a mesma chamada duas vezes. Vai duplicar?

Nej, om du använde samma idempotency_key – idempotensen är beständig i databasen.

O put_url expirou antes do upload terminar. E agora?

Be om en ny put_url (giltig i 1 timme) och gör om uppladdningen; ingenting har skapats ännu.

Como restrinjo o que cada integração pode fazer?

Skapa separata nycklar per system, var och en med endast nödvändiga scope (t.ex. den interna instrumentpanelen endast med analytics:read), och återkalla varje nyckel individuellt vid behov.

Relaterade artiklar

Löste det inte? Öppna ett ärende – vårt team svarar snabbt.