Daktela API Dokumentace

Příchozí hovor

Popis:

Každý příchozí hovor můžeme nechat projít přes volitelný kontext, kde můžeme změnit chování ústředny nebo notifikovat CRM systém. Vhodné například při potřebě získání nějaké informace ze CRM systému a následně na základě této informace změnit chování ústředny. Například pokud se potřebujeme při příchozím hovoru dotázat CRM systému na jméno firmy volajícího zákazníka a toto jméno firmy následně zobrazit na telefonu operátorům. Strategie vyzvánění ringall u fronty nemusí být vždy plně podporována.

Nastavení:

Rozklikneme Nastavení ústředny -> Volitelný context -> Systemový hook na Příchodu
Doplníme tento kód, kde VasCRMsystem.domain je adresa CRM systému, kterého se dotazujeme. Poslední parametr CRMAPI je jméno hash pole, které případně chceme naplnit.
AGI(notify_crm_api.agi,"https://VasCRMsystem.domain:port/path/script?callid=${CALLERID(num)}&dnd=${FROM_DID}","CRMAPI")
Pokud při volání vrátíte platnou JSON strukturu, která bude například vypadat takto
{"NAME":"Daktela s.r.o.", "ADDRESS":"Pod Krejcarkem 975"}
v rámci dialplanu můžete k vráceným hodnotám přistupovat jako hash pole
- ${HASH(CRMAPI,NAME)} - vrací hodnotu "Daktela s.r.o."
- ${HASH(CRMAPI,ADDRESS)} - vrací hodnotu "Pod Krejcarkem 975"

Vyzvánění na lince

Popis:

Každé vyzvánění na lince můžeme nechat projít přes volitelný kontext, kde můžeme změnit chování ústředny nebo notifikovat CRM systém. Vhodné například při potřebě notifikovat CRM systém o tom, že na klapce začína zvonit hovor s číslem volajícího. Strategie vyzvánění ringall u fronty nemusí být vždy plně podporována.

Nastavení:

Rozklikneme Nastavení ústředny -> Volitelný context -> Systemový hook při zvonění na lince
Doplníme tento kód, kde VasCRMsystem.domain je adresa CRM systému, kterého se dotazujeme. Poslední parametr CRMAPI je jméno hash pole, které případně chceme naplnit.
AGI(notify_crm_api.agi,"https://VasCRMsystem.domain:port/path/script?callerId=${CALLERID(num)}&calleeId=${FROM_DID}&line=${REAL_EXTEN}&idcall=${ID_CALL}&action=ringing","CRMAPI")
Pokud při volání vrátíte platnou JSON strukturu, která bude například vypadat takto
{"NAME":"Daktela s.r.o.", "ADDRESS":"Pod Krejcarkem 975"}
v rámci dialplanu můžete k vráceným hodnotám přistupovat jako hash pole
- ${HASH(CRMAPI,NAME)} - vrací hodnotu "Daktela s.r.o."
- ${HASH(CRMAPI,ADDRESS)} - vrací hodnotu "Pod Krejcarkem 975"

Zodpovězený hovor

Popis:

Každé zodpovězení hovoru na lince můžeme nechat projít přes volitelný kontext, kde můžeme změnit chování ústředny nebo notifikovat CRM systém. Vhodné například při potřebě notifikovat CRM systém o tom, že na klapce došlo k zodpovězení hovor s číslem volajícího. Strategie vyzvánění ringall u fronty nemusí být vždy plně podporována.

Nastavení:

Rozklikneme Nastavení ústředny -> Volitelný context -> Systemový hook při zodpovězení hovoru
Doplníme tento kód, kde VasCRMsystem.domain je adresa CRM systému, kterého se dotazujeme. Poslední parametr CRMAPI je jméno hash pole, které případně chceme naplnit.
AGI(notify_crm_api.agi,"https://VasCRMsystem.domain:port/path/script?callerId=${CALLERID(num)}&calleeId=${FROM_DID}&line=${REAL_EXTEN}&idcall=${ID_CALL}&action=answer","CRMAPI")
Pokud při volání vrátíte platnou JSON strukturu, která bude například vypadat takto
{"NAME":"Daktela s.r.o.", "ADDRESS":"Pod Krejcarkem 975"}
V rámci dialplanu můžete k vráceným hodnotám přistupovat jako hash pole
- ${HASH(CRMAPI,NAME)} - vrací hodnotu "Daktela s.r.o."
- ${HASH(CRMAPI,ADDRESS)} - vrací hodnotu "Pod Krejcarkem 975"

Zavěšený hovor

Popis:

Každé zavěšení hovoru můžeme nechat projít přes volitelný kontext, kde můžeme notifikovat CRM systém. Vhodné například při potřebě notifikovat CRM systém o tom, že na klapce došlo k ukončení hovoru s číslem volajícího. Strategie vyzvánění ringall u fronty nemusí být vždy plně podporována.

Nastavení:

Rozklikneme Nastavení ústředny -> Volitelný context -> Systemový hook při zavěšení hovoru
Doplníme tento kód, kde VasCRMsystem.domain je adresa CRM systému, kterého se dotazujeme. Poslední parametr CRMAPI je jméno hash pole, které případně chceme naplnit.
AGI(notify_crm_api.agi,"https://VasCRMsystem.domain:port/path/script?callerId=${CALLERID(num)}&calleeId=${FROM_DID}&line=${REAL_EXTEN}&idcall=${ID_CALL}&action=hangup","CRMAPI")
Pokud při volání vrátíte platnou JSON strukturu, která bude například vypadat takto
{"NAME":"Daktela s.r.o.", "ADDRESS":"Pod Krejcarkem 975"}
v rámci dialplanu můžete k vráceným hodnotám přistupovat jako hash pole
- ${HASH(CRMAPI,NAME)} - vrací hodnotu "Daktela s.r.o."
- ${HASH(CRMAPI,ADDRESS)} - vrací hodnotu "Pod Krejcarkem 975"

Vytvoření nebo editování fronty

Požadovaná verze: 3.0

Akce:

CreateQueue: Vytvoří novou frontu. Pokud číslo fronty už bude existovat, tak se fronta jen edituje podle nových parametrů.

Povinné parametry:

number: Číslo fronty
title: Jméno fronty
direction: Typ fronty příchozí nebo odchozí

Volitelné parametry:

id: ID fronty
outboundcid: Odchozí identifikace u odchozí fronty
description: Popisek fronty
wrapuptime: Délka zotavení na pauze WRAP po skončení hovoru
outbounder: Nastavíme pokud chceme vytvořit outbounder frontu

Ukázka použití:

Popis:

Vytvoříme novou odchozí navolávací frontu číslo 123456789 s názvem Support

Vstup:

https://MojeVU.daktela.com/api/3.1/CreateQueue/xml?access_token=1234567890123456789012345678901234567890&number=12345678&title=Support&direction=out&outbounder=true

Výstup:

{"status":1,"error":null,"result":null}

Informace o frontách

Požadovaná verze: 3.0

Akce:

GetQueues: Získá informace o vytvořených frontách Pokud není předané ID, tak se vrátí všechny fronty.

Volitelné parametry:

id: ID fronty, které nás zajímá.

Ukázka použití:

Popis:

Získáme informace o frontě s ID 3

Vstup:

https://MojeVU.daktela.com/api/3.0/GetQueues/3/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"queue":"3","name":"1002","title":"Outbounder","description":"","direction":"out","outboundcid":"","wrapuptime":"0","outbounder":"1","form":"0","missed":null,"options":"{\"type\":\"outbounder\",\"wrapuptime\":\"\",\"lajdaktime\":\"\",\"qa_form\":\"\",\"missed\":\"\",\"maxwait\":\"\",\"maxlength\":\"\",\"threshold_time\":\"\",\"threshold_users\":\"\",\"threshold_calls\":\"\",\"callback_callstart\":\"http:\\\/\\\/\",\"callback_callanswer\":\"http:\\\/\\\/\",\"callback_callend\":\"http:\\\/\\\/\",\"outboundcid\":\"\",\"allowed_time\":\"10:00-18:00|mon-fri|*|*\"}","deleted":"0","user":"1","penalty":"0","login":"manual"}}

Přihlášení uživatele do fronty

Požadovaná verze: 3.0

Akce:

LoginQueue: Přihlásí uživatele do fronty nebo kampaně, kterou specifikujeme číslem.

Povinné parametry:

user: Přihlašovací jméno agenta
queue: Číslo fronty nebo kampaně do které chceme uživatele přihlásit, pokud tam má právo

Volitelné parametry:

extension: Číslo klapky u které agent sedí. Tento parametr se nemusí specifikovat znovu, pokud uživatel už je aktuálně přihlášen v některé fronte.
priority: S jakou prioritou se má přihlásit do fronty. Povolené hodnoty od normální po nejnižší prioritu: 0, 1, 2. Pokud není specifikováno bere se priorita nastavená u uživatele k dané frontě. Tento parametr má smysl pouze u příchozí fronty.

Ukázka použití:

Popis:

Přihlásíme uživatele michalhajek do fronty 5001 s normální prioritou

Vstup:

https://MojeVU.daktela.com/api/3.0/LoginQueue/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&queue=5001&priority=0

Výstup:

{"error":null,"status":1}

Odhlášení živatele z fronty

Požadovaná verze: 3.0

Akce:

LogoutQueue: Odhlásí uživatele z fronty nebo kampaně, kterou specifikujeme číslem.

Povinné parametry:

user: Přihlašovací jméno agenta
queue: Číslo fronty nebo kampaně z které chceme uživatele odhlásit

Ukázka použití:

Popis:

Odhlásíme uživatele michalhajek z fronty 5001

Vstup:

https://MojeVU.daktela.com/api/3.0/LogoutQueue/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&queue=5001

Výstup:

{"error":null,"status":1}

Popis:

Pokus o odhlášení uživatele michalhajek z fronty 5000 v době, kdy agent vyřizuje na této frontě hovor.

Vstup:

https://MojeVU.daktela.com/api/3.0/LogoutQueue/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&queue=5000

Výstup:

{"error":"Nelze se odhlasit z fronty\/kampan\u011b, ve kter\u00e9 prob\u00edh\u00e1 hovor s \u010d\u00edslem 468008585","status":0}

Zodpovězení příchozího call centrového hovoru

Požadovaná verze: 3.7

Akce:

Answer: Automaticky vzdáleně zodpovíme příchozí hovor u operátora, který přišel z příchozi call centrové fronty a vyzvání na lince. Telefon operátora musí podporovat funkci auto answer.

Povinné parametry:

extension: Číslo klapky(skupiny) operátora, na které přichází hovor (nemusíme již vyplňovat povinný parametr user)
user: Přihlašovací jméno agenta, na kterého přichází hovor (nemusíme již vyplňovat povinný parametr extension)

Ukázka použití:

Popis:

U operátora s loginem hajek zvoní příchozí hovor a tento hovor chceme automaticky zodpovědět

Vstup:

https://MojeVU.daktela.com/api/3.7/Answer/json?access_token=1234567890123456789012345678901234567890&user=hajek

Výstup:

{"status":1,"error":null,"result":{"calling_number":"226211245","calling_queue":"2000","calling_queue_name":"Support","id_call":"14555781215.224"}}

Přehrání hlášky do probíhajícího hovoru

Požadovaná verze: 3.6

Akce:

ControlPlayback: Pokud na lince probíhá hovor, je možné na ní přehrát libovolnou hlášku, která je k dispozici na ústředně. Tuto hlášku uslyší interní klapka(operátor) tak i druhá strana(zákazník).

Povinné parametry:

extension

Číslo klapky, na které musí probíhat hovor (nemusíme již vyplňovat povinný parametr user)

user

Přihlašovací jméno agenta, který uskutečnuje probíhající hovor (nemusíme již vyplňovat povinný parametr extension)

command

Jaký příkaz se má provést

play - začne přehrávat hlášku
rewind - již přehrávanou hlášku je možné posunout zpět
pause - zapauzování přehrávané hlášky pro odpauzování se volá stejný příkaz
forward - již přehravanou hlášku je možné posunout dopředu
stop - ukončení již přehrávané hlášky
status - zjištění, zda se hláška jěště přehrává. Vrácene pole obsahuje položku playing, podle toho zda hláška probíhá(true) nebo ne(false).

Volitelné parametry:

recording: U příkazu play specifikujeme název nahrávky, kterou chceme přehrát. Seznam hlášek se spravuje v modulu Nastavení ústředny.
begintime: U příkazu play je možné specifikovat od jakého začátku v milisekundách se má začít přehrávat hláška
skiptime: Tuto volbu je třeba specifikovat u příkazu play a značí o kolik milisekund se má přeskočít přehrávání hlášky pokud dodatečně zavoláme příkazy rewind nebo forward

Ukázka použití:

Popis:

Na probíhajícím hovoru u linky 500 chceme přehrát hlášku, kterou uslyší i zákazník.

Vstup:

https://MojeVU.daktela.com/api/3.6/ControlPlayback/json?access_token=1234567890123456789012345678901234567890&command=play&extension=500&recording=Upozornujeme_ze_v_ramci_zkvalitneni_sluzeb_mohou_byt_hovory_monitorovany.wav

Výstup:

{"status":1,"error":null,"result":null}

Popis:

Probíhající hlášku z předchozího příkladu chceme pozastavit

Vstup:

https://MojeVU.daktela.com/api/3.6/ControlPlayback/json?access_token=1234567890123456789012345678901234567890&command=pause&extension=500

Výstup:

{"status":1,"error":null,"result":null}

Vytvoří odchozí call centrový hovor

Požadovaná verze: 3.1

Akce:

CreateCall: Vytvoří odchozí telefonní hovor s požadavkem na call centrum.

Povinné parametry:

user: Přihlašovací jméno agenta, který chce vytvořit hovor
number: Telefonní číslo na které chceme volat

Volitelné parametry:

accountcode: Jedinečný kód, který se nese celou dobu s hovorem
autoanswer: Pokud telefon podporuje automatické vyzvednutí hovoru, je možné tutu funkci použít. Výchozí stav je vypnuto.
waitingtime: Jak dlouho v sekundach má zvonit telefon u linky / extension. Výchozí stav: 30 sekund
dialingtime: Jak dlouho v sekundach má zvonit telefon u zákazníka. Výchozí stav: 120 sekund
idcall: ID podle kterého se dá nalézt CDR informace a nahrávka
agenttext: Textová informace, kterou uvidí agent na displeji svého telefonu během vytáčení hovoru.
queue: Číslo odchozí fronty, přes kterou chceme volat. Agent musí být přihlášen do CC. Pokud bude přihlášen do jiné odchozí fronty, hovor bude zaznamenán na frontu, která je v parametru.
ticket: Unikátní název ticketu

Ukázka použití:

Popis:

Odchozí hovor od uživatele michalhajek na veřejné číslo 800123456 a zapnutou funkcí auto answer

Vstup:

https://MojeVU.daktela.com/api/3.1/CreateCall/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&number=800123456&autoanswer=yes

Výstup:

{"error":null,"status":1,"result":{"id_call":"123456789.1234SJ"}}}

Popis:

Odchozí hovor od uživatele michalhajek na veřejné číslo 800123456 a zapnutou funkcí auto answer. Uživatel ale není přihlášen do odchozí fronty.

Vstup:

https://MojeVU.daktela.com/api/3.1/CreateCall/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&number=800123456&autoanswer=yes

Výstup:

{"error":"Agent nen\u00ed p\u0159ihl\u00e1\u0161en do odchoz\u00ed kampan\u011b\/fronty","status":0}

Vytvoření uživatele

Požadovaná verze: 4.0

Akce:

CreateUser: Vytvoří uživatele

Povinné parametry:

role: Unikátní identifikátor role
profile: Unikátní identifikátor profilu
name: Login uživatele
title: Jméno uživatele
password: Heslo uživatele

Volitelné parametry:

description: Popis uživatele
email: Email uživatele

Ukázka použití:

Popis:

Vytvoří uživatele s loginem 'operator1', jménem 'Pepa Novák', roli 'role_52f22ad1ba23e', profilem 'profile_530ca64179669' a heslem 'takneheslo'

Vstup:

https://MojeVU.daktela.com/api/4.0/CreateUser/json?access_token=12345678901234567890123456789012345678907&role=role_52f22ad1ba23e&profile=profile_530ca64179669&name=operator1&title=Pepa%20Novák&password=tajneheslo

Výstup:

{"status":1,"error":null,"result":{"user":4,"role":"role_52f22ad1ba23e","profile":"profile_530ca64179669","name":"operator2","title":"Pepa Nov\u00e1k","description":null,"password":"tajneheslo","email":null,"deleted":null}}

Smazání uživatele

Požadovaná verze: 3.0

Akce:

DeleteUser: Smaže uživatele s předaným id

Povinné parametry:

id: ID uživatele, který se ma smazat

Ukázka použití:

Popis:

Smažeme uživatele s ID 2

Vstup:

http://api.server/api/3.0/DeleteUser/2/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"error":null,"status":1}

Vrátí uživatele na základě tokenu

Požadovaná verze: 4.0

Akce:

GetUser: Najde uživatele podle tokenu

Ukázka použití:

Popis:

Získání uživatele podle access tokenu 1234567890123456789012345678901234567890

Vstup:

https://MojeVU.daktela.com/api/4.0/GetUser/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":""}

Popis:

Chybný stav při nesprávném access tokenu

Vstup:

https://MojeVU.daktela.com/api/4.0/GetUser/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"error":"Uživatel neexistuje","status":0}

Informace o uživatelích

Požadovaná verze: 3.0

Akce:

GetUsers: Získá informace o uživatelích Pokud není předané ID, tak se vrátí všichni uživatelé.

Volitelné parametry:

id: ID uživatele, který nás zajímá.
extension: Hledáme uživatele, který má svázanou interni, externí nebo skupinu napevno se svým účtem

Ukázka použití:

Popis:

Získaní všech uživatelů

Vstup:

http://api.server/api/3.0/GetUsers/xml?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"1":{"user":"1","role":"role_43h424k432","profile":"profile_hj34242342","name":"admin","title":"Administrator","description":"Administrator z\u00e1kazn\u00edka","password":"cordheslo","email":"jedna@jedna.cz","deleted":"0"},"3":{"user":"3","role":"role_43h424k432","profile":"profile_hj34242342","name":"hajekhu","title":"Hajek Hugo","description":"","password":"heslo","email":"","deleted":"0"}}}

Popis:

Získáme informace o uživateli s ID 2

Vstup:

https://MojeVU.daktela.com/api/3.0/GetUsers/3/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"user":"3","role":"role_43h424k432","profile":"profile_hj34242342","name":"hajekhu","title":"Hajek Hugo","description":"","password":"heslo","email":"","deleted":"0"}}

Zavěšení hovoru

Požadovaná verze: 3.0

Akce:

Hangup: Ukončení probihajícího hovoru. Stačí předat číslo linky nebo agenta.

Povinné parametry:

user: Přihlašovací jméno agenta (stačí jeden povinný parametr)
extension: Číslo klapky (stačí jeden povinný parametr)
call: Unikátní ID hovoru (stačí jeden povinný parametr)

Ukázka použití:

Popis:

Zavěšení hovoru u uživatele michalhajek

Vstup:

https://MojeVU.daktela.com/api/3.1/Hangup/json?access_token=1234567890123456789012345678901234567890&user=michalhajek

Výstup:

{"error":null,"status":1}

Popis:

Zavěšení hovoru u klapky 300

Vstup:

https://MojeVU.daktela.com/api/3.1/Hangup/json?access_token=1234567890123456789012345678901234567890&extension=300

Výstup:

{"error":null,"status":1}

Přihlášení uživatele do fronty

Požadovaná verze: 3.0

Akce:

LoginQueue: Přihlásí uživatele do fronty nebo kampaně, kterou specifikujeme číslem.

Povinné parametry:

user: Přihlašovací jméno agenta
queue: Číslo fronty nebo kampaně do které chceme uživatele přihlásit, pokud tam má právo

Volitelné parametry:

extension: Číslo klapky u které agent sedí. Tento parametr se nemusí specifikovat znovu, pokud uživatel už je aktuálně přihlášen v některé fronte.
priority: S jakou prioritou se má přihlásit do fronty. Povolené hodnoty od normální po nejnižší prioritu: 0, 1, 2. Pokud není specifikováno bere se priorita nastavená u uživatele k dané frontě. Tento parametr má smysl pouze u příchozí fronty.

Ukázka použití:

Popis:

Přihlásíme uživatele michalhajek do fronty 5001 s normální prioritou

Vstup:

https://MojeVU.daktela.com/api/3.0/LoginQueue/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&queue=5001&priority=0

Výstup:

{"error":null,"status":1}

Přihlášení uživatele do Call Centra

Požadovaná verze: 3.4

Akce:

Login: Předáme uživatelské jméno a číslo linky pod kterou chceme uživatele přihlásit do Call Centra. Pokud uživatel má definované automatické přihlášení do fronty, tak se provede automatické přihlašení do fronty. Jinak je třeba zavolat LoginQueue a přihlásit uživatele do front.

Povinné parametry:

user: Přihlašovací jméno agenta

Volitelné parametry:

extension: Číslo linky u které agent sedí. Pokud agent má svázanou linku se svým učtem, není potřeba předávat tuto linku.

Ukázka použití:

Popis:

Přihlásíme agenta michalhajek, který sedí u linky 100 do Call Centra

Vstup:

https://MojeVU.daktela.com/api/3.4/Login/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&extension=100

Výstup:

{"status":1,"error":null,"result":null}

Odhlášení živatele z fronty

Požadovaná verze: 3.0

Akce:

LogoutQueue: Odhlásí uživatele z fronty nebo kampaně, kterou specifikujeme číslem.

Povinné parametry:

user: Přihlašovací jméno agenta
queue: Číslo fronty nebo kampaně z které chceme uživatele odhlásit

Ukázka použití:

Popis:

Odhlásíme uživatele michalhajek z fronty 5001

Vstup:

https://MojeVU.daktela.com/api/3.0/LogoutQueue/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&queue=5001

Výstup:

{"error":null,"status":1}

Popis:

Pokus o odhlášení uživatele michalhajek z fronty 5000 v době, kdy agent vyřizuje na této frontě hovor.

Vstup:

https://MojeVU.daktela.com/api/3.0/LogoutQueue/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&queue=5000

Výstup:

{"error":"Nelze se odhlasit z fronty\/kampan\u011b, ve kter\u00e9 prob\u00edh\u00e1 hovor s \u010d\u00edslem 468008585","status":0}

Odhlášení uživatele z Call Centra

Požadovaná verze: 3.4

Akce:

Logout: Předáme uživatelské jméno agenta, kterého chceme odhlásit ze všech přihlášených front a z call centra. Dojde tak k uvolnení linky u které agent sedi.

Povinné parametry:

user: Přihlašovací jméno agenta

Ukázka použití:

Popis:

Odhlásíme agenta michalhajek z Call Centra

Vstup:

https://MojeVU.daktela.com/api/3.4/Logout/json?access_token=1234567890123456789012345678901234567890&user=michalhajek

Výstup:

{"status":1,"error":null,"result":null}

Příposlech call centrového hovoru

Požadovaná verze: 3.1

Akce:

Monitoring: Online příposlech probíhajícího hovoru s požadavkem na call centre

Povinné parametry:

user: Přihlašovací jméno operátora, kterého chceme poslouchat
listener: Číslo klapky, kde chceme poslouchat hovor
mode: Jaký typ příposlechu má být zvolen spy - listener nemůže mluvit s exten ani se zákazníkem (pouze poslouchá) whisper - listener může mluvit s exten, ale zákazník to neslyší (listener slyší zákazníka) whisperprivate - listener může mluvit s exten, ale zákazník to neslyší (listener neslyší zákazníka) barge - listener může mluvit s exten i se zákazníkem (všichni se slyší) interactive - přepínání mezi módy pomocí DTMF klávesnice telefonu 4=spy(výchozí), 5=whisper, 6=barge

