ThunderPhone 2.0 on nüüd saadaval.Iseteenindusena alates 2 senti/min.Loe uudist

Developer cookbook

Tee väljuvaid kõnesid (API)

Käivita oma koodist tehisintellektipõhine väljuv kõne — küsitluse, järeltegevuse või kinnituse töövood.

Väljaminevad kõned võimaldavad sul anda ThunderPhone'ile sihtnumbri ja agendi konfiguratsiooni ning lasta häälagendil sinu eest kõne teha. Tüüpilised kasutusjuhud:

  • Kohtumiste kinnitused
  • Küsitluste järelkõned
  • „Teine katse” pärast vastamata kõnet
  • Dispetšerilaadsed teavitused

Eeltingimused

  1. Vali väljaminevaid kõnesid toetav number

    Kasuta numbrit, mis kuulub sulle VoIP-ühenduse kaudu, või taotle luba kasutada oma ThunderPhone'i numbreid väljaminevateks kõnedeks lehel Phone Numbers. ThunderPhone'i numbrid on algselt ainult sissetulevate kõnede jaoks. ThunderPhone vaatab iga taotluse käsitsi üle; pärast heakskiitmist saavad need numbrid teha kõnesid kuni heakskiidetud päevase limiidini (lähtestatakse kell 00:00 UTC) ja käitada kampaaniaid ning saad taotleda suuremat limiiti. Kliendi VoIP-numbritel puudub päevane limiit, seega soovitame neid väljaminevateks kõnedeks. Vaata Kasuta oma numbreid.

  2. Loo agent

    Väljaminevatele kõnedele kohandatud viip algab tavaliselt sellega, et agent tutvustab ennast ja oma eesmärki — „Tere, siin Acme, helistan, et kinnitada teie homset kohtumist kell 15…“ Määra outbound_speak_order väärtuseks agent_first (vaikeväärtus).

  3. Hoia positiivset saldot

    Väljaminevad kõned tagastavad 402 Payment Required, kui saldo on ≤ $0.00. Lisa raha või luba automaatne saldo täiendamine juhtpaneelil jaotises Organisatsioon → Arvelduse seaded. Sinu sk_live_ võti saab kontrollida saldot päringuga GET /v1/billing, kuid ei saa saldot täiendada ega automaatset täiendamist muuta.

Tee kõne salvestatud agendiga

Lihtsaim viis — viita agendile ID järgi:

curl -X POST https://api.thunderphone.com/v1/call \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from_number": "+15551234567",
    "to_number":   "+14155552671",
    "agent_id":    12
  }'

Vastus:

{ "call_id": 987654321, "status": "initiated" }

Tee kõne sisseehitatud konfiguratsiooniga

Kui soovid ühekordset viipa, mida ei tasu agendina salvestada, edasta selle asemel config. Selle struktuur vastab call.incoming veebikonksu vastuseskeemile:

curl -X POST https://api.thunderphone.com/v1/call \
  -H "Authorization: Bearer sk_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "from_number": "+15551234567",
    "to_number":   "+14155552671",
    "config": {
      "prompt":  "You are confirming Jane Doe appointment for 3pm tomorrow…",
      "voice":   "john",
      "product": "spark"
    }
  }'

Jälgi kõnet

Telli paralleelselt telephony.complete veebikonksu — see on kiireim viis teada saada, et kõne on lõppenud. Kui sa ei saa sissetulevaid veebikonkse vastu võtta, päri GET /v1/calls/{call_id} iga paari sekundi järel; kirje sisaldab pärast kõne lõppu väärtusi end_reason, duration_seconds ja salvestise URL-i.

Kui sinu agent on seadistatud pärast kõnet struktureeritud andmeid eraldama, edastatakse need andmed eraldi pärast lõplikku kinnitamist.

Edasta kõnepõhiseid muutujaid salvestatud agendile

Salvestatud agendid saavad viibatekstis kasutada kohatäiteid nagu {{name}} või {{name|there}}. Kui teed agent_id abil väljuva kõne, edasta selle kõne väärtustega variables:

{
  "from_number": "+[REDACTED_PHONE]",
  "to_number": "+[REDACTED_PHONE]",
  "agent_id": 12,
  "variables": {
    "name": "Jordan"
  }
}

Kasuta kohatäite nimega seotud stringväärtusi. Need muutujad kehtivad salvestatud agentidele; selle juhendi tekstisisene config-i näide neid ei kasuta.

Tõrkerežiimid, mida tasub käsitleda

TõrgeLahendus
402 Payment RequiredLisa kontole raha või luba automaatne saldo täitmine
400 koos code: destination_not_allowedThunderPhone ei helista sellele numbrile: kehtetud numbrid, hädaabinumbrid, kõrgendatud tariifiga numbrid, lühinumbrid või sanktsioonidega riigid. ThunderPhone'i numbritelt saab helistada ainult tavalistele USA ja Kanada numbritele (mitte kõrgendatud tariifiga numbritele). reason näitab, millisega on tegemist; vaata blokeeritud sihtkohti
409 koos retryable: false ThunderPhone'i numbri puhulJärgi väärtust code: taotle väljaminevate kõnede võimalust lehel Phone Numbers, oota poolelioleva ülevaatuse lõppu või kasuta mõnda muud sobivat numbrit
429 koos code: platform_outbound_daily_limit_reachedOrganisatsioon on kasutanud ära tänased ThunderPhone'i numbritelt tehtavate väljaminevate kõnede limiidi. Oota väärtuseni resets_at (00:00 UTC), taotle lehel Phone Numbers kõrgemat limiiti või helista oma VoIP-ühenduse numbrilt
429 koos code: concurrent_call_limit_reachedOrganisatsioonil on pooleli sama palju kõnesid kui selle samaaegsete kõnede limiit (vaikimisi 20, arvestades sissetulevaid, väljaminevaid, veebist ja testkõnesid). Proovi uuesti pärast päises Retry-After määratud sekundeid või kui kõne lõpeb; limiidi suurendamiseks kirjuta aadressil support@thunderphone.com
429 koos code: same_number_too_soonHelistasid samale to_number numbrile vähem kui 10 sekundit tagasi. Proovi uuesti pärast päises Retry-After määratud sekundeid
409 koos retryable: false kliendi VoIP-numbri puhulParanda väärtusega code nimetatud olek; kinnitamise nurjumise korral käivita POST /v1/phone-numbers/{id}/verify-voip
409 idempotentsuskonfliktKasuta võtit uuesti ainult algse normaliseeritud päringuga või saada uus võti
404 from_number is not registered to this organizationVeendu, et from_number vastab sinu organisatsiooni aktiivsele telefoninumbrile. Selle vastuse tagastab ka number, mille seadistamine on juba pooleli, nurjunud, lõpetamisel või lõpetatud
500 ainult väljaga detailVäljaminevat trunk'i pole seadistatud. Võta ühendust toega; see ei ole numbri oleku probleem, mida saad ise parandada
502 Bad GatewayAjutine SIP-i / LiveKit-i tõrge; uuesti proovimine on turvaline

Täieliku stabiilsete sobivuskoodide loendi ja mõlema 409 vastusekuju jaoks vaata väljuvate kõnede viidet. Kui aktiivne number muutub sobimatuks pärast päringu vastuvõtmist, kuid enne kõne tegemist, tagastab lõplik kontroll mitteuuesti proovitava 409-i vastusekoormuse.

Ooteaja juhtimine

Väljuvatele kõnedele, mis venivad pikaks, kuna kõne vastuvõtja reageerib aeglaselt (IVR-menüüd, järjekorrad), saab määrata ülempiiri max_hold_seconds abil:

{
  "from_number": "+15551234567",
  "to_number":   "+14155552671",
  "agent_id":    12,
  "max_hold_seconds": 120
}

Agent lõpetab kõne, kui viimase N sekundi jooksul pole inimese häält vastu võetud. Vaikeväärtus on 900 sekundit (15 minutit).


Järgmised sammud