Metódy na uskutočňovanie hovorov
1. Metóda POST /api/protected/api/auth/confirmationCall v odseku “Integrácie” > “Pre vývojárov” > “Paid methods”
Metóda vám umožňuje uskutočniť identifikáciu pri volaní. Zákazník si na to nemusí aktivovať číslo, hovory prichádzajú z nášho čísla. Po zdvihnutí slúchadla sa prehrá hlasový súbor o potrebe stlačenia čísla 9, hovor bude bezplatný, ale samotný spôsob hovoru stojí od 0,0083€. Metóda spája požiadavku API s konkrétnym volaním pomocou overovacieho kódu, ktorý bude popísaný po popise parametrov metódy.
Príklad volania metódy:
curl -X 'POST' \
'https://paidmethods.kompaas.tech/api/protected/api/auth/confirmationCall' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-H 'Sec-Fetch-Mode: cors' \
-H 'Authorization: Bearer <Token>' \
-d '{
"phone_number": "421222202999"
}'
Parametre metódy:
phone_number - telefónne číslo zákazníka na ktoré postupuje prichádzajúci hovor.
Po úspešnom vykonaní metódy sa dostane odpoveď v nasledujúcom formáte:
{
"status": "success",
"code": 200,
"object": {
"login_did": "7777777777",
"code": "2463",
"account_id": "117793",
"verification_call_uuid": "119214e015ed_117793"
}
}
1. Parameter Ok: — stav žiadosti. True — úspešné.
2. Parameter caller_number — čéslo s ktorého sa uskutočnil hovor.
3. Parameter verification_call_uuid — autorizační kód. Vyzerá nasledovne (príklad) “`fa278be48dc2_117793`», kde prvá časť kódu po symbol “_” — identifikácia hovoru, а čísla po symbolu “_” — zákaznícke číslo klienta. Kód je potrebný na priradenie údajov volania (CDR) ku konkrétnemu volaniu API. Ak chcete prijímať údaje o hovore, potrebujete v odseku “Integrácie” zapnúť webhook “Flash call” a potom budú informácie o hovore odoslané na zadanú adresu URL. Autorizační kód, ktorý ho spája s konkrétnym volaním API, nájdete v údajoch o hovore v parametri «verification_call_uuid»: «fa278be48dc2_117793”.
Callback —stav autorizačného hovoru
Prijatý hovor
«q931_status»: 16,
«final_status»: «ANSWER»
Obsadené
«q931_status»: 17,
«final_status»: «CANCEL»
Neprijatý hovory
«q931_status»: 16,
«final_status»: «CANCEL»
Neprejdený hovor v systéme ox7, odmietnutý iným operátorom
«q931_status»: 31
Hovor sa neuskutoční z dôvodu problémov fakturácie
«q931_status»: 41
Všetky ostatné kódy «q931_status», iné ako 31, 16 alebo 17 - číslo nie je dostupné.
Vytvorenie Webhookov pre prijatie informácií o hovore
Ak chcete získať informácie o hovore (CDR) na URL v súvislosti s volaním API, musíte v odseku «Integrácie», «Webhooks» pripojiť nový webhook na «Password call»
V pole «Telo požiadavky» v rámci typu údajov JSON musíte zadať text požiadavky, ktoré vám budú preposlané na URL adresu. Vytvorené udalosti si môžete skontrolovať v odseku «Monitoring»