Ukázka použití:

Popis:

Příposlech hovoru, kdy listener může mluvit s klapkou, ale zákazník listenera neuslyší

Vstup:

https://MojeVU.daktela.com/api/3.0/Monitoring/json?access_token=1234567890123456789012345678901234567890&user=hajekhu&listener=200&mode=spy

Výstup:

{"status":1,"error":null,"result":{"calling_direction":"out","calling_number":"468008585","calling_queue":"1006","calling_queue_name":"ObycOdchozi","ringing":"2","billsec":"177"}}

Zrušení pauzy u uživatele

Požadovaná verze: 3.0

Akce:

PauseOff: Zrušíme uživateli v call centru nastavenou pauzu

Povinné parametry:

user: Přihlašovací jméno agenta (nemusíme již vyplňovat povinný parametr extension)
extension: Číslo klapky agenta (nemusíme již vyplňovat povinný parametr user)

Ukázka použití:

Popis:

Odhlásíme z pauzy uživatele michalhajek

Vstup:

https://MojeVU.daktela.com/api/3.0/PauseOff/json?access_token=1234567890123456789012345678901234567890&user=michalhajek

Výstup:

{"error":null,"status":1}

Nastavení pauzy u uživatele

Požadovaná verze: 3.0

Akce:

PauseOn: Nastavíme uživateli v call centru danou pauzu v případě že neuskutečnuje žádný hovor Pokud na pauze už je, dojde k přenastavení na konkrétní pauzu

Povinné parametry:

user: Přihlašovací jméno agenta (nemusíme již vyplňovat povinný parametr extension)
extension: Číslo klapky agenta (nemusíme již vyplňovat povinný parametr user)
pause: Na jaké ID pauzy přepneme uživatele

Volitelné parametry:

force: Pokud je nastaveno na yes, tak se pauza nastaví i v případě, že agent zvoní, hovoří nebo je na on holdu. Výchozí stav je no.

Ukázka použití:

Popis:

Nastavíme pauzu s ID 7, která představuje třeba Oběd

Vstup:

https://MojeVU.daktela.com/api/3.1/PauseOn/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&pause=7

Výstup:

{"error":null,"status":1}

Popis:

Nastavíme pauzu s ID 100, která neexistuje

Vstup:

https://MojeVU.daktela.com/api/3.1/PauseOn/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&pause=100

Výstup:

{"error":"Tato pauza nebyla nalezena","status":0}

Vyzvedne hovor z fronty

Požadovaná verze: 4.0

Akce:

PickupFromQueue: Vyzvedne hovor z fronty

Ukázka použití:

Popis:

Vyzvednou hovor a predat uzivateli pavelmoravec

Vstup:

https://api.daktela.com/api/4.0/PickupFromQueue/json?access_token=1234567890123456789012345678901234567890&call_id=1404828279.15208&user=pavelmoravec

Výstup:

{"status":1,"error":null,"result":[]}

Přesměrování hovoru

Požadovaná verze: 3.0

Akce:

Transfer: Přesměrování hovoru s představením (attended) nebo bez představování (blind).

Povinné parametry:

user: Přihlašovací jméno agenta odkud se má hovor přesměrovat (stačí user nebo extension)
extension: Číslo klapky odkud se má hovor přesměrovat (stačí user nebo extension)
number: Telefonní číslo, kam se má přesměrovat (stačí jeden z parametru number, dst_queue, dst_user)
dst_queue: ID fronty, kam se má hovor přesměrovat (stačí jeden z parametru number, dst_queue, dst_user)
dst_user: ID uživatel, kam se má hovor přesměrovat (stačí jeden z parametru number, dst_queue, dst_user)

Volitelné parametry:

type: Jaký druh přesměrování se má provést. Pokud neuvedete použije se attended attended - přesměrování s představením (nejprve budete hovořit s číslem kam přesměrováváte a teprve pak se hovor přesměruje s volajícím) blind - přesměrování bez představování (rovnou se přesměruje volajíci na číslo kam přesmérováváte)

Ukázka použití:

Popis:

Přesměrování hovoru od uživatele michalhajek na číslo 100

Vstup:

https://MojeVU.daktela.com/api/3.1/Transfer/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&type=attended&number=800123456

Výstup:

{"error":null,"status":1}

Úprava uživatele

Požadovaná verze: 4.0

Akce:

UpdateUser: Upravý uživatele

Povinné parametry:

name: Login uživatele

Volitelné parametry:

role: Unikátní identifikátor role
profile: Unikátní identifikátor profilu
title: Jméno uživatele
description: Popis uživatele
password: Heslo uživatele
email: Email uživatele

Ukázka použití:

Popis:

Upravý heslo uživatele s loginem 'operator1' na 'silne.Heslo321'

Vstup:

https://MojeVU.daktela.com/api/4.0/UpdateUser/json?access_token=12345678901234567890123456789012345678907&name=operator1&password=silne.Heslo321

Výstup:

{"status":1,"error":null,"result":{"user":4,"role":"role_52f22ad1ba23e","profile":"profile_530ca64179669","name":"operator2","title":"Pepa Nov\u00e1k","description":null,"password":"#silneHeslo321","email":null,"deleted":null}}

Získání informace o hovoru

Požadovaná verze: 3.0

Akce:

AboutCall: Vrátí všechny CDR informace o hovoru, tedy například zdrojovou linku, cílovou linku, agenta, frontu, dobu vyzvánění, dobu spojení, směr, cestu k nahrávce, příchozí číslo a hash k binárnímu stažení nahrávky. Pro binární stažení nahrávky použijeme recording_hash, kterou předáme akci GetRecording

Povinné parametry:

id_call: Unikátní číslo hovoru

Ukázka použití:

Popis:

Chceme informace o hovoru s unikátním číslem 1319030658.204

Vstup:

https://MojeVU.daktela.com/api/3.0/AboutCall/json?access_token=1234567890123456789012345678901234567890&id_call=1350478005.0

Výstup:

{"status":1,"error":null,"result":[{"calldate":"2011-10-19 15:24:46","clid":"200","src":"200","dst":"468008580","dcontext":"from-internal","channel":"SIP\/200-0000009f","dstchannel":"SIP\/pbx-000000a0","lastapp":"ResetCDR","lastdata":"w","duration":"32","billsec":"29","disposition":"ANSWERED","amaflags":"3","accountcode":"","uniqueid":"1319030686.213","userfield":"\/RECORDINGS\/2011\/10\/19\/OUT200-468008580-20111019-152447-1319030686.213.wav","real_exten":"200","direction":"out","from_did":null,"id_call":"1319030658.204","id_queue":"2","id_agent":"4","waiting_time":"3","ringing_time":"3","hold_time":"0","orig_pos":"1","position":"1","disposition_cause":"agent","disconnection_cause":"","recording_hash":"225fae9e2c0a2e830c7d0e9e80040f4245a6asv93gfdgxD1319030658.204"}]}

Zodpovězení příchozího call centrového hovoru

Požadovaná verze: 3.7

Akce:

Answer: Automaticky vzdáleně zodpovíme příchozí hovor u operátora, který přišel z příchozi call centrové fronty a vyzvání na lince. Telefon operátora musí podporovat funkci auto answer.

Povinné parametry:

extension: Číslo klapky(skupiny) operátora, na které přichází hovor (nemusíme již vyplňovat povinný parametr user)
user: Přihlašovací jméno agenta, na kterého přichází hovor (nemusíme již vyplňovat povinný parametr extension)

Ukázka použití:

Popis:

U operátora s loginem hajek zvoní příchozí hovor a tento hovor chceme automaticky zodpovědět

Vstup:

https://MojeVU.daktela.com/api/3.7/Answer/json?access_token=1234567890123456789012345678901234567890&user=hajek

Výstup:

{"status":1,"error":null,"result":{"calling_number":"226211245","calling_queue":"2000","calling_queue_name":"Support","id_call":"14555781215.224"}}

Vytvoří odchozí hovor typu Click to Call

Požadovaná verze: 3.9

Akce:

ClickToCall: Vytvoří odchozí hovor s číslem zákazníka ve frontě typu Click to Call. Až operátor zodpoví tento hovor, tak bude spojen se zákazníkem.

Povinné parametry:

queue: Číslo fronty typu Click to Call
number: Telefonní číslo zákazníka, které se má spojit

Volitelné parametry:

agenttext: Textová informace, kterou uvidí agent na displeji svého telefonu během spojování hovoru.
waitingtime: Jak dlouho v sekundách má tento hovor v příchozí frontě čekat, než je zodpovězen operátorem. V případě tohoto nastavení se nebere v potaz hodnota maximální čekací doba v definici fronty. Defaultní hodnota 7200 sekund.
idcall: ID podle kterého se dá nalézt CDR informace a nahrávka

Ukázka použití:

Popis:

Vytvořit hovor typu Click to Call, kde číslo zákazníka je 226211245 a fronta (musí být typu Click to Call) 2006. Operátor už při vyzvánění uvidí na telefonu text Pepa Novak a číslo 226211245.

Vstup:

https://MojeVU.daktela.com/api/3.9/ClickToCall/json?access_token=1234567890123456789012345678901234567890&queue=2006&number=226211245&agenttext=Pepa%20Novak

Výstup:

{"status":1,"error":null,"result":{"id_call":"1358860092.8131WS"}}

Přehrání hlášky do probíhajícího hovoru

Požadovaná verze: 3.6

Akce:

ControlPlayback: Pokud na lince probíhá hovor, je možné na ní přehrát libovolnou hlášku, která je k dispozici na ústředně. Tuto hlášku uslyší interní klapka(operátor) tak i druhá strana(zákazník).

Povinné parametry:

extension

Číslo klapky, na které musí probíhat hovor (nemusíme již vyplňovat povinný parametr user)

user

Přihlašovací jméno agenta, který uskutečnuje probíhající hovor (nemusíme již vyplňovat povinný parametr extension)

command

Jaký příkaz se má provést

play - začne přehrávat hlášku
rewind - již přehrávanou hlášku je možné posunout zpět
pause - zapauzování přehrávané hlášky pro odpauzování se volá stejný příkaz
forward - již přehravanou hlášku je možné posunout dopředu
stop - ukončení již přehrávané hlášky
status - zjištění, zda se hláška jěště přehrává. Vrácene pole obsahuje položku playing, podle toho zda hláška probíhá(true) nebo ne(false).

Volitelné parametry:

recording: U příkazu play specifikujeme název nahrávky, kterou chceme přehrát. Seznam hlášek se spravuje v modulu Nastavení ústředny.
begintime: U příkazu play je možné specifikovat od jakého začátku v milisekundách se má začít přehrávat hláška
skiptime: Tuto volbu je třeba specifikovat u příkazu play a značí o kolik milisekund se má přeskočít přehrávání hlášky pokud dodatečně zavoláme příkazy rewind nebo forward

Ukázka použití:

Popis:

Na probíhajícím hovoru u linky 500 chceme přehrát hlášku, kterou uslyší i zákazník.

Vstup:

https://MojeVU.daktela.com/api/3.6/ControlPlayback/json?access_token=1234567890123456789012345678901234567890&command=play&extension=500&recording=Upozornujeme_ze_v_ramci_zkvalitneni_sluzeb_mohou_byt_hovory_monitorovany.wav

Výstup:

{"status":1,"error":null,"result":null}

Popis:

Probíhající hlášku z předchozího příkladu chceme pozastavit

Vstup:

https://MojeVU.daktela.com/api/3.6/ControlPlayback/json?access_token=1234567890123456789012345678901234567890&command=pause&extension=500

Výstup:

{"status":1,"error":null,"result":null}

Vytvoří odchozí call centrový hovor

Požadovaná verze: 3.1

Akce:

CreateCall: Vytvoří odchozí telefonní hovor s požadavkem na call centrum.

Povinné parametry:

user: Přihlašovací jméno agenta, který chce vytvořit hovor
number: Telefonní číslo na které chceme volat

Volitelné parametry:

accountcode: Jedinečný kód, který se nese celou dobu s hovorem
autoanswer: Pokud telefon podporuje automatické vyzvednutí hovoru, je možné tutu funkci použít. Výchozí stav je vypnuto.
waitingtime: Jak dlouho v sekundach má zvonit telefon u linky / extension. Výchozí stav: 30 sekund
dialingtime: Jak dlouho v sekundach má zvonit telefon u zákazníka. Výchozí stav: 120 sekund
idcall: ID podle kterého se dá nalézt CDR informace a nahrávka
agenttext: Textová informace, kterou uvidí agent na displeji svého telefonu během vytáčení hovoru.
queue: Číslo odchozí fronty, přes kterou chceme volat. Agent musí být přihlášen do CC. Pokud bude přihlášen do jiné odchozí fronty, hovor bude zaznamenán na frontu, která je v parametru.
ticket: Unikátní název ticketu

Ukázka použití:

Popis:

Odchozí hovor od uživatele michalhajek na veřejné číslo 800123456 a zapnutou funkcí auto answer

Vstup:

https://MojeVU.daktela.com/api/3.1/CreateCall/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&number=800123456&autoanswer=yes

Výstup:

{"error":null,"status":1,"result":{"id_call":"123456789.1234SJ"}}}

Popis:

Odchozí hovor od uživatele michalhajek na veřejné číslo 800123456 a zapnutou funkcí auto answer. Uživatel ale není přihlášen do odchozí fronty.

Vstup:

https://MojeVU.daktela.com/api/3.1/CreateCall/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&number=800123456&autoanswer=yes

Výstup:

{"error":"Agent nen\u00ed p\u0159ihl\u00e1\u0161en do odchoz\u00ed kampan\u011b\/fronty","status":0}

Vytvořit odchozí hovor

Požadovaná verze: 3.0

Akce:

CreateCall: Vytvoří odchozí telefonní hovor bez požadavků na call centrum.

Povinné parametry:

extension: Číslo klapky, která chce vytvořít odchozí volání
number: Telefonní číslo na které chceme volat

Volitelné parametry:

accountcode: Jedinečný kód, který se nese celou dobu s hovorem
autoanswer: Pokud telefon podporuje automatické vyzvednutí hovoru, je možné tutu funkci použít. Výchozí stav je vypnuto.
waitingtime: Jak dlouho v sekundach má zvonit telefon u linky / extension. Výchozí stav: 30 sekund
idcall: ID podle kterého se dá nalézt CDR informace a nahrávka
agenttext: Textová informace, kterou uvidí agent na displeji svého telefonu během vytáčení hovoru.

Ukázka použití:

Popis:

Odchozí hovor z linky 300 na veřejné číslo 800123456

Vstup:

https://MojeVU.daktela.com/api/3.0/CreateCall/json?access_token=1234567890123456789012345678901234567890&extension=300&number=800123456

Výstup:

{"error":null,"status":1,"result":{"id_call":"123456789.1234SJ"}}

Popis:

Odchozí hovor z linky 300 na veřejné číslo 800123456 a zepnutou funkcí auto answer

Vstup:

https://MojeVU.daktela.com/api/3.0/CreateCall/json?access_token=1234567890123456789012345678901234567890&extension=300&number=800123456&autoanswer=yes

Výstup:

{"error":null,"status":1,"result":{"id_call":"123456789.1234SJ"}}

Vytvoření vzdáleného odchozího hovoru

Požadovaná verze: 3.8

Akce:

CreateRemoteCall: Předáme externí telefonní číslo, na které chceme spojit hovor s jiným číslem. Po zodpovězení hovoru na primarynumber dojde k vytáčení čísla na secondarynumber.

Povinné parametry:

primarynumber: Externí telefonní číslo, na které se má nejprve zavolat
secondarynumber: Telefonní číslo, které chceme spojit po zodpovězení primarynumber

Volitelné parametry:

accountcode: Jedinečný kód, který se nese celou dobu s hovorem
directdid: Pokud je nastaven na true, tak se hovor směruje na číslo (secondarynumber), které je definované v Přichozím směrování v modulu Nastavení ústředny. Můžeme tak například zákazníkovi na primarynumber přehrát hlášku nebo hovor poslat do IVR menu, atd. Defaultně je tato volba vypnuta.
dialingtime: Jak dlouho vyzvání hovor v sekundách než je zavěšen
idcall: ID podle kterého se dá nalézt CDR informace a nahrávka
recording: Má se hovor nahrávat
variables: Pole hash proměnných, ktere můžeme později používat v dialplanu ústředny. Proměnné jsou dostupné přes funkci HASH(CRMAPI,foo). Viz 2. příklad.

Ukázka použití:

Popis:

Chceme na čísle 226211245 spojit hovor s číslem 468008585

Vstup:

https://MojeVU.daktela.com/api/3.8/CreateRemoteCall/json?access_token=1234567890123456789012345678901234567890&primarynumber=226211245&secondarynumber=468008585

Výstup:

{"status":1,"error":null,"result":{"id_call":"1346154802.5542WS"}}

Popis:

Chceme zavolat na číslo 226211245 a hovor směrovat do příchozího směrování na 9999. Na tomto příchozím čísle 9999 máme navěšené Oznámení. Předvyplníme si k hovoru i proměnnou myid, kterou můžeme zpracovat po přehráti oznámení.

Vstup:

https://MojeVU.daktela.com/api/3.8/CreateRemoteCall/json?access_token=1234567890123456789012345678901234567890&primarynumber=226211245&secondarynumber=9999&directdid=true&variables[myid]=1234567

Výstup:

{"status":1,"error":null,"result":{"id_call":"1346154802.5542WS"}}

Výpis pokusů o spojení hovorů v callcentru

Požadovaná verze: 4.1

Akce:

GetAttempts: Vypsání pokusů o spojení callcentrových hovorů. Maximální limit vrácených hovorů je 1000, po překročení se vrací chyba.

Povinné parametry:

datetime_from: Od jakého času se mají hledat hovory. Formát času YYYY-MM-DD HH:MM:SS
datetime_to: Do jakého času se mají hledat hovory. Formát času YYYY-MM-DD HH:MM:SS

Volitelné parametry:

queues: Pole ID front
id_call: Unikátní číslo hovoru
users: Pole ID uživatelů
skip: Offset řádků, výchozí hodnota: 0
take: Počet řádků, výchozí hodnota: 100

Ukázka použití:

Popis:

Vyhledáme pokusy o spojení hovorů v časovém rozmezí 2015-08-14 00:00:00 do 2015-10-31 00:00:00 a ID front 1

Vstup:

https://MojeVU.daktela.com/api/4.1/GetAttempts/json?access_token=1234567890123456789012345678901234567890&datetime_from=2015-08-14 00:00:00&datetime_to=2015-10-31 00:00:00&queues[]=1&skip=0&take=100

Výstup:

{"status":1,"error":null,"result":{"data":[{"id":111,"id_call":"1443007798.918","name":"ATTEMPT","start_time":"2015-09-23 13:30:25","end_time":"2015-09-23 13:30:45","duration":20,"id_agent":4,"id_queue":1,"data1":"","data2":"","data3":"","data4":""},{"id":110,"id_call":"1443007798.918","name":"ATTEMPT","start_time":"2015-09-23 13:29:59","end_time":"2015-09-23 13:30:19","duration":20,"id_agent":4,"id_queue":1,"data1":"","data2":"","data3":"","data4":""}],"total":"2"}}

Stáhnutí nahrávky

Požadovaná verze: 3.0

Akce:

GetRecording: Po předání validního hashe z akce AboutCall můžeme stáhnout nahrávku. Akce podporuje navázání přerušeného stahování.

Povinné parametry:

recording_hash: Tento hash získáme z akce AboutCall

Volitelné parametry:

octetstream: Pokud nastavíme na true, bude hlavička Content-Type nastavena na application/octet-stream. Pokud bude na false (výchozí hodnota), hlavička Content-Type bude nastavena na audio/x-wav nebo audio/mpeg.

Ukázka použití:

Popis:

Požadujeme nahrávku s kontrolním hashem 225fae9e2c0a2e830c7d0e9e80040f4245a65d2e1319030658.204

Vstup:

https://MojeVU.daktela.com/api/3.0/GetRecording/json?recording_hash=225fae9e2c0a2e830c7d0e9e80040f4245a65d2e1319030658.204

Výstup:

Binární výstup s nahrávkou

Zavěšení hovoru

Požadovaná verze: 3.0

Akce:

Hangup: Ukončení probihajícího hovoru. Stačí předat číslo linky nebo agenta.

Povinné parametry:

user: Přihlašovací jméno agenta (stačí jeden povinný parametr)
extension: Číslo klapky (stačí jeden povinný parametr)
call: Unikátní ID hovoru (stačí jeden povinný parametr)

Ukázka použití:

Popis:

Zavěšení hovoru u uživatele michalhajek

Vstup:

https://MojeVU.daktela.com/api/3.1/Hangup/json?access_token=1234567890123456789012345678901234567890&user=michalhajek

Výstup:

{"error":null,"status":1}

Popis:

Zavěšení hovoru u klapky 300

Vstup:

https://MojeVU.daktela.com/api/3.1/Hangup/json?access_token=1234567890123456789012345678901234567890&extension=300

Výstup:

{"error":null,"status":1}

Příposlech hovoru

Požadovaná verze: 3.0

Akce:

Monitoring: Online příposlech probíhajícího hovoru bez požadavků na call centrum

Povinné parametry:

exten: Číslo klapky, kterou chceme poslouchat
listener: Číslo klapky, kde chceme poslouchat hovor
mode: Jaký typ příposlechu má být zvolen spy - listener nemůže mluvit s exten ani se zákazníkem (pouze poslouchá) whisper - listener může mluvit s exten, ale zákazník to neslyší (listener slyší zákazníka) whisperprivate - listener může mluvit s exten, ale zákazník to neslyší (listener neslyší zákazníka) barge - listener může mluvit s exten i se zákazníkem (všichni se slyší) interactive - přepínání mezi módy pomocí DTMF klávesnice telefonu 4=spy(výchozí), 5=whisper, 6=barge

Ukázka použití:

Popis:

Příposlech hovoru, kdy listener může mluvit s klapkou, ale zákazník listenera neuslyší

Vstup:

https://MojeVU.daktela.com/api/3.0/Monitoring/json?access_token=1234567890123456789012345678901234567890&exten=100&listener=200&mode=whisper

Výstup:

{"error":null,"status":1}

Příposlech call centrového hovoru

Požadovaná verze: 3.1

Akce:

Monitoring: Online příposlech probíhajícího hovoru s požadavkem na call centre

Povinné parametry:

user: Přihlašovací jméno operátora, kterého chceme poslouchat
listener: Číslo klapky, kde chceme poslouchat hovor
mode: Jaký typ příposlechu má být zvolen spy - listener nemůže mluvit s exten ani se zákazníkem (pouze poslouchá) whisper - listener může mluvit s exten, ale zákazník to neslyší (listener slyší zákazníka) whisperprivate - listener může mluvit s exten, ale zákazník to neslyší (listener neslyší zákazníka) barge - listener může mluvit s exten i se zákazníkem (všichni se slyší) interactive - přepínání mezi módy pomocí DTMF klávesnice telefonu 4=spy(výchozí), 5=whisper, 6=barge

Ukázka použití:

Popis:

Příposlech hovoru, kdy listener může mluvit s klapkou, ale zákazník listenera neuslyší

Vstup:

https://MojeVU.daktela.com/api/3.0/Monitoring/json?access_token=1234567890123456789012345678901234567890&user=hajekhu&listener=200&mode=spy

