API Enterprise for samtaleauditoring: Endepunkter og eksempler
Praktisk referanse for API v1 for auditoring: autentisering med organisasjonsnøkkel, opprette auditoringer via URL eller opplasting, agenter, team, manus, analyse og HMAC-webhooks.
Praktisk referanse for API v1 for samtaleauditoring – integrasjonskanalen til auditoringsmodulen med din PABX eller telefoniplattform. Krever organisasjon med Enterprise-plan og en API-nøkkel for organisasjonen.
Autentisering
Opprett nøkkelen i /dashboard/organization/auditorias (OWNER/ADMIN; opptil 10 aktive nøkler per organisasjon) og send den i hver forespørsel:
Authorization: Bearer vpt_live_SUA_CHAVE_DA_ORG
- Hemmeligheten vises kun én gang ved oppretting – vi lagrer bare hashen.
- Hver nøkkel bærer scopes (
audits:write,audits:read,usage:read,analytics:read, blant andre); det som ikke er gitt, blir nektet som standard. - Rate limit: 60 forespørsler/minutt per nøkkel.
Opprette en auditoring
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:
- Godtar
audio_url(kunhttps, offentlig) ellerupload_id(se nedenfor). webhook_urler obligatorisk – resultatet kommer via webhook, ikke polling.idempotency_keylagres varig: gjenutsendelser med samme nøkkel oppretter ikke duplisert auditoring.- Umiddelbar respons:
202 { "audit_id": "...", "status": "queued" }.
Forespørsler: GET /api/v1/audits (liste) og GET /api/v1/audits/{id} (detalj).
Opptak uten offentlig URL
For PABX som ikke eksponerer URL, be om en midlertidig opplastings-URL:
curl -X POST https://www.vozparatexto.com.br/api/v1/uploads \
-H "Authorization: Bearer vpt_live_SUA_CHAVE_DA_ORG"
Svaret inneholder en put_url som er gyldig i 1 time: last opp filen med en PUT og bruk upload_id som returneres når du oppretter auditoringen.
Registrering av operasjonen og målinger
| Endpoint | Funksjon |
|---|---|
GET/POST /api/v1/agents | Agenter (med ekstern identifikator fra ditt system) |
GET/POST /api/v1/teams | Team |
GET/POST /api/v1/scripts + POST /api/v1/scripts/{id}/versions | Manus og versjoner |
GET /api/v1/usage | Forbruk for perioden |
GET /api/v1/analytics/summary | Analytisk sammendrag for operasjonen |
GET /api/v1/analytics/agents/{external_id} | Målinger per agent |
Webhooks og garantier
- Leveranser signert med HMAC-SHA256 (
X-VPT-Signature+X-VPT-Event); valider før behandling. - Timeout på 15 s per forsøk, opptil 6 forsøk med backoff fra 5 min til 24 t.
- Fastlåste jobber forsvinner ikke: stillestående kø >10 min blir satt i kø igjen; fastlåst behandling >60 min blir feil med feil-webhook. All innsendt lyd genererer en endelig callback.
Mer detaljer i Webhooks og varsler.
FAQ
Kan jeg bruke min personlige API-nøkkel her?
Nei – API-et for auditoring bruker organisasjonens nøkler, opprettet av OWNER/ADMIN i auditoringspanelet, med egne scopes.
Jeg sendte den samme samtalen to ganger. Blir den duplisert?
Nei, hvis du brukte den samme idempotency_key – idempotensen er varig i databasen.
put_url utløp før opplastingen var ferdig. Hva nå?
Be om en ny put_url (gyldig i 1 time) og send på nytt; ingenting er opprettet ennå.
Hvordan begrenser jeg hva hver integrasjon kan gjøre?
Opprett separate nøkler per system, hver med bare de nødvendige scopene (f.eks. det interne dashbordet kun med analytics:read), og tilbakekall dem enkeltvis ved behov.
Relaterte artikler
Ikke løst? Åpne en sak – teamet vårt svarer raskt.