Both sides previous revisionPrevious revisionNext revision | Previous revision |
api:calls [2018/05/21 13:31] – [Nahrané hovory] david | api:calls [2025/01/03 13:22] (current) – [Historie hovorů] root |
---|
* **recipient**: telefonní číslo, se kterým budete spojeni po navázání hovoru mezi ústřednou a číslem předanným pomocí parametru caller | * **recipient**: telefonní číslo, se kterým budete spojeni po navázání hovoru mezi ústřednou a číslem předanným pomocí parametru caller |
* nepovinné parametry: | * nepovinné parametry: |
* **delayed** - opožděný callback; možné hodnoty jsou buď jedno číslo určující počet minut, o kolik bude callback zdržen, anebo přesné datum pro vytvoření callbacku ve formátu [[http://www.w3.org/TR/xmlschema-2/#dateTime|dateTime z XML Schema]] (například: //2036-07-16T08:12:14Z//) | * **delayed** - opožděný callback; možné hodnoty jsou buď jedno číslo určující počet minut, o kolik bude callback zdržen, anebo přesné datum pro vytvoření callbacku ve formátu [[http://www.w3.org/TR/xmlschema-2/#dateTime|dateTime z XML Schema]] (například: //2036-07-16T08:12:14Z//); pozor na znak "+" (viz [[wp>Percent-encoding]]) |
* **line** - v případě přihlášení přes API heslo určuje linku, přes kterou bude callback realizován (u této linky bude callback evidován ve výpisu hovorů, příjemci callbacku se zobrazí při volání číslo přiřazené k lince, ...) | * **line** - v případě přihlášení přes API heslo určuje linku, přes kterou bude callback realizován (u této linky bude callback evidován ve výpisu hovorů, příjemci callbacku se zobrazí při volání číslo přiřazené k lince, ...) |
* **simple** - v případě předání hodnoty "true" nebude moci //caller// pomocí hvězdičky a DTMF tónu vytočit jiné číslo; zároveň nedochází ke snaze využít ke spojení další operátory, pokud první operátor selhal nebo hovor nespojil; implicitní je hodnota "false". Pokud si tedy někdo objedná hovor a ten hovor pak odmítne, nebude se pokus opakovat. | * **simple** - v případě předání hodnoty "true" nebude moci //caller// pomocí hvězdičky a DTMF tónu vytočit jiné číslo; zároveň nedochází ke snaze využít ke spojení další operátory, pokud první operátor selhal nebo hovor nespojil; implicitní je hodnota "false". Pokud si tedy někdo objedná hovor a ten hovor pak odmítne, nebude se pokus opakovat. |
=== GET /calls.csv, GET /calls.json, GET /calls.xml === | === GET /calls.csv, GET /calls.json, GET /calls.xml === |
* výpis hovorů | * výpis hovorů |
* povinné parametry: | * povinné parametry (jedna ze dvou možností níže): |
* **from**, **to**: časové rozmezí hovorů; řetězec formátovaný jako [[http://www.w3.org/TR/xmlschema-2/#dateTime|dateTime z XML Schema]] (například: //2013-06-05T11:15:00+02:00//) | - **from**, **to**: časové rozmezí hovorů; řetězec formátovaný jako [[http://www.w3.org/TR/xmlschema-2/#dateTime|dateTime z XML Schema]] (například: //2013-06-05T11:15:00+02:00//); pozor na znak "+" (viz [[wp>Percent-encoding]]) |
| - **since_id**: ID posledního staženého hovoru - vhodné pro periodické stahování nových záznamů |
* nepovinné parametry: | * nepovinné parametry: |
* **direction**: //in/////out/////redirected//; filtr na příchozí/odchozí/přesměrované hovory | * **direction**: //in/////out/////redirected//; filtr na příchozí/odchozí/přesměrované hovory |
* **status**: //answered/////missed//; filtr na zvednuté/zmeškané hovory | * **status**: //answered/////missed//; filtr na zvednuté/zmeškané hovory |
* **phone_number_filter**: prefix nebo celé telefonní číslo (např. 0049 nebo 00420533533533); filtruje podle source_number i destination_number (OR) | * **phone_number_filter**: prefix nebo celé telefonní číslo (např. 0049 nebo 00420533533533); filtruje podle source_number i destination_number (OR) |
* **sip_ids**: pokud je předána hodnota true, přidají se k záznamům o hovorech atributy //sip_in_call_id// a //sip_out_call_id// | * **sip_ids**: pokud je předána hodnota true, přidají se k záznamům o hovorech atributy //sip_in_call_id// a //sip_out_call_id//. Pomocí těchto id je možné výpis hovorů spárovat s [[:call_records_upload|nahávkami]] |
| * **include_sms**: pokud je předána hodnota true, vrací se zároveň i SMS zprávy a není potřeba načítat SMS samostatně (pomocí GET /sms.csv (/sms.xml, /sms.json)) |
* stránkování: | * stránkování: |
* na jeden dotaz vracíme maximálně 2000 hovorů, při větším počtu je potřeba použít stránkování | * na jeden dotaz vracíme maximálně 2000 hovorů, při větším počtu je potřeba použít stránkování |
* statistika hovorů za zvolené období | * statistika hovorů za zvolené období |
* povinné parametry: | * povinné parametry: |
* **from**, **to**: časové rozmezí hovorů; řetězec formátovaný jako [[http://www.w3.org/TR/xmlschema-2/#dateTime|dateTime z XML Schema]] (například: //2013-06-05T11:15:00+02:00//) | * **from**, **to**: časové rozmezí hovorů; řetězec formátovaný jako [[http://www.w3.org/TR/xmlschema-2/#dateTime|dateTime z XML Schema]] (například: //2013-06-05T11:15:00+02:00//); pozor na znak "+" (viz [[wp>Percent-encoding]]) |
* nepovinné parametry: | * nepovinné parametry: |
* **direction**: //in/////out/////redirected//; filtr na příchozí/odchozí/přesměrované hovory | * **direction**: //in/////out/////redirected//; filtr na příchozí/odchozí/přesměrované hovory |
* statistika hovorů za zvolené období podle destinací | * statistika hovorů za zvolené období podle destinací |
* povinné parametry: | * povinné parametry: |
* **from**, **to**: časové rozmezí hovorů; řetězec formátovaný jako [[http://www.w3.org/TR/xmlschema-2/#dateTime|dateTime z XML Schema]] (například: //2013-06-05T11:15:00+02:00//) | * **from**, **to**: časové rozmezí hovorů; řetězec formátovaný jako [[http://www.w3.org/TR/xmlschema-2/#dateTime|dateTime z XML Schema]] (například: //2013-06-05T11:15:00+02:00//); pozor na znak "+" (viz [[wp>Percent-encoding]]) |
* nepovinné parametry: | * nepovinné parametry: |
* **direction**: //in/////out/////redirected//; filtr na příchozí/odchozí/přesměrované hovory | * **direction**: //in/////out/////redirected//; filtr na příchozí/odchozí/přesměrované hovory |
* statistika zmeškaných hovorů za zvolené období | * statistika zmeškaných hovorů za zvolené období |
* povinné parametry: | * povinné parametry: |
* **from**, **to**: časové rozmezí hovorů; řetězec formátovaný jako [[http://www.w3.org/TR/xmlschema-2/#dateTime|dateTime z XML Schema]] (například: //2013-06-05T11:15:00+02:00//) | * **from**, **to**: časové rozmezí hovorů; řetězec formátovaný jako [[http://www.w3.org/TR/xmlschema-2/#dateTime|dateTime z XML Schema]] (například: //2013-06-05T11:15:00+02:00//); pozor na znak "+" (viz [[wp>Percent-encoding]]) |
* vyžaduje [[:api#autentizace|autentizaci]] | * vyžaduje [[:api#autentizace|autentizaci]] |
* příklad odpovědi: | * příklad odpovědi: |