Výstup:

{"status":1,"error":null,"result":{"calling_direction":"out","calling_number":"468008585","calling_queue":"1006","calling_queue_name":"ObycOdchozi","ringing":"2","billsec":"177"}}

Vyzvedne hovor z fronty

Požadovaná verze: 4.0

Akce:

PickupFromQueue: Vyzvedne hovor z fronty

Ukázka použití:

Popis:

Vyzvednou hovor a predat uzivateli pavelmoravec

Vstup:

https://api.daktela.com/api/4.0/PickupFromQueue/json?access_token=1234567890123456789012345678901234567890&call_id=1404828279.15208&user=pavelmoravec

Výstup:

{"status":1,"error":null,"result":[]}

Přesměrování hovoru

Požadovaná verze: 3.0

Akce:

Transfer: Přesměrování hovoru s představením (attended) nebo bez představování (blind).

Povinné parametry:

user: Přihlašovací jméno agenta odkud se má hovor přesměrovat (stačí user nebo extension)
extension: Číslo klapky odkud se má hovor přesměrovat (stačí user nebo extension)
number: Telefonní číslo, kam se má přesměrovat (stačí jeden z parametru number, dst_queue, dst_user)
dst_queue: ID fronty, kam se má hovor přesměrovat (stačí jeden z parametru number, dst_queue, dst_user)
dst_user: ID uživatel, kam se má hovor přesměrovat (stačí jeden z parametru number, dst_queue, dst_user)

Volitelné parametry:

type: Jaký druh přesměrování se má provést. Pokud neuvedete použije se attended attended - přesměrování s představením (nejprve budete hovořit s číslem kam přesměrováváte a teprve pak se hovor přesměruje s volajícím) blind - přesměrování bez představování (rovnou se přesměruje volajíci na číslo kam přesmérováváte)

Ukázka použití:

Popis:

Přesměrování hovoru od uživatele michalhajek na číslo 100

Vstup:

https://MojeVU.daktela.com/api/3.1/Transfer/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&type=attended&number=800123456

Výstup:

{"error":null,"status":1}

Zodpovězení příchozího call centrového hovoru

Požadovaná verze: 3.7

Akce:

Answer: Automaticky vzdáleně zodpovíme příchozí hovor u operátora, který přišel z příchozi call centrové fronty a vyzvání na lince. Telefon operátora musí podporovat funkci auto answer.

Povinné parametry:

extension: Číslo klapky(skupiny) operátora, na které přichází hovor (nemusíme již vyplňovat povinný parametr user)
user: Přihlašovací jméno agenta, na kterého přichází hovor (nemusíme již vyplňovat povinný parametr extension)

ÿ ᾰ˾hr />

Ukázka použití:

Popis:

U operátora s loginem hajek zvoní příchozí hovor a tento hovor chceme automaticky zodpovědět

Vstup:

https://MojeVU.daktela.com/api/3.7/Answer/json?access_token=1234567890123456789012345678901234567890&user=hajek

Výstup:

{"status":1,"error":null,"result":{"calling_number":"226211245","calling_queue":"2000","calling_queue_name":"Support","id_call":"14555781215.224"}}

Přehrání hlášky do probíhajícího hovoru

Požadovaná verze: 3.6

Akce:

ControlPlayback: Pokud na lince probíhá hovor, je možné na ní přehrát libovolnou hlášku, která je k dispozici na ústředně. Tuto hlášku uslyší interní klapka(operátor) tak i druhá strana(zákazník).

Povinné parametry:

extension

Číslo klapky, na které musí probíhat hovor (nemusíme již vyplňovat povinný parametr user)

user

Přihlašovací jméno agenta, který uskutečnuje probíhající hovor (nemusíme již vyplňovat povinný parametr extension)

command

Jaký příkaz se má provést

play - začne přehrávat hlášku
rewind - již přehrávanou hlášku je možné posunout zpět
pause - zapauzování přehrávané hlášky pro odpauzování se volá stejný příkaz
forward - již přehravanou hlášku je možné posunout dopředu
stop - ukončení již přehrávané hlášky
status - zjištění, zda se hláška jěště přehrává. Vrácene pole obsahuje položku playing, podle toho zda hláška probíhá(true) nebo ne(false).

Volitelné parametry:

recording: U příkazu play specifikujeme název nahrávky, kterou chceme přehrát. Seznam hlášek se spravuje v modulu Nastavení ústředny.
begintime: U příkazu play je možné specifikovat od jakého začátku v milisekundách se má začít přehrávat hláška
skiptime: Tuto volbu je třeba specifikovat u příkazu play a značí o kolik milisekund se má přeskočít přehrávání hlášky pokud dodatečně zavoláme příkazy rewind nebo forward

Ukázka použití:

Popis:

Na probíhajícím hovoru u linky 500 chceme přehrát hlášku, kterou uslyší i zákazník.

Vstup:

https://MojeVU.daktela.com/api/3.6/ControlPlayback/json?access_token=1234567890123456789012345678901234567890&command=play&extension=500&recording=Upozornujeme_ze_v_ramci_zkvalitneni_sluzeb_mohou_byt_hovory_monitorovany.wav

Výstup:

{"status":1,"error":null,"result":null}

Popis:

Probíhající hlášku z předchozího příkladu chceme pozastavit

Vstup:

https://MojeVU.daktela.com/api/3.6/ControlPlayback/json?access_token=1234567890123456789012345678901234567890&command=pause&extension=500

Výstup:

{"status":1,"error":null,"result":null}

Vytvořit odchozí hovor

Požadovaná verze: 3.0

Akce:

CreateCall: Vytvoří odchozí telefonní hovor bez požadavků na call centrum.

Povinné parametry:

extension: Číslo klapky, která chce vytvořít odchozí volání
number: Telefonní číslo na které chceme volat

Volitelné parametry:

accountcode: Jedinečný kód, který se nese celou dobu s hovorem
autoanswer: Pokud telefon podporuje automatické vyzvednutí hovoru, je možné tutu funkci použít. Výchozí stav je vypnuto.
waitingtime: Jak dlouho v sekundach má zvonit telefon u linky / extension. Výchozí stav: 30 sekund
idcall: ID podle kterého se dá nalézt CDR informace a nahrávka
agenttext: Textová informace, kterou uvidí agent na displeji svého telefonu během vytáčení hovoru.

Ukázka použití:

Popis:

Odchozí hovor z linky 300 na veřejné číslo 800123456

Vstup:

https://MojeVU.daktela.com/api/3.0/CreateCall/json?access_token=1234567890123456789012345678901234567890&extension=300&number=800123456

Výstup:

{"error":null,"status":1,"result":{"id_call":"123456789.1234SJ"}}

Popis:

Odchozí hovor z linky 300 na veřejné číslo 800123456 a zepnutou funkcí auto answer

Vstup:

https://MojeVU.daktela.com/api/3.0/CreateCall/json?access_token=1234567890123456789012345678901234567890&extension=300&number=800123456&autoanswer=yes

Výstup:

{"error":null,"status":1,"result":{"id_call":"123456789.1234SJ"}}

Aktuální stav klapek

Požadovaná verze: 3.0

Akce:

DeviceStates: Získá aktuální stav klapek, tedy která linka je ve stavu dostupná, nedostupná, přidržení hovoru, hovořící linka Možnosti ve status jsou: AVAILABLE (dostupná) UNAVAILABLE (nedostupná) ONHOLD (přidržení hovoru) INUSE (hovořící linka) RINGING (zvonící linka)

Ukázka použití:

Popis:

Vrací seznam všech linek s jejich stavy na PBX

Vstup:

https://MojeVU.daktela.com/api/3.1/DeviceStates/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":[{"exten":"100","status":"AVAILABLE","ip":"172.22.254.254","port":"5064"},{"exten":"200","status":"AVAILABLE","ip":"212.24.153.186","port":"20652"},{"exten":"300","status":"AVAILABLE","ip":"212.24.153.186","port":"5063"},{"exten":"500","status":"UNAVAILABLE","ip":"-none-","port":"0"}]}

Vrátí uživatele dané linky.

Požadovaná verze: 4.1

Akce:

GetExtensionUsers: Vrátí uživatele dané linky.

Povinné parametry:

extension: Název linky.

Ukázka použití:

Popis:

Vypsat uživatele linky číslo 100.

Vstup:

https://MojeVU.daktela.com/api/4.1/GetExtensionUsers/json?access_token=1234567890123456789012345678901234567890&extension=100

Výstup:

{"status":1,"error":null,"result":{"data":[{"user":"1","role":"1","profile":"1","name":"klatil","title":"Zvonimír Klátil","description":"","email":"","deleted":"0"}]}}

Zavěšení hovoru

Požadovaná verze: 3.0

Akce:

Hangup: Ukončení probihajícího hovoru. Stačí předat číslo linky nebo agenta.

Povinné parametry:

user: Přihlašovací jméno agenta (stačí jeden povinný parametr)
extension: Číslo klapky (stačí jeden povinný parametr)
call: Unikátní ID hovoru (stačí jeden povinný parametr)

Ukázka použití:

Popis:

Zavěšení hovoru u uživatele michalhajek

Vstup:

https://MojeVU.daktela.com/api/3.1/Hangup/json?access_token=1234567890123456789012345678901234567890&user=michalhajek

Výstup:

{"error":null,"status":1}

Popis:

Zavěšení hovoru u klapky 300

Vstup:

https://MojeVU.daktela.com/api/3.1/Hangup/json?access_token=1234567890123456789012345678901234567890&extension=300

Výstup:

{"error":null,"status":1}

Příposlech hovoru

Požadovaná verze: 3.0

Akce:

Monitoring: Online příposlech probíhajícího hovoru bez požadavků na call centrum

Povinné parametry:

exten: Číslo klapky, kterou chceme poslouchat
listener: Číslo klapky, kde chceme poslouchat hovor
mode: Jaký typ příposlechu má být zvolen spy - listener nemůže mluvit s exten ani se zákazníkem (pouze poslouchá) whisper - listener může mluvit s exten, ale zákazník to neslyší (listener slyší zákazníka) whisperprivate - listener může mluvit s exten, ale zákazník to neslyší (listener neslyší zákazníka) barge - listener může mluvit s exten i se zákazníkem (všichni se slyší) interactive - přepínání mezi módy pomocí DTMF klávesnice telefonu 4=spy(výchozí), 5=whisper, 6=barge

Ukázka použití:

Popis:

Příposlech hovoru, kdy listener může mluvit s klapkou, ale zákazník listenera neuslyší

Vstup:

https://MojeVU.daktela.com/api/3.0/Monitoring/json?access_token=1234567890123456789012345678901234567890&exten=100&listener=200&mode=whisper

Výstup:

{"error":null,"status":1}

Přesměrování hovoru

Požadovaná verze: 3.0

Akce:

Transfer: Přesměrování hovoru s představením (attended) nebo bez představování (blind).

Povinné parametry:

user: Přihlašovací jméno agenta odkud se má hovor přesměrovat (stačí user nebo extension)
extension: Číslo klapky odkud se má hovor přesměrovat (stačí user nebo extension)
number: Telefonní číslo, kam se má přesměrovat (stačí jeden z parametru number, dst_queue, dst_user)
dst_queue: ID fronty, kam se má hovor přesměrovat (stačí jeden z parametru number, dst_queue, dst_user)
dst_user: ID uživatel, kam se má hovor přesměrovat (stačí jeden z parametru number, dst_queue, dst_user)

Volitelné parametry:

type: Jaký druh přesměrování se má provést. Pokud neuvedete použije se attended attended - přesměrování s představením (nejprve budete hovořit s číslem kam přesměrováváte a teprve pak se hovor přesměruje s volajícím) blind - přesměrování bez představování (rovnou se přesměruje volajíci na číslo kam přesmérováváte)

Ukázka použití:

Popis:

Přesměrování hovoru od uživatele michalhajek na číslo 100

Vstup:

https://MojeVU.daktela.com/api/3.1/Transfer/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&type=attended&number=800123456

Výstup:

{"error":null,"status":1}

Vytvoření nebo editování pauzy

Požadovaná verze: 3.3

Akce:

CreatePause: Vytvoří nebo upraví pauzu, která bude dostupná pro všechny operátory v call centrových aplikací, jako je například WebAgent, PhoneAgent, API.

Povinné parametry:

title: Jméno pauzy
type: O jaký typ pauzy se jedna. Zda je to systémová pauza Wrap(wrap), systémová pauza Lajdák(lajdak) nebo nesystémová pauza(normal).
paid: Zda je pauza proplácená(yes) nebo není(no). Například Wrap pauza by měla být proplácená, ale pauza Lajdák nikoliv. *

Volitelné parametry:

id: ID pauzy, kterou získáme přes GetPauses. Pokud předáme ID pauzy, tak provedeme editaci pauzy.
code: Speciální kód pauzy

Ukázka použití:

Popis:

Vytvoříme novou pauzu Oběd, nesystémové pauzy (normal), která se nebude operátorům proplácet.

Vstup:

https://MojeVU.daktela.com/api/3.3/CreatePause/json?access_token=1234567890123456789012345678901234567890&name=Obed&type=normal&billable=no

Výstup:

{"status":1,"error":null,"result":null}

Popis:

Změníme jméno pauzy Obed s ID 9 na nové jméno Svacina

Vstup:

https://MojeVU.daktela.com/api/3.3/CreatePause/9/json?access_token=1234567890123456789012345678901234567890&name=Svacina&type=normal&billable=yes

Výstup:

{"status":1,"error":null,"result":null}

Výpis všech pauz

Požadovaná verze: 3.3

Akce:

GetPauses: Vypíšeme všechny pauzy, včetně smazaných.

Ukázka použití:

Popis:

Výpis všech pauz

Vstup:

https://MojeVU.daktela.com/api/3.3/GetPauses/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"3":{"pause":"3","name":"666","title":"Lajdak","type":"lajdak","paid":"0","deleted":"0"},"2":{"pause":"2","name":"20","title":"Wrap","type":"wrap","paid":"1","deleted":"0"},"4":{"pause":"4","name":"13","title":"Backoffice","type":null,"paid":"1","deleted":"0"},"6":{"pause":"6","name":"11","title":"Prestavka","type":null,"paid":"0","deleted":"0"},"7":{"pause":"7","name":"10","title":"Obed","type":"","paid":"0","deleted":"0"},"8":{"pause":"8","name":"667","title":"Email","type":"","paid":"1","deleted":"0"},"9":{"pause":"9","name":"668","title":"Obed22","type":"","paid":"0","deleted":"0"}}}

Vypsání všech definovaných pauz

Požadovaná verze: 3.0

Akce:

GetPauses: Vrátí všechny definované pauzy

Volitelné parametry:

id: Vrácení informace o pauze s konkrétním ID. Pokud se nepředá, tak vrací všechny pauzy

Ukázka použití:

Popis:

Chceme všechny pauzy

Vstup:

https://MojeVU.daktela.com/api/3.0/GetPauses/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"3":{"pcode_id":"3","pcode":"666","pcode_desc":"Lajdak","read_key":"","isBillable":"0","isPayable":"0","pauseType":"w","sys_dt_creazione":"0000-00-00 00:00:00","sys_user_creazione":"0","sys_dt_modifica":"0000-00-00 00:00:00","sys_user_modifica":"0","sys_optilock":"0"},"2":{"pcode_id":"2","pcode":"20","pcode_desc":"Wrap","read_key":"","isBillable":"1","isPayable":"0","pauseType":"w","sys_dt_creazione":"0000-00-00 00:00:00","sys_user_creazione":"0","sys_dt_modifica":"0000-00-00 00:00:00","sys_user_modifica":"0","sys_optilock":"0"},"4":{"pcode_id":"4","pcode":"13","pcode_desc":"Backoffice","read_key":"","isBillable":"1","isPayable":"0","pauseType":"-","sys_dt_creazione":"0000-00-00 00:00:00","sys_user_creazione":"0","sys_dt_modifica":"0000-00-00 00:00:00","sys_user_modifica":"0","sys_optilock":"0"},"5":{"pcode_id":"5","pcode":"12","pcode_desc":"Email","read_key":"","isBillable":"1","isPayable":"0","pauseType":"-","sys_dt_creazione":"0000-00-00 00:00:00","sys_user_creazione":"0","sys_dt_modifica":"0000-00-00 00:00:00","sys_user_modifica":"0","sys_optilock":"0"},"6":{"pcode_id":"6","pcode":"11","pcode_desc":"Prestavka","read_key":"","isBillable":"0","isPayable":"0","pauseType":"-","sys_dt_creazione":"0000-00-00 00:00:00","sys_user_creazione":"0","sys_dt_modifica":"0000-00-00 00:00:00","sys_user_modifica":"0","sys_optilock":"0"},"7":{"pcode_id":"7","pcode":"10","pcode_desc":"Obed","read_key":"","isBillable":"0","isPayable":"0","pauseType":"-","sys_dt_creazione":"0000-00-00 00:00:00","sys_user_creazione":"0","sys_dt_modifica":"0000-00-00 00:00:00","sys_user_modifica":"0","sys_optilock":"0"}}}

Popis:

Chceme pauzu s ID 3

Vstup:

https://MojeVU.daktela.com/api/3.0/GetPauses/3/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"3":{"pcode_id":"3","pcode":"666","pcode_desc":"Lajdak","read_key":"","isBillable":"0","isPayable":"0","pauseType":"w","sys_dt_creazione":"0000-00-00 00:00:00","sys_user_creazione":"0","sys_dt_modifica":"0000-00-00 00:00:00","sys_user_modifica":"0","sys_optilock":"0"}}}

Zrušení pauzy u uživatele

Požadovaná verze: 3.0

Akce:

PauseOff: Zrušíme uživateli v call centru nastavenou pauzu

Povinné parametry:

user: Přihlašovací jméno agenta (nemusíme již vyplňovat povinný parametr extension)
extension: Číslo klapky agenta (nemusíme již vyplňovat povinný parametr user)

Ukázka použití:

Popis:

Odhlásíme z pauzy uživatele michalhajek

Vstup:

https://MojeVU.daktela.com/api/3.0/PauseOff/json?access_token=1234567890123456789012345678901234567890&user=michalhajek

Výstup:

{"error":null,"status":1}

Nastavení pauzy u uživatele

Požadovaná verze: 3.0

Akce:

PauseOn: Nastavíme uživateli v call centru danou pauzu v případě že neuskutečnuje žádný hovor Pokud na pauze už je, dojde k přenastavení na konkrétní pauzu

Povinné parametry:

user: Přihlašovací jméno agenta (nemusíme již vyplňovat povinný parametr extension)
extension: Číslo klapky agenta (nemusíme již vyplňovat povinný parametr user)
pause: Na jaké ID pauzy přepneme uživatele

Volitelné parametry:

force: Pokud je nastaveno na yes, tak se pauza nastaví i v případě, že agent zvoní, hovoří nebo je na on holdu. Výchozí stav je no.

Ukázka použití:

Popis:

Nastavíme pauzu s ID 7, která představuje třeba Oběd

Vstup:

https://MojeVU.daktela.com/api/3.1/PauseOn/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&pause=7

Výstup:

{"error":null,"status":1}

Popis:

Nastavíme pauzu s ID 100, která neexistuje

Vstup:

https://MojeVU.daktela.com/api/3.1/PauseOn/json?access_token=1234567890123456789012345678901234567890&user=michalhajek&pause=100

Výstup:

{"error":"Tato pauza nebyla nalezena","status":0}

Získání informace o hovoru

Požadovaná verze: 3.0

Akce:

AboutCall: Vrátí všechny CDR informace o hovoru, tedy například zdrojovou linku, cílovou linku, agenta, frontu, dobu vyzvánění, dobu spojení, směr, cestu k nahrávce, příchozí číslo a hash k binárnímu stažení nahrávky. Pro binární stažení nahrávky použijeme recording_hash, kterou předáme akci GetRecording

Povinné parametry:

id_call: Unikátní číslo hovoru

Ukázka použití:

Popis:

Chceme informace o hovoru s unikátním číslem 1319030658.204

Vstup:

https://MojeVU.daktela.com/api/3.0/AboutCall/json?access_token=1234567890123456789012345678901234567890&id_call=1350478005.0

Výstup:

{"status":1,"error":null,"result":[{"calldate":"2011-10-19 15:24:46","clid":"200","src":"200","dst":"468008580","dcontext":"from-internal","channel":"SIP\/200-0000009f","dstchannel":"SIP\/pbx-000000a0","lastapp":"ResetCDR","lastdata":"w","duration":"32","billsec":"29","disposition":"ANSWERED","amaflags":"3","accountcode":"","uniqueid":"1319030686.213","userfield":"\/RECORDINGS\/2011\/10\/19\/OUT200-468008580-20111019-152447-1319030686.213.wav","real_exten":"200","direction":"out","from_did":null,"id_call":"1319030658.204","id_queue":"2","id_agent":"4","waiting_time":"3","ringing_time":"3","hold_time":"0","orig_pos":"1","position":"1","disposition_cause":"agent","disconnection_cause":"","recording_hash":"225fae9e2c0a2e830c7d0e9e80040f4245a6asv93gfdgxD1319030658.204"}]}

Výpis CDR s cenou hovoru

Požadovaná verze: 3.5

Akce:

CDR: Vypsání CDR (Call Detail Records) s funkcí účtování hovoru. Cena hovoru je zavislá na ceníku, který je importovaný do modulu Přehledy voláni

Povinné parametry:

datetime_from: Od jakého času se mají vypsat hovory. Formát času YYYY-MM-DD HH:MM:SS
datetime_to: Do jakého času se mají vypsat hovory. Formát času YYYY-MM-DD HH:MM:SS

Volitelné parametry:

real_extens: Čísla klapek, která se účastnila hovorů. Možnost zadat více klapek do pole.
accountcodes: Podle jakých accountcodů vypsat hovory. Možnost zadat více accountcodů do pole.
direction: Jaký směr hovoru chceme vypsat. Možnosti jsou in,out,local
destinations: Přes jaké destinace vypsat hovory. Je možné zadávat více typů destinací do pole. Informace o destinacích nalezneme v modulu Přehledy volání.
disposition: Vypsání jen zodpovězených hovorů, nastavíme na ANSWERED.
src_channels: Přes jaké příchozí kanály chceme vypsat hovory. Možnost zadat více kanálů do pole.
dst_channels: Přes jaké odchozí kanály chceme vypsat hovory. Možnost zadat více kanálů do pole.
min_price_call: Budou vypsány jen hovory, které jsou dražší než zde specifikujeme. Měna se zde nespefifikuje, záleží v jaké měně je importovaný ceník v modulu Přehledy volání. Například 2.50
billing: Boolean hodnota, pokud chceme cenu hovoru

Ukázka použití:

Popis:

Vypsat zodpovězené odchozí hovory, které jsou uskutečněny v březnu 2012 pro klapky 300, 500 a vynechat hovory, které jsou levnější nez 1.20. Současně hovory šly přes kanaly SIP/daktela a SIP/gsm

Vstup:

https://MojeVU.daktela.com/api/3.5/CDR/json?access_token=1234567890123456789012345678901234567890&datetime_from=2012-03-01%2000:00:00&datetime_to=2012-03-31%2023:59:59&direction=out&disposition=ANSWERED&min_price_call=1.20&real_extens[]=300&real_extens[]=500&dst_channels[]=SIP/proxy&dst_channels=SIP/gsm

Výstup:

