fi
5 min lukuaika Business

Enterprise-API puheluiden auditointiin: päätepisteet ja esimerkit

Käytännön viite API v1 -auditointiin: todennus organisaation avaimella, auditointien luominen URL- tai latauslinkillä, agentit, tiimit, käsikirjoitukset, analytiikka ja HMAC-webhookit.

Käytännön viite puheluiden auditoinnin API v1:een – integraatiokanava auditointimoduulille PABX-järjestelmääsi tai puhelinalustaan. Vaatii organisaation, jolla on yrityssopimus, ja organisaation API-avaimen.

Todennus

Luo avain kohdassa /dashboard/organization/auditorias (OWNER/ADMIN; enintään 10 aktiivista avainta organisaatiota kohden) ja lähetä se jokaisessa pyynnössä:

Authorization: Bearer vpt_live_SUA_CHAVE_DA_ORG
  • Salaisuus näytetään vain kerran luonnin yhteydessä – säilytämme vain hajautusarvon.
  • Jokaisessa avaimessa on laajuudet (audits:write, audits:read, usage:read, analytics:read ja muita); myöntämättömät oikeudet evätään oletuksena.
  • Rajanopeus: 60 pyyntöä minuutissa avainta kohden.

Auditoinnin luominen

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"
  }'

Säännöt:

  • Hyväksyy audio_url-osoitteen (vain https, julkinen) tai upload_id-arvon (katso alla).
  • webhook_url on pakollinen – tulos toimitetaan webhookilla, ei kyselyllä.
  • idempotency_key tallennetaan pysyvästi: uudelleenlähetykset samalla avaimella eivät luo päällekkäistä auditointia.
  • Välitön vastaus: 202 { "audit_id": "...", "status": "queued" }.

Kyselyt: GET /api/v1/audits (lista) ja GET /api/v1/audits/{id} (yksityiskohdat).

Tallenteet ilman julkista URL-osoitetta

Jos PABX ei paljasta URL-osoitetta, pyydä väliaikainen lähetys-URL:

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

Vastaus sisältää put_url-osoitteen, joka on voimassa 1 tunnin: lähetä tiedosto PUT-pyynnöllä ja käytä palautettua upload_id-arvoa auditointia luodessasi.

Toiminnan rekisteröinti ja mittarit

PäätepisteToiminto
GET/POST /api/v1/agentsAgentit (ulkoisella tunnisteella omasta järjestelmästäsi)
GET/POST /api/v1/teamsTiimit
GET/POST /api/v1/scripts + POST /api/v1/scripts/{id}/versionsKäsikirjoitukset ja versiot
GET /api/v1/usageJakson kulutus
GET /api/v1/analytics/summaryToiminnan analyyttinen yhteenveto
GET /api/v1/analytics/agents/{external_id}Mittarit agenttikohtaisesti

Webhookit ja takuut

  • Toimitukset allekirjoitetaan HMAC-SHA256-menetelmällä (X-VPT-Signature + X-VPT-Event); vahvista ennen käsittelyä.
  • Aikakatkaisu 15 s per yritys, enintään 6 yritystä vaihtelevalla viiveellä 5 minuutista 24 tuntiin.
  • Juuttuneet työt eivät katoa: pysähtynyt jono >10 min asetetaan uudelleen jonoon; yli 60 min juuttunut käsittely muuttuu virheeksi virhe-webhookilla. Jokainen lähetetty ääni tuottaa lopullisen callbackin.

Lisätietoja kohdassa Webhookit ja ilmoitukset.

UKK

Voinko käyttää henkilökohtaista API-avaimesi tässä?

Ei – auditointi-API käyttää organisaation avaimia, jotka OWNER/ADMIN luo auditointipaneelissa omilla laajuuksillaan.

Lähetin saman puhelun kahdesti. Syntyykö kaksoiskappale?

Ei, jos käytit samaa idempotency_key-arvoa – idempotenssi on pysyvä tietokannassa.

put_url vanheni ennen latauksen valmistumista. Mitä nyt?

Pyydä uusi put_url (voimassa 1 tunti) ja lähetä uudelleen; mitään ei ole vielä luotu.

Kuinka rajoitan, mitä kukin integraatio voi tehdä?

Luo erilliset avaimet järjestelmäkohtaisesti, kukin vain tarvittavilla laajuuksilla (esim. sisäinen koontinäyttö vain analytics:read), ja peruuta ne yksitellen tarvittaessa.

Aiheeseen liittyvät artikkelit

Eikö ratkennut? Avaa tukipyyntö – tiimimme vastaa nopeasti.