Contacts


Základní popis

Lze použít libovolnou z níže nabízených metod.

Pro autorizaci použijte login a heslo uživatele platformy VOIPEX (naimportované kontakty jsou dostupné pro všechny uživatele ve společné organizaci)


Sekce dat každého importovaného kontaktuPopisPovinné údaje v dané sekci
pojmenování kontaktutyto údaje lze následně zobrazovat v CTI okně při příchozím hovoru a v panelech a statistikách callcentraje povinné uvedení alespoň jednoho z parametrů "lastName" nebo "firstName" nebo "organization"

telefonní a email kontaktní údaje

podle těchto údajů je vyhledáváno. Platnost telefonních čísel je kontrolována pomocí knihovny Googlei18n/libphonenumber (můžete si vaše čísla ověřit i pomocí API funkce /v3/contacts/validator/phone-number/{phoneNumber}je povinné alespoň jedno telefonní číslo. Minimálně musí být vždy vyplněno phone1
agenti pro obsluhu kontaktupomocí zde uložených značek lze dynamicky routovat hovory v IVR, více info v popisu nových funkcí iPBX 3.1.8 nejsou povinné žádné údaje
doplňující uživatelská poletyto údaje lze následně zobrazovat v CTI okně při příchozím hovorunejsou povinné žádné údaje



Import dat pomocí CURL

Tato metoda je preferována pro dávkový import. Nahrazuje dřívější metody importu pomocí FTP

Pokud nemáte na své stanici nebo serveru CURL klienta, můžete si jej stáhnout pro svůj OS z https://curl.haxx.se/download.html

Importem jsou předchozí data smazána a nahrazena novými

Import se při nalezení chyby nezastaví, naimportují se všechny řádky kde nebyla nalezena chyba a všechny chybné řádky jsou vypsány na standardní výstup


Ukázka formátu příkazového řádku

curl -X POST -H "Content-Type: multipart/form-data" -H "Authorization: Basic <auth>" --form file=@<filename> https://flow.voipex.io/v3/contacts/upload

V příkazovém řádku upravte :

  • <auth> - zadejte "login:heslo" uživatele platformy VOIPEX (celý tento řetězec je nutno zakódovat jako Base64, např. pro údaje novak:hesloNovak použijete bm92YWs6aGVzbG9Ob3Zhaw==  )
  • <filename> - název vašeho CSV souboru, např. import.csv (soubor může být do velikosti max 20MB)


Pro konverzi řetězce na Base64 string můžete použít developerskou konzoli vašeho browseru (doporučen Chrome, ale není podmínkou) :

  • Ve vašem browseru stisknětě CTRL-Shift-i nebo F12
  • Přepněte se na záložku Console
  • Na příkazové řádce napište btoa("novak:hesloNovak") 
  • V výpisu dostanete potřebný Base64 hash

Struktura CSV souboru

  • Telefoní čísla: musí být v mezinárodním formátu (řádek v csv obsahující nevalidní telefonní číslo podle /v3/contacts/validator/phone-number/{phoneNumber} nebude zpracován)
  • Kódování: utf-8 (diakritika je akceptována)
  • Omezení: Každý záznam musí obsahovat minimálně jedno telefoní číslo. CSV soubor musí obsahovat řádek s hlavičkou.
  • Rozšiřující Uri sloupce : Pokud jsou uvedeny, stanou se v CTI okně zobrazené údaje klikatelnými a je otevřeno okno na uvedený link. POZOR !!! Při použití rozšiřujících Uri sloupců důrazně doporučujeme uživatelům povolit Editor kontaktů jen s oprávněním "Pouze čtení". Při editaci kontaktu uživatelem dojde ke smazání nastavení Uri sloupců.
  • Sloupce :
    • firstName - jméno max 255 znaků (povinné pokud není uvedeno lastName nebo organzation)
    • lastName - příjmení  max 255 znaků (povinné pokud není uvedeno firstName nebo organization)
    • organization - název organizace max 255 znaků (povinné pokud není uvedeno firstName nebo lastName)
    • externalId - id záznamu v externím systému  max 255 znaků
    • email - platná emailová adresa 
    • phone1 - primární telefonní číslo ve formátu +420xxxxxxxxx (povinné vždy)
    • phone2 -  sekundární telefonní číslo 
    • agent1 - max 55 znaků
    • agent2 - max 55 znaků
    • customField1 -  max 55 znaků 
    • customField2 -  max 55 znaků 
    • customField3 - max 55 znaků  
    • customField4 -  max 55 znaků 
    • customField5 -  max 55 znaků 
    • customField6 -  max 55 znaků 
  • Rozšiřující sloupce (pokud jsou v importu uvedeny, jejich obsah je chápán jako uri adresa na které je otevřeno okno prohlížeče po kliknutí na hodnotu zobrazenou v CTI okně) :
    • nameUri
    • organizationUri
    • customField1Uri
    • customField2Uri
    • customField3Uri
    • customField4Uri
    • customField5Uri
    • customField6Uri


Vzor nejmenšího možného CSV souboru :

!!! POZOR !!! phone1 musí být vždy vyplněno jako primární kontaktní číslo !!!

lastName;phone1
"Novák";"+420222333444"


Vzor maximálního možného CSV souboru :

firstName;lastName;organization;externalId;email;phone1;phone2;agent1;agent2;customField1;customField2;customField3;customField4;customField5;customField6;organizationUri
"Jan";"Novák";"IPEX a.s.";"36936";"jan@novak.com";"+420222333444";"+420777711100";"22";"100";"VIP";"Mikuš";"Helpdesk";"323";"2000";"0";"https://nase.aplikace.cz/account/12123"
"Ivan";"Neúplný";;"1";;"+420222333444";"+420777711100";"22";"100";"VIP";"Mikuš";"Helpdesk";"323";"2000";"0";"https://nase.aplikace.cz/account/35873"

V uvedené ukázce jsou  např. customFields zamýšleny jako Důležitost, Obchodník, Technik, Středisko, Tržba a Dluh.

Na druhém řádku je ukázka formátu, pokud v některých sloupcích nejsou data předána (zůstanou jen dva středníky).


Informace o výsledku importu

  • Při úspěšném dokončení importu:
{ "message":"uploaded","error":"" }

Pokud je vráceno error: "" znamená to že nebyla nalezena žádná chyba.

Řádky, kde je reportována chyba NEJSOU naimportovány a je nutno import opakovat po opravě zdrojového csv souboru.

Řádek může být odmítnut i z důvodu, že importované číslo neodpovídá požadavkům mezinárodního formátu kontrolovaného výš uvedenou knihovnou.

  • Při chybě:
Error on line number x occured. <Error message>

V <Error message> bude popis konkrétní chyby.



Import pomocí platformy Integromat

Pro import pomocí Integromatu můžete použít připravený modul IPEX Update Contacts (zjednodušuje výrazně propojení systémů proti staršímu modulu IPEX - ImportContacts. POZOR nezaměňovat s modulem IPEX Update Contact, který provádí  update jen jediného kontaktu, zatímco Update Contacts provádí hromadný import/aktualizaci kontaktů)


Kontakty můžete exportovat z vašeho systému :

  • modulem na výpis kontaktů, pokud pro váš systém existuje v Integromatu podpora
  • modulem obecného HTTP požadavku, kterým si můžete zavolat REST API vašeho systému, čímž lze napojit téměř všechny systémy


Například pro načtení kontaktů ze služby People365 to lze zajistit následovně :


Kde v modulu IPEX Update Contacts provedete mapování výstupu z modulu Array aggregator a v něm si lehce nadefinujete položky, které chcete zobrazovat v CRM okně při příchozím hovoru a jako identitu v panelech a statistikách Callcentra  :

        

         

Místo modulu People365, můžete volat RESTAPI vašeho systému pomocí obecného modulu HTTP :


S nastavením a dalšími možnostmi vám poradí naši konzultanti.


Import dat pomocí REST API

Tato metoda je preferována pro import změn nebo postupný import velkého množství dat (předpokládá se naprogramování klienta na straně zákazníka)

Doporučená implementace by měla používat verzi v3/contacts  z dokumentace https://flow.voipex.io/documentation