{"status":1,"error":null,"result":[{"date":"2012-03-05 13:05:20","real_exten":"500","dst":"468008585","billsec":"321","duration":"328","disposition":"ANSWERED","accountcode":"","uniqueid":"1330949120.242","id_call":"1330949120.242","from_did":null,"direction":"out","price":"4.94999987","destination_type":"Pevna_Linka","destination_type_description":"Pevna_Linka","destination":"Ceska republika","destination_price":"0.9000"},{"date":"2012-03-05 13:10:57","real_exten":"500","dst":"468008585","billsec":"170","duration":"177","disposition":"ANSWERED","accountcode":"","uniqueid":"1330949457.244","id_call":"1330949457.244","from_did":null,"direction":"out","price":"2.69999993","destination_type":"Pevna_Linka","destination_type_description":"Pevna_Linka","destination":"Ceska republika","destination_price":"0.9000"},{"date":"2012-03-05 13:13:56","real_exten":"500","dst":"468008585","billsec":"2200","duration":"2206","disposition":"ANSWERED","accountcode":"","uniqueid":"1330949636.250","id_call":"1330949636.250","from_did":null,"direction":"out","price":"33.29999912","destination_type":"Pevna_Linka","destination_type_description":"Pevna_Linka","destination":"Ceska republika","destination_price":"0.9000"},{"date":"2012-03-05 13:51:08","real_exten":"500","dst":"468008585","billsec":"923","duration":"929","disposition":"ANSWERED","accountcode":"","uniqueid":"1330951868.260","id_call":"1330951868.260","from_did":null,"direction":"out","price":"13.94999963","destination_type":"Pevna_Linka","destination_type_description":"Pevna_Linka","destination":"Ceska republika","destination_price":"0.9000"},{"date":"2012-03-08 14:13:31","real_exten":"500","dst":"840101010","billsec":"4","duration":"8","disposition":"ANSWERED","accountcode":"","uniqueid":"1331212411.14","id_call":"1331212411.14","from_did":null,"direction":"out","price":"3.82999992","destination_type":"Specialni_Cisla","destination_type_description":"Specialni_Cisla","destination":"Bila linka ","destination_price":"1.9150"},{"date":"2012-03-13 16:57:13","real_exten":"300","dst":"603927227","billsec":"6","duration":"17","disposition":"ANSWERED","accountcode":"1002","uniqueid":"1331654233.196","id_call":"1331654233.586WS","from_did":null,"direction":"out","price":"2.25000000","destination_type":"Mobilni_Hovory","destination_type_description":"Mobilni_Hovory","destination":"Ceska republika - mobil T-mobile","destination_price":"4.5000"},{"date":"2012-03-26 10:51:29","real_exten":"500","dst":"491200163","billsec":"83","duration":"91","disposition":"ANSWERED","accountcode":"1002","uniqueid":"1332751889.0","id_call":"1332751889.9807WS","from_did":null,"direction":"out","price":"1.34999996","destination_type":"Pevna_Linka","destination_type_description":"Pevna_Linka","destination":"Ceska republika","destination_price":"0.9000"}]}

Stáhnutí nahrávky

Požadovaná verze: 3.0

Akce:

GetRecording: Po předání validního hashe z akce AboutCall můžeme stáhnout nahrávku. Akce podporuje navázání přerušeného stahování.

Povinné parametry:

recording_hash: Tento hash získáme z akce AboutCall

Volitelné parametry:

octetstream: Pokud nastavíme na true, bude hlavička Content-Type nastavena na application/octet-stream. Pokud bude na false (výchozí hodnota), hlavička Content-Type bude nastavena na audio/x-wav nebo audio/mpeg.

Ukázka použití:

Popis:

Požadujeme nahrávku s kontrolním hashem 225fae9e2c0a2e830c7d0e9e80040f4245a65d2e1319030658.204

Vstup:

https://MojeVU.daktela.com/api/3.0/GetRecording/json?recording_hash=225fae9e2c0a2e830c7d0e9e80040f4245a65d2e1319030658.204

Výstup:

Binární výstup s nahrávkou

Informace o posledním hovoru pro telefonní číslo

Požadovaná verze: 3.9

Akce:

LastCallNumber: Vrací informaci o posledním hovoru pro dané telefonní číslo, tedy informaci o agentovi a ve které frontě hovor probíhal.

Povinné parametry:

phonenumber: Telefonní číslo

Volitelné parametry:

interval: Kolik vteřin zpátky se dívat do historie (defaultně 1 den)
answered: Zodpovězený hovor (true | false)
queues: Pole ID front
queues_number: Pole čísel front (např. 2000)

Ukázka použití:

Popis:

Vypsat jaký agent a v jaké frontě naposledy hovořil s číslem 226211245 za poslední 2 dny.

Vstup:

https://MojeVU.daktela.com/api/3.9/LastCallNumber/json?access_token=1234567890123456789012345678901234567890&phonenumber=226211245&queues_number[]=99990&queues_number[]=2000&answered=yes&interval=172800

Výstup:

{"status":1,"error":null,"result":{"call":"1354715424.94","call_time":"2012-12-05 14:50:24","direction":"out","queue":"2","user":"4","answered":true,"clid":"468008585","waiting_time":5,"ringing_time":5,"hold_time":0,"duration":6,"disposition":"user","orig_posision":1,"attempts":0,"queue_title":"Daktela Test OUT","queue_number":"99990","queue_direction":"out","user_title":"Hajek","user_login":"hajek"}}

Informace o posledním hovoru pro klapku nebo uživatele

Požadovaná verze: 3.9

Akce:

LastCall: Vrací informaci o probíhajícím hovoru, případně o posledním ukončeném hovoru

Povinné parametry:

extension: Číslo klapky (nemusíme již vyplňovat povinný parametr user)
user: Přihlašovací jméno agenta (nemusíme již vyplňovat povinný parametr extension)

Ukázka použití:

Popis:

Chceme získat telefonní číslo zákazníka a ID hovoru, se kterým naposledy hovořila klapka číslo 500, případně se zákazníkem ještě hovoří

Vstup:

https://MojeVU.daktela.com/api/3.9/LastCall/json?access_token=1234567890123456789012345678901234567890&extension=500

Výstup:

{"status":1,"error":null,"result":{"exten":"500","user":null,"queue":null,"id_call":"1352986386.46","direction":"out","clid":"468008585","time":"2012-11-15 14:33:06","_is_realtime":false}}

Realtime přítomnost uživatelů ve frontě typu Chat nebo Click-to-Call

Požadovaná verze: 3.9

Akce:

RTQueuePresence: Vrací informaci, zda je chatová (Click-to-Call) fronta online. Pokud jsou do dane fronty přihlášeni operátoři, vrací true. Vhodné v případě, kdy chcete před zákazníky schovávat chatový (případně Click-to-Call) formulář.

Povinné parametry:

queue: Číslo fronty

Ukázka použití:

Popis:

Dostupnost fronty číslo 2005.

Vstup:

https://MojeVU.daktela.com/api/3.9/RTQueuePresence/json?access_token=1234567890123456789012345678901234567890&queue=2005

Výstup:

{"status":1,"error":null,"result":{"count_users":1,"online_presence":true}}

Realtime statistika hovorů

Požadovaná verze: 3.5

Akce:

RTStatsCalls: Vrací aktuální přehled probíhajících hovorů

Ukázka použití:

Popis:

Význam jednotlivých hodnot z výstupu:

id - ID hovoru
queue - ID fronty, kde probíhá hovor
agent - ID operátora, který vyřizuje hovor (hovor musí být zodpovězený)
users - ID operátorů, kteří jsou spojeni s hovorem (při ringall strategii ve frontě, zde bude uvedeno více operátorů)
clid - Telefonní číslo zákazníka
direction - Směr hovoru (in,out)
state - V jakém stavu se nachází hovor (Waiting,Ringing,Speaking,On Hold, Transfered)
enter_time_absolute - Čas, kdy hovor vstoupil do fronty. Formát času YYYY-MM-DD HH:MM:SS
enter_time_relative - Kolik sekund trvá hovor, včetně doby čekání, vyzvánění a hovoření.
wait_time_absolute - Čas, kdy hovor začal čekat ve frontě (stejný jako enter_time_absolute). Formát času YYYY-MM-DD HH:MM:SS
wait_time_relative - Kolik sekund trvalo, než byl hovor zodpovězen
ring_time_absolute - Čas, kdy hovor začal vyzvánět u operátora. Formát času YYYY-MM-DD HH:MM:SS
ring_time_relative - Kolik sekund trvalo vyzvánění
answer_time_absolute - Čas, kdy byl hovor zodpovězen operátorem. Formát času YYYY-MM-DD HH:MM:SS
answer_time_relative - Kolik sekund trvá hovoření s operátorem
hold_time_absolute - Čas, kdy byl hovor přidržen operátorem (hold). Formát času YYYY-MM-DD HH:MM:SS
hold_time_relative - Kolik sekund už je hovor přidržen (hold)

Vstup:

https://MojeVU.daktela.com/api/3.5/RTStatsCalls/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"1332333840.98":{"id":"1332333840.98","queue":"6","agent":"3","users":["3"],"clid":"100","direction":"in","state":"Speaking","enter_time_absolute":"2012-03-21 13:44:02","enter_time_relative":"7","wait_time_absolute":"2012-03-21 13:44:02","wait_time_relative":"5","ring_time_absolute":"2012-03-21 13:44:04","ring_time_relative":"5","answer_time_absolute":"2012-03-21 13:44:07","answer_time_relative":"2","hold_time_absolute":null,"hold_time_relative":"0"}}}

Realtime statistika aktivovaných pauz

Požadovaná verze: 3.5

Akce:

RTStatsPauses: Vrací aktuální přehled nastavených pauz u operátorů

Ukázka použití:

Popis:

Význam jednotlivých hodnot z výstupu:

id - ID pauzy
users - ID operátorů, kteří mají tuto pauzu nastavenou
count - Počet operátorů, kteří mají nastavenou tuto pauzu

Vstup:

https://MojeVU.daktela.com/api/3.5/RTStatsPauses/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"4":{"id":"4","count":"1","users":["3"]}}}

Realtime statistika front s celkovým přehledem

Požadovaná verze: 3.5

Akce:

RTStatsQueuesSummary: Vrací aktuální celkový přehled o celkovém počtu agentů a hovorů ve frontách

Volitelné parametry:

users: ID operátorů, které chceme vyfiltrovat
queues: ID front, které chceme vyfiltrovat

Ukázka použití:

Popis:

Význam jednotlivých hodnot z výstupu:

users_total - Celkový počet přihlášených operátorů
users_ready - Celkový počet volných operátorů, kteří jsou schopni přijímat hovory
users_busy - Celkový počet obsazených operátorů, kteří právě hovoří
users_pause - Celkový počet zapauzovaných operátorů, kteří mají nastavenou pauzu
calls_count - Celkový počet probíhajících hovorů
calls_in - Celkový počet příchozích hovorů
calls_out - Celkový počet odchozích hovorů
calls_wait - Celkový počet hovorů, které jsou ve stavu vyzvánění
calls_time - Nejdelší doba čekání v sekundách na zodpovězení hovoru

Vstup:

https://MojeVU.daktela.com/api/3.5/RTStatsQueuesSummary/json?users[0]=3&users[1]=1&access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"users_total":1,"users_ready":0,"users_busy":0,"users_pause":1,"calls_count":0,"calls_in":0,"calls_out":0,"calls_wait":0,"calls_time":0}}

Realtime statistika front

Požadovaná verze: 3.5

Akce:

RTStatsQueues: Vrací aktuální přehled o celkovém počtu agentů a hovorů po jednotlivých frontách

Ukázka použití:

Popis:

Význam jednotlivých hodnot z výstupu:

id - ID fronty
users_total - Počet přihlášených operátorů v této frontě
users_ready - Počet volných operátorů, kteří jsou schopni přijímat hovory v této frontě
users_busy - Počet obsazených operátorů, kteří právě hovoří v této frontě
users_pause - Počet zapauzovaných operátorů, kteří mají nastavenou pauzu v této frontě
calls_count - Počet probíhajících hovorů v této frontě
calls_wait - Počet hovorů, které jsou ve stavu vyzvánění v této frontě
calls_time - Nejdelší doba čekání na zodpovězení hovoru v této frontě

Vstup:

https://MojeVU.daktela.com/api/3.5/RTStatsQueues/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"4":{"id":"4","users_total":1,"users_ready":0,"users_busy":1,"users_pause":0,"calls_count":1,"calls_wait":0,"calls_time":null},"6":{"id":"6","users_total":1,"users_ready":0,"users_busy":1,"users_pause":0,"calls_count":0,"calls_wait":0,"calls_time":0}}}

Realtime statistika přihlášených operátorů s filtrem front

Požadovaná verze: 3.5

Akce:

RTStatsSessions: Vrací aktuální přehled přihlášených operátorů s možností vyfiltrovat si operátory, kteří jsou přihlášeni ve frontách (parametr queues)

Volitelné parametry:

users: Pole ID uživatelů
queues: Pole ID front

Ukázka použití:

Popis:

Význam jednotlivých hodnot z výstupu:

id - ID operátora
extension - Číslo linky
queues - ID front, kde je operátor přihlášen
state - V jakém stavu se operátor nachází (Logged, Idle, Paused, Calling, Ringing, Speaking, On Hold)
pause - Pokud je state Paused, zde je uvedeno ID pauzy
state_time_absolute - Čas, kdy se u operátora změnil stav. Formát času YYYY-MM-DD HH:MM:SS
state_time_relative - Kolik sekund uplynulo od poslední změny stavu
login_time_absolute - Čas, kdy se operátor přihlásil. Formát času YYYY-MM-DD HH:MM:SS
login_time_relative - Kolik sekund je operátor přihlášen

Vstup:

https://MojeVU.daktela.com/api/3.5/RTStatsSessions/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"3":{"id":"3","extension":"200","queues":["6"],"state":"Paused","pause":"4","state_time_absolute":"2012-03-21 14:08:06","state_time_relative":"940","login_time_absolute":"2012-03-21 10:21:21","login_time_relative":"14545"}}}

Realtime stav uživatele

Požadovaná verze: 3.9

Akce:

RTUserState: Vrací aktuální stav uživatele, který je přihlášen v Call Centru, včetně probíhajícího hovoru

Povinné parametry:

user: Přihlašovací jméno agenta (nemusíme již vyplňovat povinný parametr extension)
extension: Číslo klapky (nemusíme již vyplňovat povinný parametr user)

Ukázka použití:

Popis:

Význam jednotlivých hodnot z výstupu:

agent_name - Přihlašovací jméno (login) operátora
agent_title - Celé jméno operátora
id_agent - ID operátora
exten - číslo interní klapky ke které je operátor přihlášen
logintime - absolutní čas, kdy se operátor přihlásil do call centra
agent_state - v jakém stavu se operátor nachází
- Logged - operátor je přihlášen do call centra, ale není přihlášen do fronty
- Idle - operátor je nečínný, tzn je připraven příjmout hovor
- Paused - operátor je na pauze
- Ringing - operátorský telefon právě zvoní
- Speaking - operátor hovoří
- On Hold - operátor přidržel hovor (nejspíše bude přepojovat)
state_time - absolutní čas, kdy se u operátora naposledy změnil stav (Paused, Ringing, Speaking, On Hold)
id_pause - na jaké ID pauzy je operátor
onpause - absolutní čas, kdy se operátor přepnul na pauzu (stejná hodnota jako u state_time v případě Paused)
calls - pokud operátor hovoří, tak jsou hovory v tomto poli vypsaný

id_call - ID hovoru
direction - směr hovoru (in - příchozí, out - odchozí)
clid - Telefonní číslo zákazníka se kterým operátor hovoří (pokud je směr hovoru "in" - číslo volajícího, "out" - číslo volaného)
clid_name - Textové jméno ke clid (volitelně)
id_queue - ID fronty ve které probíhá hovor
oqueue - objekt fronty ve které probíhá hovor (informativně)
entered - absolutní čas, kdy zákazník vstoupil do fronty. U odchozího hovoru je to čas, kdy operátor začal vytáčet zákazníka
ringed - absolutní čas, kdy hovor začal vyzvánět u operátora
answered - absolutní čas, kdy byl hovor zodpovězen operátorem
call_state - v jakém stavu se hovor nachází

Ringing - hovor vyzvání u operátora
Speaking - hovor je zodpovězen operátorem
On Hold - hovor je přidržen, operátor se chystá přepojovat

onhold - absolutní čas, kdy se operátor dal na On Hold

callscript_opened - ID callscriptu (formulář, record), který má operátor otevřený

Vstup:

https://MojeVU.daktela.com/api/3.9/RTUserState/json?access_token=1234567890123456789012345678901234567890&user=demouser

Výstup:

{"status":1,"error":null,"result":{"agent_name":"demouser","agent_title":"Demo User","id_agent":"4","exten":"6666","logintime":"2013-01-22 11:22:49","agent_state":"Speaking","state_time":"2013-02-01 14:20:53","id_pause":null,"onpause":null,"callscript_opened":"66","calls":[{"id_call":"1359724851.1068","direction":"in","clid":"300","clid_name":null,"id_queue":"1","oqueue":{"queue":"2","name":"99990","title":"Daktela Test OUT","description":"Daktela Test OUT pro ucely testovani","outboundcid":"","type":"out","direction":"out","wrapuptime":"15","outbounder":"0","form":"0","missed":null,"options":{"prefix":"","members":"","outboundcid":"","recording_user":"","recording_join":"","music":"inherit","maxwait":"","maxlength":"","call_timeout":"","ring_strategy":"leastrecent","last_agent_hours":"","ringtime":"20","retrytime":"5","wrapuptime":"15","record":"1","weight":"0","autofill":"yes","lajdaktime":"","loadtime":"","savetime":"","position_repeat":"","position_time":"no","ivr_jump":"","ivr_repeat":"","threshold_time":"","threshold_users":"","threshold_calls":"","missed":"","sort_time":"ASC","contact_timeout":"","contact_url":"http:\/\/","contact_open":"","qa_form":"","target":"terminate","target_terminate":"hangup","target_announcement":"2","target_extension":"500","target_signal":"","target_condition":"1","target_context":"-6","target_param":"","target_ivr_menu":"8","target_ringgroup":"600","target_queue":"1","target_custom":""},"deleted":"0","penalty":null,"login":null},"entered":"2013-02-01 14:20:52","ringed":"2013-02-01 14:20:53","answered":"2013-02-01 14:21:02","call_state":"Speaking","onhold":null}]}}

Realtime stav uživatele s informací o otevřeném formuláři a seznamu přihlášených front

Požadovaná verze: 4.0

Akce:

RTUserState: Vrací aktuální stav uživatele, který je přihlášen v Call Centru, včetně probíhajícího hovoru

Povinné parametry:

user: Přihlašovací jméno agenta (nemusíme již vyplňovat povinný parametr extension)
extension: Číslo klapky (nemusíme již vyplňovat povinný parametr user)

Volitelné parametry:

hash: Hash naposledy vráceného výsledku. Pokud předáte hash, tak se vrátí nová data jen při změně stavu operátora nebo pokud se nezmění stav od posledního vraceného stavu do 60 sekund. Při volání této metody pamatujte na prodloužení doby u klientského programu (wget, curl, atd) vrácených dat alespoň na 70 sekund.

Ukázka použití:

Popis:

Význam jednotlivých hodnot z výstupu:

agent_name - Přihlašovací jméno (login) operátora
agent_title - Celé jméno operátora
id_agent - ID operátora
exten - číslo interní klapky ke které je operátor přihlášen
logintime - absolutní čas, kdy se operátor přihlásil do call centra
agent_state - v jakém stavu se operátor nachází
- Logged - operátor je přihlášen do call centra, ale není přihlášen do fronty
- Idle - operátor je nečínný, tzn je připraven příjmout hovor
- Paused - operátor je na pauze
- Ringing - operátorský telefon právě zvoní
- Speaking - operátor hovoří
- On Hold - operátor přidržel hovor (nejspíše bude přepojovat)
state_time - absolutní čas, kdy se u operátora naposledy změnil stav (Paused, Ringing, Speaking, On Hold)
id_pause - na jaké ID pauzy je operátor
onpause - absolutní čas, kdy se operátor přepnul na pauzu (stejná hodnota jako u state_time v případě Paused)
calls - pokud operátor hovoří, tak jsou hovory v tomto poli vypsaný

id_call - ID hovoru
direction - směr hovoru (in - příchozí, out - odchozí)
clid - Telefonní číslo zákazníka se kterým operátor hovoří (pokud je směr hovoru "in" - číslo volajícího, "out" - číslo volaného)
clid_name - Textové jméno ke clid (volitelně)
id_queue - ID fronty ve které probíhá hovor
oqueue - objekt fronty ve které probíhá hovor (informativně)
entered - absolutní čas, kdy zákazník vstoupil do fronty. U odchozího hovoru je to čas, kdy operátor začal vytáčet zákazníka
ringed - absolutní čas, kdy hovor začal vyzvánět u operátora
answered - absolutní čas, kdy byl hovor zodpovězen operátorem
call_state - v jakém stavu se hovor nachází

Ringing - hovor vyzvání u operátora
Speaking - hovor je zodpovězen operátorem
On Hold - hovor je přidržen, operátor se chystá přepojovat

onhold - absolutní čas, kdy se operátor dal na On Hold

callscript_opened - ID callscriptu (formulář, record), který má operátor otevřený
login_oqueues - seznam front do kterých se operátor může přihlásit s příznakem, zda v dané frontě je aktuálně přihlášen

queue - ID fronty
name - unikátní číslo fronty
title - název fronty
direction - směr fronty (in, out)
type - typ fronty (in, out, outbounder, ctc, dialer, chat, email)

in - příchozí fronta (může být v několika současně)
out - odchozí fronta (pouze v jedné ze skupiny out, outbounder, dialer)
outbounder - navolávací odchozí kampaň (pouze v jedné ze skupiny out, outbounder, dialer)
dialer - prediktivní vytáčení (pouze v jedné ze skupiny out, outbounder, dialer)
ctc - Click to Contact (může být v několika současně)
chat - chatová fronta (může být v několika současně)
email - emailová fronta (může být v několika současně)

rt_logged - příznak, zda v této frontě je operátor aktuálně přihlášen

hash - hash aktuálně vráceného výsledku. Tento hash můžeme předat v dalším volání RTUserState, kdy se nám vrátí data až pokud dojde ke změně od minulého výsledku, ze kterého se vygeneroval hash. Při volání je třeba vždy prodloužit dobu na vrácení dat na 70 sekund. Šetříme počty HTTP dotazů na server.

Vstup:

https://MojeVU.daktela.com/api/3.9/RTUserState/json?access_token=1234567890123456789012345678901234567890&user=demouser

Výstup:

