CISCO Enterprise Chat and Email Developer's Guide to Web Teenuse kasutusjuhend
Ettevõtte vestluse ja meili arendaja juhend Web Vestluse teenuse API-d, väljalase 12.6(1)
Unified Contact Center Enterprise ja Package Contact Center Enterprise jaoks
Esmakordselt avaldatud: mai, 2021
Viimati värskendatud: märts 2023
Ameerika peakorter
Cisco Systems, Inc.
170 Tasmani lääneosa
San Jose, CA 95134-1706
USA
https://www.cisco.com
Tel: 408 526-4000
800 553-NETS (6387)
Faks: 408 527-0883
KÄESOLEVA JUHENDI SPETSIFIKATSIOONID JA TEAVE TOODETE KOHTA VÕIB TEATAMATA MUUTUDA. KÕIK SELLES JUHENDIS ESITATUD AVALDUSED, TEAVE JA SOOVITUSED ON TÄPSED, KUID ON ESITATUD ILMA MINGI OTSESE VÕI KAUDSE GARANTIITA. KASUTAJAD PEAVAD VÕTMA TÄIELIKULT VASTUTUSE MÕISTE TOODETE KASUTAMISE EEST.
TARKVARA LITSENTS JA KAASASOLEVA TOOTE PIIRATUD GARANTII ON ESITATUD TOOTEGA KAASAS SAANUD TEABEPAKETIS JA ON SELLE VIIDEGA SIIN SISALdatud. KUI TE EI TOHI LEIA TARKVARA LITSENTSI VÕI PIIRATUD GARANTIITI, VÕTKE KOopia saamiseks ühendust OMA CISCO ESINDAJAGA.
TCP päise tihendamise Cisco teostus on California ülikooli Berkeley (UCB) poolt välja töötatud programmi kohandamine UNIX-i operatsioonisüsteemi UCB üldkasutatava versiooni osana. Kõik õigused kaitstud. Autoriõigus © 1981, California ülikooli regents.
HOIATAMATA MISKIst MUIST SIIN OLEVAst GARANTIIST KÕIK DOKUMENT FILENENDE TARNIJATE TARKVARA JA TARKVARA ON KÕIGI RIKEDEGA PAKUSTATUD „NAGU ON”. CISCO JA ÜLALnimetatud TARNIJAD LAHTUMA LAHTI KÕIGIST VÄLJASELGETUD VÕI KAUDSETE GARANTIIDEST, KAASA arvatud PIIRAMATU KAUBANDUSVÕIME, KONKREETSEKS EESMÄRGIKS SOBIVUSE, USA VÕI MITTERIIKKUMISE, VÕI JUHTIMISE MITTERIKKUMISE GARANTIIDEST KAUBANDUSPRAKTIKA.
CISCO EGA SELLE TARNIJAD EI VASTUTA ÜHTEGI JUHUL ÜHTEGI KAUDSETE, ERILISTE, TAGAJÄRGSETE VÕI JUHUSLIKKE KAHJUDE EEST, SEALHULGAS PIIRAMATU KAOTATUD KASUMID VÕI ANDMEKAHJUD VÕI KAHJUD, MIS TEKKINUD KASUTAMISEGA KASUTAMISEKS. ISEGI KUI CISCOt VÕI SELLE TARNIJAT ON SELLISTE KAHJUDE VÕIMALUSEST TEAVITATUD.
Käesolevas dokumendis kasutatud Interneti-protokolli (IP) aadressid ja telefoninumbrid ei ole mõeldud tegelikeks aadressideks ja telefoninumbriteks. Igasugune eksamples, käsu kuva väljund, võrgu topoloogia diagrammid ja muud dokumendis sisalduvad joonised on näidatud ainult illustratiivsel eesmärgil. Tegelike IP-aadresside või telefoninumbrite kasutamine illustratiivses sisus on tahtmatu ja juhuslik.
Cisco ja Cisco logo on Cisco ja/või tema sidusettevõtete kaubamärgid või registreeritud kaubamärgid USA-s ja teistes riikides. To view Cisco kaubamärkide loend, minge aadressile https://www.cisco.com/go/trademarks. Mainitud kolmandate isikute kaubamärgid on nende vastavate omanike omand. Sõna partner kasutamine ei tähenda partnerlussuhet Cisco ja ühegi teise ettevõtte vahel. (1110R)
Ettevõtte vestluse ja meili arendaja juhend Web Vestluse teenuse API-d: Unified Contact Center Enterprise ja Package Contact Center Enterprise jaoks. 8. jaanuar 2019 © 2016–2021 Cisco Systems, Inc. Kõik õigused kaitstud.
Tere tulemast ettevõtte vestluse ja e-posti (ECE) funktsiooni, mis pakub mitmekanalilist suhtlustarkvara, mida ettevõtted üle kogu maailma kasutavad Unified Contact Center Enterprise tootesarja põhikomponendina. ECE pakub valdkonna parimate rakenduste ühtset komplekti vestluse ja e-posti suhtluse haldamiseks, et võimaldada segaagenti web vestlus, meili- ja häälsuhtlus.
Teave selle juhendi kohta
Arendajate juhend Web Teenuse APIs for Chat kirjeldab, kuidas kliendid saavad vestlust kasutada Web Teenuste API-d, et kuvada nendel vestluse link web saidid, mis põhinevad järjekorra sügavusel ja agentide saadavusel uute vestluste haldamiseks.
Kogu Cisco dokumentatsiooni uusimad versioonid leiate veebist aadressil https://www.cisco.com
| Teema |
Link |
| Enterprise Chati ja e-posti täielik dokumentatsioon nii Cisco Unified Contact Center Enterprise (UCCE) kui ka Cisco Packaged Contact Center Enterprise (PCCE) jaoks | https://www.cisco.com/c/en/us/support/customer-collaboration/cisco-enterprise-chat- email/tsd-products-support-series-home.html |
Side, teenused ja lisateave
- Cisco õigeaegse ja asjakohase teabe saamiseks registreeruge Cisco Pro'sfile Juht.
- Et saada oluliste tehnoloogiatega soovitud ärimõju, külastage Cisco teenuseid.
- Teenusetaotluse esitamiseks külastage Cisco tugiteenust.
- Turvaliste, valideeritud ettevõtteklassi rakenduste, toodete, lahenduste ja teenuste avastamiseks ja sirvimiseks, külastage Ciscot Turg.
- Üldiste võrgustike loomise, koolituse ja sertifikaadi tiitlite saamiseks külastage Cisco Pressi.
- Konkreetse toote või tooteperekonna garantiiteabe leidmiseks avage juurdepääs Cisco garantiiotsija
Cisco veaotsingu tööriist
Cisco veaotsingu tööriist (BST) on a webpõhinev tööriist, mis toimib väravana Cisco vigade jälgimise süsteemi, mis haldab Cisco toodete ja tarkvara defektide ja haavatavuste põhjalikku loendit. BST pakub teile üksikasjalikku teavet teie toodete ja tarkvara defektide kohta
Väljahoiatused ja väljateated
Cisco tooteid võidakse muuta või võtmeprotsesse võib pidada oluliseks. Nendest teatatakse Cisco Field Alerts ja Cisco Field Notices abil. Väljahoiatuste ja väljateadete saamiseks saate registreeruda saidi Cisco.com tootehoiatustööriista kaudu. See tööriist võimaldab teil luua professionaalifile teadaannete saamiseks valides kõik huvipakkuvad tooted.
Logi sisse www.cisco.com ja seejärel pääsete tööriista juurde aadressil https://www.cisco.com/cisco/support/notifications.html
Dokumentatsiooni tagasiside
Oleme teie kommentaaride eest tänulikud.
Dokumendi konventsioonid
See juhend kasutab järgmisi tüpograafilisi tavasid.
| konventsioon | Näitab |
| Kursiiv | Rõhuasetus. Või avaldatud dokumendi pealkiri. |
| Paks | Kasutajaliidese üksuste sildid, nagu nupud, kastid ja loendid. Või tekst, mille peab kasutaja ise sisestama. |
| Monoruum | A nimi file või kaust, andmebaasitabeli veerg või väärtus või käsk. |
| Muutuv | Kasutajaspetsiifiline tekst; on kasutajate või installatsioonide lõikes erinev. |
Sissejuhatus
Enterprise Chati ja E-posti kliendid saavad vestlust kasutada Web Teenuste API-d, et kuvada nendel vestluse link web saidid, mis põhinevad agentide saadavusel uute vestluste haldamiseks. API-sid saab kasutada järgmistel eesmärkidel:
- Nupu Vestlus lubamiseks või keelamiseks web saidid olenevalt saadaolevatest agentidest.
- Et saada aega, kui kaua klient peab ootama, enne kui agent on vestluseks saadaval.
- Et leida kliendi asukoht järjekorras, et hinnata, kui kaua võib klient oodata, enne kui agent on vestluseks saadaval.
- Täiendavate andmete kogumiseks kirjutage vestlusseansside jaoks uusi kohandatud küsitlusi.
API juurutamine järgib REST-põhiste API-de standardeid ja annab anonüümse juurdepääsu. API tagastab andmed XML-vormingus.
Toetatud versioonid
- ECE 12.6(1)
- ECE 12.5(1)
Skeemi definitsioonid
Aastal kasutatud skeemi määratlused web teenused on saadaval XSD-vormingus files jaotuses. Skeemi definitsioonide eraldamiseks saate kasutada tööriista PackIt. Need asuvad e-teenuses. kõrva file asukohas
lib/int/egpl_application_server.jar/com/egain/live/framework/bosh/xsd.
Kuva vestlusvalik, mis põhineb agendi saadavusel
Kontrollige, kas on olemas agente (määratletud kui Agent Console'is märgitud ruut Vestluse jaoks saadaval), kes saavad käsitleda vestlusi, mis algavad konkreetsest sisenemispunktist. Kasutage seda API-d, et otsustada, kas kuvada või peita vestluslingi websaidi agentide saadavuse alusel.
Taotlus
Agendi saadavuse kontrollimise taotlusel on järgmine vorm:
| meetod | URL |
| SAADA | /egain/chat/entrypoint/agentAvailability/id |
URL PARAMEETRID
| Nimi | Kirjeldus | Tüüp | Nõutav | Vaikeväärtus valikulised parameetrid |
| ID | Sisendpunkti ID, mille agendi saadavust soovite kontrollida. | pikk | Jah |
TAOTLE PÄISED
Ei kohaldata.
TAOTLUSE OSA
Mitte ühtegi
XSD FOR REQUEST BODY
Ei kohaldata.
SAMPLE REQUEST XML
Ei kohaldata.
Vastus
Vastus sisaldab HTTP olekukoodi ja vastuse keha.
OLEKOODID
Edukoodid:
200: Agendi saadavuse olek tagastatakse. Tõene vastus tähendab, et agent on saadaval. Vale vastus tähendab, et agent pole saadaval.
Veakoodid:
- 500: Agendi saadavuse teavet ei saa tuua.
VASTUSE PÄISED
Ei kohaldata.
VASTUSE KEHA
HTTP/1.1 200 OK
<agentAvailability available=”true” xmlns: ns2=” http://bindings.egain.com/chat ” xmlns: ns4=”urn:ietf:params: xml:ns:xmpp-stanzas” xmlns: ns3=” jabber:client” xmlns:ns5=”http://jabber.org/protocol/httpbind “/>
XSD FOR RESPONSE BODY
XML-skeem on määratletud faili eGainBosh.xsd sõlmes agentAvailability file.
Kuva vestlusvalik, mis põhineb agendi võimsusel vestluste jaoks
Hangib kõigi agentide suutlikkuse, et töötada antud sisenemispunktiga vastendatud järjekorras olevate uute vestlustegevustega.
See API tagastab erinevuse kõigi agentide vastuvõetava maksimaalse koormuse ja kõigi sisenemispunkti järjekorras olevate agentide praeguse koormuse vahel. Kasutage seda API-d, et otsustada kuvada nuppu Vestlus või pakkuda klientidele uusi vestlusi ainult siis, kui on saadaval agendid, kes saavad rohkem tööd teha.
Taotlus
Agendi suutlikkuse kontrollimise taotlus on järgmisel kujul:
| meetod | URL |
| SAADA | /egain/chat/entrypoint/capacity/id |
URL PARAMEETRID
| Nimi | Kirjeldus | Tüüp | Nõutav | Vaikeväärtus valikulised parameetrid |
| ID | Sisendpunkti ID, mille agendi võimsust soovite kontrollida. | pikk | Jah |
TAOTLE PÄISED
Ei kohaldata.
TAOTLUSE OSA
Ei kohaldata.
XSD FOR REQUEST BODY
Ei kohaldata.
SAMPLE REQUEST XML
Ei kohaldata.
Vastus
Vastus sisaldab HTTP olekukoodi ja vastuse keha.
OLEKOODID
Edukoodid:
- 200: Sisenemispunkti järelejäänud agentide maht tagastatakse. Positiivne arv näitab järelejäänud võimsust. Null tähendab, et süsteemis pole ühtegi agenti või kõik agendid töötavad maksimaalse koormusega.
Veakoodid:
- 500: Teavet ei saa hankida.
VASTUSE PÄISED
Ei kohaldata.
VASTUSE KEHA
Väljund genereeritakse XML-vormingus.
HTTP/1.1 200 OK
<availableSlots xmlns: ns1.0=”http://bindings.egain.com/chat “
xmlns: ns4=”urn:ietf:params: xml:ns:xmpp-stanzas” xmlns: ns3=”jabber:klient”
xmlns:ns5=” http://jabber.org/protocol/httpbind “> 2
XSD FOR RESPONSE BODY
XML-skeem on määratletud faili eGainBosh.xsd sõlmes availableSlots file.
Kuva vestlusvalik järjekorra sügavuse ja ooteaja põhjal
Hankige üksikasju määramise järjekorras ootavate vestluste arvu ja eeldatava ooteaja kohta järjekorras.
Kasutage seda API-d, et otsustada, kas kuvada või peita vestluslingi websaidi ooteaja ja järjekorras olevate vestluste arvu põhjal.
Tagastatud ooteaja väärtust mõõdetakse sekundite arvus. See väärtus põhineb keskmisel viivitusajal, mis kulub viimase 20 tegevuse jaoks agendile määramiseks ja millal agent klõpsab tegevusel, et sellega tööd alustada. See võtab arvesse nii järjekorras ootamise aega kui ka agendi postkastis veedetud aega, enne kui agent vestluse kaudu kliendiga ühenduse loob.
Taotlus
Järjekorra ooteaja ja järjekorras olevate vestluste arvu kontrollimise taotlusel on järgmine vorm:
| meetod | URL |
| SAADA | /egain/chat/entrypoint/liveSessionStatus/id |
URL PARAMEETRID
|
Nimi |
Kirjeldus | Tüüp | Nõutav | Vaikeväärtus valikulised parameetrid |
| ID | Selle sisestuspunkti ID, mille järjekorra sügavust ja ooteaega soovite kontrollida. | pikk | Jah |
TAOTLE PÄISED
Ei kohaldata.
TAOTLUSE OSA
Ei kohaldata.
XSD FOR REQUEST BODY
Ei kohaldata.
SAMPLE REQUEST XML
Ei kohaldata.
Vastus
Vastus sisaldab HTTP olekukoodi ja vastuse keha.
OLEKOODID
Edukoodid:
200: Järjekorra sügavus ja ooteaeg tagastatakse.
Veakoodid:
- 500: Järjekorra sügavust ja ooteaega ei saa tuua.
VASTUSE PÄISED
Ei kohaldata.
VASTUSE KEHA
Väljund genereeritakse XML-vormingus.
HTTP/1.1 200 OK
<sessionStatus xmlns: ns2=”http://bindings.egain.com/chat“
xmlns: ns4=”urn:ietf:params: xml:ns:xmpp-stanzas” xmlns: ns3=”jabber:klient” xmlns:ns5=”http://jabber.org/protocol/httpbind“>
<ns2:waitTime>3.0</ns2:waitTime> <ns2:queueDepth>1</ns2:queueDepth>
XSD FOR RESPONSE BODY
XML-skeem on määratletud faili eGainBosh.xsd sõlmes sessionStatus file.
Kuva vestlusvalik järjekorra sügavuse ja agendi saadavuse põhjal
Kontrollib vestluse sisenemispunkti sobivust uute vestlustegevuste käsitlemiseks järgmistel tingimustel.
- Kui on saadaval agente, kes tegelevad uute vestlustegevustega.
- Kui selle sisenemispunktiga seotud järjekord on saavutanud oma konfigureeritud maksimaalse sügavuse, st järjekorras töödeldavate vestluste koguarv on võrdne vestluste maksimaalse arvuga, mida järjekord võib mingil ajahetkel töödelda.
Kasutage seda API-d, et otsustada, kas kuvada või peita vestluslingi websaidil, mis põhineb agendi saadavusel ja sellel, kas antud sisestuspunktiga seotud järjekord suudab rohkem vestlusi vastu võtta.
Taotlus
Taotlus vestluse sisenemispunkti sobivuse kontrollimiseks on järgmisel kujul:
| meetod | URL |
| SAADA | /egain/chat/entrypoint/checkEligibility/id |
URL PARAMEETRID
|
Nimi |
Kirjeldus | Tüüp | Nõutav | Vaikeväärtus valikulised parameetrid |
| ID | Sisendpunkti ID, mida soovite kontrollida. | pikk | Jah |
TAOTLE PÄISED
Ei kohaldata.
TAOTLUSE OSA
Ei kohaldata.
XSD FOR REQUEST BODY
Ei kohaldata.
SAMPLE REQUEST XML
Ei kohaldata.
Vastus
Vastus sisaldab HTTP olekukoodi ja vastuse keha.
OLEKOODID
Edukoodid:
- 200: Sisenemispunkti sobivus tagastatakse. See tuvastatakse atribuudi responseType väärtuse järgi. Sellel atribuudil võib olla üks järgmistest väärtustest:
- 0: Selle sisenemispunktiga seotud järjekord saab käsitleda uusi vestlusi.
- 1: Uute vestluste kallal töötamiseks pole agenti saadaval.
- 2: Antud sisestuspunktiga seotud järjekorra maksimaalne sügavus on saavutatud ja uusi vestlusi ei töödelda.
- 3: Integreeritud agent CTL on saavutatud.
Veakoodid:
- 500: Vestluse sisenemispunkti sobivust ei saa tuua.
VASTUSE PÄISED
Ei kohaldata.
VASTUSE KEHA
Väljund genereeritakse XML-vormingus.
HTTP/1.1 200 OK
<checkEligibility xmlns: ns2=”http://bindings.egain.com/chat“
xmlns: ns4=”urn:ietf: params: xml:ns:xmpp-stanzas” xmlns: ns3=”jabber:klient” xmlns: ns5=”http://jabber.org/protocol/httpbind” responseType=0 />
XSD FOR RESPONSE BODY
XML-skeem on määratletud faili eGainBosh.xsd sõlmes checkEligibility file.
Kuva vestlusvalik järjekorra sügavuse, agendi saadavuse ja sisenemispunkti oleku põhjal
Kontrollib, kas antud vestluse sisenemispunkt saab uusi vestlusi töödelda järgmistel tingimustel:
- Vestluse sisenemispunkt on aktiivne.
- Kui on saadaval agente, kes tegelevad uute vestlustegevustega.
- Kui selle sisenemispunktiga seotud järjekord on saavutanud oma konfigureeritud maksimaalse sügavuse, st järjekorras töödeldavate vestluste koguarv on võrdne vestluste maksimaalse arvuga, mida järjekord võib mingil ajahetkel töödelda.
Kasutage seda API-d, et otsustada, kas kuvada või peita vestluslingi websaidi, mis põhineb vestluse sisenemispunkti olekul, agendi saadavusel ja sellel, kas antud sisestuspunktiga seotud järjekord suudab rohkem vestlusi vastu võtta.
Taotlus
Taotlus kontrollida, kas vestluse sisenemispunkt saab uusi vestlusi töödelda, on järgmisel kujul:
| meetod | URL |
| SAADA | /egain/chat/entrypoint/chatAllowed/id |
URL PARAMEETRID
| Nimi | Kirjeldus | Tüüp | Nõutav | Vaikeväärtus valikulised parameetrid |
| ID | Sisendpunkti ID, mida soovite kontrollida. | pikk | Jah |
TAOTLE PÄISED
Ei kohaldata.
TAOTLUSE OSA
Ei kohaldata.
XSD FOR REQUEST BODY
Ei kohaldata.
SAMPLE REQUEST XML
Ei kohaldata.
Vastus
Vastus sisaldab HTTP olekukoodi ja vastuse keha.
OLEKOODID
Edukoodid:
- 200: Kui uusi vestlusi saab sisestuspunkti kaudu töödelda, tagastatakse. See tuvastatakse lubatud atribuudi väärtuse järgi. Sellel atribuudil võib olla väärtus tõene või väär. Kui see on tõsi, tähendab see, et see sisenemispunkt suudab uusi vestlusi hallata. Kui see on vale, tähendab see, et see sisenemispunkt ei saa uusi vestlusi hallata. Kui väärtus on väär, võib atribuudi põhjus olla üks alltoodud väärtustest, et tuvastada põhjus, kui see pole saadaval:
- queue_depth_reached: antud sisenemispunktiga seotud järjekorra maksimaalne sügavus on saavutatud ja uut vestlust ei töödelda.
- agent_not_available: Agent pole uue vestlusega töötamiseks saadaval.
- service_not_running: agendi määramise teenus ei tööta.
- invalid_entry_point: päringus edastatud sisestuspunkt ei kehti.
- enter_point_inactive: päringus edastatud sisestuspunkt ei ole aktiivne.
- Muu: see sisenemispunkt ei saa muudel põhjustel uusi vestlusi hallata.
Veakoodid:
- 500: Ei saa tuua, kas see sisenemispunkt suudab uusi vestlusi hallata.
VASTUSE PÄISED
Ei kohaldata.
VASTUSE KEHA
Väljund genereeritakse XML-vormingus.
HTTP/1.1 200 OK
<chatAllowed xmlns: ns1.0=”http://bindings.egain.com/chat”
xmlns: ns4=”urn:ietf:params: xml:ns:xmpp-stanzas” xmlns: ns3=”jabber:klient”
xmlns: ns5=”http://jabber.org/protocol/httpbind” enabled=”true”/>
OR
HTTP/1.1 200 OK
<chatAllowed xmlns: ns2=”http://bindings.egain.com/chat“
xmlns: ns4=”urn:ietf:params: xml:ns:xmpp-stanzas” xmlns: ns3=”jabber:klient”
xmlns: ns5=”http://jabber.org/protocol/httpbind” enabled=”false” reason=”entry_point_inactive”/>
XSD FOR RESPONSE BODY
XML-skeem on määratletud faili eGainBosh.xsd sõlmes chatAllowed file.
Esitage kohandatud vestlusuuringud
Seda API-t saab kasutada vestlusseansi lõpus kuvatavate kohandatud küsitlusvormide esitamiseks.
Taotlus
| meetod | URL |
| POSTITA | /egain/chat/entrypoint/survey |
URL PARAMEETRID
Ei kohaldata.
TAOTLE PÄISED
Ei kohaldata.
TAOTLUSE OSA
Päringu sisu peab olema XML-vormingus. Järgmises tabelis kirjeldatakse kohustuslikke ja valikulisi atribuute, mida saab uuringu esitamiseks kasutada.
| Nimi | Kirjeldus |
Tüüp |
Nõutav |
| küsimus | Küsimus, mis on osa kliendile kuvatavast küsitlusest. | String | Jah |
| Vastus | Vastus vastavale küsimusele. | String | Jah |
XSD FOR REQUEST BODY
XML-skeem on määratletud faili eGainSurvey.xsd sõlmes eGainSurvey file.
SAMPLE REQUEST XML
<egainSurvey sid=”1000_d15c6659-3c4b-41df-b2b5-7bacb60df4ld” xmlns=”http://bindings.egain.com/chat“> küsimus 1 Vastus 1 2. küsimus Vastus 2 3. küsimus Vastus 3 4. küsimus Vastus 4
Vastus
Vastus sisaldab HTTP olekukoodi.
OLEKOODID
Edukoodid:
- 204: Küsitlus on edukalt esitatud.
VASTUSE PÄISED
Ei kohaldata.
VASTUSE KEHA
Ei kohaldata.
XSD FOR RESPONSE BODY
Ei kohaldata.
Ettevõtte vestluse ja meili arendaja juhend Web Vestluse teenuse API-d
Dokumendid / Ressursid
 |
CISCO Enterprise Chat and Email Developer's Guide to Web Teenindus [pdfKasutusjuhend Ettevõtte vestluse ja meili arendaja juhend Web Teenuse, ettevõtte vestluse ja meili arendaja juhend Web Teenus, arendaja juhend Web Teenindus, juhend Web Teenindus, Web Teenindus |
