Confirmation: hitelesítési hívások, API

Hívások kezdeményezésének módjai

1. POST  /api/protected/api/auth/confirmationCall amely megtalálható az  “Integrációk” > “Fejlesztőknek” > “Paid methods” menüpont alatt

A módszer lehetővé teszi, hogy hívást kezdeményezzen azonosítás céljából. Az ügyfélnek ehhez nem kell számot bekapcsolnia, a hívások a mi számunkról érkeznek. A kézibeszélő felvétele után egy hangfájl kerül lejátszásra a 9-es szám megnyomásának szükségességéről szóló üzenettel, a hívás ingyenes, de maga a metódushívás 3,49 Ft-tól kezdődik. A metódus egy API kérést egy adott híváshoz társít egy ellenőrző kód segítségével, amelyről a metódus paramétereinek leírása után lesz szó..

Példa egy metódus híváshoz: 

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


Metódus paraméterei:

phone_number - az ügyfél telefonszáma, ahova a hivás érkezik .

A módszer sikeres végrehajtása után a formátum válasza:

{
"status": "success",
"code": 200,
"object": {
"login_did": "7777777777",
"code": "2463",
"account_id": "117793",
"verification_call_uuid": "119214e015ed_117793"
}
}

1. Paraméter ok — kérés állapota. True — sikeres.

2. Paraméter caller_number — telefonszám, amelyről a hívás lett kezdeményezve .

3. Paraméter verification_call_uuid — hitelesítési kód. A következőképpen néz ki (példa) “`fa278be48dc2_117793`», ahol a kód első része az alábbi szimbólumig “_” — hívás azonosító, és a “_” — szimbólum utáni számok pedig az előfizető Ügyfélszámla száma. A kód szükséges ahhoz, hogy a hívás adatokat (CDR) egy adott API-híváshoz társítsa. A hívással kapcsolatos adatok fogadásához csatlakoztatni kell egy új Flash Call webhookot amit az   “Integrációk” - Webhookok- Új webhook- “Flash call” menüpont alatt teheti meg és akkor a megadott URL címre lesznek elküldve a hívással kapcsolatos adatok. A hívásadatokban az adott API-híváshoz tartozó ellenőrző kódot a «verification_call_uuid» részben található a: «fa278be48dc2_117793”.

Callback —a hitelesítő hívás állapota

Fogadott hívás
«q931_status»: 16,
«final_status»: «ANSWER»

Foglalt
«q931_status»: 17,
«final_status»: «CANCEL»

Nem fogadott hívás
«q931_status»: 16,
«final_status»: «CANCEL»

Nem ment át a hívás az ox7 rendszeren, másik szolgáltató elutasította a hívást 
«q931_status»: 31

Számlázási problémák miatt nem ment át a hívás 
«q931_status»: 41

Az összes többi kód «q931_status», kivéve 31,16 vagy 17 —a szám nem elérhető.

Webhook létrehozása a hívással kapcsolatos adatok fogadásához

Ahhoz, hogy a megadott URL címre  el legyenek küldve a hívással kapcsolatos  hívás adatok (CDR) amiket egy adott API-híváshoz társítani lehet  létre kell hozni az  «Integrációk» menüpont alatt a «Webhookok» almenüpontban  egy új webhookot ami «Password call»

A «Request body» mezőbe ami a JSON adattípus alatt található adja meg a kérelem törzsét, amelyek majd átadásra kerülnek a megadott URL címre. A létrehozott esemény le ellenőrizhető az  «Ellenőtzés» menüpont alatt.