{"status":1,"error":null,"result":{"agent_name":"hajek","agent_title":"Hajek 1","id_agent":"4","exten":"1001","logintime":"2013-12-03 13:43:13","agent_state":"Paused","state_time":"2013-12-10 16:12:55","id_pause":"2","onpause":"2013-12-10 16:12:55","calls":[],"callscript_opened":null,"login_oqueues":[{"queue":"1","name":"2000","title":"test","description":"","outboundcid":"","type":"in","direction":"in","wrapuptime":"30","outbounder":"0","form":"0","missed":"5","options":{"prefix":"","members":"","outboundcid":"","recording_user":"","recording_join":"","music":"default_ericsonanton","maxwait":"","maxlength":"","call_timeout":"","ring_strategy":"ringall","last_agent_hours":"0,544","ringtime":"10","retrytime":"","wrapuptime":"30","autoanswer":"1","ringinuse":"yes","weight":"0","autofill":"yes","lajdaktime":"","loadtime":"","savetime":"","position_annoucement":"no","position_repeat":"","position_time":"no","ivr_jump":"","ivr_repeat":"","ivr_immediately":"no","threshold_time":"","threshold_users":"","threshold_calls":"","missed":"5","sort_time":"ASC","contact_timeout":"","contact_url":"http:\/\/","contact_open":"","contact_window":"","qa_form":"","target":"terminate","target_terminate":"hangup","target_announcement":"2","target_extension":"500","target_voicemail":"10","target_signal":"","target_condition":"1","target_context":"6","target_param":"","target_ivr_menu":"8","target_ringgroup":"600","target_queue":"1","target_custom":""},"deleted":"0","penalty":"0","login":"manual","rt_logged":false},{"queue":"2","name":"99990","title":"Daktela Test OUT","description":"Daktela Test OUT pro ucely testovani","outboundcid":"","type":"out","direction":"out","wrapuptime":"15","outbounder":"0","form":"0","missed":null,"options":{"prefix":"","members":"","outboundcid":"","recording_user":"","recording_join":"","music":"inherit","maxwait":"","maxlength":"","call_timeout":"","ring_strategy":"leastrecent","last_agent_hours":"","ringtime":"20","retrytime":"5","wrapuptime":"15","record":"1","weight":"0","autofill":"yes","lajdaktime":"","loadtime":"","savetime":"","position_repeat":"","position_time":"no","ivr_jump":"","ivr_repeat":"","threshold_time":"","threshold_users":"","threshold_calls":"","missed":"","sort_time":"ASC","contact_timeout":"","contact_url":"http:\/\/","contact_open":"","qa_form":"","target":"terminate","target_terminate":"hangup","target_announcement":"2","target_extension":"500","target_signal":"","target_condition":"1","target_context":"-6","target_param":"","target_ivr_menu":"8","target_ringgroup":"600","target_queue":"1","target_custom":""},"deleted":"0","penalty":"0","login":"manual","rt_logged":true},{"queue":"5","name":"2001","title":"Outbounder","description":"","outboundcid":"","type":"outbounder","direction":"out","wrapuptime":"0","outbounder":"1","form":"0","missed":null,"options":{"prefix":"","members":"","outboundcid":"","recording_user":"","recording_join":"","music":"inherit","maxwait":"","maxlength":"","call_timeout":"","ring_strategy":"leastrecent","last_agent_hours":"","ringtime":"20","retrytime":"5","wrapuptime":"","weight":"0","lajdaktime":"","loadtime":"","savetime":"","position_repeat":"","position_time":"no","ivr_jump":"","ivr_repeat":"","threshold_time":"","threshold_users":"","threshold_calls":"","missed":"","sort_time":"DESC","contact_timeout":"","contact_url":"http:\/\/","contact_open":"","qa_form":"","waittime":"20","sleeptime":"5","welcome_message":"","strategy":"","priority":"60","allowed_time":"10:00-18:00|mon-fri|*|*","target":"terminate","target_terminate":"hangup","target_announcement":"2","target_extension":"500","target_signal":"","target_condition":"1","target_context":"-6","target_param":"","target_queue":"1","target_custom":""},"deleted":"0","penalty":"0","login":"manual","rt_logged":false},{"queue":"6","name":"2002","title":"CTC","description":"","outboundcid":"","type":"ctc","direction":"in","wrapuptime":"10","outbounder":"0","form":"0","missed":null,"options":{"lang":"cs_CZ","prefix":"","members":"","allow_numbers":"(00420)?[234567][0-9]{8}\r\n(00420)?910[0-9]{6}","outboundcid":"","recording_user":"","maxwait":"","maxlength":"","call_timeout":"","ring_strategy":"leastrecent","last_agent_hours":"","ringtime":"20","retrytime":"5","wrapuptime":"10","weight":"0","threshold_time":"","threshold_users":"","threshold_calls":"","missed":"","record":"1"},"deleted":"0","penalty":"0","login":"manual","rt_logged":false},{"queue":"7","name":"2003","title":"DomluvZapasySquash","description":"","outboundcid":"603927227","type":"dialer","direction":"out","wrapuptime":"0","outbounder":"1","form":"0","missed":null,"options":{"power":"on","outboundcid":"603927227","record":"1","max_ringtime":"30","max_attempts":"1","delaytime":"1800","music":"none","maxwait":"","prediction":"0","status_busy":"22","status_reject":"23","status_hangup":"24","break":"0"},"deleted":"0","penalty":"0","login":"manual","rt_logged":false},{"queue":"8","name":"2004","title":"PredictiveDialer","description":"","outboundcid":"","type":"dialer","direction":"out","wrapuptime":"0","outbounder":"1","form":"0","missed":null,"options":{"power":"on","prediction_type":"user","prediction_percent":"0","prediction_number":"1","prediction_break":"2","outboundcid":"","recording_join":"","max_ringtime":"30","max_attempts":"1","delaytime":"1800","music":"inherit","maxwait":"","target":"terminate","target_terminate":"hangup","target_announcement":"2","target_extension":"500","target_signal":"","target_condition":"1","target_context":"-6","target_param":"","target_ivr_menu":"8","target_queue":"1","target_custom":"","status_busy":"22","status_reject":"23","status_hangup":"24","savetime":"15","record":"1"},"deleted":"0","penalty":"0","login":"manual","rt_logged":false},{"queue":"9","name":"2005","title":"Prichozi s Formularem","description":"","outboundcid":"","type":"in","direction":"in","wrapuptime":"0","outbounder":"0","form":"1","missed":null,"options":{"prefix":"","members":"","outboundcid":"","recording_user":"","recording_join":"","music":"inherit","maxwait":"","maxlength":"","call_timeout":"","ring_strategy":"leastrecent","last_agent_hours":"","ringtime":"20","retrytime":"5","wrapuptime":"","weight":"10","lajdaktime":"","loadtime":"","savetime":"","position_repeat":"","position_time":"no","ivr_jump":"","ivr_repeat":"","threshold_time":"","threshold_users":"","threshold_calls":"","missed":"","sort_time":"ASC","contact_timeout":"","contact_url":"http:\/\/","contact_open":"","form":"1","qa_form":"","waittime":"20","sleeptime":"5","welcome_message":"","strategy":"","priority":"60","allowed_time":"10:00-18:00|mon-fri|*|*","target":"terminate","target_terminate":"hangup","target_announcement":"2","target_extension":"500","target_signal":"","target_condition":"1","target_context":"-6","target_param":"","target_queue":"1","target_custom":""},"deleted":"0","penalty":"0","login":"manual","rt_logged":false},{"queue":"10","name":"2006","title":"Click2Call","description":"","outboundcid":"","type":"ctc","direction":"in","wrapuptime":"0","outbounder":"0","form":"0","missed":null,"options":{"lang":"cs_CZ","prefix":"","members":"","allow_numbers":"(00420)?[234567][0-9]{8}\r\n(00420)?910[0-9]{6}","outboundcid":"","recording_user":"","maxwait":"","maxlength":"","call_timeout":"","ring_strategy":"leastrecent","last_agent_hours":"","ringtime":"20","retrytime":"5","wrapuptime":"","weight":"0","threshold_time":"","threshold_users":"","threshold_calls":"","missed":""},"deleted":"0","penalty":"0","login":"manual","rt_logged":false},{"queue":"15","name":"2008","title":"Dotazovatel","description":"","outboundcid":"603927227","type":"interviewer","direction":"out","wrapuptime":"0","outbounder":"1","form":"0","missed":null,"options":{"power":"on","allowed_time":"00:00-23:59|mon-fri|*|*","outboundcid":"603927227","max_ringtime":"30","max_attempts":"2","delaytime":"120","maxwait":"30","status_busy":"22","status_reject":"23","status_hangup":"24","target_terminate":"hangup","target":"ivr_menu","target_announcement":"2","target_extension":"500","target_signal":"","target_condition":"1","target_context":"-6","target_param":"","target_queue":"1","target_custom":"","max_threads":"4","status_answer":"9","target_ivr_menu":"8","call_timeout":"","record":"1","target_voicemail":""},"deleted":"0","penalty":"0","login":"manual","rt_logged":false},{"queue":"16","name":"2022","title":"Outbounder_clone","description":"","outboundcid":"","type":"outbounder","direction":"out","wrapuptime":"0","outbounder":"1","form":"0","missed":null,"options":{"prefix":"","members":"","outboundcid":"","recording_user":"","recording_join":"","music":"inherit","maxwait":"","maxlength":"","call_timeout":"","ring_strategy":"leastrecent","last_agent_hours":"","ringtime":"20","retrytime":"5","wrapuptime":"","weight":"0","lajdaktime":"","loadtime":"","savetime":"","position_repeat":"","position_time":"no","ivr_jump":"","ivr_repeat":"","threshold_time":"","threshold_users":"","threshold_calls":"","missed":"","sort_time":"DESC","contact_timeout":"","contact_url":"http:\/\/","contact_open":"","qa_form":"","target":"terminate","target_terminate":"hangup","target_announcement":"2","target_extension":"500","target_signal":"","target_condition":"1","target_context":"-6","target_param":"","target_ivr_menu":"8","target_queue":"1","target_custom":""},"deleted":"0","penalty":"0","login":"manual","rt_logged":false},{"queue":"17","name":"2225","title":"Outbounder_clone2","description":"","outboundcid":"","type":"outbounder","direction":"out","wrapuptime":"0","outbounder":"1","form":"0","missed":null,"options":{"prefix":"","members":"","outboundcid":"","recording_user":"","recording_join":"","music":"inherit","maxwait":"","maxlength":"","call_timeout":"","ring_strategy":"leastrecent","last_agent_hours":"","ringtime":"20","retrytime":"5","wrapuptime":"","weight":"0","lajdaktime":"","loadtime":"","savetime":"","position_repeat":"","position_time":"no","ivr_jump":"","ivr_repeat":"","threshold_time":"","threshold_users":"","threshold_calls":"","missed":"","sort_time":"DESC","contact_timeout":"","contact_url":"http:\/\/","contact_open":"","qa_form":"","target":"terminate","target_terminate":"hangup","target_announcement":"2","target_extension":"500","target_signal":"","target_condition":"1","target_context":"-6","target_param":"","target_ivr_menu":"8","target_queue":"1","target_custom":""},"deleted":"0","penalty":"0","login":"manual","rt_logged":false},{"queue":"18","name":"2009","title":"Sem prepojim","description":"","outboundcid":"","type":"in","direction":"in","wrapuptime":"0","outbounder":"0","form":"0","missed":null,"options":{"prefix":"","members":"","outboundcid":"","recording_user":"","recording_join":"","music":"default","maxwait":"","maxlength":"","call_timeout":"","ring_strategy":"rrmemory","last_agent_hours":"","ringtime":"20","retrytime":"5","wrapuptime":"","weight":"0","lajdaktime":"","loadtime":"","savetime":"","position_repeat":"","position_time":"no","ivr_jump":"","ivr_repeat":"","threshold_time":"","threshold_users":"","threshold_calls":"","missed":"","sort_time":"ASC","contact_timeout":"","contact_url":"http:\/\/","contact_open":"","qa_form":"","target":"terminate","target_terminate":"hangup","target_announcement":"2","target_extension":"500","target_signal":"","target_condition":"1","target_context":"-6","target_param":"","target_ivr_menu":"8","target_queue":"1","target_custom":""},"deleted":"0","penalty":"0","login":"manual","rt_logged":false}],"hash":"ea8c9c6ec59a0c6d5ba4711d63105cb049dbd279"}}

Realtime stav přihlášených uživatelů

Požadovaná verze: 4.1

Akce:

RTUsersState: Vrací pole uživatelů s aktuálním stavem, tedy přihlášení v Call Centru, včetně probíhajícího hovoru

Ukázka použití:

Popis:

Význam jednotlivých hodnot z výstupu:

agent_name - Přihlašovací jméno (login) operátora
agent_title - Celé jméno operátora
id_agent - ID operátora
exten - číslo interní klapky ke které je operátor přihlášen
logintime - absolutní čas, kdy se operátor přihlásil do call centra
agent_state - v jakém stavu se operátor nachází
- Logged - operátor je přihlášen do call centra, ale není přihlášen do fronty
- Idle - operátor je nečínný, tzn je připraven příjmout hovor
- Paused - operátor je na pauze
- Ringing - operátorský telefon právě zvoní
- Speaking - operátor hovoří
- On Hold - operátor přidržel hovor (nejspíše bude přepojovat)
state_time - absolutní čas, kdy se u operátora naposledy změnil stav (Paused, Ringing, Speaking, On Hold)
id_pause - na jaké ID pauzy je operátor
onpause - absolutní čas, kdy se operátor přepnul na pauzu (stejná hodnota jako u state_time v případě Paused)
calls - pokud operátor hovoří, tak jsou hovory v tomto poli vypsaný

id_call - ID hovoru
direction - směr hovoru (in - příchozí, out - odchozí)
clid - Telefonní číslo zákazníka se kterým operátor hovoří (pokud je směr hovoru "in" - číslo volajícího, "out" - číslo volaného)
clid_name - Textové jméno ke clid (volitelně)
id_queue - ID fronty ve které probíhá hovor
oqueue - objekt fronty ve které probíhá hovor (informativně)
entered - absolutní čas, kdy zákazník vstoupil do fronty. U odchozího hovoru je to čas, kdy operátor začal vytáčet zákazníka
ringed - absolutní čas, kdy hovor začal vyzvánět u operátora
answered - absolutní čas, kdy byl hovor zodpovězen operátorem
call_state - v jakém stavu se hovor nachází

Ringing - hovor vyzvání u operátora
Speaking - hovor je zodpovězen operátorem
On Hold - hovor je přidržen, operátor se chystá přepojovat

onhold - absolutní čas, kdy se operátor dal na On Hold

callscript_opened - ID callscriptu (formulář, record), který má operátor otevřený
login_oqueues - seznam front do kterých se operátor může přihlásit s příznakem, zda v dané frontě je aktuálně přihlášen

queue - ID fronty
name - unikátní číslo fronty
title - název fronty
direction - směr fronty (in, out)
type - typ fronty (in, out, outbounder, ctc, dialer, chat, email)

in - příchozí fronta (může být v několika současně)
out - odchozí fronta (pouze v jedné ze skupiny out, outbounder, dialer)
outbounder - navolávací odchozí kampaň (pouze v jedné ze skupiny out, outbounder, dialer)
dialer - prediktivní vytáčení (pouze v jedné ze skupiny out, outbounder, dialer)
ctc - Click to Contact (může být v několika současně)
chat - chatová fronta (může být v několika současně)
email - emailová fronta (může být v několika současně)

rt_logged - příznak, zda v této frontě je operátor aktuálně přihlášen

Vstup:

https://MojeVU.daktela.com/api/4.1/RTUsersState/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"1":{"agent_name":"admin","agent_title":"Administrator","id_agent":"1","exten":"500","logintime":"2016-09-26 14:40:28","agent_state":"Idle","state_time":"2016-09-26 15:37:09","id_pause":null,"onpause":null,"calls":[],"callscript_opened":null,"login_oqueues":[{"queue":"1","name":"2000","title":"test","description":"","type":"in","direction":"in","options":{"prefix":"","members":"","outboundcid":"","recording_user":"","recording_join":"","music":"inherit","maxwait":"","maxlength":"16","call_timeout":"","ring_strategy":"leastrecent","last_agent_hours":"0","ringtime":"20","retrytime":"5","wrapuptime":"","weight":"0","lajdaktime":"","loadtime":"","savetime":"","position_annoucement":"no","position_repeat":"","position_time":"no","ivr_jump":"","ivr_repeat":"","ivr_immediately":"","threshold_time":"","threshold_users":"","threshold_calls":"","missed":"","sort_time":"ASC","contact_timeout":"","contact_url":"http:\/\/","contact_open":"","contact_window":"yes","form":"","qa_form":"","target_terminate":"hangup","target_announcement":"2","target_extension":"500","target_voicemail":"","target_signal":"","target_condition":"1","target_context":"-6","target_param":"","target_language":"","target_ivr_menu":"","target_ringgroup":"","target_queue":"1","target":"custom","target_custom":"","crm_ticket_category":""},"deleted":"0","penalty":"0","login":"manual","rt_logged":false},{"queue":"3","name":"2001","title":"PRICHOZI","description":"","type":"in","direction":"in","options":{"prefix":"","members":"","outboundcid":"","recording_user":"","recording_join":"","music":"inherit","maxwait":"","maxlength":"","call_timeout":"","ring_strategy":"leastrecent","last_agent_hours":"","ringtime":"20","retrytime":"5","wrapuptime":"15","record":"1","weight":"0","lajdaktime":"","loadtime":"","savetime":"","position_annoucement":"","position_repeat":"","position_time":"no","ivr_jump":"","ivr_repeat":"","ivr_immediately":"","threshold_time":"","threshold_users":"","threshold_calls":"","missed":"","missed_time_back":"","sort_time":"ASC","contact_timeout":"","contact_url":"https:\/\/","contact_open":"","contact_window":"","form":"","qa_form":"","target":"terminate","target_terminate":"hangup","target_announcement":"2","target_extension":"500","target_voicemail":"","target_signal":"","target_condition":"1","target_context":"-7","target_param":"","target_language":"","target_ivr_menu":"","target_ringgroup":"","target_queue":"1","target_custom":"","crm_ticket_category":""},"deleted":"0","penalty":"0","login":"manual","rt_logged":false},{"queue":"4","name":"2002","title":"ODCHOZI","description":"","type":"out","direction":"out","options":{"prefix":"","members":"","outboundcid":"226219568","recording_user":"","recording_join":"","music":"inherit","maxwait":"","maxlength":"","call_timeout":"","ring_strategy":"leastrecent","last_agent_hours":"","ringtime":"20","retrytime":"5","wrapuptime":"","weight":"0","lajdaktime":"","loadtime":"","savetime":"","position_annoucement":"","position_repeat":"","position_time":"no","ivr_jump":"","ivr_repeat":"","ivr_immediately":"","threshold_time":"","threshold_users":"","threshold_calls":"","missed":"","missed_time_back":"","sort_time":"ASC","contact_timeout":"","contact_url":"https:\/\/","contact_open":"","contact_window":"","form":"","qa_form":"","target":"terminate","target_terminate":"hangup","target_announcement":"2","target_extension":"500","target_voicemail":"","target_signal":"","target_condition":"1","target_context":"-7","target_param":"","target_language":"","target_ivr_menu":"","target_ringgroup":"","target_queue":"1","target_custom":"","crm_ticket_category":""},"deleted":"0","penalty":"0","login":"manual","rt_logged":true}]}}}

Statistika opakovaných hovorů

Požadovaná verze: 3.9

Akce:

StatsCallsRepeated: Vrací počet stejných hovorů, které se v zadaném intervalu opakují

Povinné parametry:

datetime_from: Od jakého času se mají hledat hovory. Formát času YYYY-MM-DD HH:MM:SS
datetime_to: Do jakého času se mají hledat hovory. Formát času YYYY-MM-DD HH:MM:SS

Volitelné parametry:

queues: Pole ID front
phonenumber: Telefonní číslo
count: Vypsat jen telefonní čísla, kdy je počet opakovaných hovorů vetší (ve výpisu call_total)

Ukázka použití:

Popis:

Vypsat počet opakujících hovorů pro číslo 226211245 v časovém rozmezí 2012-10-01 00:00:00 do 2012-10-30 23:59:59

Vstup:

https://MojeVU.daktela.com/api/3.9/StatsCallsRepeated/json?access_token=1234567890123456789012345678901234567890&datetime_from=2012-10-01 00:00:00&datetime_to=2012-10-30 23:59:59&phonenumber=226211245

Výstup:

{"status":1,"error":null,"result":[{"clid":"226211245","call_total":45,"call_answered":9,"call_unanswered":36,"waiting_avg":39,"duration_avg":45}]}

Statistika opakovaných hovorů

Požadovaná verze: 3.9

Akce:

StatsCallsRepeated: Vrací počet stejných hovorů, které se v zadaném intervalu opakují

Povinné parametry:

datetime_from: Od jakého času se mají hledat hovory. Formát času YYYY-MM-DD HH:MM:SS
datetime_to: Do jakého času se mají hledat hovory. Formát času YYYY-MM-DD HH:MM:SS

Volitelné parametry:

queues: Pole ID front
phonenumber: Telefonní číslo
count: Vypsat jen telefonní čísla, kdy je počet opakovaných hovorů vetší (ve výpisu call_total)

Ukázka použití:

Popis:

Vypsat počet opakujících hovorů pro číslo 226211245 v časovém rozmezí 2012-10-01 00:00:00 do 2012-10-30 23:59:59

Vstup:

https://MojeVU.daktela.com/api/3.9/StatsCallsRepeated/json?access_token=1234567890123456789012345678901234567890&datetime_from=2012-10-01 00:00:00&datetime_to=2012-10-30 23:59:59&phonenumber=226211245

Výstup:

{"status":1,"error":null,"result":[{"clid":"226211245","call_total":45,"call_answered":9,"call_unanswered":36,"waiting_avg":39,"duration_avg":45}]}

Výpis všech hovorů v callcentru

Požadovaná verze: 4.1

Akce:

StatsCalls: Vypsání callcentrových hovorů. Maximální limit vrácených hovorů je 1000, po překročení se vrací chyba.

Povinné parametry:

datetime_from: Od jakého času se mají hledat hovory. Formát času YYYY-MM-DD HH:MM:SS
datetime_to: Do jakého času se mají hledat hovory. Formát času YYYY-MM-DD HH:MM:SS

Volitelné parametry:

phonenumber: Telefonní číslo
queues: Pole ID front
did: DID číslo (příchozí číslo na které se volá)
callstatus: ID volacího stavu
answered: Zodpovězený hovor (true | false)
id_call: Unikátní číslo hovoru
users: Pole ID uživatelů
skip: Offset řádků, výchozí hodnota: 0
take: Počet řádků, výchozí hodnota: 100

Ukázka použití:

Popis:

Vyhledáme zodpovězené hovory v časovém rozmezí 2014-08-14 00:00:00 do 2014-08-31 00:00:00 a ID front 2

Vstup:

https://MojeVU.daktela.com/api/4.1/StatsCalls/json?access_token=1234567890123456789012345678901234567890&datetime_from=2014-08-14 00:00:00&datetime_to=2014-08-31 00:00:00&answered=true&queues[]=2&skip=0&take=100

Výstup:

{"status":1,"error":null,"result":{"data":[{"call":"3718","name":"1408101684.96894WS","call_time":"2014-08-15 13:21:27","direction":"out","answered":"1","queue":"2","user":"4","clid":"468008585","contact":"3","did":"","waiting_time":"4","ringing_time":"4","hold_time":"0","duration":"12","orig_pos":"1","position":"1","disposition_cause":"agent","disconnection_cause":"","pressed_key":null,"score":null,"note":"","attempts":"0","qa_user_id":null},{"call":"3717","name":"1408101613.60440WS","call_time":"2014-08-15 13:20:16","direction":"out","answered":"1","queue":"2","user":"4","clid":"468008585","contact":"3","did":"","waiting_time":"3","ringing_time":"3","hold_time":"0","duration":"6","orig_pos":"1","position":"1","disposition_cause":"agent","disconnection_cause":"","pressed_key":null,"score":null,"note":"","attempts":"0","qa_user_id":null},{"call":"3712","name":"1408009470.20542WS","call_time":"2014-08-14 11:44:33","direction":"out","answered":"1","queue":"2","user":"4","clid":"468008585","contact":"3","did":"","waiting_time":"4","ringing_time":"4","hold_time":"0","duration":"6","orig_pos":"1","position":"1","disposition_cause":"agent","disconnection_cause":"","pressed_key":null,"score":null,"note":"","attempts":"0","qa_user_id":null},{"call":"3711","name":"1408009401.37480WS","call_time":"2014-08-14 11:43:24","direction":"out","answered":"1","queue":"2","user":"4","clid":"468008585","contact":"3","did":"","waiting_time":"4","ringing_time":"4","hold_time":"0","duration":"13","orig_pos":"1","position":"1","disposition_cause":"agent","disconnection_cause":"","pressed_key":null,"score":null,"note":"","attempts":"0","qa_user_id":null},{"call":"3708","name":"1408008186.36","call_time":"2014-08-14 11:23:08","direction":"out","answered":"1","queue":"2","user":"4","clid":"603927227","contact":null,"did":"","waiting_time":"20","ringing_time":"20","hold_time":"0","duration":"13","orig_pos":"1","position":"1","disposition_cause":"caller","disconnection_cause":"","pressed_key":null,"score":null,"note":"","attempts":"0","qa_user_id":null}],"total":"5"}}

