Ügynökfolyam

Áttekintés

Az Agent Stream egy WebSocket endpoint, amely lehetővé teszi a telefonos szolgáltató számára, hogy media streamjét egyetlen URL-re irányítsa, és egy IntraCord-ügynököt futtasson. Az URL-ben szereplő ügynök UUID-je kiválasztja az ügynököt, a szolgáltató elérési út szegmense pedig a streaming protokollt. A szolgáltató-specifikus azonosítók magából a stream protokollból származnak. A Cloudonix esetében az IntraCord beolvassa a tartományt a start.accountSid mezőből, majd az egyező tárolt telefóniai beállítást használja a munkamenet érvényesítésére és a szolgáltatói API-hívások kiadására (megszakítás, átvitel) a hívás során.

Ez akkor hasznos, ha:

• Olyan SIP-átjáróba vagy házon belüli tárcsázóba integrálja az IntraCordot, amely már beszéli a támogatott szolgáltató streaming protokollját.
• Ügynökönként egy stabil endpointot szeretne, ahelyett, hogy telefonszámonként bejövő webhookot kötne be

!

Az Agent Stream jelenleg csak a Cloudonix szolgáltatót támogatja. Más szolgáltatók adja vissza a NotImplementedError-t, amíg a szolgáltatónkénti megvalósítás meg nem érkezik. Ha te Twilio, Plivo, Telnyx, Vonage, ARI vagy más szolgáltatóra van szüksége, kérjük, nyissa meg a kérés a [GitHub Discussions] oldalon (https://github.com/IntraCord-hq/IntraCord/discussions) használati esetével.

Endpoint

wss://api.IntraCord.com/api/v1/agent-stream/{provider}/{agent_uuid}

A {provider} a regisztrált szolgáltató neve, jelenleg cloudonix. A {agent_uuid} az ügynök stabil UUID-je (lásd alább a Az ügynök UUID azonosítójának lekérése részt). Saját üzemeltetésű központi telepítések esetén cserélje ki a api.IntraCord.com fájlt a háttérgazdagépére.

Előfeltételek

• Az IntraCord ügynök (workflow) – közzétett vagy piszkozatban – megfelelő
• Egy Cloudonix telefóniai beállítás az Ön IntraCord-szervezetében, amelynek domain_id-je megegyezik a Cloudonix által a start üzenetfolyamban elküldött accountSid-vel. Az IntraCord az ebből a konfigurációból származó bearer tokent használja a hívási munkamenet érvényesítésére és a szolgáltatói API-hívások kibocsátására (hangup, transfer).

Szerezze be az ügynök UUID-jét

Az ügynök UUID a workflow stabil azonosítója – a verziók közzétételekor nem változik.

A felhasználói felületen való megkereséséhez és másolásához lásd: Ügynök UUID.

Csatlakozzon a WebSockethez

Útvonal paraméterei

Param	Kötelező	Leírás
provider	Igen	Szolgáltató neve. Jelenleg csak a cloudonix támogatott.
agent_uuid	Igen	A futtatandó IntraCord ügynök stabil UUID-je.

Cloudonix példa

wss://api.IntraCord.com/api/v1/agent-stream/cloudonix/{agent_uuid}

Használja ezt az URL-t a CXML <Stream>-ben a Cloudonix Voice Application visszatér, ha a hívást át kell hidalni az IntraCord ügynökhöz:

<?xml version="1.0" encoding="UTF-8"?>
<Response>
  <Connect>
    <Stream url="wss://api.IntraCord.com/api/v1/agent-stream/cloudonix/{agent_uuid}"/>
  </Connect>
  <Pause length="40"/>
</Response>

A socket első két üzenetének a Cloudonix szabványos connected és start eseményének kell lennie, Twilio-kompatibilis keretezéssel. Az IntraCord a start esemény törzséből kiolvassa a streamSid, callSid, session, accountSid, from, to, context, tracks és mediaFormat mezőket. Az accountSid alapján megkeresett telefóniai beállítás Bearer tokenjével ellenőrzi a Cloudonix-munkamenetet, majd megkezdi a audio streamingjét.

A workflow futásának életciklusa

Amikor a WebSocket elfogadásra kerül, IntraCord:

1. Megkeresi a agent_uuid workflow-ját
2. Kvótaellenőrzést futtat a workflow tulajdonosa felhasználójával szemben
3. Létrehoz egy új WorkflowRun (call_type=inbound, mode=cloudonix, név WR-AGS-XXXXXXXX)
4. A futást átállítja a running-re
5. Beolvassa és ellenőrzi a Cloudonix start üzenetet, majd lebélyegzi a from/to számokat a initial_context-en, a session-t pedig a session-ben session-ként tárolja a következőn: gathered_context, és rögzíti a accountSid számot a futás inbound_webhook naplójában
6. Elindítja az ügynökfolyamatot

A futás azonnal látható az ügynök Futások lapja alatt, amint elkészül, akárcsak egy bejövő vagy kimenő hívás.

Zárja be a kódokat

Kód	Ok
1008	Útválasztási hiba – ismeretlen szolgáltató, a workflow nem található, vagy a kvóta túllépve
1011	Szerveroldali hiba vagy nem támogatott szolgáltató az Agent Stream
4400	Szolgáltatói szintű kézfogási hiba – a cloudonix esetében hiányzik a start.accountSid, nincs egyező telefóniai beállítás, hiányzik a bearer token a konfigurációból, hibásan formázott connected/start események, vagy a munkamenet ellenőrzése sikertelen a Cloudonix ellen

Biztonsági megjegyzések

• Kezelje az URL-t titokként – maga az ügynök UUID engedélyezi a kapcsolatot. Tárolja és továbbítsa csak TLS-en keresztül, és kerülje a nyers URL naplózását olyan helyeken, ahol a hozzáférés szélesebb, mint a műveleti csapat.
• Az URL-ben nem adnak át bearer tokeneket vagy szolgáltatói titkokat. A szolgáltatói Credentials a tárolt telefóniai beállításban élnek (a start.accountSid Cloudonix esetén), és az IntraCord szerveroldali használatával ellenőrzi a munkamenetet és a szolgáltatói API-hívásokat.