Hívásindítás — dial

Művelet	Mit tesz	Jog
POST `/dial/ivr`	egy szám hívása, felvétel után IVR-re	`dial:write`
POST `/dial/user`	hívás egy felhasználó mellékéről, interjúval	`dial:write`

POST `/dial/ivr` IVR-hívás

A phoneNumber számot hívja, és ha felveszi, az extension IVR-re kapcsolja. A hívott félnek kijelzett szám, a számkijelzés és a rögzítés a projekt beállítása.

A válasz a hívás indításakor jön, a hívás azonosítójával — a felvételt nem várja meg. A hívás a hívásnaplóban ezzel az azonosítóval található meg: a Location fejléc a calls/get-jére mutat.

{ "projectCode": "REMINDER", "extension": "600", "phoneNumber": "3610000001" }

Mező	Régi	Típus		Leírás
`projectId`	`prid`	`integer`		a projekt belső azonosítója — a `projectId` vagy a `projectCode` kötelező
`projectCode`	`prcode`	`string`		a projekt külső azonosítója
`extension`		`string`	kötelező	az IVR mellékszáma, 3–5 számjegy
`phoneNumber`	`phone`	`string`	kötelező	a hívott szám

A számból és a mellékből csak a számjegyek számítanak, a számból legalább 3 kell. A számot abban az alakban add meg, ahogy hívni kell: a rendszer nem alakítja át.

{ "id": 8812346 }

Mező	Régi	Típus	Leírás
`id`	`cdrid`	`integer`	a hívás belső azonosítója — a hívásnaplóban is ez

HTTP	`code`	Mikor
`400`	`INVALID_ARGUMENT`	hiányzó vagy 3 számjegynél rövidebb szám (`Parameter 'phoneNumber' must be a phone number`) · nem 3–5 számjegyű mellék · se `projectId`, se `projectCode`
`422`	`VALIDATION_FAILED`	mezőhiba (`fields`): ismeretlen `projectId` vagy `projectCode` (`INVALID_VALUE`)
`422`	`VALIDATION_FAILED`	a projekt nem aktív: felfüggesztett, lezárt vagy archivált (`PROJECT_NOT_ACTIVE`)
`422`	`VALIDATION_FAILED`	a `phoneNumber` a kimenő tiltólistán szerepel (`BLOCKED_NUMBER`)
`422`	`VALIDATION_FAILED`	ugyanarra a számra ugyanarról az IVR-ről rövid időn belül nem indul új hívás — várj, és indítsd újra (`IVR_REPEAT`)
`422`	`VALIDATION_FAILED`	a hívásindítás átmenetileg nem érhető el (`PBX_UNAVAILABLE`)
`422`	`VALIDATION_FAILED`	a hívásindítás az ügyfélnél nincs bekapcsolva (`CALL_NOT_HERE`)
`429`	`RATE_LIMITED`	a kulcs napi hívás-korlátja fölött — a két műveleté közös; másnap indíthatsz újra
`503`	`MAINTENANCE`	karbantartás: a hívásindítás rövid ideig nem fogad

curl "$BASE/dial/ivr" -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \
  -d '{"projectCode": "REMINDER", "extension": "600", "phoneNumber": "3610000001"}'

POST `/dial/user` Hívás egy felhasználó mellékéről

A bejelentkezett operátor felületén interjút nyit a számmal, és a mellékéről hívja. Az interjú a felhasználó bejövő projektjén nyílik; a hívott félnek kijelzett szám, a számkijelzés és a rögzítés a projekt beállítása.

A válasz megvárja, hogy a hívás elinduljon — ez néhány másodperc —, és a hívás azonosítójával jön; a felvételt nem várja meg. A hívás a hívásnaplóban ezzel az azonosítóval található meg: a Location fejléc a calls/get-jére mutat.

{ "userCode": "KOVACSA", "phoneNumber": "3610000001", "interviewCode": "CRM-4711" }