Trasování akcí hovorů, pauz, front a přihlášení do call centra

Požadovaná verze: 3.5

Akce:

StatsTrace: Chronologicky vypíše pro daného operátora požadovanou akci, jako je například doba, kdy se uživatel přihlásil nebo odhlásil do Call Centra, fronty, pauzy a také hovory, které na operátora šly

Povinné parametry:

datetime_from: Od jakého času se mají hledat akce. Formát času YYYY-MM-DD HH:MM:SS
datetime_to: Do jakého času se mají hledat akce. Formát času YYYY-MM-DD HH:MM:SS
user: Přihlašovací jméno uživatele, kterého chceme vypsat

Volitelné parametry:

trace

Jakou akci chceme vypsat. Pokud nespecifikujeme, vypíšou se všechny akce (all)

all - všechny akce
call - začátek a konec hovoru včetně vyzvánění
pause - přihlášení a odhlášení z pauzy
queue - přihlášení a odhlášení z fronty
login - přihlášení a odhlášení z call centra

Ukázka použití:

Popis:

Vypíšeme všechny akce pro uživatele s přihlašovacím jménem hajek v časovém rozmezí 18.5.2012 - 30.5.2012 Význam jednotlivých hodnot z výstupu:

time - Datum a čas, kdy proběhla tato akce. Formát času YYYY-MM-DD HH:MM:SS
duration - kolik sekund trvala tato akce, je vyplněná u ukončovací akce
action_name - jméno akce (call, pause, queue, login, ring_out, ring_in)
action_start - každá akce musí mít žačátek a konec, tedy pokud je nastavena 1 znamená to žačátek akce, 0 znamená ukončenou akci
action_title - textový popisek počáteční a ukončovací akce
event_id - pro danou action_name je takovýto význam
- call - Linka nebo skupina, která hovor zodpověděla
- pause - ID pauzy
- queue - ID fronty
- ring_in - ID příchozího hovoru
- ring_out - Linka nebo skupina, na které odchozí hovor vyzváněl
- login - žádné informace
event_title - pro danou action_name je takovýto význam
- call - Telefonní číslo na které se volalo
- pause - Jméno pauzy
- queue - Jméno fronty
- ring_in - Linka nebo skupina, na které příchozí hovor vyzváněl
- ring_out - Telefonní číslo, na které se volalo
- login - žádné informace
time_unixtime - Datum a čas, kdy proběhla tato akce, ale ve formátu UNIX time nebo POSIX time, tedy počet sekund od 1.ledna 1970.

Vstup:

http://MojeVU.daktela.com/api/3.5/StatsTrace/json?access_token=1234567890123456789012345678901234567890&datetime_from=2012-05-18%2000:00:00&datetime_to=2012-05-30%2000:00:00&user=hajek&trace=all

Výstup:

{"status":1,"error":null,"result":[{"time":"2012-05-18 12:33:23","duration":0,"action_name":"login","action_start":"1","action_title":"P\u0159ihl\u00e1\u0161en\u00ed na \u00fast\u0159ednu","event_id":"","event_title":""},{"time":"2012-05-18 12:33:28","duration":0,"action_name":"queue","action_start":"1","action_title":"P\u0159ihl\u00e1\u0161en\u00ed do fronty","event_id":"4","event_title":"Odchozi bez F"},{"time":"2012-05-18 12:34:03","duration":0,"action_name":"ring_out","action_start":"1","action_title":"Za\u010d\u00e1tek vyzv\u00e1n\u011bn\u00ed - Odchod","event_id":"718","event_title":"468008585"},{"time":"2012-05-18 12:34:09","duration":6,"action_name":"ring_out","action_start":"0","action_title":"Konec vyzv\u00e1n\u011bn\u00ed - Odchod","event_id":"718","event_title":"468008585"},{"time":"2012-05-18 12:34:09","duration":0,"action_name":"call","action_start":"1","action_title":"Za\u010d\u00e1tek hovoru","event_id":"718","event_title":"468008585"},{"time":"2012-05-18 12:34:58","duration":49,"action_name":"call","action_start":"0","action_title":"Konec hovoru","event_id":"718","event_title":"468008585"},{"time":"2012-05-18 12:35:08","duration":0,"action_name":"ring_out","action_start":"1","action_title":"Za\u010d\u00e1tek vyzv\u00e1n\u011bn\u00ed - Odchod","event_id":"720","event_title":"468008585"},{"time":"2012-05-18 12:35:13","duration":5,"action_name":"ring_out","action_start":"0","action_title":"Konec vyzv\u00e1n\u011bn\u00ed - Odchod","event_id":"720","event_title":"468008585"},{"time":"2012-05-18 12:35:13","duration":0,"action_name":"call","action_start":"1","action_title":"Za\u010d\u00e1tek hovoru","event_id":"720","event_title":"468008585"},{"time":"2012-05-18 12:35:31","duration":0,"action_name":"ring_out","action_start":"1","action_title":"Za\u010d\u00e1tek vyzv\u00e1n\u011bn\u00ed - Odchod","event_id":"719","event_title":"603927227"},{"time":"2012-05-18 12:35:40","duration":9,"action_name":"ring_out","action_start":"0","action_title":"Konec vyzv\u00e1n\u011bn\u00ed - Odchod","event_id":"719","event_title":"603927227"},{"time":"2012-05-18 12:35:40","duration":0,"action_name":"call","action_start":"1","action_title":"Za\u010d\u00e1tek hovoru","event_id":"719","event_title":"603927227"},{"time":"2012-05-18 12:36:03","duration":23,"action_name":"call","action_start":"0","action_title":"Konec hovoru","event_id":"719","event_title":"603927227"},{"time":"2012-05-18 12:36:03","duration":0,"action_name":"pause","action_start":"1","action_title":"Za\u010d\u00e1tek pauzy","event_id":"2","event_title":"Wrap"},{"time":"2012-05-18 12:36:14","duration":11,"action_name":"pause","action_start":"0","action_title":"Konec pauzy","event_id":"2","event_title":"Wrap"},{"time":"2012-05-18 12:36:31","duration":78,"action_name":"call","action_start":"0","action_title":"Konec hovoru","event_id":"720","event_title":"468008585"}]}

Statistika přihlášení uživatelů na pauzy

Požadovaná verze: 4.1

Akce:

StatsUsersPauses: Chronologicky vypisuje příhlášení jednotlivých uživatelů na pauzy

Povinné parametry:

datetime_from: Od jakého času se mají hledat přihlášení na pauzy. Formát času YYYY-MM-DD HH:MM:SS
datetime_to: Do jakého času se mají hledat přihlášení na pauzy. Formát času YYYY-MM-DD HH:MM:SS

Volitelné parametry:

users: Pole ID uživatelů
pauses: Pole ID pauz.
skip: Offset řádků, výchozí hodnota: 0
take: Počet řádků, výchozí hodnota: 100

Ukázka použití:

Popis:

Chronologicky vypíšeme přihlášení uživatele s ID 1 v časovém rozmezí 2012-08-01 00:00:00 do 2014-10-30 23:59:59

Vstup:

https://MojeVU.daktela.com/api/4.1/StatsUsersPauses/json?access_token=1234567890123456789012345678901234567890&datetime_from=2012-08-01 00:00:00&datetime_to=2014-10-30 23:59:59&users[]=1&skip=0&take=100

Výstup:

{"status":1,"error":null,"result":{"data":[{"id":"1052","user":"1","start_time":"2014-08-05 13:21:33","end_time":"2014-08-05 13:21:43","duration":10,"pause":2},{"id":"1053","user":"1","start_time":"2014-08-05 13:50:51","end_time":"2014-08-05 13:50:56","duration":5,"pause":2},{"id":"1055","user":"1","start_time":"2014-08-05 14:00:18","end_time":"2014-08-05 14:00:28","duration":10,"pause":2}],"total":"135"}}

Statistika přihlášení uživatelů do front

Požadovaná verze: 4.1

Akce:

StatsUsersQueues: Chronologicky vypisuje příhlášení jednotlivých uživatelů do front

Povinné parametry:

datetime_from: Od jakého času se mají hledat přihlášení do front. Formát času YYYY-MM-DD HH:MM:SS
datetime_to: Do jakého času se mají hledat přihlášení do front. Formát času YYYY-MM-DD HH:MM:SS

Volitelné parametry:

users: Pole ID uživatelů
skip: Offset řádků, výchozí hodnota: 0
take: Počet řádků, výchozí hodnota: 100

Ukázka použití:

Popis:

Chronologicky vypíšeme přihlášení uživatele s ID 1 v časovém rozmezí 2012-08-01 00:00:00 do 2012-10-30 23:59:59

Vstup:

https://MojeVU.daktela.com/api/4.1/StatsUsersQueues/json?access_token=1234567890123456789012345678901234567890&datetime_from=2012-08-01 00:00:00&datetime_to=2012-10-30 23:59:59&users[]=1&skip=0&take=100

Výstup:

{"status":1,"error":null,"result":{"data":[{"user":"1","start_time":"2014-08-14 13:35:07","end_time":"2014-09-09 14:55:20","duration":2251213,"queue":5},{"user":"1","start_time":"2014-08-21 14:03:39","end_time":"2014-09-09 14:55:21","duration":1644702,"queue":3},{"user":"1","start_time":"2014-09-02 14:37:57","end_time":"2014-09-09 14:55:22","duration":605845,"queue":4}],"total":10}}

Statistika přihlášení uživatelů

Požadovaná verze: 4.1

Akce:

StatsUsersSessions: Chronologicky vypisuje příhlášení jednotlivých uživatelů do callcentra

Povinné parametry:

datetime_from: Od jakého času se mají hledat hovory. Formát času YYYY-MM-DD HH:MM:SS
datetime_to: Do jakého času se mají hledat hovory. Formát času YYYY-MM-DD HH:MM:SS

Volitelné parametry:

users: Pole ID uživatelů
skip: Offset řádků, výchozí hodnota: 0
take: Počet řádků, výchozí hodnota: 100

Ukázka použití:

Popis:

Chronologicky vypíšeme přihlášení uživatele s ID 3 v časovém rozmezí 2012-10-01 00:00:00 do 2014-10-30 23:59:59

Vstup:

https://MojeVU.daktela.com/api/4.1/StatsUsersSessions/json?datetime_from=2012-01-01%2000:00:00&datetime_to=2014-10-30%2023:59:59&users[]=3&skip=0&take=100

Výstup:

{"status":1,"error":null,"result":{"data":[{"id":"1","user":"3","start_time":"2013-01-08 10:51:04","end_time":"2013-01-08 10:51:42","duration":38},{"id":"5","user":"3","start_time":"2013-01-30 12:13:28","end_time":"2013-01-30 12:14:06","duration":38},{"id":"9","user":"3","start_time":"2013-02-03 10:00:40","end_time":"2013-02-03 10:01:19","duration":39}],"total":"7"}}

Získáme volitelné parametry pro hostovanou SMS bránu

Požadovaná verze: 3.1

Akce:

GetSMSSettings: Získáte URL a emailové callbacky při příchozí a odchozí SMS zprávě, časy, kdy se můžou odesílat SMS zpŕavy a počty odeslaných zpráv za časové období.

Ukázka použití:

Popis:

Získání parametrů

Vstup:

http://api.daktela.com/api/3.1/GetSMSSettings/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"settings":{"billing_id":"674","enabled_sms":"CONNECT","outgoing_price":"0.000","incoming_callback":null,"outgoing_callback":null,"incoming_email":null,"outgoing_email":null,"email_notification_allow":"in,out,confirmed","sending_rate_limit":"0","sending_rate_time":"0","allowed_hour_begin":"0","allowed_hour_end":"0","sending_rate_limit_admin":"1000","sending_rate_time_admin":"86400","lang":"cs_CZ","connect_sender":null},"sim":[]}}

Vrátí všechny SMS zprávy s možností vyhledávání

Požadovaná verze: 3.1

Akce:

GetSMS: Pokud nepředáme vyhledávací kritéria, tak vrátí všechny SMS zprávy seřazené podle data (od nejstarší po nejnovější). Vyhledávací kritéria jsou telefonní číslo, text ve zprávách, číslo brány, číslo slotu, číslo portu. Pokud result obsahuje "error", tak v code_error je v hex zapsaný kód s chybou, výpis všech chybových kódů získáte zde

Volitelné parametry:

id: ID konkrétní SMS zprávy
direction: Vrátíme jen příchozí(in) nebo odchozí(out) zprávy.
keyword: Vyhledávání podle telefonního čísla nebo textu ve zprávách.
accountcode: Volitelná identifikace zprávy u odchozí zprávy. Možnost předat jako pole, pokud chceme předat více accountcodu.
email: Volitelná položka email, pokud byla předána u odchozí zprávy.
gw: Vrátíme zprávy, které šly přes tuto bránu.
slot: Vrátíme zprávy, které šly přes tento slot.
port: Vrátíme zprávy, které šly přes tento port.
datetime_from: Od jakého data a času se mají vypsat SMS zprávy. Formát vstupu je YYYY-MM-DD HH:MM:SS
datetime_to: Do jakého data a času se mají vypsat SMS zprávy. Formát vstupu je YYYY-MM-DD HH:MM:SS

Důležité: Upozorňujeme, že doba uchovávání SMS zpráv na Daktele je nastavena na 6 měsíců. SMS zprávy starší než 6 měsíců budou automaticky smazány.

Ukázka použití:

Popis:

Vrátíme všechny SMS zprávy s vyhledáváním textu ahoj

Vstup:

https://api.daktela.com/api/3.1/GetSMS/json?access_token=1234567890123456789012345678901234567890&keyword=ahoj

Výstup:

{"status":1,"error":null,"result":[{"id":"7180","billing_id":"259","direction":"out","datetime":"2011-10-11 01:07:01","datetime_processed":"2011-10-10 23:07:26","number":"603927227","attempts":"0","count_sms":"1","from_client":"","message":"Ahoj toto je jen na ukazku","result":"error","confirmation_enable":"1","confirmed":"0","price":"0.000","gw_number":"1","slot_number":"1","port_number":"2","accountcode":null,"email":null},{"id":"7178","billing_id":"259","direction":"out","datetime":"2011-10-10 17:25:19","datetime_processed":"2011-10-10 15:27:03","number":"603927227","attempts":"0","count_sms":"1","from_client":"","message":"Ahoj,jak se mas?","result":"ok","confirmation_enable":"1","confirmed":"1","price":"3.500","gw_number":"1","slot_number":"1","port_number":"1","accountcode":null,"email":null}]}

Odstraní odesílání skupinových SMS zpráv

Požadovaná verze: 3.1

Akce:

RemoveGroupSMS: Nenávratně zastaví skupinové odesílání SMS zpráv, které jsou ve stavu čekání na odeslání. Výsledkem je počet zpráv, které odeslány nebudou ze skupiny.

Povinné parametry:

id: ID konkrétní skupinové SMS zprávy (group_id)

Ukázka použití:

Popis:

Odstraníme skupinové SMS zprávy se skupinovým ID 1234

Vstup:

https://api.daktela.com/api/3.1/RemoveGroupSMS/1234/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"count_removed":2}}

Odeslat skupinovou SMS zprávu

Požadovaná verze: 3.1

Akce:

SendGroupSMS: Odešleme skupinovou SMS zprávu přes hostingovou bránu. Limit je 20.000 zpráv. Pokud vlastníme více SIM karet, tak se SMS zprávy odesílají cyklicky.

Povinné parametry:

number: Pole s telefonníma číslama, na které chceme poslat zprávu. Limit je 20.000 zpráv.
message: Pole SMS zpráv. Délka jedné zprávy může být 160 znaku. Pokud je zadáno více znaků, bude SMS automaticky rozdělena na více zpráv. Může být zadáno maximálně 1377 (utf8 603) znaků. Limit je 20.000 zpráv.

Volitelné parametry:

confirmation: Zda má být zpětně potvrzeno doručenkou. Je třeba mít definovany URL callback nebo emailovou adresu, kam se zašle potvrzení.
unicode: Text SMS zprávy odeslán včetně diakritiky. Max délka jedné SMS zprávy se zkrátí na 70 znaků. Pokud není unicode nastaven, text zprávy se automaticky zkonvertuje na ASCII znaky.
email: Email na který se má zaslat odpověd na odeslanou SMS zprávu nebo potvrzení o doručení.
accountcode: Volitelná identifikace zprávy. Tento kód bude vracen v URL callbacku.
priority: Priorita zprávy. Rozmezí 0 (nízká) až 20 (vysoká). Výchozí je 10.
datetime_scheduled: Datum a čas kdy se má odeslat zpráva. Format: YYYY-MM-DD HH:MM:SS

Ukázka použití:

Popis:

Chceme odeslat skupinovou SMS zprávu na číslo 123456789 s textem Ahoj a současně chceme odeslat na číslo 987654321 s textem Cau. bez potvrzení o doručení. V count_sms se nám vrací počet odeslaných SMS zpráv.

Vstup:

https://api.daktela.com/api/3.1/SendGroupSMS/json?number[0]=123456789&message[0]=Ahoj1&number[1]=987654321&message[1]=Ahoj2&access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"2445":{"count_sms":0,"id":2445,"group_id":2445},"2446":{"count_sms":1,"id":2446,"group_id":2445},"2447":{"count_sms":1,"id":2447,"group_id":2445}}}

Odeslat SMS zprávu

Požadovaná verze: 3.1

Akce:

SendSMS: Odešleme SMS zprávu přes hostingovou bránu. Pokud vlastníme více SIM karet a nespecifikujeme číslo gw, slotu a portu, tak se SMS zprávy odesílají cyklicky.

Povinné parametry:

number: Telefonní číslo, na které chceme poslat zprávu
message: Text SMS zprávy. Délka jedné zprávy může být 160 znaku. Pokud je zadáno více znaků, bude SMS automaticky rozdělena na více zpráv. Může být zadáno maximálně 1377 (utf8 603) znaků.

Volitelné parametry:

confirmation: Zda má být zpětně potvrzeno doručenkou. Je třeba mít definovany URL callback nebo emailovou adresu, kam se zašle potvrzení.
unicode: Text SMS zprávy odeslán včetně diakritiky. Max délka jedné SMS zprávy se zkrátí na 70 znaků. Pokud není unicode nastaven, text zprávy se automaticky zkonvertuje na ASCII znaky.
email: Email na který se má zaslat odpověd na odeslanou SMS zprávu nebo potvrzení o doručení.
accountcode: Volitelná identifikace zprávy. Tento kód bude vracen v URL callbacku.
gw: Můžeme specifikovat přes jaké číslo brány má SMS odejít, pokud je v hostingu více SIM karet. Pro použití je třeba specifikovat gw, slot i port.
slot: Můžeme specifikovat přes jaké číslo slotu má SMS odejít, pokud je v hostingu více SIM karet. Pro použití je třeba specifikovat gw, slot i port.
port: Můžeme specifikovat přes jaké číslo portu má SMS odejít, pokud je v hostingu více SIM karet. Pro použití je třeba specifikovat gw, slot i port.
priority: Priorita zpravy. Rozmezi 0 (nízká) až 20 (vysoká). Výchozí je 10.
datetime_scheduled: Datum a čas kdy se má odeslat zpráva. Format: YYYY-MM-DD HH:MM:SS

Ukázka použití:

Popis:

Chceme odeslat SMS zprávu na číslo 123456789 bez potvrzení o doručení. V count_sms se nám vrací počet odeslaných SMS zpráv.

Vstup:

https://api.daktela.com/api/3.1/SendSMS/json?number=123456789&message=Ahoj&access_token=1234567890123456789012345678901234567890

Výstup:

{"error":null,"status":1,"result":{"count_sms":"1", "id":"2222"}}

Popis:

Odešleme SMS zprávu s požadavkem o potvrzeném doručení(musí být nastaven callback nebo email, na který chceme tuto informaci předat) a vložíme i accountcode.

Vstup:

https://api.daktela.com/api/3.1/SendSMS/json?number=123456789&message=Ahoj&access_token=1234567890123456789012345678901234567890&confirmation=yes&accountcode=ID12345

Výstup:

{"error":null,"status":1,"result":{"count_sms":"1", "id":"2222"}}

Volitelné nastavení pro hostovanou SMS bránu

Požadovaná verze: 3.1

Akce:

SetSMSSettings: Možnost nastavit příchozí nebo odchozí URL callback, který se zavolá při každé přijaté nebo odeslané SMS zprávě. Stejně tak se dá nastavit email, na který se má příchozí zpráva poslat. URL může obsahovat přihlašovací údaje přes Basic Authorizaci (htaccess). Například http://login:heslo@pbx.in:8080/path

Volitelné parametry:

incoming_callback: Na jakou URL adresu se mají notifikovat všechny příchozí SMS zprávy.
outgoing_callback: Na jakou URL adresu se mají notifikovat všechny odchozí SMS zprávy, včetně doručenek.
incoming_email: Na jakou emailovou adresu se mají notifikovat všechny příchozí SMS zprávy.
outgoing_email: Na jakou emailovou adresu se mají notifikovat všechny odchozí SMS zprávy včetně doručenek.
sending_rate_limit: Počet zpráv, které se můžou maximálně odeslat. Je třeba specifikovat i parametr sending_rate_time. Omezení platí jen pro zprávy, které jsou odeslány jednotlivě, tedy přes SendSMS. Pro vypnutí nastavte 0.
sending_rate_time: Za jakou dobu v sekundach se může odeslat maximální počet zpráv. Je třeba specifikovat i parametr sending_rate_limit. Omezení platí jen pro zprávy, které jsou odeslány jednotlivě, tedy přes SendSMS. Pro vypnutí nastavte 0.
allowed_hour_begin: Počáteční hodina, od kdy se mohou odesílat SMS zprávy. Zprávy poslané mimo povolený interval, budou uloženy na serveru a odeslány budou až bude časový interval splněný. Pro vypnutí nastavte 0.
allowed_hour_end: Konečná hodina, do kdy se mohou odesílat SMS zprávy. Zprávy poslané mimo povolený interval, budou uloženy na serveru a odeslány budou až bude časový interval splněný. Pro vypnutí nastavte 0.

Ukázka použití:

Popis:

Nastavení příchozího URL callbacku na http://callback.daktela.com/CRM/sms

Vstup:

https://api.daktela.com/api/3.1/SetSMSSettings/json?access_token=1234567890123456789012345678901234567890&incoming_callback=http://MojeVU.daktela.com/CRM/sms

Výstup:

{"error":null,"status":1}

Popis:

Nastavení příchozího URL callbacku na http://callback.daktela.com/CRM/sms, ale chceme si sami pojmenovat jména parametrů (zbývající parametry, které se nevyspecifikují budou doplněny automaticky na konec URL)

