Vodniki
SIP
Če vam glasovni agent in preprosto preusmerjanje ne zadoščata in želite številko povezati z lastnim softphonom ali telefonsko centralo (PBX), potrebujete ponudnika SIP trunka - volai je eden izmed njih. Ta stran je vodnik korak za korakom.
1Dohodni klici na vaš strežnik SIP
Nastavite usmerjanje številke na mode: "sip" in vnesite svoj sipUri - od tu naprej klic potuje neposredno k vam, ne k naši ponudbi agenta ali preusmeritvi:
curl -X PATCH "https://volai.eu/v1/numbers/+420601234567" \
-H "Authorization: Bearer vk_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"routing": {"mode": "sip", "sipUri": "sip:reception@your-server.com"}}'Zaračuna se samo dohodna minuta (0,50 kr/min (≈ 0,02 EUR)), brez dodatnega agenta - popolna oblika zahteve in drugi načini usmerjanja so v referenci REST API.
Overitev na vaši centrali
Klic na vaš strežnik SIP najprej pošljemo kot neoverjen INVITE na sipUri. Centrala, ki nanj odgovori z zahtevo po prijavi (401/407) in brez dodatnih podatkov klic zavrne, ga v tej obliki ne prejme - zahteve namreč nihče ne more dvigniti. Zato v usmerjanje dodatno vnesite sipUsername in sipPassword - z vnosom obeh se naše omrežje na cilju prijavi (SIP digest) in izbere klicano številko. Preverjeno z živim klicem na izvorno številko SIP Vapi, ki sprejme prijavne podatke ne glede na njihovo vsebino. Ali klic poveže tudi vaša centrala, je odvisno od nje - na INVITE mora res odgovoriti z zahtevo in vneseno ime z geslom priznati; tega ne zagotavljamo za vsako centralo (v preizkusu to ni uspelo na primer proti domeni SIP Twilia). Brez sipUsername in sipPassword usmerjanje ostane v današnji neoverjeni obliki. Prijavo v usmerjanje dodate takole:
curl -X PATCH "https://volai.eu/v1/numbers/+420601234567" \
-H "Authorization: Bearer vk_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"routing": {"mode": "sip", "sipUri": "sip:reception@your-server.com", "sipUsername": "reception", "sipPassword": "supersecret123"}}'Klicano številko vedno pošljemo natanko v taki obliki, kot je v sipUri pred znakom @ - nobene predvolbe ali ničle ne dodajamo ne odvzemamo, zato mora ciljna centrala znati obdelati natanko tisto, kar tam zapišete.
sipUsername in sipPassword ne smeta vsebovati dvopičja, znaka @, presledka, narekovaja ali poševnice nazaj in smeta imeti največ 64 znakov vsak.
Vnos samo enega od polj ni mogoč - API vrne napako „Vnesite prosim ime in geslo ali pa obe polji pustite prazni.“.
Dvopičje v uporabniškem delu sipUri (pred znakom @) in vrata v gostitelju (za dvopičjem pri strežniku, npr. :5060) se z vnesenima sipUsername in sipPassword zaenkrat ne podpirajo - oboje vrne isto trdo napako. Brez prijavnih podatkov oboje deluje brez sprememb.
Izjema: BYO trunk SIP Vapi (naslov <credentialId>.sip.vapi.ai, pri organizaciji v regiji EU <credentialId>.sip.eu.vapi.ai) prijavnih podatkov ne uporablja. Vapi naše klice prepozna po IP-ju v gateways trunka in z vnesenima sipUsername in sipPassword se klic ne bi povezal, zato API takšno usmerjanje zavrne s kodo validation. Izvorne številke SIP Vapi (sip:<ime>@sip.vapi.ai) se to ne tiče.
Kdo še vidi ime in geslo
Ime in geslo potujeta s klicem naprej v naše omrežje in ostaneta v tehničnih zapisih o njegovem usmerjanju - niste edini, ki ju vidi. Zato na centrali ustvarite namenski račun samo za nas, ne glavnega skrbniškega gesla.
Partial update: izpuščeno polje ostane, kot je bilo
Če v PATCH pošljete samo sipUri in izpustite sipUsername ter sipPassword , obe polji ostaneta nespremenjeni - ni ju treba znova vnašati ob vsaki spremembi sipUri. Izpuščeno polje (v telesu povsem manjka) se vedno ohrani shranjeno; prijavo prekliče samo izrecen prazen niz pri OBEH poljih hkrati. Edina izjema je sprememba strežnika: če v sipUri spremenite tudi del za znakom @, morate geslo poslati znova - shranjenega gesla ne pošljemo na drug strežnik, kot tisti, za katerega ste ga vnesli. Trenutno stanje preverite s poljem hasSipPassword v odgovoru.
Klic se ni povezal? Spustite nas po IP-ju
Sipa prijava deluje samo proti cilju, ki na INVITE zahteva prijavo in podatke sprejme (preverjeno z izvorno številko SIP Vapi) - sicer klica ne prejmete, ne glede na to, ali prijavne podatke vnesete ali ne. Naša signalizacija prihaja iz razpona 81.31.45.0/24, v praksi najpogosteje iz 81.31.45.51 in 81.31.45.56. Na centrali dovolite celoten ta razpon - klic nato prepozna po izvornem naslovu, ne po imenu in geslu, prijavnih podatkov pa sploh ne potrebujete.
2Podatki SIP številke
Prijavne podatke linije prevzamete z enim klicem:
curl "https://volai.eu/v1/numbers/+420601234567/sip" \
-H "Authorization: Bearer vk_YOUR_KEY"{
"server": "sip.volai.cz",
"username": "123456",
"password": "a1b2c3d4e5f6",
"outboundTrunkAddress": "sip.volai.cz",
"port": 5060,
"transport": "tcp",
"inboundSignallingCidrs": ["81.31.45.0/24"]
}Nastavitev v softphonu (Zoiper, Linphone)
V obeh aplikacijah vnašate v bistvu isto, le drugače poimenovano - poiščite „Dodaj račun“ / „Račun SIP“:
| Polje | Vrednost |
|---|---|
| Strežnik / Domena | sip.volai.cz |
| Uporabniško ime | iz zgornjega odgovora (username) |
| Geslo | iz zgornjega odgovora (password) |
| Transport | TCP |
| Vrata | 5060 (privzeti SIP - če polje ponuja prazno možnost, jo pustite prazno) |
Odjemalec želi vnos področja (realm)?
Pustite polje prazno - večina odjemalcev realm prevzame iz zahteve strežnika. V dnevniku odjemalca se lahko pojavi tehnična domena našega omrežja, to je v redu. Če vaš odjemalec realm zahteva kot obvezen, pišite podpori.
Po shranjevanju bi se moral softphone registrirati (ikona stanja „online“/„registriran“) in klici na številko začnejo zvoniti neposredno v njem.
3Odhodno klicanje prek odjemalca SIP
Ko je softphone registriran, lahko prek te linije sam kliče navzven - za to ni treba klicati nobenega našega API-ja, kličete neposredno iz odjemalca kot z navadne telefonske linije.
Minute gredo z dobroimetja volai
Odhodno klicanje prek odjemalca SIP se zaračuna po enaki tarifi kot odhodni klic prek API-ja (0,92 kr/min (≈ 0,04 EUR)) in se odbije z vašega dobroimetja - ne z kakšnega ločenega računa SIP. Tarife so brez DDV, kot ves cenik.
Povezava poteka neposredno med vašim odjemalcem in strežnikom sip.volai.cz, ne prek našega API-ja, zato minut ni mogoče blokirati natanko v trenutku izbiranja. Klic, izbran neposredno iz odjemalca SIP, se zaračuna naknadno iz zapisov omrežja - najprej 10 minut po koncu, običajno v pol ure - in se na dobroimetju ne pokaže v trenutku izbiranja. Dnevna omejitev klicev in preverjanje dobroimetja ob izbiranju za te klice ne veljata, ker nadzorujeta samo klice prek API-ja - dobroimetje lahko zato pade pod nič. Ko dobroimetje pade na nič, se nova plačljiva dejanja prek API/MCP začnejo zavračati (klic potrebuje stanje najmanj 5 CZK). Ko stanje pade pod ničlo, se dostop SIP za linijo v nekaj minutah izklopi, preusmeritev se odklopi in prejmete e-pošto; ko dobroimetje napolnite vsaj na 5 CZK, se vse samodejno nadaljuje in geslo ostane enako. Če se dolg v tednu dni ne izravna, se številka sprosti nazaj v zalogo (s tem dostop SIP dokončno preneha). Dobroimetje zato spremljajte vnaprej, ne šele pri nič.
Imate glasovnega agenta z umetno inteligenco, ne softphona?
Ta korak računa z odjemalcem, ki se zna na linijo registrirati (SIP REGISTER) - softphone, PBX. Platforma, ki klic samo enkratno overjeno odda brez trajne registracije (običajno glasovni agenti z umetno inteligenco, kot je ElevenLabs), potrebuje drug postopek - glejte Lasten agent.
Naslov odhodnega trunka platforme vzemite iz polja outboundTrunkAddress, ne iz strežnika zgoraj - podrobno na tej strani.
4Omejitve
- Ena registracija na linijo - en komplet prijavnih podatkov prenese eno registrirano napravo hkrati. Če se prijavite z drugim odjemalcem, prvi registracijo verjetno izgubi - ne zanašajte se na več naprav hkrati na eni liniji.
- Odhodno z lastnega agenta da, polno peerjanje trunka ne - prijavni podatki linije so namenjeni temu, da se VAŠ odjemalec registrira pri NAS kot telefon. Odhodni klici z lastnega glasovnega agenta (ElevenLabs ali druga platforma) pa danes GREDO - prek releja, glejte Lasten agent. Še vedno pa ni mogoče priključiti vaše centrale kot enakovrednega operaterja z lastnim usmerjanjem DOHODNIH klicev od zunaj - za to uporabite usmerjanje
forwardna številko vaše centrale. - Samo glas - brez videa ali drugih razširitev SIP.
Sorodno
API REST
Popolna referenca vseh končnih točk: številke, klici, SMS, mobilne številke za SMS, agenti in njihovi osnutki, orodja, posnetki, webhooki, seznam »ne kliči«, relay, račun, naloge, dobroimetje, dokumenti, koledarji in integracije.
Glasovni agent
Sistemski poziv, orodja, predaja človeku, posnetki in strukturirani podatki klica.
Prinesite svojega agenta
Povežite platformo tretje osebe (ElevenLabs, Asterisk ...) - brez doplačila za agenta.