Mező	Régi	Típus		Leírás
`userId`	`userid`	`integer`		a felhasználó belső azonosítója — a `userId` vagy a `userCode` kötelező
`userCode`	`user_code`	`string`		a felhasználó külső azonosítója
`phoneNumber`	`phone`	`string`	kötelező	a hívott szám
`interviewCode`	`interview_code`	`string(80)`		az interjú kódja: ezzel kereshető az interjúk között
`projectId`	—	`integer`		a projekt belső azonosítója — a felhasználó bejövő projektjei közül; ha egy van, elhagyható
`projectCode`	—	`string`		a projekt külső azonosítója

A projektet akkor kell megadnod, ha a felhasználónak több bejövő projektje van. Ha a felhasználó a CapITris desktop kliensben dolgozik, a hívás az ott kiválasztott bejövő projekten nyílik, a kérés projektje nem számít.

{ "id": 8812347 }

Mező	Régi	Típus	Leírás
`id`	`cdrid`	`integer`	a hívás belső azonosítója — a hívásnaplóban is ez

HTTP	`code`	Mikor
`400`	`INVALID_ARGUMENT`	hiányzó vagy 3 számjegynél rövidebb szám · se `userId`, se `userCode` · 80 karakternél hosszabb `interviewCode` · több bejövő projektnél se `projectId`, se `projectCode`
`422`	`VALIDATION_FAILED`	mezőhiba (`fields`): ismeretlen `userId`, `userCode`, `projectId` vagy `projectCode` (`INVALID_VALUE`)
`422`	`VALIDATION_FAILED`	a projekt nem aktív: felfüggesztett, lezárt vagy archivált (`PROJECT_NOT_ACTIVE`)
`422`	`VALIDATION_FAILED`	a projekt nem a felhasználó bejövő projektje, vagy a felhasználónak nincs bejövő projektje (`USER_PROJECT`)
`422`	`VALIDATION_FAILED`	a `phoneNumber` a kimenő tiltólistán szerepel (`BLOCKED_NUMBER`)
`422`	`VALIDATION_FAILED`	a felhasználó nincs bejelentkezve operátorként, vagy a felülete nem vette át a hívást — a hívás nem indult el (`USER_NOT_AVAILABLE`)
`422`	`VALIDATION_FAILED`	a felhasználó most nem hívhat: hívásban, interjúban vagy automatikus tárcsázásban van (`USER_BUSY`)
`422`	`VALIDATION_FAILED`	ugyanarra a számra ugyanannak a felhasználónak rövid időn belül nem indul új hívás — várj, és indítsd újra (`PAIR_REPEAT`)
`422`	`VALIDATION_FAILED`	a felhasználó felülete átvette a hívást, de az indulása nem látszik — mielőtt újraindítod, nézd meg a hívásnaplóban (`CALL_UNCERTAIN`)
`422`	`VALIDATION_FAILED`	a hívásindítás az ügyfélnél nincs bekapcsolva (`CALL_NOT_HERE`)
`429`	`RATE_LIMITED`	a kulcs napi hívás-korlátja fölött — a két műveleté közös; másnap indíthatsz újra
`503`	`MAINTENANCE`	karbantartás: a hívásindítás rövid ideig nem fogad

curl "$BASE/dial/user" -H "X-API-Key: $API_KEY" -H "Content-Type: application/json" \
  -d '{"userCode": "KOVACSA", "phoneNumber": "3610000001", "interviewCode": "CRM-4711"}'

A régi API-ból

Cím	Kérés	Válasz	Működés
`control/ivrcall` → POST `/dial/ivr`	—	—	a mellék 3–5 számjegy; a kulcsnak lehet napi hívás-korlátja
`control/usrcall` → POST `/dial/user`	a projekt megadható	—	foglalt vagy be nem jelentkezett felhasználónál azonnal hibát ad; a kulcsnak lehet napi hívás-korlátja