Vstup:

https://api.daktela.com/api/3.1/SetSMSSettings/json?access_token=1234567890123456789012345678901234567890&incoming_callback=http://MojeVU.daktela.com/CRM/sms?own_number=$number&own_text=$message&own_id=$id&own_direction=$direction

Výstup:

{"error":null,"status":1}

Popis:

Chceme, aby server odesílal SMS zprávy od 8:00 do 16:59.

Vstup:

https://api.daktela.com/api/3.1/SetSMSSettings/json?access_token=1234567890123456789012345678901234567890&allowed_hour_begin=8&allowed_hour_end=16

Výstup:

{"error":null,"status":1}

Informace o odeslaných skupinových SMS zprávách

Požadovaná verze: 3.1

Akce:

StatusGroupSMS: Vrátí počty zpráv, které jsou ve stavu odeslánych, čekajících, chybně odeslaných

Volitelné parametry:

id: ID konkrétní skupinové SMS zprávy (group_id)
waiting: Pokud chceme získat informace jen o čekajících skupinových zprávách, nastavíme na true hodnotu.

Ukázka použití:

Popis:

Získáme informace o počtu zpráv, které je třeba ještě odeslat u skupinových zpráv Význam jednotlivých hodnot z výstupu:

group_id - ID skupinové SMS
accountcode - Volitelný identifikátor, pokud byl specifikovaný při odesílání
datetime_processed - Datum posledního zpracování/odeslání SMS zprávy
datetime - Datum, kdy byl vytvořen požadavek na odeslání skupinové SMS zprávy
count_total - Celkový počet SMS zpráv ve skupině
count_ok - Počet v pořádku odeslaných zpráv ze skupiny
count_waiting - Počet zpráv, které čekají na odeslání ve skupině
count_error - Počet zpráv, které skončily s chybou

Vstup:

https://api.daktela.com/api/3.1/StatusGroupSMS/json?access_token=1234567890123456789012345678901234567890&waiting=true

Výstup:

{"status":1,"error":null,"result":{"11213":{"group_id":"11213","accountcode":"1","datetime_processed":"2012-04-14 02:43:39","datetime":"2012-04-14 02:43:33","count_total":"3","count_ok":"1","count_waiting":"2","count_error":"0"}}}

Celkový počet čekajících zpráv k odeslání

Požadovaná verze: 3.1

Akce:

StatusSMS: Vrací celkový počet čekajících zpráv a době poslední odeslané zprávy

Ukázka použití:

Popis:

Význam jednotlivých hodnot z výstupu:

count_waiting - počet zpráv, které čekají ve frontě na odeslání
last_datetime_processed - datum a čas poslední úspěšně odeslané zprávy ( bez potvrzené doručenky )

Vstup:

https://api.daktela.com/api/3.1/StatusSMS/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"count_waiting":"3963","last_datetime_processed":"2013-08-06 16:35:26"}}

Vrátí všechny SMS zprávy s možností vyhledávání

Požadovaná verze: 4.1

Akce:

GetSMSConnect

Pokud nepředáme vyhledávací kritéria, tak vrátí všechny SMS zprávy seřazené podle data (od nejstarší po nejnovější).
Result zpráv

NEW - zpráva čeká na odeslání
SENT - zpráva odeslána
DELIVERED - zpráva doručena. Čas se zapíše do atributu datetime_delivered. (musí být zapnutá doručenka)
NOTDELIVERED - zpráva nebyla doručena, např číslo neexistuje, blokováno. Čas se zapíše do atributu datetime_notdelivered. (musí být zapnutá doručenka)
EXPIRED - zpráva byla poslána na existující číslo, ale nebyla po dobu několika dní přečtena. Čas se zapíše do atributu datetime_notdelivered. (musí být zapnutá doručenka)
ERROR - interní chyba
FORBIDDEN - stopnutí posílání zpráv (např chybná SMS kampaň)

Volitelné parametry:

id: ID konkrétní SMS zprávy
direction: Vrátíme jen příchozí(in) nebo odchozí(out) zprávy.
keyword: Vyhledávání podle telefonního čísla nebo textu ve zprávách.
datetime_from: Od jakého data a času se mají vypsat SMS zprávy. Formát vstupu je YYYY-MM-DD HH:MM:SS
datetime_to: Do jakého data a času se mají vypsat SMS zprávy. Formát vstupu je YYYY-MM-DD HH:MM:SS
accountcode: Volitelná identifikace zprávy u odchozí zprávy. Možnost předat jako pole, pokud chceme předat více accountcodu.

Důležité: Upozorňujeme, že doba uchovávání SMS zpráv na Daktele je nastavena na 6 měsíců. SMS zprávy starší než 6 měsíců budou automaticky smazány.

Ukázka použití:

Popis:

Vrátíme všechny SMS zprávy s vyhledáváním textu ahoj

Vstup:

https://api.daktela.com/api/4.1/GetSMSConnect/json?access_token=1234567890123456789012345678901234567890&keyword=ahoj

Výstup:

{"status":1,"error":null,"result":{"16":{"id":"16","message_id":"013000000009689Bulk_000000bc","billing_id":"987","direction":"OUT","result":"SENT","datetime":"2014-09-01 15:00:40","datetime_sent":"2014-09-01 15:00:41","datetime_delivered":null,"datetime_billed":null,"sender":null,"recipient":"00420123456789","price":"0.590","message":"Ahoj","sms_encoding":"UTF8","count_sms":"1","request_dlr":"0","attempts":"0","group_id":null}}}

Získáme volitelné parametry pro hostovanou SMS bránu

Požadovaná verze: 3.1

Akce:

GetSMSSettings: Získáte URL a emailové callbacky při příchozí a odchozí SMS zprávě, časy, kdy se můžou odesílat SMS zpŕavy a počty odeslaných zpráv za časové období.

Ukázka použití:

Popis:

Získání parametrů

Vstup:

http://api.daktela.com/api/3.1/GetSMSSettings/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"settings":{"billing_id":"674","enabled_sms":"CONNECT","outgoing_price":"0.000","incoming_callback":null,"outgoing_callback":null,"incoming_email":null,"outgoing_email":null,"email_notification_allow":"in,out,confirmed","sending_rate_limit":"0","sending_rate_time":"0","allowed_hour_begin":"0","allowed_hour_end":"0","sending_rate_limit_admin":"1000","sending_rate_time_admin":"86400","lang":"cs_CZ","connect_sender":null},"sim":[]}}

Odeslat skupinovou SMS zprávu

Požadovaná verze: 3.1

Akce:

SendGroupSMSConnect: Odešleme skupinovou SMS zprávu přes SMS connect. Limit je 20.000 zpráv.

Povinné parametry:

number: Pole s telefonníma číslama, na které chceme poslat zprávu. Limit je 20.000 zpráv.
message: Pole SMS zpráv. Délka jedné zprávy může být 160 znaku. Pokud je zadáno více znaků, bude SMS automaticky rozdělena na více zpráv. Může být zadáno maximálně 1377 (utf8 603) znaků. Limit je 20.000 zpráv.

Volitelné parametry:

confirmation: Zda má být zpětně potvrzeno doručenkou. Je třeba mít definovany URL callback nebo emailovou adresu, kam se zašle potvrzení.
accountcode: Volitelná identifikace zprávy. Tento kód bude vracen v URL callbacku.
priority: Priorita zpravy. Rozmezi 0 (nízká) až 20 (vysoká). Výchozí je 10.
datetime_scheduled: Datum a čas kdy se má odeslat zpráva. Format: YYYY-MM-DD HH:MM:SS
sender: Odchozí identifikace. Tato identifikace musí být povolena. Výchozí Info.

Ukázka použití:

Popis:

Chceme odeslat skupinovou SMS zprávu na číslo 123456789 s textem Ahoj a současně chceme odeslat na číslo 987654321 s textem Cau. bez potvrzení o doručení. V count_sms se nám vrací počet odeslaných SMS zpráv.

Vstup:

https://api.daktela.com/api/3.1/SendGroupSMS/json?number[0]=123456789&message[0]=Ahoj1&number[1]=987654321&message[1]=Ahoj2&access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"2445":{"count_sms":0,"id":2445,"group_id":2445},"2446":{"count_sms":1,"id":2446,"group_id":2445},"2447":{"count_sms":1,"id":2447,"group_id":2445}}}

Odeslat SMS zprávu

Požadovaná verze: 4.1

Akce:

SendSMSConnect: Odešleme SMS zprávu

Povinné parametry:

number: Telefonní číslo, na které chceme poslat zprávu, ve tvaru +420xxx
message: Text SMS zprávy. Délka jedné zprávy může být 160 znaku. Pokud je zadáno více znaků, bude SMS automaticky rozdělena na více zpráv. Může být zadáno maximálně 1377 (utf8 603) znaků.

Volitelné parametry:

confirmation: Zda má být zpětně potvrzeno doručenkou. Je třeba mít definovany URL callback nebo emailovou adresu, kam se zašle potvrzení.
priority: Priorita zpravy. Rozmezi 0 (nízká) až 20 (vysoká). Výchozí je 10.
accountcode: Volitelná identifikace zprávy. Tento kód bude vracen v URL callbacku.
datetime_scheduled: Datum a čas kdy se má odeslat zpráva. Format: YYYY-MM-DD HH:MM:SS
sender: Odchozí identifikace. Tato identifikace musí být povolena. Výchozí Info.
unicode: Text SMS zprávy odeslán včetně diakritiky. Max délka jedné SMS zprávy se zkrátí na 70 znaků. Pokud není unicode nastaven, text zprávy se automaticky zkonvertuje na ASCII znaky.

Ukázka použití:

Popis:

Chceme odeslat SMS zprávu na číslo +420123456789 bez potvrzení o doručení. V count_sms se nám vrací počet odeslaných SMS zpráv.

Vstup:

https://api.daktela.com/api/4.1/SendSMSConnect/json?number=%2B420123456789&message=Ahoj&access_token=1234567890123456789012345678901234567890

Výstup:

{"error":null,"status":1,"result":{"id":"2222"}}

Volitelné nastavení pro hostovanou SMS bránu

Požadovaná verze: 3.1

Akce:

SetSMSSettings: Možnost nastavit příchozí nebo odchozí URL callback, který se zavolá při každé přijaté nebo odeslané SMS zprávě. Stejně tak se dá nastavit email, na který se má příchozí zpráva poslat. URL může obsahovat přihlašovací údaje přes Basic Authorizaci (htaccess). Například http://login:heslo@pbx.in:8080/path

Volitelné parametry:

incoming_callback: Na jakou URL adresu se mají notifikovat všechny příchozí SMS zprávy.
outgoing_callback: Na jakou URL adresu se mají notifikovat všechny odchozí SMS zprávy, včetně doručenek.
incoming_email: Na jakou emailovou adresu se mají notifikovat všechny příchozí SMS zprávy.
outgoing_email: Na jakou emailovou adresu se mají notifikovat všechny odchozí SMS zprávy včetně doručenek.
sending_rate_limit: Počet zpráv, které se můžou maximálně odeslat. Je třeba specifikovat i parametr sending_rate_time. Omezení platí jen pro zprávy, které jsou odeslány jednotlivě, tedy přes SendSMS. Pro vypnutí nastavte 0.
sending_rate_time: Za jakou dobu v sekundach se může odeslat maximální počet zpráv. Je třeba specifikovat i parametr sending_rate_limit. Omezení platí jen pro zprávy, které jsou odeslány jednotlivě, tedy přes SendSMS. Pro vypnutí nastavte 0.
allowed_hour_begin: Počáteční hodina, od kdy se mohou odesílat SMS zprávy. Zprávy poslané mimo povolený interval, budou uloženy na serveru a odeslány budou až bude časový interval splněný. Pro vypnutí nastavte 0.
allowed_hour_end: Konečná hodina, do kdy se mohou odesílat SMS zprávy. Zprávy poslané mimo povolený interval, budou uloženy na serveru a odeslány budou až bude časový interval splněný. Pro vypnutí nastavte 0.

Ukázka použití:

Popis:

Nastavení příchozího URL callbacku na http://callback.daktela.com/CRM/sms

Vstup:

https://api.daktela.com/api/3.1/SetSMSSettings/json?access_token=1234567890123456789012345678901234567890&incoming_callback=http://MojeVU.daktela.com/CRM/sms

Výstup:

{"error":null,"status":1}

Popis:

Nastavení příchozího URL callbacku na http://callback.daktela.com/CRM/sms, ale chceme si sami pojmenovat jména parametrů (zbývající parametry, které se nevyspecifikují budou doplněny automaticky na konec URL)

Vstup:

https://api.daktela.com/api/3.1/SetSMSSettings/json?access_token=1234567890123456789012345678901234567890&incoming_callback=http://MojeVU.daktela.com/CRM/sms?own_number=$number&own_text=$message&own_id=$id&own_direction=$direction

Výstup:

{"error":null,"status":1}

Popis:

Chceme, aby server odesílal SMS zprávy od 8:00 do 16:59.

Vstup:

https://api.daktela.com/api/3.1/SetSMSSettings/json?access_token=1234567890123456789012345678901234567890&allowed_hour_begin=8&allowed_hour_end=16

Výstup:

{"error":null,"status":1}

Celkový počet čekajících zpráv k odeslání

Požadovaná verze: 4.1

Akce:

StatusSMSConnect: Vrací celkový počet čekajících zpráv k odeslaní

Ukázka použití:

Popis:

Význam jednotlivých hodnot z výstupu:

count_waiting - počet zpráv, které čekají ve frontě na odeslání

Vstup:

https://api.daktela.com/api/4.1/StatusSMSConnect/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"count_waiting":"3963"}}

Zavření otevřeného call scriptu u operátora

Požadovaná verze: 4.0

Akce:

CallScriptClose: Uloží a zavře otevřený call script (záznam, hovorový formulář) u operátora, včetně odhlášení z WRAP pauzy.

Povinné parametry:

record: ID záznamu (nemusíme již vyplňovat povinný parametr call_id)
call_id: Unikátní název hovoru se kterým je svazaný otevřený záznam (nemusíme již vyplňovat povinný parametr record)

Volitelné parametry:

status: Unikátní název stavu, který se má nastavit. Stav se musí nastavit vždy, pokud se jedná o první navolávání záznamu.
number: Upravit telefonní číslo
nextcall: Nastavit datum a čas příštího navolání. Formát času YYYY-MM-DD HH:MM:SS
user: Přihlašovácí jméno operátora, kterého chceme nastavit. Vhodné pokud chceme, aby tento záznam řešil jiný operátor. Pro uvolnění operátora nechte tento parametr prázdný.
fields: Pole volitelných formulářových položek, které chceme upravit. Klíčem je unikátní nazev položky.
pause: Unikátní název pauzy na kterou se máme přepnout z WRAP po uložení formuláře. Pokud není specifikováno, dojde k odhlášení z WRAP pauzy.

Ukázka použití:

Popis:

U operátora s přihlašovacím jménem novak máme otevřený call script s unikátním hovorem 1367484976.46040WS. Tento call script chceme uzavřít jako hotový (nechceme už tento záznam později řešit) s unikátním názvem stavu objednavka. Po uložení call scriptu odhlásíme operátora z pauzy.

Vstup:

https://MojeVU.daktela.com/api/4.0/CallScriptClose/json?access_token=1234567890123456789012345678901234567890&call_id=1367484976.46040WS&status=objednavka

Výstup:

{"status":1,"error":null,"result":{"record":{"record":67,"user":"1","queue":"5","name":"record_5266716a6fa61","title":"226211245","number":"226211245","nextcall":null,"status":"4","action":5,"call_id":"1367484976.46040WS","edited":"2013-11-29 17:11:52","created":"2013-10-22 14:36:58","deleted":"0","changes":{"fields":false,"record_snapshots":false}},"cc":{"result":true,"error":null}}}

Popis:

U operátora s přihlašovacím jménem novak máme otevřený call script s unikátním hovorem 1367484976.46041WS. Tento call script chceme uzavřít s přeplánovánim na 2013-12-01 18:00:00 s unikátním názvem stavu zavolat_pozdeji_rozmysli. Ve formuláři je políčko s unikátním názvem field_poznamka a to chceme nastavit na Nabidku slysel. Po uložení call scriptu přepneme operátora na pauzu s unikátním názvem obed.

Vstup:

https://MojeVU.daktela.com/api/4.0/CallScriptClose/json?access_token=1234567890123456789012345678901234567890&call_id=1367484976.4601WS&status=zavolat_pozdeji_rozmysli&nextcall=2013-12-01 18:00:00&pause=obed&fields[field_poznamka]=Nabidku slysel

Výstup:

{"status":1,"error":null,"result":{"record":{"record":68,"user":"1","queue":"5","name":"record_5266716a6fa61","title":"226211245","number":"226211245","nextcall":null,"status":"4","action":6,"call_id":"1367484976.46041WS","edited":"2013-11-29 19:11:52","created":"2013-10-22 15:36:58","deleted":"0","changes":{"fields":false,"record_snapshots":false}},"cc":{"result":true,"error":null}}}

Popis:

Význam jednotlivých hodnot z výstupu:

record - informace (objekt) o call scriptu po uzavření (pouze informativně)
cc - informace o call centrovém stavu operátora během přepínání pauzy po uložení call scriptu

result - přepnutí pauzy bylo úspěšné (případně odhlášení z pauzy)
error - textová informace, proč přepnutí pauzy nebylo úspěšné

Vstup:

https://MojeVU.daktela.com/api/4.0/CallScriptClose/json?access_token=1234567890123456789012345678901234567890&call_id=1367484976.46040WS&status=objednavka&pause=pause_20&

Výstup:

{"status":1,"error":null,"result":{"record":{"record":66,"user":"1","queue":"5","name":"record_5266716a6fa61","title":"226211245","number":"226211245","nextcall":null,"status":"4","action":5,"call_id":"1111","edited":"2013-11-29 18:45:40","created":"2013-10-22 14:36:58","deleted":"0","changes":{"fields":false,"record_snapshots":false}},"cc":{"result":false,"error":"Agent nen\u00ed p\u0159ihl\u00e1\u0161en do \u017e\u00e1dn\u00e9 z front, tedy nen\u00ed mo\u017en\u00e9 ho d\u00e1t na pauzu"}}}

Informace o otevřeném call scriptu u operátora

Požadovaná verze: 4.0

Akce:

CallScriptOpened: Vrací informace o otevřeném call scriptu (záznamu, hovorový formulář) u operátora. Otevřený formulář brání zrušit pauzu nebo se odhlásit z Call Centra, proto je třeba tyto formuláře uzavřít.

Povinné parametry:

user: Přihlašovací jméno operátora u kterého chceme získat otevřený formulář.

Ukázka použití:

Popis:

Informace o otevřeném formuláři

Vstup:

https://MojeVU.daktela.com/api/4.0/CallScriptOpened/json?access_token=1234567890123456789012345678901234567890&user=daktelatester

Výstup:

{"status":1,"error":null,"result":{"record":{"record":"62","user":"3","queue":"3","name":"record_5284b0d39f93d","title":"Hovor 468008589","number":"468008589","nextcall":null,"status":"8","action":"4","call_id":"1385987312.20","edited":"2013-12-02 13:28:32","created":"2013-11-14 12:15:31","deleted":"0","changes":{"fields":false,"record_snapshots":false}},"fields":{"2":{"field":"2","type":"text","name":"field_5283f87c364f0","title":"P\u0159\u00edjmen\u00ed","description":"","multiple":"0","fieldset":null,"pattern":"","col":null,"deleted":"0","required":null,"position":null,"free":null,"object":{"field":null,"error":null},"options":null,"value":["Evropa 58"],"time":"2013-11-20 17:09:56","user":"3","version":"1"}}}}

Popis:

U operátora není otevřený žádný formulář

Vstup:

https://MojeVU.daktela.com/api/4.0/CallScriptOpened/json?access_token=1234567890123456789012345678901234567890&user=daktelatester

Výstup:

{"status":1,"error":null,"result":{"record":null}}

Kopírování záznamu z jedné kampaně do jiné kampaně

Požadovaná verze: 3.3

Akce:

CopyRecords: Podle hledaných kritérií vyfiltruje záznamy z jedné kampaně, které zkopíruje do jiné kampaně.

Povinné parametry:

id: ID záznamu, který se zkopíruje (nemusíme již vyplňovat povinný parametr src_queue)
src_queue: Číslo kampaně, ze které se budou prohledávat záznamy (nemusíme již vyplňovat povinný parametr id)
dst_queue: Číslo cílové kampaně do které chceme zkopírovat záznamy

Volitelné parametry:

search_datetime_modify_from

Od jakého data a času filtrovat poslední změnu záznamu v kampani src_queue. Formát času YYYY-MM-DD HH:MM:SS

search_datetime_modify_to

Do jakého data a času filtrovat poslední změnu záznamu v kampani src_queue. Formát času YYYY-MM-DD HH:MM:SS

search_datetime_nextcall_from

Od jakého data a času filtrovat naplánované hovory v kampani src_queue. Formát času YYYY-MM-DD HH:MM:SS

search_datetime_nextcall_to

Do jakého data a času filtrovat naplánované hovory v kampani src_queue. Formát času YYYY-MM-DD HH:MM:SS

search_datetime_created_from

Od jakého data a času filtrovat vytvoření záznamu v kampani src_queue. Formát času YYYY-MM-DD HH:MM:SS

search_datetime_created_to

Do jakého data a času filtrovat vytvoření záznamu v kampani src_queue. Formát času YYYY-MM-DD HH:MM:SS

update_action

V jaké akci mají být nově zkopírované záznamy. Pokud se nespecifikuje, tak se akce přenese beze změny z původní kampaně.

0 - volné
5 - formulář je uložený a hotový
6 - formulář je naplánovaný na později (měl by být vyplněný update_datetime_nextcall)

update_callstatus

V jakém ID stavu hovoru mají být nově zkopírované záznamy. Pokud se nespecifikuje, tak se akce přenese beze změny z původní kampaně. Pro uvolnění stavu zadejte tento parametr prázdný.

update_agent

Jakému ID uživatele mají být přiděleny nově zkopírované záznamy. Pokud se nespecifikuje, tak se akce přenese beze změny z původní kampaně. Pro uvolnění agenta zadejte tento parametr prázdný.

update_datetime_nextcall

Na jaký datum a čas mají být naplanovaný hovory.

update_datetime_modify

Má se při kopírování záznamů změnit datum poslední modifikace v cílové kampani. Povolené hodnoty jsou: yes / no

Ukázka použití:

Popis:

Překopírujeme záznam s ID 9 (v jaké kampani se nachází není třeba znát) do kampaně číslo 2009. Všechny systémové položky jako callstatus, agent, akce s čísly budou nezměněny.

Vstup:

http://MojeVU.daktela.com/api/3.3/CopyRecords/json?access_token=1234567890123456789012345678901234567890&id=9&dst_queue=2003

Výstup:

{"status":1,"error":null,"result":null}

Popis:

Vstup:

http://MojeVU.daktela.com/api/3.3/CopyRecords/json?access_token=1234567890123456789012345678901234567890&src_queue=2003&dst_queue=2009&search_datetime_modify_from=2013-01-11%2000:00:00&search_datetime_modify_to=2013-01-16%2023:59:59&update_agent=&update_action=0

Výstup:

{"status":1,"error":null,"result":null}

Importování jednoho záznamu do outbounder kampaně

Požadovaná verze: 4.1

Akce:

CreateRecord: Importuje data jednoho záznamu do outbounder kampaně. Je třeba pamatovat, pokud se změní struktura kampaně, například přidáním nebo jiném rozmístěním datových položek, že je třeba upravit i volání tohoto API.

Povinné parametry:

queue: ID fronty nebo kampaně do které chceme naimportovat záznamy
phonenumber: Telefonní číslo, které chceme importovat

Volitelné parametry:

fields: Pole hodnot volitelných položek, které chceme importovat. Klíč v poli je ID volitelné položky. Pokud nejsou specifikovány všechny položky ve formuláři, tak jsou nahrazeny prázdným řetězcem.
user: Pokud chceme přiřadit importovaný kontakt konkrétnímu ID uživateli. Takto naimportované kontakty bude navolávat pouze tento uživatel.
nextcall: Pokud chceme specifikovat od kdy se mají importované kontakty nejdřive navolávat. Formát času je ve formátu YYYY-MM-DD HH:MM:SS

Ukázka použití:

Popis:

Naimportujeme záznam s tel. číslem 226211245 s položkou na formuláři Jméno (má ID 3)

Vstup:

http://MojeVU.daktela.com/api/4.1/CreateRecord/json?access_token=1234567890123456789012345678901234567890&queue=2003&fields[3]=Tohle%20je%20importovano%20pres%20API&phonenumber=226211245

Výstup:

{"status":1,"error":null,"result":{"count":1,"record":{"record":47,"user":null,"queue":"1","name":"record_53e8cf5a6ee77","title":"226211245","number":"226211245","nextcall":null,"status":null,"action":0,"call_id":null,"edited":null,"created":"2014-08-11 16:12:42","deleted":0,"changes":{"fields":false,"record_snapshots":false}}}}

Smaže record.

Požadovaná verze: 4.1

Akce:

DeleteRecord: Smaže record.

Povinné parametry:

record: ID recordu

Ukázka použití:

Popis:

Smaže record.

Vstup:

https://MojeVU.daktela.com/api/4.1/DeleteRecord/json?access_token=1234567890123456789012345678901234567890&record=64

Výstup:

{"status":1,"error":null,"result":1}

Export formulářových dat

Požadovaná verze: 3.8

Akce:

ExportData: Exportuje formulářová data z kampaní podle vyhledávacích kritérií.

Povinné parametry:

queue: Číslo fronty ve které chceme exportovat data

Volitelné parametry:

datetime_modify_from

Od jakého data a času filtrovat poslední změnu záznamu. Formát času YYYY-MM-DD HH:MM:SS (pokud není specifikováno, vypíše se vše)

datetime_modify_to

Do jakého data a času filtrovat poslední změnu záznamu. Formát času YYYY-MM-DD HH:MM:SS (pokud není specifikováno, vypíše se vše)

datetime_nextcall_from

Od jakého data a času filtrovat naplánované hovory. Formát času YYYY-MM-DD HH:MM:SS (pokud není specifikováno, vypíše se vše)

datetime_nextcall_to

Do jakého data a času filtrovat naplánované hovory. Formát času YYYY-MM-DD HH:MM:SS (pokud není specifikováno, vypíše se vše)

datetime_created_from

Od jakého data a času filtrovat vytvoření záznamu. Formát času YYYY-MM-DD HH:MM:SS (pokud není specifikováno, vypíše se vše)

datetime_created_to

Do jakého data a času filtrovat vytvoření záznamu. Formát času YYYY-MM-DD HH:MM:SS (pokud není specifikováno, vypíše se vše)

actions

Pole akcí, ve kterém se nacházejí formuláře (pokud není specifikováno, vypíše se vše)

0 - volné
1,2,3 - formulář načtený operátorem
4 - formulář před uložením
5 - formulář je uložený a hotový
6 - formulář je naplánovaný na později

callstatuses

Pole ID volacích stavů, ve kterém se nacházejí formuláře (pokud není specifikováno, vypíše se vše)

agents

Pole ID agentů, kteří zpracovávají formuláře (pokud není specifikováno, vypíše se vše)

phonenumber

Telefonní číslo, které je uloženo na formuláři u položky telefonní číslo (pokud není specifikováno, vypíše se vše)

Ukázka použití:

Popis:

Získáme formulářová data z kampaně číslo 2003, pro agenta s ID 1 nebo agenta s ID 2

Vstup:

https://MojeVU.daktela.com/api/3.8/ExportData/json?access_token=1234567890123456789012345678901234567890&queue=2003&agents[]=1&agents[]=2

Výstup:

{"status":1,"error":null,"result":[{"sysdata_number":{"label":"Tel.\u010d\u00edslo","value":"226211245","id":"sysdata_number"},"sysdata_date":{"label":"Datum","value":"28.08.2012 16:20:17","id":"sysdata_date"},"sysdata_date_nextcall":{"label":"Datum p\u0159\u00ed\u0161t\u00edho vol\u00e1n\u00ed","value":"28.08.2012 16:20:11","id":"sysdata_date_nextcall"},"sysdata_date_create":{"label":"Datum vytvo\u0159en\u00ed","value":"27.08.2012 11:13:52","id":"sysdata_date_create"},"sysdata_callstatus":{"label":"Stav hovoru","value":null,"id":"sysdata_callstatus"},"sysdata_action":{"label":"Akce s \u010d\u00edsly","value":"odlo\u017een\u00e1 na pozd\u011bji","id":"sysdata_action"},"sysdata_action_number":{"label":"Akce s \u010d\u00edsly \u010d\u00edslo","value":"6","id":"sysdata_action_number"},"sysdata_asterisk_uniqueid":{"label":"Unik\u00e1tn\u00ed \u010d\u00edslo hovoru","value":null,"id":"sysdata_asterisk_uniqueid"},"sysdata_asterisk_recording":{"label":"Nahr\u00e1vka hovoru","value":null,"id":"sysdata_asterisk_recording"},"sysdata_agent_id":{"label":"Agent ID","value":"1","id":"sysdata_agent_id"},"sysdata_agent_login":{"label":"Agent login","value":"admin","id":"sysdata_agent_login"},"sysdata_agent_name":{"label":"Jm\u00e9no agenta","value":"Administrator","id":"sysdata_agent_name"},"sysdata_id":{"label":"ID","value":"318","id":"sysdata_id"},"data_1":{"label":"Jm\u00e9no","value":"Michal","id":"data_1"},"data_4":{"label":"Adresa","value":"Nemcice","id":"data_4"},"data_5":{"label":"PS\u010c","value":"12345","id":"data_5"}}]}

Počet navolání záznamu

Požadovaná verze: 4.1

Akce:

GetRecordAttempts: Vrátí počty přijatých a nepřiatých navolání záznamu

Povinné parametry:

record: ID recordu

Ukázka použití:

Popis:

Vrátí počty přijatých a nepřiatých navolání záznamu

Vstup:

https://MojeVU.daktela.com/api/4.1/GetRecordAttempts/json?access_token=1234567890123456789012345678901234567890&record=5

Výstup:

{"status":1,"error":null,"result":{"count_answered":"3","count_unanswered":"1","last_datetime":"2014-04-17 13:45:13"}}

Vrátí snapshoty recordu.

Požadovaná verze: 4.1

Akce:

GetRecordSnapshots: Vrátí snapshoty recordu.

Povinné parametry:

record: ID recordu

Ukázka použití:

Popis:

Vrátí snapshoty recordu

Vstup:

https://MojeVU.daktela.com/api/4.1/GetRecordSnapshots/json?access_token=1234567890123456789012345678901234567890&record=51

Výstup:

{"status":1,"error":null,"result":{"data":[{"record_snapshot":"173","record":"51","user":null,"queue":"1","name":"record_53ea24732cd62","title":"800123456","number":"800123456","nextcall":null,"status":null,"action":"0","call_id":"","created":"2014-08-12 16:28:03","created_by":null,"fields":{"1":["42"]}}],"total":1}}

Vrátí record.

Požadovaná verze: 4.1

Akce:

GetRecords: Vrátí record na základě vstupních parametrů.

Volitelné parametry:

q: Fulltext našeptávač.
filter: Filtr.
sort: Sort.
skip: Offset.
take: Limit.

Ukázka použití:

Popis:

Vrátí record.

Vstup:

https://MojeVU.daktela.com/api/4.1/GetRecords/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"data":[{"record":"52","user":null,"queue":"1","name":"record_53eb81ff2bf56","title":"800123456","number":"800123456","nextcall":null,"status":null,"action":"0","call_id":"","edited":null,"created":"2014-08-13 17:19:27","deleted":"0","fields":{"1":["42"],"17":[]}},{"record":"53","user":null,"queue":"1","name":"record_53eb820b62d3f","title":"800123456","number":"800123456","nextcall":null,"status":null,"action":"0","call_id":"","edited":null,"created":"2014-08-13 17:19:39","deleted":"0","fields":{"1":["42"],"17":[]}},{"record":"54","user":null,"queue":"1","name":"record_53eb820c775ce","title":"800123456","number":"800123456","nextcall":null,"status":null,"action":"0","call_id":"","edited":null,"created":"2014-08-13 17:19:40","deleted":"0","fields":{"1":["42"],"17":[]}}],"total":"3"}}

Vypsání všech definovaných stavů

Požadovaná verze: 3.8

Akce:

GetStatuses: Vrátí všechny definované stavy

Volitelné parametry:

id: Vrácení informace o stavu s konkrétním ID. Pokud se nepředá, tak vrací všechny stavy
queue: Vrátí informace o stavu jen pro tento název fronty

Ukázka použití:

Popis:

Chceme všechny stavy

Vstup:

https://MojeVU.daktela.com/api/3.8/GetStatuses/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":{"4":{"code":"nechce_nabidku","id":"4","description":"Nechce slyset nabidku","deleted":"0"},"5":{"code":"nebere","id":"5","description":"Nebere","deleted":"0"},"7":{"code":"nevolat","id":"7","description":"Nema zajem s nami hovorit","deleted":"0"},"8":{"code":"nezajem","id":"8","description":"Nema zajem","deleted":"0"},"9":{"code":"objednavka","id":"9","description":"Objednavka","deleted":"0"},"12":{"code":"nema_cas","id":"12","description":"Volat pozdeji - nema cas","deleted":"0"},"14":{"code":"rozmysli_se","id":"14","description":"Volat pozdeji - rozmysli se","deleted":"0"},"15":{"code":"neopravnena_osoba","id":"15","description":"Volat pozdeji - neopravnena osoba","deleted":"0"},"16":{"code":"prevolavka","id":"16","description":"Prevolavka","deleted":"0"}}}

Přesunutí záznamu z jedné kampaně do jiné kampaně

Požadovaná verze: 3.3

Akce:

MoveRecords: Podle hledaných kritérií vyfiltruje záznamy z jedné kampaně, které přesune do jiné kampaně. V původní kampani už tyto záznamy nebudou.

Povinné parametry:

id: ID záznamu, který se přesune (nemusíme již vyplňovat povinný parametr src_queue)
src_queue: Číslo kampaně, ze které se budou prohledávat záznamy (nemusíme již vyplňovat povinný parametr id)
dst_queue: Číslo cílové kampaně do které chceme přesunout záznamy

Volitelné parametry:

search_datetime_modify_from

Od jakého data a času filtrovat poslední změnu záznamu v kampani src_queue. Formát času YYYY-MM-DD HH:MM:SS

search_datetime_modify_to

Do jakého data a času filtrovat poslední změnu záznamu v kampani src_queue. Formát času YYYY-MM-DD HH:MM:SS

search_datetime_nextcall_from

Od jakého data a času filtrovat naplánované hovory v kampani src_queue. Formát času YYYY-MM-DD HH:MM:SS

search_datetime_nextcall_to

Do jakého data a času filtrovat naplánované hovory v kampani src_queue. Formát času YYYY-MM-DD HH:MM:SS

search_datetime_created_from

Od jakého data a času filtrovat vytvoření záznamu v kampani src_queue. Formát času YYYY-MM-DD HH:MM:SS

search_datetime_created_to

Do jakého data a času filtrovat vytvoření záznamu v kampani src_queue. Formát času YYYY-MM-DD HH:MM:SS

update_action

V jaké akci mají být nově přesunuté záznamy. Pokud se nespecifikuje, tak se akce přenese beze změny z původní kampaně.

0 - volné
5 - formulář je uložený a hotový
6 - formulář je naplánovaný na později (měl by být vyplněný update_datetime_nextcall)

update_callstatus

V jakém ID stavu hovoru mají být nově přesunuté záznamy. Pokud se nespecifikuje, tak se akce přenese beze změny z původní kampaně. Pro uvolnění stavu zadejte tento parametr prázdný.

update_agent

Jakému ID uživatele mají být přiděleny nově přesunuté záznamy. Pokud se nespecifikuje, tak se akce přenese beze změny z původní kampaně. Pro uvolnění agenta zadejte tento parametr prázdný.

update_datetime_nextcall

Na jaký datum a čas mají být naplanovaný hovory.

Ukázka použití:

Popis:

Přesuneme záznam s ID 9 (v jaké kampani se nachází není třeba znát) do kampaně číslo 2009. Všechny systémové položky jako callstatus, agent, akce s čísly budou nezměněny.

Vstup:

http://MojeVU.daktela.com/api/3.3/MoveRecords/json?access_token=1234567890123456789012345678901234567890&id=9&dst_queue=2003

Výstup:

{"status":1,"error":null,"result":null}

Popis:

Vstup:

http://MojeVU.daktela.com/api/3.3/MoveRecords/json?access_token=1234567890123456789012345678901234567890&src_queue=2003&dst_queue=2009&search_datetime_modify_from=2013-01-11%2000:00:00&search_datetime_modify_to=2013-01-16%2023:59:59&update_agent=&update_action=0

Výstup:

{"status":1,"error":null,"result":null}

Vyhledáni kontaktů, které jsou naimportované v Call Centru

Požadovaná verze: 3.2

Akce:

SimpleSearchContact: Výstupem jsou všechny kontakty včetně celé formulářové struktury, které odpovídají hledanému filtru

Povinné parametry:

phonenumber: Telefonní číslo, které chceme hledat

Volitelné parametry:

queues: Pole čísel kampaní ve kterých chceme hledat telefonní číslo

Ukázka použití:

Popis:

Získáme kontakty, které jsou z čísla 226211245 a hledání omezíme na čísla front 1002 a 1000

Vstup:

https://MojeVU.daktela.com/api/3.2/SimpleSearchContact/json?phonenumber=226211245&queues[]=1002&queues[]=1000&access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":[{"id_list":"3","name_campaign":"Outbounder","id_code_possibili":"3","number_campaign":"1002","array_struct":{"id_field":["1","6","2","7"],"type_field":["text","text","text","selectbox"],"label_field":["Jm\u00e9no","Email","P\u0159\u00edjmen\u00ed","Vyber"],"default_value_field":["","","","[\"ANO\",\"NE\"]"],"ro_field":[false,false,false,false],"order_field":["1","2","3","4"],"value_data":["Michal","noreply@daktela.com","Hajek","ANO"]},"sysdata_struct":{"id":"3","number":"2262112455","date":"2012-03-20 16:12:51","date_nextcall":null,"callstatus":"7","action":"5","asterisk_uniqueid":"1329393906.6650WS","agent_id":"3"},"status_error":null}]}

Změní record.

Požadovaná verze: 4.1

Akce:

UpdateRecord: Změní record na základě vstupních parametrů.

Povinné parametry:

record: ID recordu

Volitelné parametry:

queue: ID fronty
phonenumber: Telefonní číslo, které chceme upravit
fields: Pole hodnot volitelných položek, které chceme upravit. Klíč v poli je ID volitelné položky. Pokud nejsou specifikovány všechny položky ve formuláři, tak jsou nahrazeny prázdným řetězcem.
user: Pokud chceme přiřadit uživatele konkrétnímu záznamu. Pro uvolnění uživatele zadejte tento parametr prázdný.
status: ID statusu. Pro uvolnění statusu zadejte tento parametr prázdný.
action: Pokud chceme upravit akci. Hodnoty: 0 - Volná, 5 - Hotová, 6 - Akcia pre nextcall
nextcall: Pokud chceme specifikovat kdy se má záznam navolávat. Formát času je YYYY-MM-DD HH:MM:SS

Ukázka použití:

Popis:

Upravit záznam s id 64 kde fronta bude 1, tel.č. 226211246 a volitelna položoka 3 nasvana na 42

Vstup:

http://MojeVU.daktela.com/api/4.1/UpdateRecord/json?access_token=1234567890123456789012345678901234567890&record=64&queue=1&phonenumber=226211246&fields[3]=42

Výstup:

{"status":1,"error":null,"result":{"count":1,"record":{"record":64,"user":null,"queue":"1","name":"record_53eca5880656f","title":"226211245","number":"226211246","nextcall":"2014-08-08 19:30:30","status":null,"action":"UpdateRecord","call_id":"","edited":"2014-08-14 14:05:00","created":"2014-08-14 14:03:20","deleted":"0","fields":{"3":["42"],"17":[]}}}}

Vytvoření nové spouštěcí události

Požadovaná verze: 3.8

Akce:

CreateEvent: Vytvoříme novou událost, na kterou mohou být v modulu Notifikačního centra navázány další aktivity

Povinné parametry:

event: Jméno události, které musí začínat s prefixem Custom_

Volitelné parametry:

params: Pole parametrů, které se mohou používat při vyhodnocování podmínek a spouštění akcí v modulu Notifikačního centra. Klíč v poli je název proměnné.
time: Datum a čas, kdy se má spustit tato událost. Formát data a času může být ve formátu, jaký používá funkce strtotime.

Ukázka použití:

Popis:

V Notifikačním centru máme definovanou událost Custom_SendSMS, která pošle SMS zprávu, pokud je definovaná proměnná number a message.

Vstup:

https://MojeVU.daktela.com/api/3.8/CreateEvent/json?access_token=1234567890123456789012345678901234567890&event=Custom_SendSMS&params[number]=226211245&params[message]=Ahoj&params[foo][bar]=examplevalue

Výstup:

{"status":1,"error":null,"result":[{"number":"226211245","message":"Ahoj","foo":{"bar":"examplevalue"}}]}

Uzavření aktivity

Požadovaná verze: 4.0

Akce:

ActivityClose: Uzavře aktivitu s definovaným stavem u daného uživatele

Povinné parametry:

activity: Unikátní název aktivity
status: Unikátní název stavu, který se má nastavit

Ukázka použití:

Popis:

Aktivita s názvem activity_123 uzavřeme se stavem objednavka

Vstup:

https://MojeVU.daktela.com/api/4.0/ActivityClose/json?access_token=1234567890123456789012345678901234567890&activity=activity_123&status=objednavka

Výstup:

{"status":1,"error":null,"result":""}

Popis:

Chybný stav při nesprávném názvu stavu

Vstup:

https://MojeVU.daktela.com/api/4.0/ActivityClose/json?access_token=1234567890123456789012345678901234567890&activity=activity_123&status=nevolat

Výstup:

{"error":"Stav neexistuje","status":0}

Změna stavu aktivity

Požadovaná verze: 4.0

Akce:

ActivityUpdate: Změní stav aktivit s definovaným stavem u daného uživatele

Povinné parametry:

activities: Unikátní název aktivity
status: Unikátní název stavu, který se má nastavit

Ukázka použití:

Popis:

Ticketu activity_100, activity_200 změní stav na objednavka

Vstup:

https://MojeVU.daktela.com/api/4.0/TicketUpdate/json?access_token=1234567890123456789012345678901234567890&activities[]=activity_100&activities[]=activity_200&status=objednavka

Výstup:

{"status":1,"error":null,"result":""}

Ověří číslo v autodialeru

Požadovaná verze: 4.0

Akce:

CheckNumber: Ověří číslo v parametru v autodialeru a vrátí stav

Ukázka použití:

Popis:

Ověřit číslo 777888999

Vstup:

https://api.daktela.com/api/4.0/CheckNumber/json?access_token=1234567890123456789012345678901234567890&number=777888999

Výstup:

{"status":1,"error":null,"result":{"number":"777888999","time":"2014-02-11 16:10:47","status":"1"}}

Vrátí stavy výsledků čištění

Požadovaná verze: 4.0

Akce:

GetStatuses: Vrátí stavy výsledků čištění

Ukázka použití:

Popis:

Vypsat všechny stavy výsledků čištění

Vstup:

https://api.daktela.com/api/4.0/GetStatuses/json?access_token=1234567890123456789012345678901234567890

Výstup:

{"status":1,"error":null,"result":[{"status":"1","name":"Volany ucastnik je docasne nedostupny","code":"2"},{"status":"2","name":"Schranka","code":"2"},{"status":"3","name":"Nedostupny","code":"2"}]}

Vytvoření emailu

Požadovaná verze: 4.1

Akce:

EmailCreate: Vytvoří email

Povinné parametry:

queue: Číslo fronty
subject: Předmet emailu
from: Odesilatel emailu
body: Tělo emailu v HTML nebo plaintext formátu

Volitelné parametry:

user: Login uřivatele
name: Unikátní identifikátor emailu

Ukázka použití:

Popis:

Vytvoří email s předmětem 'Muj predmet', od odesilatele 'osoba@firma.cz' a textem 'Dlouhy text emailu'

Vstup:

https://MojeVU.daktela.com/api/4.1/EmailCreate/json?access_token=1234567890123456789012345678901234567890&queue=2000&subject=Muj%20predmet&from=osoba@email.cz&body=Dlouhy%20text%20emailu

Výstup:

{"status":1,"error":null,"result":{"email":{"email":15,"queue":"10","user":null,"contact":null,"name":"email_530f2641060a1","title":"Muj predmet","address":"osoba@email.cz","direction":"in","wait_time":null,"duration":null,"answered":null,"text":"

Dlouhy text emailu<\/p>","options":null,"time":"2014-02-27 12:49:21"},"activity":{"activity":244,"ticket":5,"name":"ticket_530f264109f1c","title":"Muj predmet","action":null,"type":"EMAIL","item":15,"queue":"10","user":null,"contact":null,"status":null,"priority":"20","options":null,"time":"2014-02-27 12:49:21","time_wait":null,"time_open":null,"time_close":null}}}

Popis:

Chybný stav při nesprávném typu fronty

Vstup:

https://MojeVU.daktela.com/api/4.1/EmailCreate/json?access_token=1234567890123456789012345678901234567890&queue=6666&subject=Muj%20predmet&from=osoba@email.cz&body=Dlouhy%20text%20emailu

Výstup:

{"error":"Zadana fronta neni typu email","status":0}

Webhooks

Popis:

Nastavení:

Popis:

Nastavení:

Popis:

Nastavení:

Popis:

Nastavení:

Fronty

Akce:

Povinné parametry:

Volitelné parametry:

Ukázka použití:

Popis:

Vstup:

Výstup:

Akce:

Volitelné parametry:

Ukázka použití:

Popis:

Vstup:

Výstup:

Akce:

Povinné parametry:

Volitelné parametry:

Ukázka použití:

Popis:

Vstup:

Výstup:

Akce:

Povinné parametry:

Ukázka použití:

Popis:

Vstup:

Výstup:

Popis:

Vstup:

Výstup:

Operátoři

Akce:

Povinné parametry:

Ukázka použití:

Popis:

Vstup:

Výstup:

Akce:

Povinné parametry:

Volitelné parametry:

Ukázka použití:

Popis:

Vstup:

Výstup:

Popis:

Vstup:

Výstup:

Akce:

Povinné parametry:

Volitelné parametry:

Ukázka použití:

Popis:

Vstup:

Výstup:

Popis:

Vstup:

Výstup:

Akce:

Povinné parametry:

Volitelné parametry:

Ukázka použití:

Popis:

Vstup:

Výstup:

Akce:

Povinné parametry:

Ukázka použití:

Popis:

Vstup:

Výstup:

Akce: