{"swagger":"2.0","host":"restapi.ipex.cz","basePath":"/","schemes":["https"],"info":{"title":"IPEX RESTAPI Dokumentace","version":"8.113.2","description":"IPEX restapi pro B2B partnery"},"securityDefinitions":{"soap":{"type":"apiKey","name":"Authorization","in":"header"}},"security":[{"soap":[]}],"tags":[],"paths":{"/alive":{"get":{"summary":"Alive check route","operationId":"getAlive","tags":["alive"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/health":{"get":{"summary":"Return status on dependent system","operationId":"getHealth","description":"Return list of dependent services and their state","tags":["health"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/calls":{"get":{"summary":"Výpis hovorů","operationId":"getV1Calls","description":"Výpis uskutečněných hovorů.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"string","format":"date-time","description":"vypsat od","name":"dateFrom","in":"query","required":true},{"type":"string","format":"date-time","description":"vypsat do","default":"2026-10-27","name":"dateTo","in":"query"},{"type":"string","description":"hledané číslo","minLength":9,"name":"number","in":"query"},{"type":"number","description":"id zákazníka","name":"customerId","in":"query"},{"type":"string","description":"id z externího systému","name":"externId","in":"query"},{"type":"number","description":"typ výpisu: 1 – odchozí hovory, 2 – odchozí zdarma, 3 – odchozí zdarma na peering partnery, 4 – odchozí placené mobil a pevná, 5 – příchozí hovory, 6 – zmeškané příchozí hovory, 7 – všechny hovory (žádný filtr), 8 – odchozí kumulovaný výpis (ala ceník), 9 – odchozí kumulovaný výpis podle státu, 10 – příchozí kumulovaný výpis hovorů, 13 – odchozí zmeškané, 14 – odchozí a příchozí hovory, nekumulovaný výpis včetně nákladových cen (tři poslední sloupce na konci - délka (sek.), cena (hal.), počet), 15 – podklady k fakturaci všech zákazníků (prepaid a postpaid), 16 – podklady k fakturaci všech zákazníků (prepaid), 17 – podklady k fakturaci všech zákazníků (postpaid)","default":1,"enum":[1,2,3,4,5,6,7,8,9,10,13,14,15,16,17,18,101,151],"minimum":1,"name":"typHistory","in":"query"},{"type":"boolean","description":"přidá sloupeček s interním id zákazníka. Pokud je definován customerId, musí být showCustomerId nastaven na false!","default":true,"name":"showCustomerId","in":"query"},{"type":"boolean","description":"přidá sloupečky s počtem volných jednotek spotřebovaných daným hovorem","name":"showFreeUnits","in":"query"},{"type":"boolean","description":"přidá sloupeček s flagy","default":true,"name":"showFlags","in":"query"},{"type":"boolean","description":"Sloupec s typem CDR (alternativa flagu, pro zpětnou kompatibilitu)","default":false,"name":"showCDRType","in":"query"},{"type":"boolean","description":"přidá sloupeček s DPH","default":true,"name":"showVAT","in":"query"},{"type":"boolean","description":"přidá sloupeček s unikátním ID hovoru (nefunguje u kumulovaných výpisů)","name":"showUID","in":"query"},{"type":"boolean","description":"přidá sloupeček s jednotkami, MB pro data, ks pro SMS","default":true,"name":"showUnit","in":"query"}],"tags":["v1/calls"],"responses":{"200":{"schema":{"$ref":"#/definitions/pole%20s%20jednotliv%C3%BDmi%20z%C3%A1znamy%20historie%20telefon%C3%A1t%C5%AF"},"description":"Successful"}}}},"/v1/connectors":{"get":{"summary":"List of all connectors","operationId":"getV1Connectors","description":"Connector list

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"Statement restriction only to customer with id","name":"customerId","in":"query"},{"type":"string","description":"Connector type","enum":["pbx","voipTrunk","videoZoom","integration","internet","helpdesk","support","generic","zoomVideo","room"],"name":"type","in":"query"},{"type":"integer","description":"Connector id","name":"connectorId","in":"query"},{"type":"boolean","description":"To show connector price in statement","default":true,"name":"showPrice","in":"query"}],"tags":["v1/connectors"],"responses":{"200":{"schema":{"$ref":"#/definitions/connectors"},"description":"Successful"}}},"post":{"summary":"Automatic activation of a new connector","operationId":"postV1Connectors","description":"Activate new trunk with routed phone number started with 910

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model123"}}],"tags":["v1/connectors"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/customers":{"get":{"summary":"Výpis zákazníků","operationId":"getV1Customers","description":"Vypíše seznam zákazníků.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"id zákazníka","name":"id","in":"query"},{"type":"string","description":"hledaní fulltextem v názvu, adrese a poznámce zákazníka","name":"fulltext","in":"query"},{"type":"number","description":"hledání podle čísla","name":"number","in":"query"},{"type":"string","description":"název firmy","name":"customerName","in":"query"},{"type":"string","description":"ulice","name":"street","in":"query"},{"type":"string","description":"město","name":"city","in":"query"},{"type":"string","description":"PSČ","name":"zipCode","in":"query"},{"type":"string","description":"poznámka","name":"note","in":"query"},{"type":"string","description":"přihlašovací jméno zákazníka","name":"login","in":"query"},{"type":"string","description":"IČO","name":"tin","in":"query"},{"type":"string","description":"id z externího systému","name":"externId","in":"query"},{"type":"string","description":"Typ fakturace uživatelů CC","name":"type","in":"query"},{"type":"boolean","description":"user is hidden","name":"hidden","in":"query"},{"type":"string","enum":["Nefakturovat","MarketplaceSF","MarketplaceMS","Rucne","Postpaid","Prepaid","PostpaidPilot"],"name":"ipex_zpusobFakturace","in":"query"},{"type":"string","format":"date","description":"Interní, včetně rovného data","name":"ipex_datumFakturaceOd","in":"query"},{"type":"string","format":"date","description":"Interní, mimo rovného data","name":"ipex_datumFakturaceDo","in":"query"},{"type":"boolean","description":"Interní","name":"ipex_zvysenaPozornost","in":"query"},{"type":"number","description":"Číslováno od 0","name":"page","in":"query"},{"type":"number","name":"pageSize","in":"query"}],"tags":["v1/customers"],"responses":{"200":{"schema":{"$ref":"#/definitions/customers"},"description":"Successful"}}},"post":{"summary":"Výtvoří nového zákazníka","operationId":"postV1Customers","description":"Vytvoří nového zákazníka.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model124"}}],"tags":["v1/customers"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/ictPriceList":{"get":{"summary":"Get all pricelists","operationId":"getV1Ictpricelist","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"Page number from 0","default":0,"minimum":0,"name":"page","in":"query","required":false},{"type":"integer","description":"Page size","default":20,"minimum":1,"name":"pageSize","in":"query","required":false},{"type":"string","default":"name","enum":["name"],"name":"orderBy","in":"query","required":false},{"type":"string","default":"DESC","enum":["ASC","DESC"],"name":"orderDir","in":"query","required":false}],"tags":["v1/ictPriceList"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model5"},"description":"Successful"}}}},"/v1/invoices":{"get":{"summary":"Získání seznamu služeb","operationId":"getV1Invoices","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"Období pro fakturaci v měsících (0 pro aktuální měsíc, -6 pro předchozí půlrok)","default":0,"minimum":-3,"maximum":0,"name":"monthOffset","in":"query"},{"type":"number","description":"ID zákazníka","minimum":1,"name":"customerId","in":"query","required":true}],"tags":["v1/invoices"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model7"},"description":"Successful"}}}},"/v1/pbx":{"get":{"summary":"Vrátí info o ústřednách","operationId":"getV1Pbx","description":"Bez filtru vrací všechny ústředny

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"PBX id","name":"id","in":"query"},{"type":"number","description":"Only one service id","name":"serviceId","in":"query"},{"type":"number","description":"Filter by customer id","name":"customerId","in":"query"}],"tags":["v1/pbx"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model9"},"description":"Successful"}}},"post":{"summary":"Create new virtual PBX","operationId":"postV1Pbx","description":"Create SIP trunk with test number and virtual PBX connected to this trunk

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model136"}}],"tags":["v1/pbx"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model137"},"description":"Successful"}}}},"/v1/phone-numbers":{"get":{"summary":"Deprecated list of phone numbers","operationId":"getV1Phonenumbers","description":"Deprecated - use /v2/phone-numbers

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"integer","description":"Customer id","name":"customerId","in":"query"},{"type":"string","description":"External id","name":"externalId","in":"query"},{"type":"boolean","description":"Force to load and show actual operator ID. Significantly slows response.","default":false,"name":"showOpid","in":"query"},{"type":"string","description":"Filter one number","name":"number","in":"query"},{"type":"integer","description":"How many numbers to return","name":"limit","in":"query"},{"type":"integer","description":"How many numbers to skip before beginning to return numbers","default":0,"name":"offset","in":"query"},{"type":"string","description":"Search in number and customer","name":"search","in":"query"},{"type":"string","description":"Name of the variable to sort by","enum":["number","customerName"],"name":"orderBy","in":"query"},{"type":"string","description":"Sorting order","default":"asc","enum":["asc","desc"],"name":"order","in":"query"}],"tags":["v1/phone-numbers"],"responses":{"200":{"schema":{"$ref":"#/definitions/Array%20of%20phone%20numbers"},"description":"Successful"}}}},"/v1/requests":{"get":{"summary":"Seznam objednávek","operationId":"getV1Requests","description":"Vypíše přehled objednávek pro zákazníka, tel. číslo, celého providera nebo operátora podle stavu nebo data.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"id objednávky","name":"requestId","in":"query"},{"type":"array","description":"stav objednávky","x-constraint":{"single":true},"items":{"type":"string","enum":["new","processing","canceled","finished","error"]},"collectionFormat":"multi","name":"requestStatus","in":"query"},{"type":"array","description":"typ objednávky","x-constraint":{"single":true},"items":{"type":"string","enum":["activate_mobil","portin_mobil","portin_voip","change_mobil","change_datapack_mobil","change_sim_mobil","suspend_mobil","reactivate_mobil","cease_mobil","change_tariff_mobil","limit_mobil","unlimit_mobil","create_trunk","portout_mobil","change_trunk","order_new_numbers_voip","delete_trunk","portout_mobil_finish","portout_voip","activate_voip","update_voip","cease_voip","create_pbx","delete_pbx","create_user","update_user","delete_user","create_service","update_service","add_user_service","delete_user_service","create_number","update_number","cease_number","create_room","delete_room","update_room","remove_voip_oku","change_oku_mobil","delete_service"]},"collectionFormat":"multi","name":"requestType","in":"query"},{"type":"string","description":"přihlašovací jméno uživatele, který vytvořil objednávku","name":"login","in":"query"},{"type":"number","description":"id zákazníka","name":"customerId","in":"query"},{"type":"string","description":"obecná identifikace objednávky např. tel. číslo","name":"identifier","in":"query"},{"type":"string","description":"obecná identifikace2 objednávky např. iccid","name":"identifier2","in":"query"},{"type":"string","format":"date-time","description":"vytvořeno od","name":"insertedFrom","in":"query"},{"type":"string","format":"date-time","description":"vytvořeno do (včetně)","name":"insertedTo","in":"query"},{"type":"string","format":"date","description":" poslední změna od","name":"changedFrom","in":"query"},{"type":"string","format":"date","description":" poslední změna do (včetně)","name":"changedTo","in":"query"},{"type":"boolean","description":"podrobnější výpis","name":"detail","in":"query"}],"tags":["v1/requests"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model11"},"description":"Successful"}}}},"/v1/rights":{"get":{"summary":"Vypíše seznam oprávnění","operationId":"getV1Rights","description":"Vypíše seznam oprávnění uživatele

Authentication

For access to this url you must used one of these authentications:
","tags":["v1/rights"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model12"},"description":"Successful"}}}},"/v1/services":{"get":{"summary":"List of services","operationId":"getV1Services","description":"Vypíše seznam služeb.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"array","description":"id of switchboard","x-constraint":{"single":true},"items":{"type":"integer"},"collectionFormat":"multi","name":"containerId","in":"query"},{"type":"string","description":"number","minLength":9,"name":"number","in":"query"},{"type":"array","description":"number state","x-constraint":{"single":true},"items":{"type":"string","enum":["reserved","active","canceled","stopped","prepared","limited","finished"]},"collectionFormat":"multi","name":"status","in":"query"},{"type":"string","description":"type of payment","enum":["prepaid","postpaid"],"name":"paymentType","in":"query"},{"type":"string","description":"detail of contetnt which will be returned","default":"short","enum":["short","extended","full"],"name":"detail","in":"query"},{"type":"string","description":"what will be returned - all content detail, or diagnostic content only","default":"full","enum":["diagnostics","full"],"name":"result","in":"query"},{"type":"integer","description":"customer id","minimum":1,"name":"customerId","in":"query"},{"type":"string","description":"service type (voip for fax+voice and all for everything)","default":"all","enum":["voice","fax","mobile","voip","all","pbx","voipTrunk","videoZoom","integration","internet","helpdesk","suppport","generic","zoomVideo","room","sms"],"name":"numberType","in":"query"},{"type":"string","description":"external system id","name":"externId","in":"query"}],"tags":["v1/services"],"responses":{"200":{"schema":{"$ref":"#/definitions/services"},"description":"Successful"}}}},"/v1/wholesale-invoices":{"get":{"summary":"Get list of wholesale invoices","operationId":"getV1Wholesaleinvoices","description":"Get list of supliers invoices

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"By default invoices created in last 12 months","default":12,"minimum":1,"maximum":60,"name":"months","in":"query","required":false},{"type":"integer","description":"Page number from 0","default":0,"minimum":0,"name":"page","in":"query","required":false},{"type":"integer","description":"Page size","default":20,"minimum":1,"name":"pageSize","in":"query","required":false},{"type":"string","default":"number","enum":["number","state","taxFulfillmentDate","dueOn","htmlLink","subTotal","total"],"name":"orderBy","in":"query","required":false},{"type":"string","default":"DESC","enum":["ASC","DESC"],"name":"orderDir","in":"query","required":false}],"tags":["v1/wholesale-invoices"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model16"},"description":"Successful"}}}},"/v2/phone-numbers":{"get":{"summary":"List of phone numbers","operationId":"getV2Phonenumbers","description":"List of phone numbers including oku code

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"integer","description":"Customer id","name":"customerId","in":"query"},{"type":"string","description":"External id","name":"externalId","in":"query"},{"type":"boolean","description":"Force to load and show actual operator ID. Significantly slows response.","default":false,"name":"showOpid","in":"query"},{"type":"string","description":"Filter one number","name":"number","in":"query"},{"type":"integer","description":"How many numbers to return","name":"limit","in":"query"},{"type":"integer","description":"How many numbers to skip before beginning to return numbers","default":0,"name":"offset","in":"query"},{"type":"string","description":"Search in number and customer","name":"search","in":"query"},{"type":"string","description":"Name of the variable to sort by","enum":["number","customerName"],"name":"orderBy","in":"query"},{"type":"string","description":"Sorting order","default":"asc","enum":["asc","desc"],"name":"order","in":"query"}],"tags":["v2/phone-numbers"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model19"},"description":"Successful"}}}},"/v1/accounts/{username}":{"get":{"summary":"Get provider users","operationId":"getV1AccountsUsername","description":"Get provider users

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"string","description":"Username","name":"username","in":"path"}],"tags":["v1/accounts"],"responses":{"200":{"schema":{"$ref":"#/definitions/accounts"},"description":"Successful"}}},"put":{"summary":"Update provider user","operationId":"putV1AccountsUsername","description":"Update provider user

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"string","description":"User username","name":"username","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model169"}}],"tags":["v1/accounts"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model118"},"description":"Successful"}}},"delete":{"summary":"Delete user","operationId":"deleteV1AccountsUsername","description":"Delete user

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"string","description":"User username","name":"username","in":"path","required":true}],"tags":["v1/accounts"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model186"},"description":"Successful"}}}},"/v1/analysis/connector":{"get":{"summary":"Connector analysis","operationId":"getV1AnalysisConnector","description":"Analysis of provide's connectors profit.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"string","format":"date-time","description":"Date from which we want the data. The date included.","name":"periodFrom","in":"query","required":true},{"type":"string","format":"date-time","description":"Date to which we want the data. The date included.","name":"periodTo","in":"query","required":false}],"tags":["v1/analysis"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model22"},"description":"Successful"}}}},"/v1/calls/technical-overview":{"get":{"summary":"Voip technical overview","operationId":"getV1CallsTechnicaloverview","description":"Technical over view of all call for isp.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"string","name":"number","in":"query","required":false},{"type":"string","format":"date-time","description":"Date from which we want the data. The date included.","name":"dateFrom","in":"query","required":false},{"type":"string","format":"date-time","description":"Date to which we want the data. The date included.","name":"dateTo","in":"query","required":false}],"tags":["v1/calls"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model24"},"description":"Successful"}}}},"/v1/connectors/invoices":{"get":{"summary":"Billing list for all connectors","operationId":"getV1ConnectorsInvoices","description":"Lists billing items for all connectors.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"string","format":"date-time","description":"date from","name":"dateFrom","in":"query","required":true},{"type":"string","format":"date","description":"date to","default":1794508163049,"name":"dateTo","in":"query","required":true},{"type":"array","description":"Bill detail","default":"basic","x-constraint":{"single":true},"items":{"type":"string","enum":["sum","basic"]},"collectionFormat":"multi","name":"detail","in":"query"}],"tags":["v1/connectors"],"responses":{"200":{"schema":{"$ref":"#/definitions/invoices"},"description":"Successful"}}}},"/v1/connectors/{connectorId}":{"get":{"summary":"Connector detail","operationId":"getV1ConnectorsConnectorid","description":"Returns connector detail infromations

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"Connector id","name":"connectorId","in":"path","required":true}],"tags":["v1/connectors"],"responses":{"200":{"schema":{"$ref":"#/definitions/trunk%20connector"},"description":"Successful"}}},"put":{"summary":"Connector change","operationId":"putV1ConnectorsConnectorid","description":"Change connector settings. Just insert parameters you want to change.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"integer","description":"Id of trunk you want to edit","name":"connectorId","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model123"}}],"tags":["v1/connectors"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model96"},"description":"Successful"}}}},"/v1/containers/{type}":{"get":{"summary":"Zobrazí výpis ústředen","operationId":"getV1ContainersType","description":"Zobrazí výpis ústředen

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"string","description":"typ ústředny, pro mobily používat volbu Mobile, pro pevné linky ISP","enum":["Mobile","ISP","Other"],"name":"type","in":"path"}],"tags":["v1/containers"],"responses":{"200":{"schema":{"$ref":"#/definitions/containers%20type"},"description":"Successful"}}}},"/v1/customers/{id}":{"get":{"summary":"Detail zákazníka","operationId":"getV1CustomersId","description":"Vypíše detail zákazníka podle id.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"customer id","name":"id","in":"path","required":true}],"tags":["v1/customers"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model3"},"description":"Successful"}}},"put":{"summary":"Aktualizace parametrů zákazníka","operationId":"putV1CustomersId","description":"Aktualizace parametrů zákazníka.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"id zákazníka","name":"id","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model124"}}],"tags":["v1/customers"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}},"deprecated":true},"patch":{"summary":"Aktualizace parametrů zákazníka","operationId":"patchV1CustomersId","description":"Aktualizace parametrů zákazníka - aktualizuje pouze uvedené položky

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"id zákazníka","name":"id","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model189"}}],"tags":["v1/customers"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/freeUnits/history":{"get":{"summary":"Výpis čerpání volných jednotek","operationId":"getV1FreeunitsHistory","description":"Souhrný výpis čerpání volných jednotek.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"array","description":"čísla, pro která omezit výpis. Bez filtru vypíše volné jednotky pro všechna čísla.","items":{"type":"number"},"collectionFormat":"multi","name":"number","in":"query"},{"type":"number","description":"rok výpisu","minimum":1900,"maximum":2099,"name":"year","in":"query","required":true},{"type":"number","description":"měsíc výpisu (1-12)","minimum":1,"maximum":12,"name":"month","in":"query","required":true}],"tags":["v1/freeUnits"],"responses":{"200":{"schema":{"$ref":"#/definitions/free%20units"},"description":"Successful"}}}},"/v1/helpdesk/{id}":{"get":{"summary":"Get service helpdesk detail","operationId":"getV1HelpdeskId","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"Id of service","name":"id","in":"path","required":true}],"tags":["v1/helpdesk"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model29"},"description":"Successful"}}}},"/v1/ictPriceList/{id}":{"get":{"summary":"Get pricelist detail","operationId":"getV1IctpricelistId","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","minimum":1,"name":"id","in":"path","required":true}],"tags":["v1/ictPriceList"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model32"},"description":"Successful"}}},"patch":{"summary":"Update pricelist name","operationId":"patchV1IctpricelistId","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","minimum":1,"name":"id","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model192"}}],"tags":["v1/ictPriceList"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/internet/types":{"get":{"summary":"Create new service of type internet","operationId":"getV1InternetTypes","description":"

Authentication

For access to this url you must used one of these authentications:
","tags":["v1/internet"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model34"},"description":"Successful"}}}},"/v1/internet/{id}":{"get":{"summary":"Get service internet detail","operationId":"getV1InternetId","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"Id of service","name":"id","in":"path","required":true}],"tags":["v1/internet"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model35"},"description":"Successful"}}}},"/v1/invoiceItem/idList":{"get":{"summary":"Get list of inserted ids - for hints","operationId":"getV1InvoiceitemIdlist","description":"

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","tags":["v1/invoiceItem"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model37"},"description":"Successful"}}}},"/v1/invoiceItem/{id}":{"get":{"summary":"Get virtual service detail","operationId":"getV1InvoiceitemId","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"Id of service","name":"id","in":"path","required":true}],"tags":["v1/invoiceItem"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model39"},"description":"Successful"}}}},"/v1/invoices/{paymentType}":{"get":{"summary":"Získání fakturačních podkladů","operationId":"getV1InvoicesPaymenttype","description":"Vypíše seznam faktur koncových zákazníků přihlášeného providera.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"string","description":"Režim placení (prepaid/postpaid/both)","enum":["prepaid","postpaid","both"],"name":"paymentType","in":"path","required":true},{"type":"integer","description":"Období pro fakturaci v měsících (0 pro aktuální měsíc, -6 pro předchozí půlrok)","default":0,"name":"monthOffset","in":"query"},{"type":"string","description":"Určuje, zda zobrazit globální analýzu zisku (bez rozlišení dle typu platby).","default":"none","enum":["global","none"],"name":"analysis","in":"query"}],"tags":["v1/invoices"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model41"},"description":"Successful"}}}},"/v1/mobile/{number}":{"get":{"summary":"Detail mobilního čísla","operationId":"getV1MobileNumber","description":"Vrátí detail nastavení mobilního čísla.
Je požadován parametr number nebo iccid.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"string","description":"mobilní číslo (dříve pojmenováno msisdn)","minLength":9,"name":"number","in":"path"},{"type":"string","description":"iccid","name":"iccid","in":"query"},{"type":"string","description":"typ výpisu detailu čísla (basic: základní výpis, credit: základní výpis a informace o kreditu, simDetail: základní výpis a detail SIM karty, full: kompletní výpis)","default":"basic","enum":["basic","credit","simDetail","full"],"name":"detail","in":"query"}],"tags":["v1/mobile"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model45"},"description":"Successful"}}}},"/v1/providers/settings":{"get":{"summary":"Nastavení providera","operationId":"getV1ProvidersSettings","description":"Výpis nastavení providera. Jedná se obecné nastavení např. fakturací a brandingu.

Authentication

For access to this url you must used one of these authentications:
","tags":["v1/providers"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model46"},"description":"Successful"}}}},"/v1/reports/customers":{"get":{"summary":"Počet zákazníků","operationId":"getV1ReportsCustomers","description":"Vrátí počet zákazníků

Authentication

For access to this url you must used one of these authentications:
","tags":["v1/reports"],"responses":{"200":{"description":"počet zákazníků","schema":{"type":"integer","description":"počet zákazníků"}}}}},"/v1/reports/numbers":{"get":{"summary":"Počet služeb","operationId":"getV1ReportsNumbers","description":"Vrátí počet služeb

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"array","description":"které statistiky zobrazit","x-constraint":{"single":true},"items":{"type":"string","enum":["status","paymentType","numberType","customerId","customerCount","serviceId"]},"collectionFormat":"multi","name":"show","in":"query"},{"type":"array","description":"stavy čísel","x-constraint":{"single":true},"items":{"type":"string","enum":["reserved","active","canceled","stopped","prepared","limited","finished"]},"collectionFormat":"multi","name":"status","in":"query"},{"type":"string","description":"typ platby (prepaid, postpaid)","enum":["prepaid","postpaid"],"name":"paymentType","in":"query","required":false},{"type":"string","description":"typ čísla (voice, fax, mobile)","enum":["voice","fax","mobile"],"name":"numberType","in":"query","required":false},{"type":"number","description":"id zákazníka","name":"customerId","in":"query","required":false}],"tags":["v1/reports"],"responses":{"200":{"schema":{"$ref":"#/definitions/number%20stats"},"description":"Successful"}}}},"/v1/requests/{requestId}":{"get":{"summary":"Detail objednávky","operationId":"getV1RequestsRequestid","description":"Vypíše detail objednávky služby.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"id objednávky","name":"requestId","in":"path","required":true}],"tags":["v1/requests"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model51"},"description":"Successful"}}},"delete":{"summary":"Storno objednávky","operationId":"deleteV1RequestsRequestid","description":"Lze stornovat selhané portace (portace musí být nejprve zrušena na straně T-Mobile) nebo odložené objednávky na změnu nastavení.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"number","description":"id objednávky","name":"requestId","in":"path","required":true}],"tags":["v1/requests"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/ruian/{fulltext}":{"get":{"summary":"List of addresses found by fulltext","operationId":"getV1RuianFulltext","description":"List of addresses found in ruian db according to fulltext. Maximum address returned by route is 10

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"string","description":"Fulltext string to search by","name":"fulltext","in":"path","required":true},{"type":"string","description":"Type of detail to return","default":"full","enum":["text","structure","full"],"name":"detail","in":"query"}],"tags":["v1/ruian"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model53"},"description":"Successful"}}}},"/v1/services/fulltext":{"get":{"summary":"Service full text","operationId":"getV1ServicesFulltext","description":"Search services by pseudo full text

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"string","description":"Name of service type","default":"all","enum":["all","trunk","pbx","integration","internet","support","helpdesk","video","room","communicator","landline","mobile","fax","voipTrunk","zoomVideo","sms","voicebot","chatbot","invoiceItem","helpdeskWebchat","helpdeskFbMessenger"],"name":"type","in":"query"},{"type":"integer","description":"ID of customer","name":"customerId","in":"query","required":false},{"type":"string","description":"Value for fulltext searching","name":"fullTextSearch","in":"query","required":false}],"tags":["v1/services"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model57"},"description":"Successful"}}}},"/v1/services/shared":{"get":{"summary":"Get list of shared services","operationId":"getV1ServicesShared","description":"Services where customer has only some numbers

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"ID of customer","name":"customerId","in":"query","required":false}],"tags":["v1/services"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model63"},"description":"Successful"}}}},"/v1/services/{serviceId}":{"get":{"summary":"Get service","operationId":"getV1ServicesServiceid","description":"Get service by service id

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"Service id","minimum":1,"name":"serviceId","in":"path","required":true}],"tags":["v1/services"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model64"},"description":"Successful"}}},"delete":{"summary":"Delete service","operationId":"deleteV1ServicesServiceid","description":"Marks service as deleted. Frees resources, keeps some settings internally.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"integer","minimum":1,"name":"serviceId","in":"path","required":true}],"tags":["v1/services"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model188"},"description":"Successful"}}}},"/v1/support/{id}":{"get":{"summary":"Get guaranteed support detail","operationId":"getV1SupportId","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"Id of service","name":"id","in":"path","required":true}],"tags":["v1/support"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model66"},"description":"Successful"}}}},"/v1/tariffPlans/{tariffPlanId}":{"get":{"summary":"Detail ceníku","operationId":"getV1TariffplansTariffplanid","description":"Vrátí detail ceníku.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"integer","description":"id ceníku, ke kterému se má zjistit detail. 0 pro výpis všech ceníků","name":"tariffPlanId","in":"path"},{"type":"string","default":"mobile","enum":["all","mobile","voip","endUser","trunk","800"],"name":"type","in":"query"}],"tags":["v1/tariffPlans"],"responses":{"200":{"schema":{"$ref":"#/definitions/seznam%20cen%C3%ADk%C5%AF"},"description":"Successful"}}}},"/v1/ticketing/check-user":{"get":{"summary":"Get requestor user by username","operationId":"getV1TicketingCheckuser","description":"return user

Authentication

For access to this url you must used one of these authentications:
","tags":["v1/ticketing"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model68"},"description":"Successful"}}}},"/v1/users/me":{"get":{"summary":"Get user by its anvil token","operationId":"getV1UsersMe","description":"Get user by its anvil token

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"string","description":"Level of detail","default":"full","enum":["full","standard","basic"],"name":"detail","in":"query","required":false}],"tags":["v1/users"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model77"},"description":"Successful"}}}},"/v1/voip/profiles":{"get":{"summary":"Seznam profilů pevných linek","operationId":"getV1VoipProfiles","description":"Seznam profilů používaný v sekci antifraud

Authentication

For access to this url you must used one of these authentications:
","tags":["v1/voip"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/voip/{number}":{"get":{"summary":"Detail čísla pevné linky","operationId":"getV1VoipNumber","description":"Vrátí detail čísla pevné linky.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"string","description":"mobilní číslo (dříve pojmenováno msisdn)","minLength":9,"name":"number","in":"path","required":true},{"type":"string","description":"iccid","name":"iccid","in":"query"},{"type":"string","description":"typ výpisu detailu čísla (basic: základní výpis, onlyOperatorId: jen identifikace operátora (?), full: kompletní výpis)","default":"basic","enum":["basic","onlyOperatorId","full"],"name":"detail","in":"query"}],"tags":["v1/voip"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model80"},"description":"Successful"}}}},"/v2/phone-numbers/diagnostic":{"get":{"summary":"Number diagnostic detail","operationId":"getV2PhonenumbersDiagnostic","description":"Only for operators

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"string","description":"Filter one number","name":"number","in":"query","required":true},{"type":"boolean","description":"Return all unfiltered data - for debug","default":false,"name":"full","in":"query","required":false}],"tags":["v2/phone-numbers"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model83"},"description":"Successful"}}}},"/v1/connectors/{connectorId}/invoices":{"get":{"summary":"Billing list for all connector.","operationId":"getV1ConnectorsConnectoridInvoices","description":"Lists billing items for connector.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"id konektoru","name":"connectorId","in":"path","required":true},{"type":"string","format":"date-time","description":"date from","name":"dateFrom","in":"query"},{"type":"string","format":"date","description":"date to","default":1794508163370,"name":"dateTo","in":"query"},{"type":"integer","description":"month offset in actual year","maximum":0,"name":"monthOffset","in":"query"},{"type":"array","description":"bill detail","default":"basic","x-constraint":{"single":true},"items":{"type":"string","enum":["sum","basic"]},"collectionFormat":"multi","name":"detail","in":"query"}],"tags":["v1/connectors"],"responses":{"200":{"schema":{"$ref":"#/definitions/invoices"},"description":"Successful"}}}},"/v1/connectors/{connectorId}/phoneNumbers":{"get":{"summary":"Phone number list","operationId":"getV1ConnectorsConnectoridPhonenumbers","description":"list all phone numbers in connector

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"id konektoru","name":"connectorId","in":"path","required":true},{"type":"string","description":"number","minLength":9,"name":"number","in":"query"},{"type":"array","description":"Phone number state","x-constraint":{"single":true},"items":{"type":"string","enum":["reserved","active","canceled","stopped","prepared","limited","finished"]},"collectionFormat":"multi","name":"status","in":"query"},{"type":"string","description":"Payment type","enum":["prepaid","postpaid"],"name":"paymentType","in":"query"},{"type":"number","description":"Customer id","name":"customerId","in":"query"},{"type":"number","description":"Pbx id","name":"containerId","in":"query"},{"type":"string","description":"Number type","enum":["voice","fax","mobile"],"name":"numberType","in":"query"},{"type":"string","description":"Record id in external system","name":"externId","in":"query"},{"type":"string","enum":["Normal","800"],"name":"category","in":"query"}],"tags":["v1/connectors"],"responses":{"200":{"schema":{"$ref":"#/definitions/phone%20numbers"},"description":"Successful"}}}},"/v1/containers/{containerId}/roamingProfiles":{"get":{"summary":"Seznam profilů roamingu","operationId":"getV1ContainersContaineridRoamingprofiles","description":"Vypíše seznam profilů roamingu na ústředně.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"id ústředny","name":"containerId","in":"path","required":true}],"tags":["v1/containers"],"responses":{"200":{"schema":{"$ref":"#/definitions/roaming%20list"},"description":"Successful"}}}},"/v1/containers/{containerId}/phoneNumbers":{"get":{"summary":"Seznam čísel","operationId":"getV1ContainersContaineridPhonenumbers","description":"Vypíše seznam čísel na ústředně.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"id ústředny","name":"containerId","in":"path","required":true},{"type":"string","description":"číslo","minLength":9,"name":"number","in":"query"},{"type":"array","description":"stav čísla","x-constraint":{"single":true},"items":{"type":"string","enum":["reserved","active","canceled","stopped","prepared","limited","finished"]},"collectionFormat":"multi","name":"status","in":"query"},{"type":"string","description":"typ platby","enum":["prepaid","postpaid"],"name":"paymentType","in":"query"},{"type":"number","description":"Id zákazníka","name":"customerId","in":"query"},{"type":"number","description":"Id konektoru","name":"trunkId","in":"query"},{"type":"string","description":"typ čísla (HAPI přidává voip pro fax+voice a all pro vše)","enum":["voice","fax","mobile","voip","all"],"name":"numberType","in":"query"},{"type":"string","description":"id z externího systému","name":"externId","in":"query"},{"type":"string","default":"","enum":["extended"],"name":"detail","in":"query"}],"tags":["v1/containers"],"responses":{"200":{"schema":{"$ref":"#/definitions/Phone%20numbers"},"description":"Successful"}}}},"/v1/containers/{containerId}/dataPacks":{"get":{"summary":"Seznam datových balíčků","operationId":"getV1ContainersContaineridDatapacks","description":"Vypíše seznam datových balíčků na ústředně.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"id ústředny","name":"containerId","in":"path","required":true},{"type":"integer","description":"id koncového ceníku, pokud není zadán, volí se výchozí ceník přiřazený ústředně, podle ceníku se zobrazují nákupní ceny","name":"tariffPlanId","in":"query"},{"type":"array","description":"filtrace na typ balíčku, pro aktivaci, upgrade nebo datové sim","x-constraint":{"single":true},"items":{"type":"string","enum":["activation","upgrade","data_sim"]},"collectionFormat":"multi","name":"type","in":"query"}],"tags":["v1/containers"],"responses":{"200":{"schema":{"$ref":"#/definitions/data%20pack%20list"},"description":"Successful"}}}},"/v1/containers/{containerId}/flatPacks":{"get":{"summary":"Seznam flatových balíčků","operationId":"getV1ContainersContaineridFlatpacks","description":"Vypíše seznam flatových balíčků na ústředně.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"id ústředny","name":"containerId","in":"path","required":true},{"type":"number","description":"id koncového ceníku, pokud není zadán, volí se výchozí ceník přiřazený ústředně, podle ceníku se zobrazují nákupní ceny","name":"tariffPlanId","in":"query"}],"tags":["v1/containers"],"responses":{"200":{"schema":{"$ref":"#/definitions/data%20flat%20list"},"description":"Successful"}}}},"/v1/containers/{containerId}/simcards":{"get":{"summary":"Seznam SIM karet","operationId":"getV1ContainersContaineridSimcards","description":"Vypíše seznam SIM karet na mobilní ústředně.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"number","description":"id ústředny","name":"containerId","in":"path","required":true},{"type":"string","description":"fulltext ICCID","name":"fulltext","in":"query"},{"type":"string","description":"ICCID","name":"iccid","in":"query"},{"type":"integer","description":"limit výpisu","name":"limit","in":"query"},{"type":"string","description":"stav SIM","enum":["assigned","available","lost","quarantine"],"name":"status","in":"query"}],"tags":["v1/containers"],"responses":{"200":{"schema":{"$ref":"#/definitions/simCards"},"description":"Successful"}}}},"/v1/customers/customername/{id}":{"get":{"summary":"Vrátí jméno zákazníka s daným id","operationId":"getV1CustomersCustomernameId","description":"Vrátí jméno zákazníka s daným id.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"id zákazníka","name":"id","in":"path","required":true}],"tags":["v1/customers"],"responses":{"200":{"schema":{"$ref":"#/definitions/provider"},"description":"Successful"}}}},"/v1/customers/{customerId}/users":{"get":{"summary":"Get all customer users","operationId":"getV1CustomersCustomeridUsers","description":"Return all customer users

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"Customer id in IPEX a.s. systems. Usually required, optional only for some tokens","minimum":1,"name":"customerId","in":"path","required":true}],"tags":["v1/customers"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model94"},"description":"Successful"}}}},"/v1/ictPriceList/items/{itemId}":{"get":{"summary":"Get pricelist item","operationId":"getV1IctpricelistItemsItemid","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","minimum":1,"name":"itemId","in":"path","required":true}],"tags":["v1/ictPriceList"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model95"},"description":"Successful"}}},"patch":{"summary":"Change pricelist item price","operationId":"patchV1IctpricelistItemsItemid","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","minimum":1,"name":"itemId","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model199"}}],"tags":["v1/ictPriceList"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/invoices/{paymentType}/{fileFormat}":{"get":{"summary":"Tiskový výstup z fakturačních podkladů","operationId":"getV1InvoicesPaymenttypeFileformat","description":"Vyrobí přílohu k faktuře s rozpisem služeb.\n Výstupem je přímo HTML vhodné pro tisk, odděluje jednotlivé zákazníky na novou stránku. Výstup: base64Binary document – dokument ve formátu HTML/PDF/XML

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"string","description":"Rezim placeni(prepaid/postpaid/both)","default":"both","enum":["prepaid","postpaid","both"],"name":"paymentType","in":"path","required":true},{"type":"string","description":"požadovaný formát výstupního dokumentu","default":"html","enum":["html","xml","csv","json-html"],"name":"fileFormat","in":"path","required":true},{"type":"integer","description":"id zákazníka","default":0,"name":"customerId","in":"query"},{"type":"integer","description":"Období pro fakturaci v měsících (0 pro aktuální měsíc, -6 nebo 6 pro předchozí půlrok)","default":0,"name":"monthOffset","in":"query"},{"type":"string","description":"Zda vypsat včetně uživatelských licenci a ostatních fakturovaných služeb. Pro zpětnou kompatibilitu defaultně pouze hovorné.","default":"","enum":["ICTServices"],"name":"include","in":"query"}],"tags":["v1/invoices"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/mobile/availablePortationDates/{cvop}":{"get":{"summary":"Seznam možných dnů portace","operationId":"getV1MobileAvailableportationdatesCvop","description":"Ověří platnost ČVOP/OKU kódu a vrátí seznam možných dnů portace. Pozice 4-7 v ČVOP kódu je datum od kdy je platný ČVOP, a tedy i datum od kdy je možné portovat. Datum portace nemůže být dříve než je platnost ČVOP kódu a později než je platnost + 60 dnů.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"Číslo portace (ČVOP), nebo číslo OKU. 14 míst","minimum":10000000000000,"maximum":99999999999999,"x-constraint":{"sign":"positive"},"name":"cvop","in":"path","required":true}],"tags":["v1/mobile"],"responses":{"200":{"schema":{"$ref":"#/definitions/data%20portace"},"description":"Successful"}}}},"/v1/mobile/{number}/resetPostpaidLimit":{"get":{"summary":"Pouze pro zpětnou kompatibilitu. Použijte PUT.","operationId":"getV1MobileNumberResetpostpaidlimit","description":"Pouze pro zpětnou kompatibilitu. Použijte PUT.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"number","description":"telefonní číslo","name":"number","in":"path","required":true}],"tags":["v1/mobile"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}},"put":{"summary":"Provede zrušení limitu mobilu","operationId":"putV1MobileNumberResetpostpaidlimit","description":"Provede zrušení limitu mobilu. Provede ruční obnovení postpaid limitu.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"number","description":"telefonní číslo","name":"number","in":"path","required":true}],"tags":["v1/mobile"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/mobile/{number}/suspend":{"get":{"summary":"Pouze pro zpětnou kompatibilitu. Použijte PUT.","operationId":"getV1MobileNumberSuspend","description":"Pouze pro zpětnou kompatibilitu. Použijte PUT.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"number","description":"telefonní číslo","name":"number","in":"path","required":true}],"tags":["v1/mobile"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model96"},"description":"Successful"}}},"put":{"summary":"Provede pozastavení mobilního čísla","operationId":"putV1MobileNumberSuspend","description":"Provede pozastavení mobilního čísla. Jedná se o asynchronní operaci, návratovou hodnotu je id žádosti, podle kterého lze sledovat průběh zpracování pomocí metody /requests. Pozastavení automaticky deaktivuje flat, datový balíček a lte.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"number","description":"telefonní číslo","name":"number","in":"path","required":true}],"tags":["v1/mobile"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model96"},"description":"Successful"}}}},"/v1/mobile/{number}/reactivate":{"get":{"summary":"Pouze pro zpětnou kompatibilitu. Použijte PUT.","operationId":"getV1MobileNumberReactivate","description":"Pouze pro zpětnou kompatibilitu. Použijte PUT.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"number","description":"telefonní číslo","name":"number","in":"path","required":true}],"tags":["v1/mobile"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model96"},"description":"Successful"}}},"put":{"summary":"Provede odblokovani mobilu","operationId":"putV1MobileNumberReactivate","description":"Provede odblokovani mobilu. Reaktivace mobilního čísla. Jedná se o asynchronní operaci, návratovou hodnotu je id žádosti, podle kterého lze sledovat průběh zpracování.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"number","description":"telefonní číslo","name":"number","in":"path","required":true}],"tags":["v1/mobile"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model96"},"description":"Successful"}}}},"/v1/mobile/{number}/credit":{"get":{"summary":"Načte historii kreditu pro mobil","operationId":"getV1MobileNumberCredit","description":"Načte historii kreditu 6 měsíců zpětně

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"telefonní číslo","name":"number","in":"path","required":true}],"tags":["v1/mobile"],"responses":{"200":{"schema":{"$ref":"#/definitions/credit%20history"},"description":"Successful"}}},"put":{"summary":"Provede přičtení kreditu pro mobil","operationId":"putV1MobileNumberCredit","description":"Provede přičtení kreditu.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"telefonní číslo","name":"number","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model174"}}],"tags":["v1/mobile"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/reports/cz/ctu":{"get":{"summary":"Statistiky ČTÚ","operationId":"getV1ReportsCzCtu","description":"Vrací statistické data o volání požadované ČTÚ.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"string","description":"Určení, jaká kategorie statistik se má zobrazit - Specialni kategorie pro vypis statistik hovorneho. Implementovano zatim pouze CTU","default":"CTU","enum":["CTU"],"name":"byType","in":"query","required":false},{"type":"string","format":"date-time","description":"filtrování statistiky - první datum od kterého se má načítat hovorné","default":"2016-01-01T00:00:00.000Z","name":"dateFrom","in":"query","required":false},{"type":"string","format":"date-time","description":"filtrování statistiky - první datum od kterého se již hovorné nepočítá (tzn. že 2016-07-01 načte vše až do konce června 2016","default":"2017-01-01T00:00:00.000Z","name":"dateTo","in":"query","required":false},{"type":"string","description":"filtrování statistiky - Typ statistiky - voip / mobilni","default":"voip","enum":["mobile","voip"],"name":"statsType","in":"query","required":false}],"tags":["v1/reports"],"responses":{"200":{"schema":{"$ref":"#/definitions/number%20stats%20-%20pole%20s%20jednotliv%C3%BDmi%20kategoriemi%20hovor%C5%AF%20%2B%20csv%20pro%20download"},"description":"Successful"}}}},"/v1/reports/providers/top-customers":{"get":{"summary":"Get top customers","operationId":"getV1ReportsProvidersTopcustomers","description":"Return top customers according params

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"string","description":"Order by price","enum":["ASC","DESC"],"name":"order","in":"query"},{"type":"integer","description":"Count of top customer","minimum":1,"name":"top","in":"query"}],"tags":["v1/reports"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model100"},"description":"Successful"}}}},"/v1/ruian/address/{ruianId}":{"get":{"summary":"Get address detail","operationId":"getV1RuianAddressRuianid","description":"Get address detail from ruian

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"Ruian address id","name":"ruianId","in":"path","required":true}],"tags":["v1/ruian"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model53"},"description":"Successful"}}}},"/v1/services/{serviceId}/properties":{"get":{"summary":"Get service properties","operationId":"getV1ServicesServiceidProperties","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"Service id","minimum":1,"name":"serviceId","in":"path","required":true}],"tags":["v1/services"],"responses":{"200":{"description":"Service properties which are allowed to all customer users to see.","schema":{"$ref":"#/definitions/Model101"}}}},"put":{"summary":"Update property in service","operationId":"putV1ServicesServiceidProperties","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"Service id","minimum":1,"name":"serviceId","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model177"}}],"tags":["v1/services"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model64"},"description":"Successful"}}}},"/v1/sms/integration/{serviceId}":{"get":{"summary":"Get SMS service detail","operationId":"getV1SmsIntegrationServiceid","description":"Get SMS service detail

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"Service id","minimum":1,"name":"serviceId","in":"path","required":true}],"tags":["v1/sms"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model104"},"description":"Successful"}}},"put":{"summary":"Updates SMS service","operationId":"putV1SmsIntegrationServiceid","description":"Updates service for sending and receiving SMS - set default numbers, webhooks, etc.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"Service id","minimum":1,"name":"serviceId","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model103"}}],"tags":["v1/sms"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model179"},"description":"Successful"}}}},"/v1/sso/ticketing/token":{"get":{"summary":"Return token token for usage in requestor","operationId":"getV1SsoTicketingToken","description":"Return new token

Authentication

For access to this url you must used one of these authentications:
","tags":["v1/sso"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/tariffPlans/{tariffPlanId}/price":{"get":{"summary":"Vrátí cenu","operationId":"getV1TariffplansTariffplanidPrice","description":"Metoda vrátí cenu dle koncového ceníku za portaci/měsíční paušál, nebo za hovor na zadané číslo.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"integer","description":"id tarifu, ke kterému se má zjistit detail","name":"tariffPlanId","in":"path","required":true},{"type":"string","description":"pro zjištení ceny za portaci/mesícní paušál","enum":["portinMobile","portinVoip","monthlyFeeMobile","monthlyFeeVoip"],"name":"cdrType","in":"query","required":false},{"type":"string","description":"pro zjištení ceny za volání na zadané číslo","maxLength":15,"name":"number","in":"query","required":false}],"tags":["v1/tariffPlans"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model105"},"description":"Successful"}}}},"/v1/tariffPlans/{tariffPlanId}/trunkTypes":{"get":{"summary":"Načte číselník ceníků pro tarif","operationId":"getV1TariffplansTariffplanidTrunktypes","description":"Zobrazí výpis typů konektorů.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"integer","description":"id tarifu, ke kterému se má zjistit detail","name":"tariffPlanId","in":"path","required":true},{"type":"number","description":"Nalezení trunk-typu s uživatelskou cenou vyšší než tato","name":"customer_price_higher","in":"query"}],"tags":["v1/tariffPlans"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model107"},"description":"Successful"}}}},"/v1/voip/{number}/credit":{"get":{"summary":"Načte historii kreditu pro pevnou linku","operationId":"getV1VoipNumberCredit","description":"Načte historii kreditu 6 měsíců zpětně

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"telefonní číslo","name":"number","in":"path","required":true}],"tags":["v1/voip"],"responses":{"200":{"schema":{"$ref":"#/definitions/credit history"},"description":"Successful"}}},"put":{"summary":"Provede přičtení kreditu pro pevnou linku","operationId":"putV1VoipNumberCredit","description":"Provede přičtení kreditu.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"number","description":"telefonní číslo","name":"number","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model174"}}],"tags":["v1/voip"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/voip/{number}/state":{"get":{"summary":"Detail čísla pevné linky","operationId":"getV1VoipNumberState","description":"Vrátí detail čísla pevné linky.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"string","description":"číslo pevné linky","minLength":9,"name":"number","in":"path","required":true},{"type":"string","description":"iccid","name":"iccid","in":"query"}],"tags":["v1/voip"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model108"},"description":"Successful"}}}},"/v1/mobile/{number}/changeSimCard/{newIccId}":{"get":{"summary":"Pouze pro zpětnou kompatibilitu. Použijte /mobile/{number}/renew","operationId":"getV1MobileNumberChangesimcardNewiccid","description":"Výměna SIM karty u mobilního císla. Jedná se o asynchronní operaci, návratovou hodnotou je id žádosti, podle kterého lze sledovat průběh zpracování pomocí /requests.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"number","description":"tel. číslo simkarty","name":"number","in":"path","required":true},{"type":"number","description":"nové IccId pro simkartu","name":"newIccId","in":"path","required":true}],"tags":["v1/mobile"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/reports/providers/customers/count":{"get":{"summary":"Return count of customer","operationId":"getV1ReportsProvidersCustomersCount","description":"Return count of customer according to provider ID

Authentication

For access to this url you must used one of these authentications:
","tags":["v1/reports"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/reports/providers/requests/count":{"get":{"summary":"Get count of request","operationId":"getV1ReportsProvidersRequestsCount","description":"Return count of request

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"array","x-constraint":{"single":true},"items":{"type":"string","enum":["new","processing","canceled","finished","error"]},"collectionFormat":"multi","name":"state","in":"query","required":false}],"tags":["v1/reports"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model109"},"description":"Successful"}}}},"/v1/reports/zoom/provider/{month}":{"get":{"summary":"Zoom call detail","operationId":"getV1ReportsZoomProviderMonth","description":"Return historical detail of zoom call

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"string","format":"date","description":"Get records for given month","default":"2019-01-01","name":"month","in":"path","required":true}],"tags":["v1/reports"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model111"},"description":"Successful"}}}},"/v1/reports/connectors/{connectorId}/phoneNumbers/count":{"get":{"summary":"Phone number count","operationId":"getV1ReportsConnectorsConnectoridPhonenumbersCount","description":"count of all phone numbers in connector

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"connector ID","name":"connectorId","in":"path","required":true}],"tags":["v1/reports"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model112"},"description":"Successful"}}}},"/v1/reports/customers/{customerId}/services/count":{"get":{"summary":"Get count of services","operationId":"getV1ReportsCustomersCustomeridServicesCount","description":"Return count of services according to customer ID and type of service.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"ID of customer","minimum":1,"name":"customerId","in":"path","required":true},{"type":"array","x-constraint":{"single":true},"items":{"type":"string","enum":["trunk","pbx","integration","video","room","communicator"]},"collectionFormat":"multi","name":"type","in":"query","required":false}],"tags":["v1/reports"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model113"},"description":"Successful"}}}},"/v1/reports/customers/{customerId}/requests/count":{"get":{"summary":"Get count of orders","operationId":"getV1ReportsCustomersCustomeridRequestsCount","description":"Return count of new and processing orders by customer ID

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"Customer ID","name":"customerId","in":"path","required":true}],"tags":["v1/reports"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model109"},"description":"Successful"}}}},"/v1/reports/zoom/customer/{customerId}/{month}":{"get":{"summary":"Zoom call detail","operationId":"getV1ReportsZoomCustomerCustomeridMonth","description":"Return historical detail of zoom calls

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"Customer id","minimum":1,"name":"customerId","in":"path","required":true},{"type":"string","format":"date","description":"Get records for given month","default":"2019-01-01","name":"month","in":"path","required":true}],"tags":["v1/reports"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model115"},"description":"Successful"}}}},"/v1/reports/customers/{customerId}/invoices/sum/{monthOffset}":{"get":{"summary":"Sum of invoices","operationId":"getV1ReportsCustomersCustomeridInvoicesSumMonthoffset","description":"Return sum of invoices for provider

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"integer","description":"Number of month offset","minimum":0,"name":"monthOffset","in":"path","required":true},{"type":"integer","description":"customer ID","minimum":1,"name":"customerId","in":"path","required":true}],"tags":["v1/reports"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model116"},"description":"Successful"}}}},"/v1/accounts":{"post":{"summary":"Create provider user","operationId":"postV1Accounts","description":"Create provider user

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model117"}}],"tags":["v1/accounts"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model118"},"description":"Successful"}}}},"/v1/helpdesk":{"post":{"summary":"Create new service of type helpdesk - for some user licences","operationId":"postV1Helpdesk","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model125"}}],"tags":["v1/helpdesk"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model126"},"description":"Successful"}}}},"/v1/internet":{"post":{"summary":"Create new service of type internet","operationId":"postV1Internet","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model127"}}],"tags":["v1/internet"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model126"},"description":"Successful"}}}},"/v1/mobile":{"post":{"summary":"Create mobile phone number","operationId":"postV1Mobile","description":"Provede aktivaci mobilního čísla s režimem placení typu postpaid nebo prepaid. Jedná se o asynchronní operaci, návratovou hodnotu je id žádosti, podle kterého lze sledovat průběh zpracování.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model129"}}],"tags":["v1/mobile"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model130"},"description":"Successful"}}},"put":{"summary":"Úprava mobilního čísla","operationId":"putV1Mobile","description":"Provede aktivaci mobilního čísla s režimem placení typu postpaid nebo prepaid. Jedná se o asynchronní operaci, návratovou hodnotu je id žádosti, podle kterého lze sledovat průběh zpracování.
Aktualizaci je možné provést běžnou objednávkou, která se provede hned jak je to možné, nebo plánovanou. Objednávka je plánovaná v okamžiku, kdy je nastaveno datum v parametru requiredActivationDate. Datum plánované objednávky musí být min. následující den, ale obvykle je to první den následujícího mesíce. Plánovanou objednávkou lze měnit pouze hlasový flat, datový balíček, ceník, denní zahraniční limit a typ platby, při nastavení ostatních parametrů se vrací chyba.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model168"}}],"tags":["v1/mobile"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model96"},"description":"Successful"}}}},"/v1/sms":{"post":{"summary":"Send SMS","operationId":"postV1Sms","description":"Send SMS to phone number. Sender number can be any customer number and is used only for billing. It will not be shown on recipient phone.
\n Rate limiting can be applied at more than 1000 SMS/hour.
\n PHP example:
$url = \"https://restapi.ipex.cz/v1/\";\n$smsData = [\n    \"from\" => \"222333444\",\n    \"to\" => \"777888999\",\n    \"message\" => \"Test SMS\",\n    \"email\" => \"your@email\"\n];\n$auth = [\n    \"username\" => \"B2B login\",\n    \"password\" => \"B2B password\"\n];\ntry {\n    $token = APIPost($url . \"token\", $auth)->accessToken;\n    $result = APIPost($url . \"sms\", $smsData, $token);\n} catch (Exception $e) {\n    echo \"Error: \" . $e->getMessage() . PHP_EOL;\n    exit(-1);\n}\necho \"Succesfully sent\" . PHP_EOL;\nexit(0);\n\nfunction APIPost($url, $data, $token = false) {\n    $curl = curl_init();\n    curl_setopt($curl, CURLOPT_POST, 1);\n    curl_setopt($curl, CURLOPT_POSTFIELDS, json_encode($data));\n    $headers = [\"Authorization: $token\", \"Content-Type: application/json\"];\n    curl_setopt($curl, CURLOPT_HTTPHEADER,  $headers);\n    curl_setopt($curl, CURLOPT_URL, $url);\n    curl_setopt($curl, CURLOPT_RETURNTRANSFER, 1);\n    $result = json_decode(curl_exec($curl));\n    $httpcode = curl_getinfo($curl, CURLINFO_HTTP_CODE);\n    curl_close($curl);\n    if ($httpcode != 200) {\n        throw new Exception($result->message);\n    }\n    return $result;\n}

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model138"}}],"tags":["v1/sms"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model139"},"description":"Successful"}}}},"/v1/support":{"post":{"summary":"Create new service of guaranteed support","operationId":"postV1Support","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model140"}}],"tags":["v1/support"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model126"},"description":"Successful"}}}},"/v1/token":{"post":{"summary":"Return token info based on email and password","operationId":"postV1Token","description":"Return token info based on email and password","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model141"}}],"tags":["v1/token"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model142"},"description":"Successful"}}}},"/v1/tokenBasic":{"post":{"summary":"Return token info based on basic auth","operationId":"postV1Tokenbasic","description":"Return token info based on username and password sent in Authorization: Basic header","parameters":[{"type":"string","description":"Basic auth - base64(username:password)","pattern":"^Basic\\s+","name":"authorization","in":"header","required":true}],"tags":["v1/tokenBasic"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model142"},"description":"Successful"}}}},"/v1/voip":{"post":{"summary":"Vytvoření pevné linky","operationId":"postV1Voip","description":"Provede aktivaci pevné linky s režimem placení typu postpaid a prepaid. Jedná se o asynchronní operaci, návratovou hodnotu je id žádosti, podle kterého lze sledovat průběh zpracování.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model145"}}],"tags":["v1/voip"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model96"},"description":"Successful"}}},"put":{"summary":"Úprava nastavení pevné linky","operationId":"putV1Voip","description":"Provede změnu nastavení pevné linky. Jedná se o asynchronní operaci, návratovou hodnotu je id žádosti, podle kterého lze sledovat průběh zpracování.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model145"}}],"tags":["v1/voip"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model96"},"description":"Successful"}}}},"/v1/ictPriceList/copy":{"post":{"summary":"Create new pricelist as a copy","operationId":"postV1IctpricelistCopy","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model146"}}],"tags":["v1/ictPriceList"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model147"},"description":"Successful"}}}},"/v1/sms/integration":{"post":{"summary":"Creates SMS service","operationId":"postV1SmsIntegration","description":"Creates service for sending and receiving SMS - set default numbers, webhooks, etc.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model148"}}],"tags":["v1/sms"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model126"},"description":"Successful"}}}},"/v1/sso/login":{"post":{"summary":"Return token info based on email and password","operationId":"postV1SsoLogin","description":"Return token info based on email and password","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model149"}}],"tags":["v1/sso"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model156"},"description":"Successful"}}}},"/v1/sso/refresh":{"post":{"summary":"Return token info based on email and password","operationId":"postV1SsoRefresh","description":"Return token info based on email and password","tags":["v1/sso"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model157"},"description":"Successful"}}}},"/v1/token/sendOTP":{"post":{"summary":"Send one time password by email","operationId":"postV1TokenSendotp","description":"Sends code to mail for two factor auth","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model141"}}],"tags":["v1/token"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/connectors/{connectorId}/portIn":{"post":{"summary":"Import phone numbers into a connector","operationId":"postV1ConnectorsConnectoridPortin","description":"Import block of numbers into connector

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"integer","description":"Connector id","name":"connectorId","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model160"}}],"tags":["v1/connectors"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model130"},"description":"Successful"}}}},"/v1/connectors/{connectorId}/orderNewBlock":{"post":{"summary":"Order a blok of numbers into a connector ","operationId":"postV1ConnectorsConnectoridOrdernewblock","description":"Order new blok of numbers for the connector

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","description":"Connector id","name":"connectorId","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model161"}}],"tags":["v1/connectors"],"responses":{"200":{"description":"návratová hodnota","schema":{"type":"integer","description":"návratová hodnota"}}}}},"/v1/connectors/{connectorId}/deactivate":{"post":{"summary":"Connector deactivation","operationId":"postV1ConnectorsConnectoridDeactivate","description":"Trunk deactivation. Phone numbers will be moved to selected trunk or will be returned to previous operator

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"integer","name":"connectorId","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model162"}}],"tags":["v1/connectors"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model96"},"description":"Successful"}}}},"/v1/containers/{containerId}/portIn":{"post":{"summary":"Portace čísel do ústředny.","operationId":"postV1ContainersContaineridPortin","description":"Vytvoří objednávku na portaci čísel do dané ústředny. Pro ISP ústředny lze zadat i parametry pro automatickou aktivaci čísel.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"integer","description":"id kontejneru","name":"containerId","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model165"}}],"tags":["v1/containers"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model96"},"description":"Successful"}}}},"/v1/maintenance/calls/checkIncomeDrop":{"post":{"summary":"Check call price sums","operationId":"postV1MaintenanceCallsCheckincomedrop","description":"Check call price sums for last 2 weeks. Create ticket when there is 20% drop in any category.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model166"}}],"tags":["v1/maintenance"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model167"},"description":"Successful"}}}},"/v2/phone-numbers/block":{"put":{"summary":"Create new block","operationId":"putV2PhonenumbersBlock","description":"Create new block in billing and create routing (when service is set)

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model170"}}],"tags":["v2/phone-numbers"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model171"},"description":"Successful"}}}},"/v1/mobile/{number}/renew":{"put":{"summary":"Výměna SIM karty pro službu/číslo.","operationId":"putV1MobileNumberRenew","description":"Výmena SIM karty u mobilního císla. Jedná se o asynchronní operaci, návratovou hodnotu je id žádosti, podle kterého lze sledovat průběh zpracování pomocí /requests

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"integer","description":"mobilní číslo","name":"number","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model172"}}],"tags":["v1/mobile"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model96"},"description":"Successful"}}}},"/v1/mobile/{number}/deactivate":{"put":{"summary":"Provede ukončení mobilní služby","operationId":"putV1MobileNumberDeactivate","description":"Provede ukončení mobilní služby. Jedná se o asynchronní operaci, návratovou hodnotou je id žádosti, podle kterého lze sledovat průběh zpracování.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"number","description":"telefonní číslo","name":"number","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model173"}}],"tags":["v1/mobile"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model96"},"description":"Successful"}}}},"/v1/mobile/{phoneNumber}/oku":{"put":{"summary":"Update oku code","operationId":"putV1MobilePhonenumberOku","description":"Old oku code is revoke and new one is assigned

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"string","description":"Phone number in international format","name":"phoneNumber","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model175"}}],"tags":["v1/mobile"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/services/{serviceId}/systemUserBinding":{"put":{"summary":"Allow integration for pbx system user","operationId":"putV1ServicesServiceidSystemuserbinding","description":"Assigns integration service to system user. For internal pbx contacts searches.

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","minimum":1,"name":"serviceId","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model178"}}],"tags":["v1/services"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/voip/{number}/deactivate":{"put":{"summary":"Provede ukončení pevné linky","operationId":"putV1VoipNumberDeactivate","description":"Provede ukončení pevné linky. Jedná se o asynchronní operaci, návratovou hodnotou je id žádosti, podle kterého lze sledovat průběh zpracování.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"string","description":"telefonní číslo","name":"number","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model180"}}],"tags":["v1/voip"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model96"},"description":"Successful"}}}},"/v1/connectors/{connectorId}/phoneNumbers/{number}":{"put":{"summary":"Editing pohone number in connector","operationId":"putV1ConnectorsConnectoridPhonenumbersNumber","description":"Edits changeable number items in a connector.

Authentication

For access to this url you must used one of these authentications:

Roles

For access to this url you must have one of these roles:
","parameters":[{"type":"integer","description":"Connector id","name":"connectorId","in":"path","required":true},{"type":"string","description":"Phone number","minLength":9,"name":"number","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model185"}}],"tags":["v1/connectors"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model130"},"description":"Successful"}}}},"/v1/pbx/{serviceId}":{"delete":{"summary":"Delete pbx","operationId":"deleteV1PbxServiceid","description":"Delete pbx from business records and from datacenter

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","minimum":1,"name":"serviceId","in":"path","required":true}],"tags":["v1/pbx"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model187"},"description":"Successful"}}},"patch":{"summary":"Update PBX parameters","operationId":"patchV1PbxServiceid","description":"Only for some supported parameters

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","minimum":1,"name":"serviceId","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model196"}}],"tags":["v1/pbx"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model197"},"description":"Successful"}}}},"/v1/helpdesk/{serviceId}":{"patch":{"summary":"Change helpdesk properties","operationId":"patchV1HelpdeskServiceid","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","minimum":1,"name":"serviceId","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model190"}}],"tags":["v1/helpdesk"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model191"},"description":"Successful"}}}},"/v1/internet/{serviceId}":{"patch":{"summary":"Change internet type and properties","operationId":"patchV1InternetServiceid","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","minimum":1,"name":"serviceId","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model193"}}],"tags":["v1/internet"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model191"},"description":"Successful"}}}},"/v1/numbers/refresh-oku":{"patch":{"summary":"Replace old OKU with new one.","operationId":"patchV1NumbersRefreshoku","description":"If some OKU has been exposed, this route can replace it with new one. For landline only!

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model195"}}],"tags":["v1/numbers"],"responses":{"default":{"schema":{"type":"string"},"description":"Successful"}}}},"/v1/support/{serviceId}":{"patch":{"summary":"Change guaranteed support type, or amount of hours","operationId":"patchV1SupportServiceid","description":"

Authentication

For access to this url you must used one of these authentications:
","parameters":[{"type":"integer","minimum":1,"name":"serviceId","in":"path","required":true},{"in":"body","name":"body","schema":{"$ref":"#/definitions/Model198"}}],"tags":["v1/support"],"responses":{"200":{"schema":{"$ref":"#/definitions/Model191"},"description":"Successful"}}}}},"definitions":{"Model1":{"type":"object","properties":{"cislo_int":{"type":"string","description":"číslo - interní - volající","maxLength":32},"cislo_ext":{"type":"string","description":"číslo - externí - volaný","maxLength":32},"destinace":{"type":"string","description":"Zóna - destinace volání - např. \"poplatek za provoz\", \"Olomoucký Kraj\" (případně jiný, u volání na pevné linky), \"ČR Mobil\" (u volání na mobil)...","maxLength":64},"datetime":{"type":"string","description":"pro kumulované výpisy","optional":["datetime","datetime"],"x-alternatives":[{"type":"string","description":"pro kumulované výpisy"},{"type":"string","format":"date","description":"čas volání ve formátu YYYY-MM-DD HH:mm:ss"}]},"odchozi":{"type":"string","description":"flag - odchozí hovor","enum":["Y","N"]},"placeny":{"type":"string","description":"flag - placený hovor","enum":["Y","N"]},"stav":{"type":"string","description":"popis stavu telefonátu","enum":["Zodpovězeno","Obsazeno","Bez odpovědi","Přijato","Zmeškáno","Nepřijato","SMS prichozi zdarma","SMS placena nedorucena","Čekám na potvrzení spojení","Blokováno","Blokováno příchozí","Kumulovaný záznam"]},"delka":{"type":"number","description":"délka telefonátu/záznamu"},"jednotka":{"type":"string","description":"jednotka záznamu","enum":["MB","ks","s","?"]},"cena":{"type":"number","description":"cena záznamu/telefonátu"},"sazba_dph":{"type":"number","description":"sazba DPH"},"pocet":{"type":"integer","description":"počet"},"delka_naklad":{"type":"number"},"jednotka_naklad":{"type":"string","enum":["MB","ks","s","?"]},"cena_naklad":{"type":"number"},"zisk":{"type":"number"},"pocet_naklad":{"type":"integer"},"zakaznik_id":{"type":"integer","description":"ID zákazníka"},"zakaznik":{"type":"string","description":"zákazník"},"cdr_flags":{"type":"string","description":"textový popis - flagy popisující, co záznam znamená - cdr_flags je řetězec ze znaků: C - hovor | S - SMS | M - MMS | D - data | F - poplatek | O - ostatní | P - premium | R - roaming"},"uid":{"type":"string","description":"UID","maxLength":40},"volne_jednotky_1":{"type":"number","description":"volne jednotky 1"},"volne_jednotky_2":{"type":"number","description":"volne jednotky 2"},"volne_jednotky_3":{"type":"number","description":"volne jednotky 3"},"volne_jednotky_4":{"type":"number","description":"volne jednotky 4"},"casove_pasmo":{"type":"string"},"volajici":{"type":"string"},"poznamka":{"type":"string"}}},"pole s jednotlivými záznamy historie telefonátů":{"type":"array","items":{"$ref":"#/definitions/Model1"}},"Model2":{"type":"object","properties":{"id":{"type":"integer","description":"Connector id","minimum":1},"name":{"type":"string","description":"Owner name"},"systemName":{"type":"string","description":"Name used internaly"},"status":{"type":"string","description":"Phone number status","example":"active","enum":["new","active","stopped"]},"paymentType":{"type":"string","description":"Payment type","example":"postpaid","enum":["prepaid","postpaid"]},"typeConector":{"type":"string","description":"Phone number type","example":"pbx","enum":["pbx","voipTrunk","videoZoom","integration","internet","helpdesk","support","generic","zoomVideo","room"]},"activationDate":{"type":"string","format":"date","description":"Activation date","example":"2019-01-01"},"customerId":{"type":"integer","description":"Customer id","example":11,"minimum":1},"customerName":{"type":"string","description":"Customer name","example":"IPEX a.s."},"tariffPlanId":{"type":"integer","description":"Price list id","example":134,"minimum":1},"tariffPlanName":{"type":"string","description":"The name of the data package"},"price":{"type":"integer","description":"End customer price","example":10,"minimum":1},"costPrice":{"type":"integer","description":"Provider price"}},"required":["id","customerId","customerName"]},"connectors":{"type":"array","items":{"$ref":"#/definitions/Model2"}},"ipex":{"type":"object","description":"Internal use only","properties":{"splatnostFaktur":{"type":"number","description":"Internal use only"},"zpusobFakturace":{"type":"string","enum":["Nefakturovat","MarketplaceSF","MarketplaceMS","Rucne","Postpaid","Prepaid","PostpaidPilot"]},"fakturovatVMene":{"type":"string","enum":["CZK","EUR","USD","PLN","CNY"]},"zvysenaPozornost":{"type":"boolean","description":"Internal use only"},"nefakturovatPolozkyB2B":{"type":"boolean","description":"Internal use only"},"stredisko":{"type":"number","description":"Internal use only","maximum":100},"typDPH":{"type":"string","enum":["tuzemsko","RCH","EU","other"]},"idObjednavkyZakaznika":{"type":"string"},"datumFakturace":{"type":"string","format":"date"},"chybaFakturace":{"type":"string"},"minimalniPlneni":{"type":"number","description":"Internal use only"},"slevaDo":{"type":"string","format":"date"},"sleva":{"type":"boolean"},"slevaProcent":{"type":"number","description":"Internal use only"}}},"Model3":{"type":"object","properties":{"id":{"type":"number","description":"id zákazníka"},"customerName":{"type":"string","description":"název firmy"},"street":{"type":"string","description":"ulice"},"city":{"type":"string","description":"město"},"zipCode":{"type":"string","description":"PSČ"},"contact":{"type":"string","description":"kontakt na zákazníka"},"note":{"type":"string","description":"poznámka"},"numberCount":{"type":"integer","description":"počet čísel"},"tin":{"type":"string","description":"IČ"},"externId":{"type":"string","description":"id z externího systému"},"ruianId":{"type":"number","description":"ruian id"},"login":{"type":"string","description":"přihlašovací jméno zákazníka"},"password":{"type":"string","description":"přihlašovací heslo zákazníka. Heslo musí mít minimální délku 8 znaků, ve kterých budou použita malá i velká písmena a také číslice."},"pin":{"type":"string","description":"PIN pro zobrazení OKU kódů"},"type":{"type":"string","description":"Typ fakturace uživatele (old, start, profi, enterprise, aiContactCenter)"},"ictPriceListId":{"type":"number","description":"ID ceniku pro ostatni sluzby"},"hidden":{"type":"boolean","description":"user is hidden"},"ipex":{"$ref":"#/definitions/ipex"}}},"customers":{"type":"array","items":{"$ref":"#/definitions/Model3"}},"paging":{"type":"object","properties":{"page":{"type":"integer","description":"Page number - from 0"},"pageSize":{"type":"integer","description":"Page size"},"totalCount":{"type":"integer","description":"Total number of records"}}},"Model4":{"type":"object","properties":{"id":{"type":"number","description":"Pricelist id"},"name":{"type":"string"}},"required":["id"]},"items":{"type":"array","items":{"$ref":"#/definitions/Model4"}},"Model5":{"type":"object","properties":{"paging":{"$ref":"#/definitions/paging"},"items":{"$ref":"#/definitions/items"}}},"Model6":{"type":"object","properties":{"product":{"type":"string","description":"Product identification"},"count":{"type":"number","description":"Product count"},"price":{"type":"number","description":"Explicit price in CZK. Instead of count"},"contract":{"type":"string","description":"Contract/account - unique identification"}},"required":["product","contract"]},"Model7":{"type":"array","items":{"$ref":"#/definitions/Model6"}},"Model8":{"type":"object","properties":{"id":{"type":"number","description":"ID ústředny (interní)"},"serviceId":{"type":"number","description":"ID služby"},"serviceName":{"type":"string","description":"Název služby"},"createdAt":{"type":"string","format":"date","description":"Čas vytvoření služby"},"trial":{"type":"boolean","description":"True, pokud je v režimu trial"},"endUserTariffPlanId":{"type":"number","description":"ID defaultního ceníku (pokud existuje trunk ústředny)"},"customerId":{"type":"number","description":"ID zákazníka, kterému patří ústředna"},"providerId":{"type":"number","description":"ID providera, kterému patří ústředna"},"name":{"type":"string","description":"Interní název ústředny"},"hostname":{"type":"string","description":"Unikátní interní hostname ústředny"},"version":{"type":"string","description":"Verze ústředny, např \"4.0.0\""},"state":{"type":"string","description":"Verze ústředny, např \"4.0.0\"","enum":["running","stopped","deleted","unknown"]},"databaseHost":{"type":"string","description":"Umístění databáze ústředny"},"databaseName":{"type":"string","description":"Název databáze ústředny"},"recordingsStorage":{"type":"string","description":"Název databáze ústředny"},"notes":{"type":"string","description":"Poznámky / varování"},"dbHost":{"type":"string","description":"location of configuration database","example":"pbx.example.com"},"dbDataHost":{"type":"string","description":"location of data database","example":"pbx-data.example.com"}},"required":["id","serviceId","serviceName","createdAt","trial","customerId","providerId","name","hostname"]},"Model9":{"type":"array","items":{"$ref":"#/definitions/Model8"}},"Information about service":{"type":"object","properties":{"id":{"type":"integer","description":"Service id","example":15},"name":{"type":"string","description":"Service name","example":"ipex.voip"}}},"Provider information":{"type":"object","properties":{"id":{"type":"integer","description":"Provider id","example":1},"name":{"type":"string","description":"Provider name","example":"Example s.r.o."}},"required":["id","name"]},"Customer information":{"type":"object","properties":{"id":{"type":"integer","description":"Customer id","example":158},"name":{"type":"string","description":"Customer name","example":"IPEX a.s."}}},"OKU codes for ranges 1/10/100/1000. OKU codes are assigned to ranges by customer assignment.":{"type":"object","properties":{"range1":{"type":"integer","description":"OKU code for range 1.","example":72250000000096},"range10":{"type":"integer","description":"OKU code for range 10.","example":72250000000097},"range100":{"type":"integer","description":"OKU code for range 100.","example":72250000000098},"range1000":{"type":"integer","description":"OKU code for range 1000.","example":2250000000098},"preferredRange":{"type":"integer","description":"Preferred range to use OKU code from.","example":100,"enum":[1,10,100,1000]},"preferred":{"type":"integer","description":"Preferred OKU code","example":72250000000098}}},"Opid information for phone number":{"type":"object","properties":{"current":{"type":"integer","description":"Current opid the phone number is.","example":225},"owner":{"type":"integer","description":"Opid which owns the phone number.","example":225}}},"Phone number":{"type":"object","properties":{"number":{"type":"string","description":"Phone number in international format","example":"+420605250000"},"service":{"$ref":"#/definitions/Information%20about%20service"},"provider":{"$ref":"#/definitions/Provider%20information"},"customer":{"$ref":"#/definitions/Customer%20information"},"oku":{"$ref":"#/definitions/OKU%20codes%20for%20ranges%201%2F10%2F100%2F1000.%20OKU%20codes%20are%20assigned%20to%20ranges%20by%20customer%20assignment."},"opids":{"$ref":"#/definitions/Opid%20information%20for%20phone%20number"},"origin":{"type":"string","description":"If phone number is ported or owned","example":"ported","enum":["ported","owned"]}},"required":["number","provider","customer","oku","origin"]},"Array of phone numbers":{"type":"array","items":{"$ref":"#/definitions/Phone%20number"}},"Model10":{"type":"object","properties":{"requestId":{"type":"number","description":"id objednávky"},"requestType":{"type":"string","description":"typ objednávky","enum":["activate_mobil","portin_mobil","portin_voip","change_mobil","change_datapack_mobil","change_sim_mobil","suspend_mobil","reactivate_mobil","cease_mobil","change_tariff_mobil","limit_mobil","unlimit_mobil","create_trunk","portout_mobil","change_trunk","order_new_numbers_voip","delete_trunk","portout_mobil_finish","portout_voip","activate_voip","update_voip","cease_voip","create_pbx","delete_pbx","create_user","update_user","delete_user","create_service","update_service","add_user_service","delete_user_service","create_number","update_number","cease_number","create_room","delete_room","update_room","remove_voip_oku","change_oku_mobil","delete_service"]},"customerId":{"type":"number","description":"id zákazníka"},"customerName":{"type":"string","description":"jméno zákazníka"},"login":{"type":"string","description":"přihlašovací jméno uživatele, který vytvořil objednávku"},"inserted":{"type":"string","format":"date","description":"datum vytvoření"},"changed":{"type":"string","format":"date","description":"poslední datum změny"},"status":{"type":"string","description":"stav objednávky","enum":["new","processing","canceled","finished","error"]},"identifier":{"type":"string","description":"obecná identifikace objednávky"},"identifier2":{"type":"string","description":"obecná identifikace2 objednávky"},"resultNote":{"type":"string","description":"poznámka ke stavu objednávky"},"note":{"type":"string","description":"poznámka k objednávce providera"}},"required":["requestId"]},"Model11":{"type":"array","items":{"$ref":"#/definitions/Model10"}},"provider":{"type":"object"},"permissions":{"type":"array","description":"pole se seznamem povolených oprávnění","items":{"type":"string"}},"Model12":{"type":"object","properties":{"login":{"type":"string","description":"login uživatele"},"name":{"type":"string","description":"jméno uživatele"},"role":{"type":"string","description":"role uživatele"},"provider":{"$ref":"#/definitions/provider"},"permissions":{"$ref":"#/definitions/permissions"}},"required":["login","name","role","provider","permissions"]},"numbers":{"type":"array","description":"pole telefonních čísel, které jsou v daném konektoru","x-constraint":{"single":true},"items":{"type":"string"}},"mobile":{"type":"object","properties":{"iccid":{"type":"string","description":"ICCID"},"dataTariffPlan":{"type":"number","description":"datový balíček"},"lte":{"type":"boolean","description":"LTE"},"flatTariffPlan":{"type":"number","description":"flat balíček"},"pin1":{"type":"string","description":"pin 1"},"pin2":{"type":"string","description":"pin 2"},"puk1":{"type":"string","description":"puk 1"},"puk2":{"type":"string","description":"puk 2"}}},"diagnostics":{"type":"object","properties":{"status":{"type":"string","description":"stav diagnostiky"},"ping":{"type":"string","description":"ping"},"firmware":{"type":"string","description":"firmware"},"ipAddress":{"type":"string","description":"ip adresa"},"ipPort":{"type":"string","description":"port stroje"},"regContact":{"type":"string","description":"IP adresa a port za NAT"}}},"forward":{"type":"object","description":"nastavení přesměrování","properties":{"numPermanent":{"type":"string","description":"číslo pro permanentní přesměrování"},"numUnreachable":{"type":"string","description":"číslo pro přesměrování při nedostupnosti"},"numBusy":{"type":"string","description":"číslo pro přesměrování při obsazenosti"},"typePermanent":{"type":"string","description":"typ permanentního přesměrování","enum":["off","voicemail","phonenumber"]},"typeUnreachable":{"type":"string","description":"typ přesměrování při nedostupnosti","enum":["off","voicemail","phonenumber"]},"typeBusy":{"type":"string","description":"typ přesměrování při obsazenosti","enum":["off","voicemail","phonenumber"]},"delaySeconds":{"type":"integer","description":"počet sekund před aktivací (max. doba vyzvánění)"}}},"ipNetwork":{"type":"object","properties":{"ip":{"type":"string","description":"IP"},"mask":{"type":"string","description":"maska sítě"}},"required":["ip","mask"]},"permitIp":{"type":"array","description":"Pole povolených rozsahů. Pro smazání firewallu zadejte prázdné pole","x-constraint":{"single":true},"items":{"$ref":"#/definitions/ipNetwork"}},"firewallType":{"type":"object","description":"Nastavení firewallu","properties":{"permitIp":{"$ref":"#/definitions/permitIp"}}},"voip":{"type":"object","properties":{"address":{"type":"string","description":"adresa"},"password":{"type":"string"},"diagnostics":{"$ref":"#/definitions/diagnostics"},"opId":{"type":"integer","description":"id operatora"},"operatorName":{"type":"string","description":"jméno operátora"},"connectorName":{"type":"string","description":"jméno konektoru"},"connectorId":{"type":"integer","description":"id konektoru"},"addressName":{"type":"string","description":"Jméno uživatele služby. Povinné pro geografická čísla (2* - 5*). Slouží pro přesnou lokalizaci tísňových volání."},"addressCTUId":{"type":"integer","description":"id adresy CTU"},"codec":{"type":"string","description":"SIP kodek","enum":["ILBC","G711","G722"]},"autoconfigurationPhoneType":{"type":"string","description":"typ telefonu pro vygenerování autokonfigurace","enum":["none","aastra_6730i","aastra_6731i","aastra_6751i","aastra_6753i","aastra_6755i","aastra_6757i","linksys_spa92x","linksys_spa94x","linksys_spa962","grandstream_budgetone20x","grandstream_gxp280","grandstream_gxp1200","grandstream_gxp2000","grandstream_gxp2010","grandstream_gxp2020","grandstream_gxv3140"]},"mac":{"type":"string","description":"MAC adresa zařízení (pro vygenerování autokonfigurace)","example":"aa00bb11ff99"},"forward":{"$ref":"#/definitions/forward"},"faxToMail":{"type":"string","description":"E-mail pro zasílání příchozích faxů (přesměruje příchozí hovory na virtuální fax)"},"firewall":{"$ref":"#/definitions/firewallType"},"clir":{"type":"boolean","description":"nastavení Calling Line Identification Restriction","default":false},"voicemail":{"type":"string","description":"nastavení voicemailu (email)"}}},"profileCurrent":{"type":"object","properties":{"outgoing":{"type":"integer","description":"Profil blokování odchozích hovorů, výchozí 0 (blokování pouze rizikových destinací)","minimum":0,"maximum":15}}},"antifraud":{"type":"object","properties":{"profileCurrent":{"$ref":"#/definitions/profileCurrent"},"profilePermanent":{"$ref":"#/definitions/profileCurrent"},"internationalLimit":{"type":"integer","description":"Denní limit pro hovory do zahraničí."}}},"currentAvailableUnits":{"type":"object","properties":{"slot1":{"type":"number","description":"pozice 1"},"slot2":{"type":"number","description":"pozice 2"},"slot3":{"type":"number","description":"pozice 3"},"slot4":{"type":"number","description":"pozice 4"}}},"Model13":{"type":"object","properties":{"number":{"type":"string","description":"number of service","example":"420777666555"},"connectorId":{"type":"integer","description":"connector id","example":123456},"numbers":{"$ref":"#/definitions/numbers"},"status":{"type":"string","description":"service status","example":"active","enum":["reserved","active","canceled","stopped","prepared","limited"]},"paymentType":{"type":"string","description":"type/mode of payment","example":"postpaid","enum":["prepaid","postpaid"]},"numberType":{"type":"string","description":"type of number","example":"room","enum":["voice","fax","mobile","specialNumber","pbx","voipTrunk","videoZoom","integration","generic","zoomVideo","room"]},"tariffPlanId":{"type":"integer","description":"pricelist id","example":12543},"createDate":{"type":"string","format":"date-time"},"customerId":{"type":"integer","description":"customer id","example":34888},"customerName":{"type":"string","description":"customer name"},"customerExternId":{"type":"string","description":"external id of customer"},"containerId":{"type":"integer","description":"customer pbx","example":15},"mobile":{"$ref":"#/definitions/mobile"},"voip":{"$ref":"#/definitions/voip"},"creditAmount":{"type":"number","description":"množství kreditu"},"monthlyCredit":{"type":"number","description":"kredit automaticky nastavovaný v měsíčních intervalech, pouze pro prepaid"},"creditExpirationDate":{"type":"string","format":"date-time","description":"datum expirace kreditu"},"monthlyLimitNotification":{"type":"integer","description":"měsíční limit pro notifikaci postpaid čísel, Pro zapnutí je nutno zadat částku nejméně 300 Kč"},"monthlyLimit":{"type":"integer","description":"měsíční limit postpaid čísla"},"containerHostname":{"type":"string","description":"adresa ústředny"},"antifraud":{"$ref":"#/definitions/antifraud"},"currentAvailableUnits":{"$ref":"#/definitions/currentAvailableUnits"},"lastBillingChange":{"type":"string","format":"date-time"}}},"services":{"type":"array","items":{"$ref":"#/definitions/Model13"}},"Model14":{"type":"object","properties":{"number":{"type":"string","description":"Invoice ID","example":"5250050"},"state":{"type":"string","description":"open, sent, overdue, paid, cancelled, uncollectible. See https://fakturoid.docs.apiary.io/#reference/invoices/invoices-collection/seznam-faktur"},"taxFulfillmentDate":{"type":"string","example":"2022-07-15"},"dueOn":{"type":"string","example":"2022-07-15"},"htmlLink":{"type":"string","example":"https://app.fakturoid.cz/acmecompany/p/3bXTk3MmZQ/20220028"},"subTotal":{"type":"number","example":123.45},"total":{"type":"number","example":144.45}},"required":["number"]},"Model15":{"type":"array","items":{"$ref":"#/definitions/Model14"}},"Model16":{"type":"object","properties":{"count":{"type":"integer","description":"Total count of found items","example":1587,"minimum":1},"items":{"$ref":"#/definitions/Model15"}}},"pagging":{"type":"object","properties":{"next":{"type":"string","description":"Url to fetch next set of data"},"first":{"type":"string","description":"Url to fetch first set of data"},"last":{"type":"string","description":"Url to fetch last set of data"},"prev":{"type":"string","description":"Url to fetch previous set of data"}},"required":["next","first","last","prev"]},"Model17":{"type":"object","properties":{"number":{"type":"string","description":"Phone number in international format","example":"+420605250000"},"service":{"$ref":"#/definitions/Information about service"},"provider":{"$ref":"#/definitions/Provider information"},"customer":{"$ref":"#/definitions/Customer information"},"oku":{"$ref":"#/definitions/OKU codes for ranges 1/10/100/1000. OKU codes are assigned to ranges by customer assignment."},"opids":{"$ref":"#/definitions/Opid information for phone number"},"origin":{"type":"string","description":"If phone number is ported or owned","example":"ported","enum":["ported","owned"]}},"required":["number","provider","customer","oku","origin"]},"Model18":{"type":"array","items":{"$ref":"#/definitions/Model17"}},"Model19":{"type":"object","properties":{"totalCount":{"type":"integer","description":"Total number of records (after filtering)"},"pagging":{"$ref":"#/definitions/pagging"},"result":{"$ref":"#/definitions/Model18"}}},"roles":{"type":"array","description":"User roles","example":[["provider_realizace","provider_fakturace"]],"items":{"type":"string","enum":["provider_superadmin","provider_admin","provider_podpora","provider_realizace","provider_fakturace","operator","provider_portace","provider_sms"]}},"Model20":{"type":"object","properties":{"providerId":{"type":"integer","description":"Provider id","example":15},"login":{"type":"string","description":"Username","example":"doe.john"},"roles":{"$ref":"#/definitions/roles"},"twoFactorAuth":{"type":"string","description":"Require second auth factor","example":"email","enum":["email"]},"name":{"type":"string","description":"First name","example":"John"},"surname":{"type":"string","description":"Last name","example":"Doe"},"email":{"type":"string","description":"User email","example":"john.doe@example.com","x-format":{"email":true}},"phone":{"type":"string","description":"User phone number","example":"605250000"}}},"accounts":{"type":"array","items":{"$ref":"#/definitions/Model20"}},"Model21":{"type":"object","properties":{"providerId":{"type":"number","description":"Provider id","example":1},"customer":{"type":"string","description":"Customer name id","example":"IPEX a.s."},"customerId":{"type":"number","description":"Customer id","example":1},"customerExternalId":{"type":"string","description":"Customer external id - id from customer system.","example":"EXT-1"},"serviceId":{"type":"number","description":"Service id.","example":1},"serviceName":{"type":"string","description":"Service name.","example":"Trunk VoIPEX"},"periodFrom":{"type":"string","format":"date-time","description":"Period start","example":"2011-01-01"},"periodTo":{"type":"string","format":"date-time","description":"Period end","example":"2011-12-31"},"tsId":{"type":"number","description":"Id of technical specification","example":1},"type":{"type":"string","description":"one of [\"charges\", \"calls\", \"actions\"]","example":"calls","enum":["charges","calls","actions"]},"oneTimeCost":{"type":"number","description":"One time cost without VAT (Nakupni cena bez DPH jednorazova)","example":0},"periodicalCost":{"type":"number","description":"Periodical cost without VAT (Nakupni cena bez DPH pravidelna)","example":0},"operatingCost":{"type":"number","description":"Operating cost without VAT (Nakupni cena bez DPH provozni)","example":0},"sellingPrice":{"type":"number","description":"Selling price without VAT (Prodejni cena bez DPH)","example":0},"profit":{"type":"number","description":"Profit without VAT (Zisk bez DPH)","example":0}}},"Model22":{"type":"array","items":{"$ref":"#/definitions/Model21"}},"Model23":{"type":"object","properties":{"callee":{"type":"string","description":"Callee (Volaný)"},"publicIp":{"type":"string","description":"Public ip (Veřejná ip)"},"start":{"type":"string","format":"date-time","description":"Call start (Začátek)"},"duration":{"type":"number","description":"Call duration (Délka)"},"device":{"type":"string","description":"Device (Zařízení)"},"localIp":{"type":"string","description":"Local ip (lokální ip)"},"caller":{"type":"string","description":"Caller (Volající)"}}},"Model24":{"type":"array","items":{"$ref":"#/definitions/Model23"}},"Model25":{"type":"object","properties":{"name":{"type":"string","description":"jméno konektoru"},"displayName":{"type":"string","description":"jméno pro zobrazení konektoru"},"id":{"type":"number","description":"identifikace"},"category":{"type":"string","description":"kategorie záznamu"},"VAT":{"type":"number","description":"sazba DPH"},"count":{"type":"number","description":"celkový počet čísel"},"pricePerUnit":{"type":"number","description":"cena za položku"},"sellPrice":{"type":"number","description":"prodejní cena"},"buyPrice":{"type":"number","description":"nákupní cena"}},"required":["category","VAT","count","sellPrice","buyPrice"]},"invoices":{"type":"array","items":{"$ref":"#/definitions/Model25"}},"generalParameters":{"type":"object","properties":{"id":{"type":"integer","description":"Connector id","example":1},"name":{"type":"string","description":"Name for easier identification","example":"ipex.voip"},"customerId":{"type":"integer","description":"Id of customer who pays for the trunk","example":10500},"systemName":{"type":"string","description":"název používaný interně"},"status":{"type":"string","description":"stav čísla","enum":["new","active","stopped"]},"activationDate":{"type":"string","format":"date-time","description":"datum aktivace"}},"required":["name","customerId"]},"status":{"type":"object","properties":{"unknown":{"type":"boolean"},"monitored":{"type":"boolean"},"online":{"type":"boolean"}}},"destinationDevice":{"type":"object","properties":{"type":{"type":"string","description":" typ zařízení, které se bude připojovat k trunku","enum":["pbx","gateway","sipModule","virtualPbx"]},"vendor":{"type":"string","description":"výrobce zařízení"},"identifier":{"type":"string","description":"přesnější typ zařízení"},"firmware":{"type":"string","description":"verze firmware zařízení"}}},"backup":{"type":"object","properties":{"number":{"type":"string","description":"při výpadku přesměrovat všechny hovory na dané tel. číslo"},"backupTrunkId":{"type":"integer","description":"při výpadku přesměrovat všechny hovory na jiný trunk"}}},"technicalParameters":{"type":"object","properties":{"destinationAddress":{"type":"string","description":"adresa umístění zařízení trunku"},"destinationAddressId":{"type":"integer","description":"Address id from ruian database where trunk will be placed","example":19,"minimum":1},"login":{"type":"string","description":"přihlašovací login pro zaregistrování zařízení"},"password":{"type":"string","description":"přihlašovací heslo pro zaregistrování zařízení."},"endUserTariffPlan":{"type":"integer","description":"koncový ceník pro určení poplatku za trunk"},"type":{"type":"integer","description":"typ trunku"},"expectedMonthlyCharge":{"type":"integer","description":"očekávaná měsiční provolávka (pro počáteční orientační nastavení interního antifraud systému)"},"ipAccessControlList":{"type":"string","description":"IP adresa zařízení připojujícího se k trunku, případně adresy oddělené čárkou (max. 255 znaků)"},"mod":{"type":"string","description":"mód registrace trunku (registration)","enum":["registration","static"]},"monitoring":{"type":"boolean","description":"zapnutí monitoringu pomocí SIP Options (false)"},"destinationDevice":{"$ref":"#/definitions/destinationDevice"},"backup":{"$ref":"#/definitions/backup"}},"required":["destinationAddressId","login","endUserTariffPlan","type"]},"trunk connector":{"type":"object","properties":{"generalParameters":{"$ref":"#/definitions/generalParameters"},"status":{"$ref":"#/definitions/status"},"technicalParameters":{"$ref":"#/definitions/technicalParameters"}}},"Model26":{"type":"object","properties":{"id":{"type":"number","description":"id ústředny"},"host":{"type":"string","description":"umístění ústředny"},"vendor":{"type":"string","description":"výrobce"},"vendorType":{"type":"string","description":"typ výrobce"},"management":{"type":"string","description":"správce"},"type":{"type":"string","description":"typ provedení (virtuální, fyzická)","enum":["Mobile","ISP","Other","Any"]},"activeNumbers":{"type":"number","description":"počet aktivních čísel"}},"required":["id","host"]},"containers type":{"type":"array","items":{"$ref":"#/definitions/Model26"}},"Model27":{"type":"object","properties":{"description":{"type":"string","description":"popis kategorie (dle aktuálního nastavení v ceníku čísla)"},"available":{"type":"string","description":"počet volných jednotek, které mělo číslo na daný měsíc k dispozici"},"remain":{"type":"string","description":"počet jednotek, které číslu zbyly na konci měsíce"},"transfer":{"type":"string","description":"počet jednotek, které se prevádí do dalšího měsíce"}}},"unit":{"type":"array","items":{"$ref":"#/definitions/Model27"}},"Model28":{"type":"object","properties":{"number":{"type":"string","description":"telefonní číslo, pro které platí tato sekce"},"units":{"$ref":"#/definitions/unit"}},"required":["number"]},"free units":{"type":"array","items":{"$ref":"#/definitions/Model28"}},"customer":{"type":"object","properties":{"id":{"type":"number","description":"ID of customer"},"name":{"type":"string","description":"Name of customer"}}},"apiCredentials":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}},"required":["username","password"]},"scimSettings":{"type":"object","properties":{"active":{"type":"boolean"},"token":{"type":"string"}},"required":["active"]},"settings":{"type":"object","properties":{"url":{"type":"string","description":"URI of requestor instance"},"apiCredentials":{"$ref":"#/definitions/apiCredentials"},"scimSettings":{"$ref":"#/definitions/scimSettings"}},"required":["url","scimSettings"]},"Model29":{"type":"object","properties":{"status":{"type":"string","description":"Service status","enum":["new","active","deleted","stopped"]},"customer":{"$ref":"#/definitions/customer"},"settings":{"$ref":"#/definitions/settings"}}},"Model30":{"type":"object","properties":{"id":{"type":"number","description":"Item id"},"name":{"type":"string"},"currency":{"type":"string"},"code":{"type":"string"},"category":{"type":"string"},"price":{"type":"number"}},"required":["id"]},"Model31":{"type":"array","items":{"$ref":"#/definitions/Model30"}},"Model32":{"type":"object","properties":{"id":{"type":"number","description":"Pricelist id"},"name":{"type":"string"},"items":{"$ref":"#/definitions/Model31"}},"required":["id"]},"Model33":{"type":"object","properties":{"id":{"type":"number","description":"Id of type"},"name":{"type":"string","description":"Readable name for user"},"ipv4RentalAllowed":{"type":"boolean","description":"Allows rental of IPV4 address"}},"required":["id","name","ipv4RentalAllowed"]},"Model34":{"type":"array","items":{"$ref":"#/definitions/Model33"}},"type":{"type":"object","properties":{"id":{"type":"number","description":"Internet type id."},"name":{"type":"string","description":"Internet type description"}},"required":["id","name"]},"Model35":{"type":"object","properties":{"status":{"type":"string","description":"Service status","enum":["new","active","deleted","stopped"]},"type":{"$ref":"#/definitions/type"},"customer":{"$ref":"#/definitions/customer"},"ipv4Rental":{"type":"string","description":"IPV4 address to rent.","x-format":{"ip":{"cidr":"optional"}}}}},"Model36":{"type":"object","properties":{"itemId":{"type":"string","description":"ID služby","example":"internet_42kbit"},"itemName":{"type":"string","description":"Nejčastější název služby","example":"Internetove pripojeni bleskurychle"},"price":{"type":"number","description":"Nejčastější cena služby","example":1000}},"required":["itemId","itemName","price"]},"Model37":{"type":"array","items":{"$ref":"#/definitions/Model36"}},"Model38":{"type":"object","properties":{"itemId":{"type":"string","description":"ID služby","example":"internet_42kbit"},"itemName":{"type":"string","description":"Název služby","example":"Internetove pripojeni bleskurychle"},"customerId":{"type":"number","description":"ID zákazníka","minimum":1},"contract":{"type":"string","description":"Zakázka - ID pro zákazníka","example":"novak.internet"},"itemCount":{"type":"number","description":"Počet položek"},"itemPrice":{"type":"number","description":"Cena za položku"},"oneTimeDate":{"type":"string","format":"date","description":"Datum zaúčtování - jednorázové položky"},"customValue":{"type":"number","description":"Nastavení hodnoty slev / volných jednotek"}},"required":["itemId","itemName","customerId","contract","itemCount","itemPrice"]},"Model39":{"type":"object","properties":{"status":{"type":"string","description":"Service status","enum":["new","active","deleted","stopped"]},"customer":{"$ref":"#/definitions/customer"},"settings":{"$ref":"#/definitions/Model38"}}},"Model40":{"type":"object","properties":{"city":{"type":"string","description":"město"},"customerName":{"type":"string","description":"název firmy"},"contact":{"type":"string","description":"kontakt na zákazníka"},"externId":{"type":"string","description":"id z externího systému"},"customerId":{"type":"integer","description":"id zákazníka"},"note":{"type":"string","description":"poznámka"},"street":{"type":"string","description":"ulice"},"tin":{"type":"string","description":"IČO"},"zipCode":{"type":"string","description":"PSČ"},"numberCount":{"type":"integer","description":"počet čísel pro typ režimu placení"},"paymentType":{"type":"string","description":"typ režimu placení"},"dateStart":{"type":"string","format":"date","description":"datum začátku období, včetně uvedeného data"},"dateEnd":{"type":"string","format":"date","description":"datum konce období, včetně uvedeného data"},"numbersTotal":{"type":"string","description":"celkový počet čísel zákazníka"},"price":{"type":"number","description":"cena"},"buyPrice":{"type":"number","description":"nákladová cena"},"buyPriceOnce":{"type":"number","description":"nákladová cena - jednorázové náklady"},"buyPriceRegular":{"type":"number","description":"nákladová cena - pravidelné náklady"},"buyPriceProcess":{"type":"number","description":"nákladová cena - provozní náklady"},"profit":{"type":"number","description":"zisk"}}},"Model41":{"type":"array","items":{"$ref":"#/definitions/Model40"}},"Model42":{"type":"array","description":"stav služby","x-constraint":{"single":true},"items":{"type":"string","enum":["reserved","active","canceled","stopped","prepared","limited","deleted"]}},"Model43":{"type":"object","properties":{"outgoing":{"type":"integer","description":"Profile to block outgoing calls. Default profile id is 0 (Block only risk destinations)","minimum":0,"maximum":15}}},"Model44":{"type":"object","properties":{"profileCurrent":{"$ref":"#/definitions/Model43"},"profilePermanent":{"$ref":"#/definitions/Model43"},"internationalLimit":{"type":"integer","description":"Daily limmit for calls to foreign countries"}}},"numberDetail":{"type":"object","properties":{"number":{"type":"string","description":"číslo služby"},"status":{"$ref":"#/definitions/Model42"},"paymentType":{"type":"string","description":"typ/režim platby","enum":["prepaid","postpaid"]},"numberType":{"type":"string","description":"typ čísla","enum":["voice","fax","mobile","connector","specialNumber"]},"tariffPlanId":{"type":"integer","description":"id ceníku"},"createDate":{"type":"string","format":"date-time"},"customerId":{"type":"integer","description":"id zákazníka"},"customerName":{"type":"string","description":"Jméno zákazníka"},"customerExternId":{"type":"string","description":"Externí id zákazníka"},"containerId":{"type":"number","description":"id ústředny"},"blockTypeId":{"type":"number","description":"Id typu bloku cisel"},"mobile":{"$ref":"#/definitions/mobile"},"creditAmount":{"type":"number","description":"množství kreditu"},"monthlyCredit":{"type":"number","description":"kredit automaticky nastavovaný v měsíčních intervalech, pouze pro prepaid"},"creditExpirationDate":{"type":"string","format":"date-time","description":"datum expirace kreditu"},"monthlyLimitNotification":{"type":"integer","description":"měsíční limit pro notifikaci postpaid čísel, Pro zapnutí je nutno zadat částku nejméně 300 Kč"},"monthlyLimit":{"type":"integer","description":"měsíční limit postpaid čísla"},"containerHostname":{"type":"string","description":"adresa ústředny"},"antifraud":{"$ref":"#/definitions/Model44"},"currentAvailableUnits":{"$ref":"#/definitions/currentAvailableUnits"},"lastBillingChange":{"type":"string","format":"date-time"}}},"provisioningAttributes":{"type":"object","properties":{"communicationLanguage":{"type":"string","description":"servisní jazyk","enum":["czech","english"]},"welcomeRoamingSms":{"type":"boolean","description":"aktivace uvítacích roamingových SMS"},"mms":{"type":"boolean","description":"aktivace MMS"},"sms":{"type":"string","description":"aktivace SMS, význam hodnot"},"incomingCall":{"type":"boolean","description":"povolení nebo zakázání příchozích hovorů"},"outgoingCall":{"type":"string","description":"povolení nebo zakázání odchozích hovorů, význam hodnot","enum":["blockAll","blockInternational","allowAll"]},"premiumService":{"type":"string","description":"povolení nebo zakázání prémiových služeb (služby jsou momentálně nedostupné a jediná možná volba je blokování všeho \"blockAll\"), význam hodnot","enum":["blockAll","blockCall","blockSms","allowAll"]},"roamingCall":{"type":"string","description":"aktivace roamingových hovorů, profily se získají pomocí metody getRoamingList"},"callForwarding":{"type":"boolean","description":"povolení přesměrovaní hovorů"},"callHold":{"type":"boolean","description":"povolení přidržení hovoru"},"clir":{"type":"string","description":"blokování identifikace volajícího , význam hodnot","enum":["permanent","temporaryAllowed","temporaryRestricted"]},"missedCallAlert":{"type":"boolean","description":"aktivace registru zmeškaných hovorů (momentálně nelze aktivovat)"},"outsideCallWarning":{"type":"boolean","description":"aktivace hlásky o volání mimo vlastní síť"},"voiceMail":{"type":"boolean","description":"povolení hlasové schránky"},"voiceMailLanguage":{"type":"string","description":"jazyk hlasové schránky","enum":["czech","english"]},"voiceMailSmsNotify":{"type":"boolean","description":"upozornení na nové hlasové zprávy"},"dataFupNotify":{"type":"boolean","description":"upozornění na dosažení FUP limitu"},"dataRoaming":{"type":"boolean","description":"aktivace dat pro roaming"},"dataRoamingLimit":{"type":"string","description":"limit v Kč pro roamingová data, 0 je pro data bez omezení","enum":["0","1225","3900","15000"]},"portOutDate":{"type":"string","format":"date-time","description":"datum a čas naplánovaného odportování čísla k jinému operátorovi"},"portationNumber":{"type":"string","description":"vygenerovaný ČVOP u odportovávaných čísel"},"internetIP":{"type":"string","description":"vnitřní IP adresa čísla v síti T-Mobile FUP – informace o FUP"}}},"fup":{"type":"object","properties":{"state":{"type":"boolean","description":"informuje o tom, jestli je FUP (omezení dat) spuštěno"},"dataRemainsKB":{"type":"number","description":"zbývající data v KB"},"dataLimitMB":{"type":"number","description":"limit v MB pro FUP"},"activationDate":{"type":"string","format":"date","description":"datum, od kterého se kontroluje dosažení limitu FUP"}}},"Model45":{"type":"object","properties":{"numberDetail":{"$ref":"#/definitions/numberDetail"},"provisioningAttributes":{"$ref":"#/definitions/provisioningAttributes"},"fup":{"$ref":"#/definitions/fup"}}},"invoice":{"type":"object","properties":{"periodFirstDay":{"type":"integer","description":"první den fakturačního období"},"periodFirstMonth":{"type":"integer","description":"první měsíc fakturačního období"},"periodLength":{"type":"integer","description":"délka fakturačního období"}}},"branding":{"type":"object","properties":{"invoiceLogo":{"type":"string","description":"logo providera na faktury, max 10MB. V GET /providers/personal je vráceno ve formátu PNG, kódováno v base64. V PUT /providers/personal je očekáváno maximální rozlišení 1000x1000px, pri větším rozlišení je logo automaticky zmenšeno pri zachování poměru stran."}}},"Model46":{"type":"object","properties":{"contactEmail":{"type":"string","description":"Kontaktní email providera"},"expireNotifyEmail":{"type":"string","description":"Email pro zasílání informací o expiraci kreditu"},"emailFrom":{"type":"string","description":"email odesílatele u potvrzovacích SMS zpráv"},"autoCreditExpire":{"type":"boolean","description":"Nulovat kredit u čísel při expiraci"},"creditExpireDays":{"type":"integer","description":"Výchozí délka expirace kreditu při aktivaci a dobíjení čísel"},"ico":{"type":"string","description":"IČO providera"},"invoice":{"$ref":"#/definitions/invoice"},"branding":{"$ref":"#/definitions/branding"},"defaultGreenLinePriceList":{"type":"integer","description":"id defaultního tarifu zelených linek"},"defaultMobilePriceList":{"type":"integer","description":"id defaultního mobilního tarifu"},"defaultUCPriceList":{"type":"integer","description":"id defaultního tarifu UC"},"defaultConnectorPriceList":{"type":"integer","description":"id defaultního tarifu konektorů"},"defaultVoipPriceList":{"type":"integer","description":"id defaultního voip tarifu"},"defaultGreenLinePaymentType":{"type":"string","description":"defaultní typ zelených linek"},"defaultMobilePaymentType":{"type":"string","description":"defaultní typ mobilních čísel"},"defaultUCPaymentType":{"type":"string","description":"defaultní typ UC"},"defaultConnectorPaymentType":{"type":"string","description":"defaultní typ konektoru"},"defaultVoipPaymentType":{"type":"string","description":"defaultní typ pevných čísel"}}},"Model47":{"type":"object","properties":{"count":{"type":"integer","description":"počet čísel v kategorii s uvedenými vlastnostmi"},"paymentType":{"type":"string","description":"typ platby (prepaid, postpaid)","enum":["prepaid","postpaid"]},"numberType":{"type":"string","description":"typ čísla (voice, fax, mobile)","enum":["voice","fax","mobile"]},"customerId":{"type":"number","description":"id zákazníka"},"serviceId":{"type":"number","description":"id konektoru"},"customerCount":{"type":"number","description":"počet různých zákazníků, kteří mají v této kategorii"},"status":{"type":"string","description":"stav čísel","enum":["reserved","active","canceled","stopped","prepared","limited","finished"]}}},"number stats":{"type":"array","items":{"$ref":"#/definitions/Model47"}},"popis služby, ke které je daný request. naplněno u typu MOBILE":{"type":"object","properties":{"customerId":{"type":"number","description":"id zákazníka"},"containerId":{"type":"integer","description":"id ústředny"},"tariffPlanId":{"type":"integer","description":"id ceníku"},"number":{"type":"string","description":"mobilní číslo","minLength":9},"iccid":{"type":"string","description":"iccid"},"dataTariffPlan":{"type":"integer","description":"datový tarif"},"lte":{"type":"boolean","description":"aktivace LTE"},"flatTariffPlan":{"type":"integer","description":"flat tarif"},"internationalLimitDay":{"type":"integer","description":"mezinárodní denní limit hovorného. Limit je v Kč a hlídá částku provolanou z ČR do zahraničí"},"requiredActivationDate":{"type":"string","format":"date-time","description":"požadované datum aktivace"},"credit":{"type":"number","description":"hodnota kreditu v Kč, pouze pro prepaid"},"monthlyCredit":{"type":"number","description":"kredit automaticky nastavovaný v měsíčních intervalech, pouze pro prepaid"},"creditExpirationDate":{"type":"string","format":"date-time","description":"datum expirace kreditu"},"monthlyLimitNotification":{"type":"integer","description":"měsíční limit pro notifikaci postpaid čísel, Pro zapnutí je nutno zadat částku nejméně 300 Kč"},"monthlyLimit":{"type":"integer","description":"měsíční limit postpaid čísla"},"paymentType":{"type":"string","description":"typ placení","enum":["prepaid","postpaid"]}},"required":["customerId","number"]},"podrobnosti k portaci. naplněno u typu MOBILE":{"type":"object","properties":{"portationNumber":{"type":"number","description":"číslo portace (ČVOP) 14 místné číslo"}}},"naplněno, pokud je typ requestu MOBILE.":{"type":"object","properties":{"communicationLanguage":{"type":"string","description":"servisní jazyk","enum":["czech","english"]},"welcomeRoamingSms":{"type":"boolean","description":"aktivace uvítacích roamingových SMS"},"mms":{"type":"boolean","description":"aktivace MMS"},"sms":{"type":"string","description":"aktivace SMS","enum":["incoming","outgoing","allowAll","blockAll"]},"incomingCall":{"type":"boolean","description":"povolení nebo zakázání příchozích hovorů"},"outgoingCall":{"type":"string","description":"povolení nebo zakázání odchozích hovorů, význam hodnot","enum":["blockAll","blockInternational","allowAll"]},"premiumService":{"type":"string","description":"povolení nebo zakázání prémiových služeb, význam hodnot","enum":["blockAll","blockCall","blockSms","allowAll"]},"roamingCall":{"type":"string","description":"aktivace roamingových hovorů, profily se získají pomocí metody roamingList"},"callForwarding":{"type":"boolean","description":"povolení přesměrovaní hovorů"},"callHold":{"type":"boolean","description":"povolení přidržení hovorů"},"clir":{"type":"string","description":"blokování identifikace volajícího (CLIR), význam hodnot","enum":["permanent","temporaryAllowed","temporaryRestricted"]},"missedCallAlert":{"type":"boolean","description":"aktivace registru zmeškaných hovorů (zasílání SMS o zmeškaných voláních)"},"outsideCallWarning":{"type":"boolean","description":"aktivace hlásky o volání mimo vlastní síť"},"voiceMail":{"type":"boolean","description":"povolení hlasové schránky"},"voiceMailLanguage":{"type":"string","description":"jazyk hlasové schránky","enum":["czech","english"]},"voiceMailSmsNotify":{"type":"boolean","description":"upozornění na nové hlasové zprávy"},"dataFupNotify":{"type":"boolean","description":"upozornění na dosažení FPU limitu"},"dataRoaming":{"type":"boolean","description":"aktivace dat pro roamingu"},"dataRoamingLimit":{"type":"number","description":"limit v Kč pro roamingová data, 0 je pro data bez omezení","enum":[0,1225,3900,15000]}}},"Model48":{"type":"object","description":"další nastavení služby, typ VOIP [activate_voip, update_voip] (adresy i portin_voip)","properties":{"password":{"type":"string","description":"heslo pro připojení koncového zařízení. Heslo musí mít minimální délku 8 znaků, ve kterých budou použita malá i velká písmena a také číslice.","minLength":8,"pattern":"(?=.*[A-Z])(?=.*[0-9])(?=.*[a-z]).{8,}"},"addressName":{"type":"string","description":"Address refinement for more accurate localization in emergency calls. Required for czech national phone numbers started with 2-5"},"addressCTUId":{"type":"integer","description":"RUIAN address id"},"codec":{"type":"string","description":"SIP kodek","enum":["ILBC","G711","G722"]},"autoconfigurationPhoneType":{"type":"string","description":"typ telefonu pro vygenerování autokonfigurace","enum":["none","aastra_6730i","aastra_6731i","aastra_6751i","aastra_6753i","aastra_6755i","aastra_6757i","linksys_spa92x","linksys_spa94x","linksys_spa962","grandstream_budgetone20x","grandstream_gxp280","grandstream_gxp1200","grandstream_gxp2000","grandstream_gxp2010","grandstream_gxp2020","grandstream_gxv3140"]},"mac":{"type":"string","description":"MAC adresa zařízení (pro vygenerování autokonfigurace)","example":"aa00bb11ff99"},"forward":{"$ref":"#/definitions/forward"},"faxToMail":{"type":"string","description":"E-mail for sending incoming fax messeges. (Redirect incoming call to virtual fax)"},"firewall":{"$ref":"#/definitions/firewallType"},"clir":{"type":"boolean","description":"nastavení Calling Line Identification Restriction","default":false},"voicemail":{"type":"string","description":"nastavení voicemailu (email)"}}},"naplněno, pokud je typ requestu VOIP":{"type":"object","properties":{"numberDetail":{"$ref":"#/definitions/provider"},"portDetail":{"$ref":"#/definitions/provider"},"provisioningAttributes":{"$ref":"#/definitions/Model48"}}},"Model49":{"type":"object","properties":{"id":{"type":"number","description":"ID typu"},"name":{"type":"string","description":"Název typu"}}},"pbx_roles":{"type":"array","description":"Požadované role v ústředně (agent, supervisor ...)","items":{"type":"string"}},"comm_roles":{"type":"array","description":"Požadované role v komunikátoru","items":{"type":"string"}},"Model50":{"type":"array","description":"Požadované role v přidělované službě","items":{"type":"string"}},"Pro requesty k uzivatelskym uctum":{"type":"object","properties":{"anvil_id":{"type":"string","description":"Anvil ID uživatele, ke kterému se request vztahuje. Pouze pro zpětnou kompatibilitu."},"keycloak_id":{"type":"string","description":"Keycloak ID uživatele, ke kterému se request vztahuje"},"email":{"type":"string","description":"E-mail uživatele (login)"},"type":{"$ref":"#/definitions/Model49"},"first_name":{"type":"string","description":"Jméno uživatele"},"last_name":{"type":"string","description":"Jméno uživatele"},"pbx_roles":{"$ref":"#/definitions/pbx_roles"},"comm_roles":{"$ref":"#/definitions/comm_roles"},"serviceId":{"type":"number","description":"ID přidělované/rušené služby"},"roles":{"$ref":"#/definitions/Model50"}}},"Model51":{"type":"object","properties":{"id":{"type":"number"},"customerId":{"type":"number","description":"id zákazníka"},"containerId":{"type":"number","description":"id ústředny"},"login":{"type":"string","description":"Login zadavatele"},"identifier":{"type":"string","description":"Identifikátor služby (např tel. číslo, email uživatele...)"},"note":{"type":"string","description":"Zadaná poznámka"},"inserted":{"type":"string","description":"Čas vložení požadavku (ISO)"},"lastChange":{"type":"string","description":"Čas poslední změny požadavku (ISO)"},"requestType":{"type":"string","description":"typ objednávky","enum":["activate_mobil","portin_mobil","portin_voip","change_mobil","change_datapack_mobil","change_sim_mobil","suspend_mobil","reactivate_mobil","cease_mobil","change_tariff_mobil","limit_mobil","unlimit_mobil","create_trunk","portout_mobil","change_trunk","order_new_numbers_voip","delete_trunk","portout_mobil_finish","portout_voip","activate_voip","update_voip","cease_voip","create_pbx","delete_pbx","create_user","update_user","delete_user","create_service","update_service","add_user_service","delete_user_service","create_number","update_number","cease_number","create_room","delete_room","update_room","remove_voip_oku","change_oku_mobil","delete_service"]},"status":{"type":"string","description":"stav objednávky","enum":["new","processing","canceled","finished","error"]},"type":{"type":"string","description":"typ objednávky mobilní/pevná","default":"mobile","enum":["mobile","voip"]},"requiredCeaseDate":{"type":"string","format":"date-time","description":"Požadované datum zrušení"},"numberDetail":{"$ref":"#/definitions/popis%20slu%C5%BEby%2C%20ke%20kter%C3%A9%20je%20dan%C3%BD%20request.%20napln%C4%9Bno%20u%20typu%20MOBILE"},"portDetail":{"$ref":"#/definitions/podrobnosti%20k%20portaci.%20napln%C4%9Bno%20u%20typu%20MOBILE"},"provisioningAttributes":{"$ref":"#/definitions/napln%C4%9Bno%2C%20pokud%20je%20typ%20requestu%20MOBILE."},"voip":{"$ref":"#/definitions/napln%C4%9Bno%2C%20pokud%20je%20typ%20requestu%20VOIP"},"user":{"$ref":"#/definitions/Pro%20requesty%20k%20uzivatelskym%20uctum"},"service":{"type":"string"}}},"Model52":{"type":"object","properties":{"id":{"type":"integer","description":"Address id in ruian database"},"text":{"type":"string","description":"Address in text format"},"kraj":{"type":"string","description":"Region name"},"okres":{"type":"string","description":"District name"},"obec":{"type":"string","description":"City / village name"},"castObce":{"type":"string","description":"District name"},"ulice":{"type":"string","description":"Street name"},"cisloOrientacniHodnota":{"type":"integer","description":"Orientation number"},"cisloOrientacniPismeno":{"type":"string","description":"Orientation number letter"},"cisloDomovni":{"type":"integer","description":"House number"},"cisloDomovniTyp":{"type":"string","description":"House number type (číslo evidenční / číslo popisné)","enum":["č.ev.","č.p."]},"psc":{"type":"string","description":"Postal code"},"obecACast":{"type":"string","description":"Generated text - city / village name and district name"},"uliceACislo":{"type":"string","description":"Generated text - street name with house number / orientation number and Orientation number letter"}},"required":["id","text"]},"Model53":{"type":"array","items":{"$ref":"#/definitions/Model52"}},"Model54":{"type":"object","properties":{"id":{"type":"integer","description":"ID of service type","example":8},"name":{"type":"string","description":"Name of service type","example":"landline","enum":["trunk","pbx","integration","internet","helpdesk","suppport","video","room","communicator","landline","mobile","fax","helpdeskWebchat","helpdeskFbMessenger"]}}},"service":{"type":"object","properties":{"id":{"type":"integer","description":"service ID","example":12331},"name":{"type":"string","description":"Name of service or phone number","example":"+420777666555"},"type":{"$ref":"#/definitions/Model54"},"subtype":{"type":"string","description":"Service subtype - only for some types (i.e. for integration)","example":"REQUESTOR"}}},"Model55":{"type":"object","properties":{"id":{"type":"integer","description":"customer ID","example":12331},"name":{"type":"string","description":"Name of customer","example":"Test s.r.o."}}},"retail":{"type":"object","properties":{"name":{"type":"string","description":"Tariff plan name","example":"Super Tariff"},"paymentType":{"type":"string","description":"Type of payment","example":"postpaid"}}},"priceLists":{"type":"object","properties":{"retail":{"$ref":"#/definitions/retail"}}},"phoneNumber":{"type":"object","properties":{"id":{"type":"integer","description":"ID of number","example":5432},"number":{"type":"string","description":"phone number","example":"+420777666555"},"isFax":{"type":"boolean","description":"Number is used for fax","example":true}}},"Model56":{"type":"object","properties":{"service":{"$ref":"#/definitions/service"},"customer":{"$ref":"#/definitions/Model55"},"priceLists":{"$ref":"#/definitions/priceLists"},"phoneNumber":{"$ref":"#/definitions/phoneNumber"},"status":{"type":"string","description":"Service status","example":"active"},"createdAt":{"type":"string"}}},"Model57":{"type":"array","items":{"$ref":"#/definitions/Model56"}},"Model58":{"type":"object","properties":{"id":{"type":"integer","description":"ID of service type","example":8},"name":{"type":"string"}}},"Model59":{"type":"object","properties":{"id":{"type":"integer","description":"service ID","example":12331},"name":{"type":"string","description":"Name of service "},"type":{"$ref":"#/definitions/Model58"}}},"Model60":{"type":"object","properties":{"id":{"type":"number"}}},"Model61":{"type":"object","properties":{"retail":{"$ref":"#/definitions/Model60"}}},"Model62":{"type":"object","properties":{"service":{"$ref":"#/definitions/Model59"},"customer":{"$ref":"#/definitions/Model55"},"priceLists":{"$ref":"#/definitions/Model61"},"status":{"type":"string","description":"Service status","example":"active"},"createdAt":{"type":"string"}}},"Model63":{"type":"array","items":{"$ref":"#/definitions/Model62"}},"Model64":{"type":"object","properties":{"id":{"type":"string","x-alternatives":[{"type":"string"},{"type":"integer"}]},"message":{"type":"string","description":"Result message","example":"updated","enum":["updated","created","deleted"]}},"required":["id","message"]},"hourPackages":{"type":"array","items":{"type":"string","description":"Hour package to add.","enum":["4hour"]}},"Model65":{"type":"object","properties":{"hourPackages":{"$ref":"#/definitions/hourPackages"},"type":{"type":"string","description":"Support type.","enum":["silver","gold","platinum"]}}},"Model66":{"type":"object","properties":{"status":{"type":"string","description":"Service status","enum":["new","active","deleted","stopped"]},"customer":{"$ref":"#/definitions/customer"},"settings":{"$ref":"#/definitions/Model65"}}},"availableUnitsName":{"type":"object","properties":{"slot1":{"type":"string","description":"název volných jednotek 1"},"slot2":{"type":"string","description":"název volných jednotek 2"},"slot3":{"type":"string","description":"název volných jednotek 3"},"slot4":{"type":"string","description":"název volných jednotek 4"}}},"costTariffPlan":{"type":"object","properties":{"name":{"type":"string","description":"název ceníku"},"id":{"type":"string","description":"id ceníku"},"versionId":{"type":"string","description":"verze ceníku"},"validFrom":{"type":"string","description":"platný od"},"validUntil":{"type":"string","description":"platný do"},"flags":{"type":"string","description":"příznaky"},"administrator":{"type":"string","description":"správce"},"availableUnitsName":{"$ref":"#/definitions/availableUnitsName"}}},"Model67":{"type":"object","properties":{"name":{"type":"string","description":"název ceníku"},"id":{"type":"number","description":"id ceníku"},"versionId":{"type":"number","description":"verze ceníku"},"validFrom":{"type":"string","format":"date","description":"platný od"},"validUntil":{"type":"string","format":"date","description":"platný do"},"flags":{"type":"string","description":"příznaky"},"administrator":{"type":"number","description":"správce"},"availableUnitsName":{"$ref":"#/definitions/availableUnitsName"},"costTariffPlan":{"$ref":"#/definitions/costTariffPlan"}}},"seznam ceníků":{"type":"array","items":{"$ref":"#/definitions/Model67"}},"Model68":{"type":"object","properties":{"userExist":{"type":"boolean","description":"Exist user","example":true}},"required":["userExist"]},"Model69":{"type":"object","description":"User type","properties":{"id":{"type":"integer","description":"User type id","example":1},"name":{"type":"string","description":"User type name","example":"STANDARD"},"price":{"type":"integer","description":"Price of licence","example":50}},"required":["id","name"]},"address":{"type":"object","description":"Customer address","properties":{"street":{"type":"string","description":"Street (ulice)","example":"Roháčova 1095/77"},"town":{"type":"string","description":"Town (město)","example":"Praha"},"postalcode":{"type":"integer","description":"Postalcode (psč)","example":13000,"enum":[0],"minimum":10000,"maximum":99999}}},"Model70":{"type":"object","description":"Customer informations","properties":{"id":{"type":"integer","description":"Customer id","example":1,"minimum":1},"externalId":{"type":"string","description":"Id from customer's system","example":"IPEX-11"},"companyName":{"type":"string","description":"IPEX a.s.","example":"IPEX a.s."},"companyRegistrationNumber":{"type":"integer","description":"Comapny registration number (ičo)","example":45021295,"enum":[0]},"address":{"$ref":"#/definitions/address"},"email":{"type":"string","description":"Email","example":"info@ipex.cz"},"login":{"type":"string","description":"Username","example":"vochomurka"}},"required":["id","companyName","companyRegistrationNumber","address"]},"Model71":{"type":"object","description":"Provider informations","properties":{"id":{"type":"integer","description":"Provider id","example":1,"minimum":1},"companyName":{"type":"string","description":"Company name","example":"IPEX a.s."},"email":{"type":"string","description":"Email","example":"info@ipex.cz","x-format":{"email":true}}},"required":["id","companyName","email"]},"operator":{"type":"object","description":"Operator informations","properties":{"id":{"type":"integer","description":"Operator id","example":1,"minimum":1}},"required":["id"]},"pbx":{"type":"array","description":"PBX roles","example":[["superadmin"]],"items":{"type":"string"}},"communicator":{"type":"array","description":"Communicator roles","example":[["admin"]],"items":{"type":"string"}},"Model72":{"type":"object","properties":{"pbx":{"$ref":"#/definitions/pbx"},"communicator":{"$ref":"#/definitions/communicator"}},"required":["pbx","communicator"]},"permissionGroup":{"type":"object","properties":{"id":{"type":"number","description":"Authorization group id"},"name":{"type":"string","description":"Authorization group name"}}},"properties":{"type":"object","description":"User properties"},"Model73":{"type":"object","description":"Service properties"},"Model74":{"type":"object","properties":{"id":{"type":"integer","description":"Service id","example":1},"type":{"type":"string","description":"Service type","example":"pbx"},"name":{"type":"string","description":"Service name","example":"video-test"},"version":{"type":"string","description":"Version of the service if set","example":"4.0.0"},"hostname":{"type":"string","description":"Service hostname. Used for service type pbx","example":"pbx.example.com"},"pbxModuleId":{"type":"integer","description":"Id of module in pbx evidence. Only for integrations type.","example":1},"properties":{"$ref":"#/definitions/Model73"},"activationDate":{"type":"string","format":"date","description":"Created date","example":"2018-07-07 07:07:07"}},"required":["id","type","name","activationDate"]},"Model75":{"type":"array","description":"User services","items":{"$ref":"#/definitions/Model74"}},"Model76":{"type":"object","properties":{"theme":{"type":"string"},"url":{"type":"string"}}},"Model77":{"type":"object","properties":{"id":{"type":"string","description":"User id from anvil","example":"xxx-ipex-xxx"},"firstName":{"type":"string","description":"First name","example":"John"},"lastName":{"type":"string","description":"Last name","example":"Doe"},"email":{"type":"string","description":"Email","example":"john.doe@example.com","x-format":{"email":true}},"type":{"$ref":"#/definitions/Model69"},"noInvoicing":{"type":"boolean","description":"True if it is demo user for testing purposes"},"level":{"type":"string","description":"level of user","example":"user","enum":["operator","provider","user"]},"customer":{"$ref":"#/definitions/Model70"},"provider":{"$ref":"#/definitions/Model71"},"operator":{"$ref":"#/definitions/operator"},"roles":{"$ref":"#/definitions/Model72"},"permissionGroup":{"$ref":"#/definitions/permissionGroup"},"updatedAt":{"type":"string","format":"date","description":"Date when record was updated","example":"2001-01-01 01:01:01"},"createdAt":{"type":"string","format":"date","description":"Date when record was created","example":"2001-01-01 01:01:01"},"properties":{"$ref":"#/definitions/properties"},"services":{"$ref":"#/definitions/Model75"},"branding":{"$ref":"#/definitions/Model76"}},"required":["id","firstName","lastName","email","type","customer","provider","operator","updatedAt","createdAt"]},"Model78":{"type":"object","properties":{"number":{"type":"string","description":"číslo služby"},"status":{"$ref":"#/definitions/Model42"},"paymentType":{"type":"string","description":"typ/režim platby","enum":["prepaid","postpaid"]},"numberType":{"type":"string","description":"typ čísla","enum":["voice","fax","mobile","connector","specialNumber"]},"tariffPlanId":{"type":"integer","description":"id ceníku"},"createDate":{"type":"string","format":"date-time"},"customerId":{"type":"integer","description":"id zákazníka"},"customerName":{"type":"string","description":"Jméno zákazníka"},"customerExternId":{"type":"string","description":"Externí id zákazníka"},"containerId":{"type":"number","description":"id ústředny"},"blockTypeId":{"type":"number","description":"Id typu bloku cisel"},"creditAmount":{"type":"number","description":"množství kreditu"},"monthlyCredit":{"type":"number","description":"kredit automaticky nastavovaný v měsíčních intervalech, pouze pro prepaid"},"creditExpirationDate":{"type":"string","format":"date-time","description":"datum expirace kreditu"},"monthlyLimitNotification":{"type":"integer","description":"měsíční limit pro notifikaci postpaid čísel, Pro zapnutí je nutno zadat částku nejméně 300 Kč"},"monthlyLimit":{"type":"integer","description":"měsíční limit postpaid čísla"},"containerHostname":{"type":"string","description":"adresa ústředny"},"antifraud":{"$ref":"#/definitions/Model44"},"currentAvailableUnits":{"$ref":"#/definitions/currentAvailableUnits"},"lastBillingChange":{"type":"string","format":"date-time"},"opId":{"type":"integer","description":"id operatora"},"operatorName":{"type":"string","description":"jméno operátora"},"connectorId":{"type":"integer","description":"id konektoru"},"connectorName":{"type":"string","description":"jméno konektoru"}}},"Model79":{"type":"object","properties":{"diagnostics":{"$ref":"#/definitions/diagnostics"},"opId":{"type":"integer","description":"id operatora"},"operatorName":{"type":"string","description":"jméno operátora"},"connectorName":{"type":"string","description":"jméno konektoru"},"connectorId":{"type":"integer","description":"id konektoru"},"password":{"type":"string"},"addressName":{"type":"string","description":"Address refinement for more accurate localization in emergency calls. Required for czech national phone numbers started with 2-5"},"addressCTUId":{"type":"integer","description":"RUIAN address id"},"codec":{"type":"string","description":"SIP kodek","enum":["ILBC","G711","G722"]},"autoconfigurationPhoneType":{"type":"string","description":"typ telefonu pro vygenerování autokonfigurace","enum":["none","aastra_6730i","aastra_6731i","aastra_6751i","aastra_6753i","aastra_6755i","aastra_6757i","linksys_spa92x","linksys_spa94x","linksys_spa962","grandstream_budgetone20x","grandstream_gxp280","grandstream_gxp1200","grandstream_gxp2000","grandstream_gxp2010","grandstream_gxp2020","grandstream_gxv3140"]},"mac":{"type":"string","description":"MAC adresa zařízení (pro vygenerování autokonfigurace)","example":"aa00bb11ff99"},"forward":{"$ref":"#/definitions/forward"},"faxToMail":{"type":"string","description":"E-mail for sending incoming fax messeges. (Redirect incoming call to virtual fax)"},"firewall":{"$ref":"#/definitions/firewallType"},"clir":{"type":"boolean","description":"nastavení Calling Line Identification Restriction","default":false},"voicemail":{"type":"string","description":"nastavení voicemailu (email)"},"address":{"type":"string","description":"adresa"}}},"Model80":{"type":"object","properties":{"numberDetail":{"$ref":"#/definitions/Model78"},"provisioningAttributes":{"$ref":"#/definitions/Model79"},"diagnostics":{"$ref":"#/definitions/diagnostics"}}},"ustredna":{"type":"object","properties":{"id":{"type":"number"},"nazev":{"type":"string"},"host":{"type":"string"},"vyrobce_id":{"type":"number"},"vyrobce":{"type":"string"},"typ":{"type":"string"},"api":{"type":"string"},"api_version":{"type":"string"},"vserver":{"type":"string"},"cisel_akt":{"type":"string"},"ts":{"type":"string"},"umisteni":{"type":"string"},"ssh_port":{"type":"string"},"https_port":{"type":"string"},"stav":{"type":"string"},"zpristupnena":{"type":"string"},"kreditInterval":{"type":"string"},"profileHW":{"type":"string"},"realVPS":{"type":"string"}}},"block":{"type":"object","properties":{"id":{"type":"number"},"nazev":{"type":"string"},"typ":{"type":"number"},"typ_nazev":{"type":"string"},"lokalita":{"type":"number"},"lokalita_nazev":{"type":"string"},"uvolneny":{"type":"string"},"cisel_celkem":{"type":"number"},"cisel_prirazeno":{"type":"number"},"prirazeny":{"type":"number"},"ts_nazev":{"type":"string"},"poznamka":{"type":"string"},"platny_od":{"type":"string","format":"date"},"platny_do":{"type":"string","format":"date"},"ustredna":{"$ref":"#/definitions/ustredna"}}},"adresa":{"type":"object","properties":{"id":{"type":"string"},"sidlo":{"type":"string"},"ulice":{"type":"string"},"mesto":{"type":"string"},"psc":{"type":"string"},"okres":{"type":"string"},"uirobce":{"type":"string"},"uiradresy":{"type":"string"}}},"forwardExt":{"type":"object","properties":{"typPermanent":{"type":"string"},"typUnreachable":{"type":"string"},"typBusy":{"type":"string"},"delaySeconds":{"type":"string"}}},"profilAktualni":{"type":"object","properties":{"odchozi":{"type":"string"}}},"phone":{"type":"object","properties":{"id":{"type":"string"},"stav":{"type":"string"},"cislo":{"type":"string"},"platba":{"type":"string"},"protokol":{"type":"string"},"tarif_prim":{"type":"string"},"tarif_sec":{"type":"string"},"tarif_data":{"type":"string"},"lte":{"type":"string"},"volne_jednotky1":{"type":"string"},"volne_jednotky2":{"type":"string"},"volne_jednotky3":{"type":"string"},"volne_jednotky4":{"type":"string"},"tarif_prichozi":{"type":"string"},"zrizeno":{"type":"string"},"zmeneno":{"type":"string"},"blok":{"type":"string"},"adresa":{"type":"string"},"ts":{"type":"string"},"email":{"type":"string"},"forward":{"type":"string"},"mes_kredit":{"type":"string"},"lokalita":{"type":"string"},"kraj_bloku_CTU":{"type":"string"},"kredit":{"type":"string"},"kredit_aktualni":{"type":"string"},"kredit_exp":{"type":"string"},"druh_cisla":{"type":"string"},"error":{"type":"string"},"forwardExt":{"$ref":"#/definitions/forwardExt"},"profilAktualni":{"$ref":"#/definitions/profilAktualni"},"profilStaly":{"$ref":"#/definitions/profilAktualni"},"clir":{"type":"string"}}},"zakaznik":{"type":"object","properties":{"id":{"type":"string"},"isp":{"type":"string"},"id_zak":{"type":"string"},"firma":{"type":"string"},"ico":{"type":"string"},"ulice":{"type":"string"},"mesto":{"type":"string"},"psc":{"type":"string"},"kontakt":{"type":"string"},"poznamka":{"type":"string"},"cisel_prepaid":{"type":"string"},"cisel_postpaid":{"type":"string"},"login":{"type":"string"},"passwd":{"type":"string"}}},"RNPDB":{"type":"object","properties":{"aktualniOpID":{"type":"integer","description":"Aktuální operator"},"aktualniOpNazev":{"type":"string","description":"Aktuální operator"},"vlastnikNazev":{"type":"string","description":"Vlastnik"},"umisteniOpID":{"type":"integer","description":"OPID umisteni (vychozi)"}}},"Model81":{"type":"object","properties":{"block":{"$ref":"#/definitions/block"},"adresa":{"$ref":"#/definitions/adresa"},"phone":{"$ref":"#/definitions/phone"},"zakaznik":{"$ref":"#/definitions/zakaznik"},"RNPDB":{"$ref":"#/definitions/RNPDB"},"volne_jednotky1_pausal":{"type":"string"},"volne_jednotky2_pausal":{"type":"string"},"volne_jednotky3_pausal":{"type":"string"},"volne_jednotky4_pausal":{"type":"string"}}},"Model82":{"type":"object","properties":{"id":{"type":"number","example":85435},"name":{"type":"string","example":"222 333 440 /10"},"pbxId":{"type":"number","example":2002825},"valid":{"type":"string","example":"2022-12-14T08:47:00.000Z"},"invalid":{"type":"string","example":"9999-12-31T22:59:59.000Z"},"pbxHostname":{"type":"string","example":"acme.voipex.io"},"ported":{"type":"number","example":1},"tsServiceId":{"type":"number","example":51615},"tsName":{"type":"string","example":"tomec-test-tick-9kAWFwba35"},"note":{"type":"string","example":"test virtualniho trunku"},"typeName":{"type":"string","example":"ISP"},"typeDescription":{"type":"string","example":"Bloky pro prideleni jednotlivym ISP."},"supplierCode":{"type":"string","example":"CTU"},"supplierName":{"type":"string","example":"Bloky přidělené od ČTÚ"},"location":{"type":"string","example":"Hlavní město Praha (2x)"}}},"blocks":{"type":"array","items":{"$ref":"#/definitions/Model82"}},"lastPipedriveInfo":{"type":"object","properties":{"name":{"type":"string","example":"Firma s.r.o."},"address":{"type":"string","example":"Ulice, město moře kuře"},"ico":{"type":"string","example":"12345678"}}},"Model83":{"type":"object","properties":{"phone":{"$ref":"#/definitions/Model81"},"blocks":{"$ref":"#/definitions/blocks"},"lastPipedriveInfo":{"$ref":"#/definitions/lastPipedriveInfo"}}},"Model84":{"type":"array","description":"Status","x-constraint":{"single":true},"items":{"type":"string","enum":["reserved","active","canceled","stopped","prepared","limited"]}},"Model85":{"type":"object","properties":{"iccid":{"type":"string","description":"ICCID"},"dataTariffPlan":{"type":"number","description":"datový balíček"},"lte":{"type":"boolean","description":"LTE","example":"true"},"flatTariffPlan":{"type":"number","description":"flat balíček"},"pin1":{"type":"string","description":"pin 1"},"pin2":{"type":"string","description":"pin 2"},"puk1":{"type":"string","description":"puk 1"},"puk2":{"type":"string","description":"puk 2"}}},"Model86":{"type":"object","properties":{"diagnostics":{"$ref":"#/definitions/diagnostics"},"opId":{"type":"integer","description":"id operatora"},"operatorName":{"type":"string","description":"jméno operátora"},"connectorName":{"type":"string","description":"jméno konektoru"},"connectorId":{"type":"integer","description":"id konektoru"},"addressName":{"type":"string","description":"Jméno uživatele služby. Povinné pro geografická čísla (2* - 5*). Slouží pro přesnou lokalizaci tísňových volání."},"addressCTUId":{"type":"integer","description":"id adresy CTU"},"codec":{"type":"string","description":"SIP kodek","enum":["ILBC","G711","G722"]},"autoconfigurationPhoneType":{"type":"string","description":"typ telefonu pro vygenerování autokonfigurace","enum":["none","aastra_6730i","aastra_6731i","aastra_6751i","aastra_6753i","aastra_6755i","aastra_6757i","linksys_spa92x","linksys_spa94x","linksys_spa962","grandstream_budgetone20x","grandstream_gxp280","grandstream_gxp1200","grandstream_gxp2000","grandstream_gxp2010","grandstream_gxp2020","grandstream_gxv3140"]},"mac":{"type":"string","description":"MAC adresa zařízení (pro vygenerování autokonfigurace)","example":"aa00bb11ff99"},"forward":{"$ref":"#/definitions/forward"},"faxToMail":{"type":"string","description":"E-mail pro zasílání příchozích faxů (přesměruje příchozí hovory na virtuální fax)"},"firewall":{"$ref":"#/definitions/firewallType"},"clir":{"type":"boolean","description":"nastavení Calling Line Identification Restriction","default":false},"voicemail":{"type":"string","description":"nastavení voicemailu (email)"},"address":{"type":"string","description":"adresa"},"password":{"type":"string"}}},"Model87":{"type":"object","properties":{"number":{"type":"string","description":"Phone number","example":"605250000"},"status":{"$ref":"#/definitions/Model84"},"paymentType":{"type":"string","description":"Payment type","example":"postpaid","enum":["prepaid","postpaid"]},"numberType":{"type":"string","description":"Phone number id","example":"voice","enum":["voice","fax","mobile","connector","specialNumber"]},"category":{"type":"string","example":"Normal","enum":["Normal","800","Mobil"]},"tariffPlanId":{"type":"integer","description":"Price list id","example":13,"minimum":1},"createDate":{"type":"string","format":"date-time"},"customerId":{"type":"integer","description":"Customer id","minimum":1},"customerName":{"type":"string","description":"Customer name"},"customerExternId":{"type":"string","description":"Externí id zákazníka"},"containerId":{"type":"integer","description":"Container id","example":12,"minimum":1},"mobile":{"$ref":"#/definitions/Model85"},"voip":{"$ref":"#/definitions/Model86"},"creditAmount":{"type":"number","description":"množství kreditu"},"monthlyCredit":{"type":"number","description":"kredit automaticky nastavovaný v měsíčních intervalech, pouze pro prepaid"},"creditExpirationDate":{"type":"string","format":"date-time","description":"datum expirace kreditu"},"monthlyLimitNotification":{"type":"integer","description":"měsíční limit pro notifikaci postpaid čísel, Pro zapnutí je nutno zadat částku nejméně 300 Kč"},"monthlyLimit":{"type":"integer","description":"měsíční limit postpaid čísla"},"containerHostname":{"type":"string","description":"adresa ústředny"},"antifraud":{"$ref":"#/definitions/antifraud"},"currentAvailableUnits":{"$ref":"#/definitions/currentAvailableUnits"},"lastBillingChange":{"type":"string","format":"date-time"}}},"phone numbers":{"type":"array","items":{"$ref":"#/definitions/Model87"}},"Model88":{"type":"object","properties":{"name":{"type":"string","description":"jméno profilu"}}},"roaming list":{"type":"array","items":{"$ref":"#/definitions/Model88"}},"Model89":{"type":"object","properties":{"number":{"type":"string","description":"číslo služby"},"status":{"$ref":"#/definitions/Model42"},"paymentType":{"type":"string","description":"typ/režim platby","enum":["prepaid","postpaid"]},"numberType":{"type":"string","description":"typ čísla","enum":["voice","fax","mobile","connector","specialNumber"]},"tariffPlanId":{"type":"integer","description":"id ceníku"},"createDate":{"type":"string","format":"date-time"},"customerId":{"type":"integer","description":"id zákazníka"},"customerName":{"type":"string","description":"Jméno zákazníka"},"customerExternId":{"type":"string","description":"Externí id zákazníka"},"containerId":{"type":"number","description":"id ústředny"},"blockTypeId":{"type":"number","description":"Id typu bloku cisel"},"mobile":{"$ref":"#/definitions/mobile"},"voip":{"$ref":"#/definitions/Model79"},"creditAmount":{"type":"number","description":"množství kreditu"},"monthlyCredit":{"type":"number","description":"kredit automaticky nastavovaný v měsíčních intervalech, pouze pro prepaid"},"creditExpirationDate":{"type":"string","format":"date-time","description":"datum expirace kreditu"},"monthlyLimitNotification":{"type":"integer","description":"měsíční limit pro notifikaci postpaid čísel, Pro zapnutí je nutno zadat částku nejméně 300 Kč"},"monthlyLimit":{"type":"integer","description":"měsíční limit postpaid čísla"},"containerHostname":{"type":"string","description":"adresa ústředny"},"antifraud":{"$ref":"#/definitions/Model44"},"currentAvailableUnits":{"$ref":"#/definitions/currentAvailableUnits"},"lastBillingChange":{"type":"string","format":"date-time"}}},"Phone numbers":{"type":"array","items":{"$ref":"#/definitions/Model89"}},"Model90":{"type":"object","properties":{"id":{"type":"number","description":"id datového balíčku"},"name":{"type":"string","description":"název datového balíčku"},"provider_price":{"type":"number","description":" cena, za kterou provider nakupuje balíček od operátora"},"customer_price":{"type":"number","description":"cena, za kterou zákazník nakupuje balíček od providera"},"customer_price_withoutVAT":{"type":"number","description":"cena, za kterou zákazník nakupuje balíček od providera, bez DPH"}}},"data pack list":{"type":"array","items":{"$ref":"#/definitions/Model90"}},"Model91":{"type":"object","properties":{"id":{"type":"number","description":"id balíčku"},"name":{"type":"string","description":"název balíčku"},"provider_price":{"type":"number","description":" cena, za kterou provider nakupuje balíček od operátora"},"customer_price":{"type":"number","description":"cena, za kterou zákazník nakupuje balíček od providera"},"customer_price_withoutVAT":{"type":"number","description":"cena, za kterou zákazník nakupuje balíček od providera, bez DPH"}}},"data flat list":{"type":"array","items":{"$ref":"#/definitions/Model91"}},"Model92":{"type":"object","properties":{"iccid":{"type":"string","description":"ICCID"},"imsi":{"type":"string","description":"IMSI"},"pin1":{"type":"string","description":"pin1"},"pin2":{"type":"string","description":"pin2"},"puk1":{"type":"string","description":"puk1"},"puk2":{"type":"string","description":"puk2"},"status":{"type":"string","description":"stav SIM","enum":["assigned","available","lost","quarantine"]}}},"simCards":{"type":"array","items":{"$ref":"#/definitions/Model92"}},"Model93":{"type":"object","properties":{"id":{"type":"string","description":"User id from anvil","example":"xxx-ipex-xxx"},"firstName":{"type":"string","description":"First name","example":"John"},"lastName":{"type":"string","description":"Last name","example":"Doe"},"email":{"type":"string","description":"Email","example":"john.doe@example.com","x-format":{"email":true}},"type":{"$ref":"#/definitions/Model69"},"noInvoicing":{"type":"boolean","description":"True if it is demo user for testing purposes"},"level":{"type":"string","description":"level of user","example":"user","enum":["operator","provider","user"]},"customer":{"$ref":"#/definitions/Model70"},"provider":{"$ref":"#/definitions/Model71"},"operator":{"$ref":"#/definitions/operator"},"roles":{"$ref":"#/definitions/Model72"},"permissionGroup":{"$ref":"#/definitions/permissionGroup"},"updatedAt":{"type":"string","format":"date","description":"Date when record was updated","example":"2001-01-01 01:01:01"},"createdAt":{"type":"string","format":"date","description":"Date when record was created","example":"2001-01-01 01:01:01"},"properties":{"$ref":"#/definitions/properties"},"services":{"$ref":"#/definitions/Model75"},"branding":{"$ref":"#/definitions/Model76"}},"required":["id","firstName","lastName","email","updatedAt","createdAt"]},"Model94":{"type":"array","items":{"$ref":"#/definitions/Model93"}},"Model95":{"type":"object","properties":{"id":{"type":"number","description":"Item id"},"name":{"type":"string"},"currency":{"type":"string"},"code":{"type":"string"},"category":{"type":"string"},"price":{"type":"number"},"priceListId":{"type":"number"}},"required":["id"]},"data portace":{"type":"array","items":{"type":"string","format":"date","description":"Seznam možných dnů portace"}},"Model96":{"type":"object","properties":{"requestId":{"type":"integer","description":"id žádosti"}}},"Model97":{"type":"object","properties":{"amount":{"type":"number","description":"hodnota kreditu"},"source":{"type":"string","description":"způsob provedení dobití"},"charger":{"type":"string","description":"kdo dobití provedl"},"rechargeDate":{"type":"string","format":"date","description":"datum dobití"}},"required":["amount","source","rechargeDate"]},"credit history":{"type":"array","items":{"$ref":"#/definitions/Model97"}},"Model98":{"type":"object","properties":{"category":{"type":"string","description":"textový popis kategorie"},"count":{"type":"integer","description":"celkový počet hovorů v dané kategorii"},"length":{"type":"number","description":"celková délka hovorů (reálná - nezarovnaná)"},"buyPrice":{"type":"number","description":"vaše nákupní cena v Kč bez DPH"},"sellPrice":{"type":"number","description":"vaše prodejní (koncová) cena v Kč bez DPH"}}},"number stats - pole s jednotlivými kategoriemi hovorů":{"type":"array","items":{"$ref":"#/definitions/Model98"}},"number stats - pole s jednotlivými kategoriemi hovorů + csv pro download":{"type":"object","properties":{"data":{"$ref":"#/definitions/number%20stats%20-%20pole%20s%20jednotliv%C3%BDmi%20kategoriemi%20hovor%C5%AF"},"extra":{"type":"string","description":"pouze pro statistiky ČTÚ. Textově csv vhodné pro import do formulářů ČTÚ."}}},"Model99":{"type":"object","properties":{"id":{"type":"integer","description":"Id of customer","example":34870},"customerName":{"type":"string","description":"Customer name","example":"Firma s.r.o."},"price":{"type":"number","description":"price","example":123.44}},"required":["id","customerName","price"]},"Model100":{"type":"array","items":{"$ref":"#/definitions/Model99"}},"Model101":{"type":"object","description":"Service properties which are allowed to all customer users to see."},"Model102":{"type":"object","properties":{"url":{"type":"string"},"method":{"type":"string","enum":["GET","POST","PUT"]}},"required":["url","method"]},"Model103":{"type":"object","properties":{"billPhoneNumber":{"type":"string","description":"Default phone number used for billing SMS. Only for basic type."},"shortName":{"type":"string","description":"Short name that is displayed as sender. Only for basic type. Need to be registered before use."},"deliverNotifyType":{"type":"string","description":"Method for sending delivery notifications.","enum":["webhook","email"]},"deliverNotifySettings":{"$ref":"#/definitions/Model102","x-alternatives":[{"$ref":"#/x-alt-definitions/deliverNotifySettings"},{"$ref":"#/x-alt-definitions/Model1"}]},"deliverNotifyAuth":{"type":"string","description":"Method to authenticate webhooks.","enum":["basic"]},"deliverNotifyAuthSettings":{"$ref":"#/definitions/apiCredentials","x-alternatives":[{"$ref":"#/x-alt-definitions/deliverNotifyAuthSettings"}]},"receiveNotifyType":{"type":"string","description":"Method for sending delivery notifications.","enum":["webhook","email"]},"receiveNotifySettings":{"$ref":"#/definitions/Model102","x-alternatives":[{"$ref":"#/x-alt-definitions/deliverNotifySettings"},{"$ref":"#/x-alt-definitions/Model1"}]},"receiveNotifyAuth":{"type":"string","description":"Method to authenticate webhooks.","enum":["basic"]},"receiveNotifyAuthSettings":{"$ref":"#/definitions/apiCredentials","x-alternatives":[{"$ref":"#/x-alt-definitions/deliverNotifyAuthSettings"}]}}},"Model104":{"type":"object","properties":{"status":{"type":"string","description":"Service status","enum":["new","active","deleted","stopped"]},"type":{"type":"string","enum":["basic","smsChat"]},"customerId":{"type":"number","description":"ID of target customer"},"settings":{"$ref":"#/definitions/Model103"}},"required":["customerId"]},"Model105":{"type":"object","properties":{"price":{"type":"number","description":"cena bez DPH pro koncového zákazníka"},"minimalLength":{"type":"integer","description":"počet sekund první tarifikační jednotky (např. 60 pro tarifikaci 60+1)"},"stepLength":{"type":"integer","description":"počet sekund následujících tarifikačních jednotek (např. 1 pro tarifikaci 60+1)"}}},"Model106":{"type":"object","properties":{"id":{"type":"integer"},"description":{"type":"string"},"provider_price":{"type":"number"},"customer_price":{"type":"number"},"channels":{"type":"integer"},"note":{"type":"string"},"minContractMonths":{"type":"integer"}},"required":["id","description","provider_price","customer_price","channels","note"]},"Model107":{"type":"array","items":{"$ref":"#/definitions/Model106"}},"Model108":{"type":"object","properties":{"state":{"type":"string","description":"textovy popis diagnostickeho stavu ustredny daneho cisla"}}},"Model109":{"type":"object","properties":{"count":{"type":"integer","description":"Count of services","example":10}},"required":["count"]},"Model110":{"type":"object","properties":{"cenaPausal":{"type":"number","description":"amount of the fee","example":12.42},"rok":{"type":"integer","description":"start year","example":2018,"minimum":2018},"mesic":{"type":"integer","description":"start month","example":1,"minimum":1,"maximum":12},"minutVCene":{"type":"integer","description":"minutes included","example":10},"prekrocenoMinut":{"type":"integer","description":"minutes over top","example":10},"productId":{"type":"string","description":"ID of product","example":"video_tym"},"roomName":{"type":"string","description":"name of room","example":"vide-zoom-AB123"},"totalMinut":{"type":"integer","description":"total duration of meeting","example":175,"minimum":0},"customer":{"type":"string","description":"customer name","example":"customer ABC"},"externalId":{"type":"string","description":"external ID","example":"ABC123"}},"required":["cenaPausal","rok","mesic","minutVCene","prekrocenoMinut","productId","roomName","totalMinut","customer","externalId"]},"Model111":{"type":"array","items":{"$ref":"#/definitions/Model110"}},"Model112":{"type":"object","properties":{"count":{"type":"integer","description":"connector ID"}},"required":["count"]},"types":{"type":"object","properties":{"chat":{"type":"integer","description":"rooms type chat","example":3},"video":{"type":"integer","description":"rooms type video","example":0},"h323":{"type":"integer","description":"rooms type h323","example":2},"personal":{"type":"integer","description":"rooms type personal","example":1}}},"Model113":{"type":"object","properties":{"count":{"type":"integer","description":"Count of services","example":14678},"types":{"$ref":"#/definitions/types"}},"required":["count"]},"Model114":{"type":"object","properties":{"cenaPausal":{"type":"number","description":"amount of the fee","example":12.42},"rok":{"type":"integer","description":"start year","example":2018,"minimum":2018},"mesic":{"type":"integer","description":"start month","example":1,"minimum":1,"maximum":12},"minutVCene":{"type":"integer","description":"minutes included","example":10},"prekrocenoMinut":{"type":"integer","description":"minutes over top","example":10},"productId":{"type":"string","description":"ID of product","example":"video_tym"},"roomName":{"type":"string","description":"name of room","example":"vide-zoom-AB123"},"totalMinut":{"type":"integer","description":"total duration of meeting","example":175,"minimum":0}},"required":["cenaPausal","rok","mesic","minutVCene","prekrocenoMinut","productId","roomName","totalMinut"]},"Model115":{"type":"array","items":{"$ref":"#/definitions/Model114"}},"Model116":{"type":"object","properties":{"sum":{"type":"number","description":"Sum of invoices","example":102.3,"minimum":0}},"required":["sum"]},"Model117":{"type":"object","properties":{"login":{"type":"string","description":"username","example":"info@example.com"},"password":{"type":"string","description":"password","example":"password"},"roles":{"$ref":"#/definitions/roles"},"twoFactorAuth":{"type":"string","description":"Require second auth factor","example":"email","enum":["email"]},"name":{"type":"string","description":"User first name","example":"John"},"surname":{"type":"string","description":"User last name","example":"Doe"},"email":{"type":"string","description":"User email","example":"john.doe@example.com","x-format":{"email":true}},"phone":{"type":"string","description":"User phone number","example":"+420605250000"}},"required":["login","password"]},"Model118":{"type":"object","properties":{"username":{"type":"string","description":"Created user username","example":"info@example.com"}},"required":["username"]},"Model119":{"type":"object","properties":{"name":{"type":"string","description":"Name for easier identification","example":"ipex.voip"},"customerId":{"type":"integer","description":"Id of customer who pays for the trunk","example":10500,"minimum":1}},"required":["name","customerId"]},"Model120":{"type":"object","properties":{"type":{"type":"string","description":"DEPRECATED","enum":["pbx","gateway","sipModule","virtualPbx"]},"vendor":{"type":"string","description":"DEPRECATED"},"identifier":{"type":"string","description":"DEPRECATED"},"firmware":{"type":"string","description":"DEPRECATED"}}},"Model121":{"type":"object","properties":{"number":{"type":"string","description":"During outage incoming calls will be forwarded on given phone number.","example":"+420222333444"},"backupTrunkId":{"type":"integer","description":"During outage incoming calls will be forwarded on given trunk.","example":1024,"minimum":1}}},"Model122":{"type":"object","properties":{"destinationAddress":{"type":"string","description":"Only for backward compatibility"},"destinationAddressId":{"type":"integer","description":"Address id from ruian database where trunk will be placed","example":19,"minimum":1},"login":{"type":"string","description":"Username to register the device. Username can only contain digits, letters, dot, dash and underscore.","example":"login","pattern":"^[a-zA-Z0-9_\\-.]+$"},"password":{"type":"string","description":"Password for device registration. Password can contain only digits, letters and minimal length is 8. \n Validation rules are apply only when is password changed","example":"aO0SqNz5rsGskjx"},"endUserTariffPlan":{"type":"integer","description":"Price list of customer paying for the trunk","example":2048},"type":{"type":"integer","description":"Trunk type","example":2,"minimum":0},"expectedMonthlyCharge":{"type":"integer","description":"Expected monthly spending for anti-fraud setting","example":1500,"maximum":200000},"ipAccessControlList":{"type":"string","description":"List of ip address allowed to connect to trunk. Ip address 0.0.0.0 is not allowed. Ip addresses are separated by comma.","example":"86.10.20.30,87.10.20.30","maxLength":255,"pattern":"^[0-9,.]+$"},"mod":{"type":"string","description":"Type of trunk registration","example":"static","enum":["registration","static"]},"sipUrl":{"type":"string","description":"Trunk hostname or ip address for static type.","example":"pbx.example.com"},"monitoring":{"type":"boolean","description":"Enable trunk monitoring"},"destinationDevice":{"$ref":"#/definitions/Model120"},"backup":{"$ref":"#/definitions/Model121"}},"required":["destinationAddressId","login","endUserTariffPlan","type","ipAccessControlList"]},"Model123":{"type":"object","properties":{"generalParameters":{"$ref":"#/definitions/Model119"},"technicalParameters":{"$ref":"#/definitions/Model122"}}},"Model124":{"type":"object","properties":{"street":{"type":"string","description":"ulice"},"city":{"type":"string","description":"město"},"zipCode":{"type":"string","description":"PSČ"},"note":{"type":"string","description":"poznámka"},"login":{"type":"string","description":"přihlašovací jméno zákazníka"},"password":{"type":"string","description":"přihlašovací heslo zákazníka. Heslo musí mít minimální délku 8 znaků Dále musí obsahovat znaky alespoň ze 3 různých kategorií (malé znaky, velké znaky, číslice, nealfanumerické znaky).","minLength":8},"contact":{"type":"string","description":"kontakt zákazníka"},"tin":{"type":"string","description":"IČO"},"externId":{"type":"string","description":"id z externího systému"},"ruianId":{"type":"number","description":"ruian id"},"pin":{"type":"string","description":"PIN pro zobrazení OKU kódů","minLength":4},"hidden":{"type":"boolean","description":"je uživatel skrytý"},"ictPriceListId":{"type":"number","description":"ID ceniku pro ostatni sluzby. Při neuvedení se nastavi prvni dostupny"},"type":{"type":"string","description":"type name","example":"start","enum":["old","start","profi","enterprise","aiContactCenter"]},"ipex":{"$ref":"#/definitions/ipex"},"invoicingState":{"type":"string","description":"internal use only","example":"invoiced","enum":["invoiced","trial","processing"]},"customerName":{"type":"string","description":"název firmy"}},"required":["customerName"]},"Model125":{"type":"object","properties":{"name":{"type":"string","description":"Unique service name"},"customerId":{"type":"number","description":"ID of target customer"},"url":{"type":"string","description":"URI of requestor instance","x-format":{"uri":true}},"apiCredentials":{"$ref":"#/definitions/apiCredentials"},"scimSettings":{"$ref":"#/definitions/scimSettings"}},"required":["name","customerId","url","scimSettings"]},"Model126":{"type":"object","properties":{"serviceId":{"type":"number","description":"Id of created service"},"requestId":{"type":"number","description":"Id of request"}},"required":["serviceId","requestId"]},"Model127":{"type":"object","properties":{"typeId":{"type":"number","description":"Internet type. From GET /internet/types"},"customerId":{"type":"number","description":"ID of target customer"},"ipv4Rental":{"type":"string","description":"IPV4 address to rent.","x-format":{"ip":{"cidr":"optional"}}}},"required":["typeId","customerId"]},"Model128":{"type":"object","properties":{"okuPortOut":{"type":"integer","description":"OKU code. Use only when you are handeling oku codes by yourself and not by IPEX TELCO a.s.","example":72250000000000},"communicationLanguage":{"type":"string","description":"servisní jazyk","enum":["czech","english"]},"welcomeRoamingSms":{"type":"boolean","description":"aktivace uvítacích roamingových SMS"},"mms":{"type":"boolean","description":"aktivace MMS"},"sms":{"type":"string","description":"aktivace SMS","enum":["incoming","outgoing","allowAll","blockAll"]},"incomingCall":{"type":"boolean","description":"povolení nebo zakázání příchozích hovorů"},"outgoingCall":{"type":"string","description":"povolení nebo zakázání odchozích hovorů, význam hodnot","enum":["blockAll","blockInternational","allowAll"]},"premiumService":{"type":"string","description":"povolení nebo zakázání prémiových služeb, význam hodnot","enum":["blockAll","blockCall","blockSms","allowAll"]},"roamingCall":{"type":"string","description":"aktivace roamingových hovorů, profily se získají pomocí metody roamingList"},"callForwarding":{"type":"boolean","description":"povolení přesměrovaní hovorů"},"callHold":{"type":"boolean","description":"povolení přidržení hovorů"},"clir":{"type":"string","description":"blokování identifikace volajícího (CLIR), význam hodnot","enum":["permanent","temporaryAllowed","temporaryRestricted"]},"missedCallAlert":{"type":"boolean","description":"aktivace registru zmeškaných hovorů (zasílání SMS o zmeškaných voláních)"},"outsideCallWarning":{"type":"boolean","description":"aktivace hlásky o volání mimo vlastní síť"},"voiceMail":{"type":"boolean","description":"povolení hlasové schránky"},"voiceMailLanguage":{"type":"string","description":"jazyk hlasové schránky","enum":["czech","english"]},"voiceMailSmsNotify":{"type":"boolean","description":"upozornění na nové hlasové zprávy"},"dataFupNotify":{"type":"boolean","description":"upozornění na dosažení FPU limitu"},"dataRoaming":{"type":"boolean","description":"aktivace dat pro roamingu"},"dataRoamingLimit":{"type":"number","description":"limit v Kč pro roamingová data, 0 je pro data bez omezení","enum":[0,1225,3900,15000]}}},"Model129":{"type":"object","properties":{"portationNumber":{"type":"number","description":"číslo portace (ČVOP) 14 místné číslo"},"numberDetail":{"$ref":"#/definitions/popis%20slu%C5%BEby%2C%20ke%20kter%C3%A9%20je%20dan%C3%BD%20request.%20napln%C4%9Bno%20u%20typu%20MOBILE"},"provisioningAttributes":{"$ref":"#/definitions/Model128"}},"required":["numberDetail"]},"Model130":{"type":"object","properties":{"requestId":{"type":"integer","description":"Request id"}}},"Model131":{"type":"object","properties":{"firstName":{"type":"string","description":"First name","example":"John"},"lastName":{"type":"string","description":"Last name","example":"Doe"},"username":{"type":"string","description":"Username","example":"john.doe@example.com","x-format":{"email":{"tlds":false,"allowUnicode":false}}},"typeId":{"type":"integer","description":"User type id","example":1,"minimum":1},"permissionGroupId":{"type":"number","description":"Permission group","example":21}},"required":["firstName","lastName","username","typeId"]},"users":{"type":"array","items":{"$ref":"#/definitions/Model131"}},"Model132":{"type":"object","properties":{"fromHour":{"type":"number","minimum":0,"maximum":23},"fromMinute":{"type":"number","minimum":0,"maximum":59},"toHour":{"type":"number","minimum":0,"maximum":23},"toMinute":{"type":"number","minimum":0,"maximum":59},"fromDay":{"type":"number","minimum":1,"maximum":7},"toDay":{"type":"number","minimum":1,"maximum":7}},"required":["fromHour","fromMinute","toHour","toMinute","fromDay","toDay"]},"slots":{"type":"array","items":{"$ref":"#/definitions/Model132"}},"timetable":{"type":"object","properties":{"holidays":{"type":"boolean"},"outOfWorkingHoursText":{"type":"string","maxLength":1024},"voicemail":{"type":"string","x-format":{"email":true}},"slots":{"$ref":"#/definitions/slots"}},"required":["holidays","outOfWorkingHoursText","slots"]},"Model133":{"type":"object","properties":{"name":{"type":"string","maxLength":64,"pattern":"^[a-z_-\\d]+$"},"callRecording":{"type":"boolean"},"recordingNotificationText":{"type":"string","maxLength":1024},"timeoutText":{"type":"string","maxLength":1024},"noLoggedAgentText":{"type":"string","maxLength":1024},"periodicAnnounceText":{"type":"string","maxLength":1024},"strategy":{"type":"string","enum":["ringall","leastrecent","fewestcalls","random","rrmemory","linear","wrandom","rrordered"]},"timeout":{"type":"number"},"maxTimeout":{"type":"number"}},"required":["name","callRecording","timeoutText","noLoggedAgentText","periodicAnnounceText","strategy","timeout","maxTimeout"]},"queues":{"type":"array","minItems":1,"maxItems":4,"items":{"$ref":"#/definitions/Model133"}},"Model134":{"type":"object","properties":{"welcomeText":{"type":"string","maxLength":1024},"timetable":{"$ref":"#/definitions/timetable"},"queues":{"$ref":"#/definitions/queues"}},"required":["welcomeText","queues"]},"Model135":{"type":"array","description":"Parametry pro IVR.","maxItems":4,"items":{"$ref":"#/definitions/Model134"}},"Model136":{"type":"object","properties":{"name":{"type":"string","description":"Unique service name - used for DNS name of service","example":"example","pattern":"^(?!-)[A-z0-9-]*(?callcentrum test Dobrý den,

\n

děkujeme Vám za zájem o službu Ústředna Callcentrum IPEX

\n

Co jsme pro Vás připravili:

\n \n

Pro přístup ke všem těmto funkcím si spusťte aplikaci komunikátor:

\n \n "},"text":{"type":"string","description":"Message to play caller","example":"You are calling IPEX a.s."},"userNotify":{"type":"boolean","description":"Send user notification email","example":true,"default":true},"trial":{"type":"boolean","description":"Start PBX in trial mode","example":false,"default":false},"scenario":{"type":"integer","description":"Volba rozcestniku","minimum":1},"numbers":{"$ref":"#/definitions/Model135"}},"required":["name","customerId","endUserTariffPlanId"]},"Model137":{"type":"object","properties":{"requestId":{"type":"integer","description":"Id of request for process tracking","example":100},"serviceId":{"type":"integer","description":"Id of PBX service","example":15,"minimum":1}},"required":["requestId","serviceId"]},"Model138":{"type":"object","properties":{"from":{"type":"string","description":"Sender phone number, used only for billing. Can start with international prefix. Optional only when number can be taken from auth token."},"to":{"type":"string","description":"Recipient phone number. Can start with international prefix."},"message":{"type":"string","description":"Text message. Only GSM-7 characters allowed. Non-gsm characters are internally translited."},"shortName":{"type":"string","description":"Short name that is displayed as sender. Optional, need to be registered before use."},"email":{"type":"string","description":"Email used for delivery notification.","maxLength":128,"x-format":{"email":true}}},"required":["to","message"]},"Model139":{"type":"object","properties":{"message":{"type":"string","description":"Returns that sms is \"sent\" successfully","enum":["sent"]}},"required":["message"]},"Model140":{"type":"object","properties":{"type":{"type":"string","description":"Support type.","enum":["silver","gold","platinum"]},"customerId":{"type":"number","description":"ID of target customer"},"hourPackages":{"$ref":"#/definitions/hourPackages"}},"required":["type","customerId"]},"Model141":{"type":"object","properties":{"username":{"type":"string","description":"Soap username","example":"ipex"},"password":{"type":"string","description":"password","example":"p@ssw0rd","minLength":3,"maxLength":30},"OTP":{"type":"string","description":"One time code","example":"123456"}},"required":["username","password"]},"Model142":{"type":"object","properties":{"accessToken":{"type":"string","description":"Soap token","example":"36761e5eaf80a487c141e867275e3a3d"},"tokenType":{"type":"string","description":"Token type","example":""},"expiresAt":{"type":"string","format":"date","description":"Date and time token expires","example":"2020-03-08T15:26:52.045Z"},"expiresIn":{"type":"integer","description":"Token lifetime","example":3600}},"required":["accessToken"]},"phoneNumberArray":{"type":"array","description":"Seznam čísel","items":{"type":"string","description":"číslo pevné linky","minLength":9}},"Model143":{"type":"object","properties":{"number":{"$ref":"#/definitions/phoneNumberArray","required":["number"],"x-alternatives":[{"$ref":"#/x-alt-definitions/phoneNumberArray"},{"type":"string","description":"číslo pevné linky","minLength":9}]},"paymentType":{"type":"string","description":"typ placení","enum":["prepaid","postpaid"]},"customerId":{"type":"integer","description":"id zákazníka"},"tariffPlanId":{"type":"integer","description":"id ceníku"},"requiredActivationDate":{"type":"string","format":"date-time","description":"požadované datum změny. Pokud není zadáno, zpracuje se okamžitě."},"credit":{"type":"number","description":"Přímé nastavení aktuální hodnoty kreditu v Kč, pouze pro prepaid"},"monthlyCredit":{"type":"number","description":"kredit automaticky nastavovaný v měsíčních intervalech, pouze pro prepaid"},"creditExpirationDate":{"type":"string","format":"date-time","description":"datum expirace kreditu"},"antifraud":{"$ref":"#/definitions/antifraud"}}},"Model144":{"type":"object","properties":{"password":{"type":"string","description":"heslo pro připojení koncového zařízení. Heslo musí mít minimální délku 8 znaků, ve kterých budou použita malá i velká písmena a také číslice.","minLength":8,"pattern":"(?=.*[A-Z])(?=.*[0-9])(?=.*[a-z]).{8,}"},"addressName":{"type":"string","description":"Jméno uživatele služby. Povinné pro geografická čísla (2* - 5*). Slouží pro přesnou lokalizaci tísňových volání."},"addressCTUId":{"type":"integer","description":"id adresy CTU"},"codec":{"type":"string","description":"SIP kodek","enum":["ILBC","G711","G722"]},"autoconfigurationPhoneType":{"type":"string","description":"typ telefonu pro vygenerování autokonfigurace","enum":["none","aastra_6730i","aastra_6731i","aastra_6751i","aastra_6753i","aastra_6755i","aastra_6757i","linksys_spa92x","linksys_spa94x","linksys_spa962","grandstream_budgetone20x","grandstream_gxp280","grandstream_gxp1200","grandstream_gxp2000","grandstream_gxp2010","grandstream_gxp2020","grandstream_gxv3140"]},"mac":{"type":"string","description":"MAC adresa zařízení (pro vygenerování autokonfigurace)","example":"aa00bb11ff99"},"forward":{"$ref":"#/definitions/forward"},"faxToMail":{"type":"string","description":"E-mail pro zasílání příchozích faxů (přesměruje příchozí hovory na virtuální fax)"},"firewall":{"$ref":"#/definitions/firewallType"},"clir":{"type":"boolean","description":"nastavení Calling Line Identification Restriction","default":false},"voicemail":{"type":"string","description":"nastavení voicemailu (email)"}}},"Model145":{"type":"object","properties":{"numberDetail":{"$ref":"#/definitions/Model143"},"provisioningAttributes":{"$ref":"#/definitions/Model144"}}},"Model146":{"type":"object","properties":{"priceListId":{"type":"number","description":"id of pricelist to clone"},"name":{"type":"string","description":"New name (unique)"},"targetProviderId":{"type":"number","description":"For internal use only"}},"required":["priceListId","name"]},"Model147":{"type":"object","properties":{"id":{"type":"number","description":"id of new pricelist"}},"required":["id"]},"Model148":{"type":"object","properties":{"type":{"type":"string","description":"Type of SMS integration. Basic is only for SMS sending, without sender number.Type \"smsChat\" needs some mobile numbers to be ported and allows sending and receiving SMS to this numbers.","enum":["basic","smsChat"]},"customerId":{"type":"number","description":"ID of target customer"},"settings":{"$ref":"#/definitions/Model103"}},"required":["customerId"]},"Model149":{"type":"object","properties":{"email":{"type":"string","description":"email","example":"ipex@ipex.cz","minLength":3,"maxLength":128,"x-format":{"email":true}},"password":{"type":"string","description":"password","example":"p@ssw0rd","minLength":3,"maxLength":30}},"required":["email","password"]},"Model150":{"type":"array","items":{"type":"string"}},"Model151":{"type":"object","properties":{"communicator":{"$ref":"#/definitions/Model150"},"pbx":{"$ref":"#/definitions/Model150"}}},"Model152":{"type":"object","properties":{"id":{"type":"integer","description":"Customer id","example":1},"name":{"type":"string","description":"Customer name","example":"IPEX a.s."}}},"Model153":{"type":"object","properties":{"id":{"type":"integer","description":"Provider id","example":14},"name":{"type":"string","description":"Provider name","example":"IPEX TELECO a.s."}}},"Model154":{"type":"object","properties":{"id":{"type":"integer","description":"Operator id","example":11},"name":{"type":"string","description":"Operator name","example":"IPEX OPERATOR a.s."}}},"Model155":{"type":"object","properties":{"theme":{"type":"string","description":"Name of the theme","example":"pink"},"logo":{"type":"string","description":"Link to logo in S3 storage.","example":"http://www.example.com/image.png","x-format":{"uri":true}}}},"Model156":{"type":"object","properties":{"accessToken":{"type":"string","description":"Token","example":"eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiJkN2FmNzljZmE1Njc4YmZiMDhjYyIsImlzcyI6Imh0dHBzOi8vYW52aWwtZGV2ZWwudm9pcGV4LmV1Iiwic3ViIjoiNDYyZDExZmItYTRiMi00MzgyLTg5ZjYtNWYzMmU5MTdmOTMzIiwiYXVkIjoiZTNkMWI1OWItNjQ2Yi00ZjhlLTk5ZGMtMjRmMzZmMjIxZDA0IiwiZXhwIjoxNTgzNjc4MTAyLCJpYXQiOjE1ODM2NzQ1MDIsInNjb3BlIjoib3BlbmlkIHByb2ZpbGUifQ.cgAB-YBsMyNRnnIBF_n9cikODV_unCdCLhz8nKTh-I-Qa4DrCcH6q7wwdOAMTcF-v6UbsKsTSNdMq7mFD4JYf4IVyrdv2u7ME3u3yan2wDzFx32rnR_Sd3IdBLUYgUu_jtY1hdswQZvo9npKk8MdE4V-MO-l4JoZjuQ_7y1CvUPEXhgWeGvqJJqXJl6jEqpDQD6_YygV09AT-RtVRTNNNItysWOLhsPYaQ8T25JJIWTouy2jywQn2ZbAI6sddrH-ybiFPQVcxJqCu09yhYCpq9oihy4xoVwTF8JwcjpwvAQXe7yH4NPWtgrQyPPQyVGbyGizPueFCm7hvJ4YYRXjkPrPxiRqws0rBmIxrWdEtOkGnCm4bfMs1Caniu6EIfpjx4th3Hs7CwLVmE0x1kJqlbHMLi6q383hPkNaH8SnjLcruNupVSSgmWWHJpGgfCOutL0hQFu_UC4yejs1QkM62tGDKtfLzWTL_SaRYqjeWvw2hZ-MYX1vkdpweT6KpVMy3QcAG0jQzDWCywjL3Qsld7BgrfBzyzfanMnmQB53rIjIvCWo8ekJvpXdkFTFY-ldLMbRxjpy3LIgY8Ppzy35MeyL73sDXvxLVu6EJqTwumEPxTq0dEVXp4uDuG-_VL5ipfdH7DDsDQ0GrcwI5UGtcipMT52wF-A1n0sBCDg8rhg"},"tokenType":{"type":"string","description":"Token type","example":"Bearer","enum":["Bearer"]},"refreshToken":{"type":"string","description":"Refresh token to get new token","example":"0bbbefa59c8eb3696a91"},"expiresIn":{"type":"integer","description":"Token lifetime","example":3600},"expiresAt":{"type":"string","format":"date","description":"Date and time token expires","example":"2020-01-01T00:00:00Z"},"id":{"type":"string","description":"User id","example":"xxx-xxx-xxx"},"username":{"type":"string","description":"Username","example":"john.doe@example.com"},"firstName":{"type":"string","description":"User first name","example":"John"},"lastName":{"type":"string","description":"User last name","example":"Doe"},"level":{"type":"string","description":"User level","example":"user","enum":["operator","provider","user"]},"roles":{"$ref":"#/definitions/Model151"},"customer":{"$ref":"#/definitions/Model152"},"provider":{"$ref":"#/definitions/Model153"},"operator":{"$ref":"#/definitions/Model154"},"branding":{"$ref":"#/definitions/Model155"}},"required":["accessToken","tokenType","expiresIn","id","firstName","lastName"]},"Model157":{"type":"object","properties":{"accessToken":{"type":"string","description":"Token","example":"eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiJkN2FmNzljZmE1Njc4YmZiMDhjYyIsImlzcyI6Imh0dHBzOi8vYW52aWwtZGV2ZWwudm9pcGV4LmV1Iiwic3ViIjoiNDYyZDExZmItYTRiMi00MzgyLTg5ZjYtNWYzMmU5MTdmOTMzIiwiYXVkIjoiZTNkMWI1OWItNjQ2Yi00ZjhlLTk5ZGMtMjRmMzZmMjIxZDA0IiwiZXhwIjoxNTgzNjc4MTAyLCJpYXQiOjE1ODM2NzQ1MDIsInNjb3BlIjoib3BlbmlkIHByb2ZpbGUifQ.cgAB-YBsMyNRnnIBF_n9cikODV_unCdCLhz8nKTh-I-Qa4DrCcH6q7wwdOAMTcF-v6UbsKsTSNdMq7mFD4JYf4IVyrdv2u7ME3u3yan2wDzFx32rnR_Sd3IdBLUYgUu_jtY1hdswQZvo9npKk8MdE4V-MO-l4JoZjuQ_7y1CvUPEXhgWeGvqJJqXJl6jEqpDQD6_YygV09AT-RtVRTNNNItysWOLhsPYaQ8T25JJIWTouy2jywQn2ZbAI6sddrH-ybiFPQVcxJqCu09yhYCpq9oihy4xoVwTF8JwcjpwvAQXe7yH4NPWtgrQyPPQyVGbyGizPueFCm7hvJ4YYRXjkPrPxiRqws0rBmIxrWdEtOkGnCm4bfMs1Caniu6EIfpjx4th3Hs7CwLVmE0x1kJqlbHMLi6q383hPkNaH8SnjLcruNupVSSgmWWHJpGgfCOutL0hQFu_UC4yejs1QkM62tGDKtfLzWTL_SaRYqjeWvw2hZ-MYX1vkdpweT6KpVMy3QcAG0jQzDWCywjL3Qsld7BgrfBzyzfanMnmQB53rIjIvCWo8ekJvpXdkFTFY-ldLMbRxjpy3LIgY8Ppzy35MeyL73sDXvxLVu6EJqTwumEPxTq0dEVXp4uDuG-_VL5ipfdH7DDsDQ0GrcwI5UGtcipMT52wF-A1n0sBCDg8rhg"},"tokenType":{"type":"string","description":"Token type","example":"Bearer"},"refreshToken":{"type":"string","description":"Refresh token to get new token","example":"0bbbefa59c8eb3696a91"},"expiresIn":{"type":"integer","description":"Token lifetime","example":3600},"expiresAt":{"type":"string","format":"date","description":"Date and time token expires","example":"2020-01-01T00:00:00Z"}}},"listNumbers":{"type":"array","items":{"type":"string","description":"Phone number to be ported"}},"rangeNumbers":{"type":"object","properties":{"first":{"type":"string","description":"First number in phone number block"},"last":{"type":"string","description":"Last number in phone number block"}}},"portInNumbers":{"type":"object","description":"List of phone numbers to be ported or block of phone numbers (divisible by ten)","example":{"listNumbers":["222333444"]},"properties":{"listNumbers":{"$ref":"#/definitions/listNumbers"},"rangeNumbers":{"$ref":"#/definitions/rangeNumbers"}}},"Model158":{"type":"object","description":"Calling profile and daily limit setup.","properties":{"profileCurrent":{"$ref":"#/definitions/Model43"},"profilePermanent":{"$ref":"#/definitions/Model43"},"internationalLimit":{"type":"integer","description":"Daily limmit for calls to foreign countries"}}},"originalOwner":{"type":"object","properties":{"name":{"type":"string","description":"Owner name [portin_voip]"},"street":{"type":"string","description":"Owner street [portin_voip]"},"houseNumber":{"type":"string","description":"Owner house number [portin_voip]"},"city":{"type":"string","description":"Owner town [portin_voip]"},"zipCode":{"type":"string","description":"Owner postal code [portin_voip]"},"tin":{"type":"string","description":"Owner company (registration) number [portin_voip]"},"referenceNumber":{"type":"string","description":"Reference number. Required when oku is not set.[portin_voip]"},"oku":{"type":"string","description":"OKU code. Required when reference number is not set. [portin_voip]","example":"70000000000007"},"authorizedPersonName":{"type":"string","description":"Name of authorized owner [portin_voip]"},"requiredPortationDate":{"type":"string","format":"date-time","description":"Expected date of portation. Non-binding. [portin_voip]"}},"required":["name","street","houseNumber","city","zipCode","authorizedPersonName"]},"provisioning":{"type":"object","properties":{"addressName":{"type":"string","description":"Address refinement for more accurate localization in emergency calls. Required for czech national phone numbers started with 2-5"},"addressCTUId":{"type":"integer","description":"RUIAN address id"},"faxToMail":{"type":"string","description":"E-mail for sending incoming fax messeges. (Redirect incoming call to virtual fax)"}}},"Model159":{"type":"object","properties":{"tariffPlanId":{"type":"integer","description":"Price list for phone numbers to be activated."},"customerId":{"type":"integer","description":"Id of customers whose phone number will be activated."},"contactPersonName":{"type":"string","description":"Contact person name","example":"Jan Novak"},"contactPersonPhone":{"type":"string","description":"Contact person phone number","example":"777888999"},"contactPersonEmail":{"type":"string","description":"Contact person email","example":"novak@firma.cz","x-format":{"email":true}},"contactPersonNote":{"type":"string","description":"Portation note","example":"note"},"antifraud":{"$ref":"#/definitions/Model158"},"originalOwner":{"$ref":"#/definitions/originalOwner"},"provisioning":{"$ref":"#/definitions/provisioning"}},"required":["tariffPlanId","customerId","contactPersonName","contactPersonPhone","contactPersonEmail"]},"Model160":{"type":"object","properties":{"numbers":{"$ref":"#/definitions/portInNumbers"},"generalParameters":{"$ref":"#/definitions/Model159"}}},"Model161":{"type":"object","properties":{"regionId":{"type":"integer"},"numbersCount":{"type":"integer"},"address":{"type":"string"},"note":{"type":"string"}},"required":["regionId","numbersCount","address"]},"Model162":{"type":"object","properties":{"type":{"type":"string","description":"Type of trunk deactivation. Actually only dismiss is allowed","example":"dismiss","enum":["dismiss"]}},"required":["type"]},"Model163":{"type":"object","description":"Technické nastavení aktivovaných čísel.","properties":{"password":{"type":"string","description":"heslo pro připojení koncového zařízení. Heslo musí mít minimální délku 8 znaků, ve kterých budou použita malá i velká písmena a také číslice.","minLength":8,"pattern":"(?=.*[A-Z])(?=.*[0-9])(?=.*[a-z]).{8,}"},"addressName":{"type":"string","description":"Address refinement for more accurate localization in emergency calls. Required for czech national phone numbers started with 2-5"},"addressCTUId":{"type":"integer","description":"RUIAN address id"},"codec":{"type":"string","description":"SIP kodek","enum":["ILBC","G711","G722"]},"autoconfigurationPhoneType":{"type":"string","description":"typ telefonu pro vygenerování autokonfigurace","enum":["none","aastra_6730i","aastra_6731i","aastra_6751i","aastra_6753i","aastra_6755i","aastra_6757i","linksys_spa92x","linksys_spa94x","linksys_spa962","grandstream_budgetone20x","grandstream_gxp280","grandstream_gxp1200","grandstream_gxp2000","grandstream_gxp2010","grandstream_gxp2020","grandstream_gxv3140"]},"mac":{"type":"string","description":"MAC adresa zařízení (pro vygenerování autokonfigurace)","example":"aa00bb11ff99"},"forward":{"$ref":"#/definitions/forward"},"faxToMail":{"type":"string","description":"E-mail for sending incoming fax messeges. (Redirect incoming call to virtual fax)"},"firewall":{"$ref":"#/definitions/firewallType"},"clir":{"type":"boolean","description":"nastavení Calling Line Identification Restriction","default":false},"voicemail":{"type":"string","description":"nastavení voicemailu (email)"}}},"Model164":{"type":"object","properties":{"tariffPlanId":{"type":"integer","description":"Price list for phone numbers to be activated."},"customerId":{"type":"integer","description":"Id of customers whose phone number will be activated."},"contactPersonName":{"type":"string","description":"Contact person name","example":"Jan Novak"},"contactPersonPhone":{"type":"string","description":"Contact person phone number","example":"777888999"},"contactPersonEmail":{"type":"string","description":"Contact person email","example":"novak@firma.cz","x-format":{"email":true}},"contactPersonNote":{"type":"string","description":"Portation note","example":"note"},"antifraud":{"$ref":"#/definitions/Model158"},"originalOwner":{"$ref":"#/definitions/originalOwner"},"paymentType":{"type":"string","description":"typ/režim platby","enum":["prepaid","postpaid"]},"credit":{"type":"number","description":"hodnota kreditu v Kč, pouze pro prepaid [activate_voip, portin_voip]"},"monthlyCredit":{"type":"number","description":"kredit automaticky nastavovaný v měsíčních intervalech, pouze pro prepaid [activate_voip, update_voip, portin_voip]"},"creditExpirationDate":{"type":"string","format":"date-time","description":"datum expirace kreditu [activate_voip, update_voip, portin_voip]"},"provisioning":{"$ref":"#/definitions/Model163"}},"required":["tariffPlanId","customerId","contactPersonName","contactPersonPhone","contactPersonEmail"]},"Model165":{"type":"object","properties":{"numbers":{"$ref":"#/definitions/portInNumbers"},"generalParameters":{"$ref":"#/definitions/Model164"}}},"Model166":{"type":"object","properties":{"createTicket":{"type":"boolean","description":"Should create ticket with report","default":false},"coeficient":{"type":"number","description":"Max allowed drop ratio (e.g. 0.8 for 20% allowed drop)","default":0.8}}},"Model167":{"type":"object","properties":{"message":{"type":"string","description":"Error string"},"ticketRef":{"type":"string","description":"Ticket id, if created"}}},"Model168":{"type":"object","properties":{"portationNumber":{"type":"number","description":"číslo portace (ČVOP) 14 místné číslo"},"numberDetail":{"$ref":"#/definitions/popis%20slu%C5%BEby%2C%20ke%20kter%C3%A9%20je%20dan%C3%BD%20request.%20napln%C4%9Bno%20u%20typu%20MOBILE"},"provisioningAttributes":{"$ref":"#/definitions/napln%C4%9Bno%2C%20pokud%20je%20typ%20requestu%20MOBILE."}},"required":["numberDetail"]},"Model169":{"type":"object","properties":{"password":{"type":"string","description":"User password","example":"password"},"roles":{"$ref":"#/definitions/roles"},"twoFactorAuth":{"type":"string","description":"Require second auth factor","example":"email","enum":["email"]},"name":{"type":"string","description":"User first name","example":"John"},"surname":{"type":"string","description":"User last name","example":"Doe"},"email":{"type":"string","description":"User email","example":"john.doe@example.com","x-format":{"email":true}},"phone":{"type":"string","description":"User phone number","example":"+420605250000"}}},"Model170":{"type":"object","properties":{"firstNumber":{"type":"string","description":"First number of block","example":"+420222333440","pattern":"^\\+[0-9]{7,100}"},"numbersCount":{"type":"number","description":"Count of numbers in block","example":10,"minimum":1},"type":{"type":"string","description":"Block type, ISP for normal numbers.","default":"ISP","enum":["ISP","800","Reserved","External","Mobil21","MobilVF","Nordic","O2Mobile","ReservedTrunk"]},"supplier":{"type":"string","description":"Number suplier - specially for foreign numbers evidence","default":"CTU"},"providerId":{"type":"number","description":"Needed only for ISP platforms","example":5421},"serviceId":{"type":"number","description":"Service to automatically route numbers, zero for ISP platform (when provider id specified)","example":5421},"ported":{"type":"boolean","description":"True for ported numbers (affects billing, and number returning)"},"tariffplanId":{"type":"number","description":"For special numbers - force tariff","example":4484},"note":{"type":"string","description":"Optional note"},"force":{"type":"boolean","description":"Create partial block on conflict"}}},"Model171":{"type":"object","properties":{"id":{"type":"number","description":"Id of created block","example":10357}}},"Model172":{"type":"object","properties":{"newIccid":{"type":"string","description":"nové iccid","pattern":"^[0-9]{19}$"}},"required":["newIccid"]},"Model173":{"type":"object","properties":{"requiredCeaseDate":{"type":"string","description":"požadované datum zrušení služby"},"deleteType":{"type":"string","description":"typ ukončení služby - cease = zrušení, portout = odchozí portace","default":"cease","enum":["cease","portout"]}},"required":["requiredCeaseDate"]},"Model174":{"type":"object","properties":{"customerId":{"type":"integer","description":"id zákazníka"},"amount":{"type":"number","description":"částka k dobití (muže být i záporná)"},"expiration":{"type":"integer","description":"počet dnů, kdy kredit automaticky vyprší"}},"required":["customerId","amount","expiration"]},"Model175":{"type":"object","properties":{"oku":{"type":"integer","description":"New oku code for phone number. Not used when codes are managed by IPEX.","example":80000000000007,"minimum":80000000000000,"maximum":89999999999999}}},"Model176":{"type":"object","properties":{"key":{"type":"string","description":"Key name to update","example":"cti_crm_call_class_list","enum":["cti_crm_call_class_list"]},"value":{"type":"string","description":"Key value","example":"{1: \"test\"}"}},"required":["key","value"]},"Model177":{"type":"array","items":{"$ref":"#/definitions/Model176"}},"Model178":{"type":"object","properties":{"allowed":{"type":"boolean","example":true}},"required":["allowed"]},"Model179":{"type":"object","properties":{"id":{"type":"number","description":"Id of updated service"},"message":{"type":"string","description":"Result message","example":"updated","enum":["updated","created","deleted"]}},"required":["id","message"]},"Model180":{"type":"object","properties":{"requiredCeaseDate":{"type":"string","format":"date-time","description":"požadované datum zrušení služby"}}},"Model181":{"type":"object","properties":{"outgoing":{"type":"integer","description":"Profile to block outgoing calls. Default profile id is 0 (Block only risk destinations)","example":1,"default":0,"minimum":0,"maximum":14}}},"profilePermanent":{"type":"object","properties":{"outgoing":{"type":"integer","description":"Profile to block outgoing calls. Default profile id is 0 (Block only risk destinations)","example":14,"default":0,"minimum":0,"maximum":14}}},"Model182":{"type":"object","properties":{"profileCurrent":{"$ref":"#/definitions/Model181"},"profilePermanent":{"$ref":"#/definitions/profilePermanent"},"internationalLimit":{"type":"integer","description":"Daily limmit for calls to foreign countries"}}},"Model183":{"type":"object","properties":{"customerId":{"type":"integer","description":"Customer id"},"tariffPlanId":{"type":"integer","description":"Optional tariff for special numbers"},"antifraud":{"$ref":"#/definitions/Model182"}}},"Model184":{"type":"object","properties":{"addressName":{"type":"string","description":"Address refinement for more accurate localization in emergency calls. Required for czech national phone numbers started with 2-5"},"addressCTUId":{"type":"integer","description":"CTU address id"}}},"Model185":{"type":"object","properties":{"numberDetail":{"$ref":"#/definitions/Model183"},"provisioningAttributes":{"$ref":"#/definitions/Model184"}}},"Model186":{"type":"object","properties":{"message":{"type":"string","description":"Response message","example":"deleted","enum":["deleted"]}}},"Model187":{"type":"object","properties":{"message":{"type":"string","description":"Status message","example":"deleted","enum":["deleted"]},"serviceId":{"type":"integer","example":1587,"minimum":1}},"required":["serviceId"]},"Model188":{"type":"object","properties":{"message":{"type":"string","description":"Status message","example":"deleted","enum":["deleted"]}}},"Model189":{"type":"object","properties":{"customerName":{"type":"string","description":"název firmy"},"street":{"type":"string","description":"ulice"},"city":{"type":"string","description":"město"},"zipCode":{"type":"string","description":"PSČ"},"note":{"type":"string","description":"poznámka"},"login":{"type":"string","description":"přihlašovací jméno zákazníka"},"password":{"type":"string","description":"přihlašovací heslo zákazníka. Heslo musí mít minimální délku 8 znaků Dále musí obsahovat znaky alespoň ze 3 různých kategorií (malé znaky, velké znaky, číslice, nealfanumerické znaky).","minLength":8},"contact":{"type":"string","description":"kontakt zákazníka"},"tin":{"type":"string","description":"IČO"},"externId":{"type":"string","description":"id z externího systému"},"ruianId":{"type":"number","description":"ruian id"},"pin":{"type":"string","description":"PIN pro zobrazení OKU kódů","minLength":4},"hidden":{"type":"boolean","description":"je uživatel skrytý"},"ictPriceListId":{"type":"number","description":"ID ceniku pro ostatni sluzby. Při neuvedení se nastavi prvni dostupny"},"type":{"type":"string","description":"type name","example":"start","enum":["old","start","profi","enterprise","aiContactCenter"]},"ipex":{"$ref":"#/definitions/ipex"},"invoicingState":{"type":"string","description":"internal use only","example":"invoiced","enum":["invoiced","trial","processing"]}}},"Model190":{"type":"object","properties":{"name":{"type":"string","description":"Unique service name"},"url":{"type":"string","description":"URI of requestor instance","x-format":{"uri":true}},"apiCredentials":{"$ref":"#/definitions/apiCredentials"},"scimSettings":{"$ref":"#/definitions/scimSettings"}},"required":["name","url","scimSettings"]},"Model191":{"type":"object","properties":{"requestId":{"type":"number","description":"Id of request"}},"required":["requestId"]},"Model192":{"type":"object","properties":{"name":{"type":"string","description":"New name (unique)"}},"required":["name"]},"Model193":{"type":"object","properties":{"typeId":{"type":"number","description":"Internet type. From GET /internet/types"},"ipv4Rental":{"type":"string","description":"IPV4 address to rent. Empty string to disable ipv4 rental.","x-format":{"ip":{"cidr":"optional"}}}},"required":["typeId"]},"Model194":{"type":"array","items":{"type":"string","description":"Phone number in international format.","example":"+42022233344"}},"Model195":{"type":"object","properties":{"numbers":{"$ref":"#/definitions/Model194"}},"required":["numbers"]},"Model196":{"type":"object","properties":{"endUserTariffPlanId":{"type":"integer","description":"Default tariff plan for calls billing.","example":12,"minimum":1},"trial":{"type":"boolean","description":"Start PBX in trial mode","example":false}}},"Model197":{"type":"object","properties":{"requestId":{"type":"integer","description":"Id of request for process tracking","example":100}},"required":["requestId"]},"Model198":{"type":"object","properties":{"type":{"type":"string","description":"Support type.","enum":["silver","gold","platinum"]},"hourPackages":{"$ref":"#/definitions/hourPackages"}},"required":["type"]},"Model199":{"type":"object","properties":{"price":{"type":"number","description":"New price"},"currency":{"type":"string","description":"Currency of price","default":"CZK","enum":["CZK","EUR"]}},"required":["price"]}},"x-alt-definitions":{"deliverNotifySettings":{"type":"object","properties":{"url":{"type":"string"},"method":{"type":"string","enum":["GET","POST","PUT"]}},"required":["url","method"]},"Model1":{"type":"object","properties":{"to":{"type":"string","x-format":{"email":true}}},"required":["to"]},"deliverNotifyAuthSettings":{"type":"object","properties":{"username":{"type":"string"},"password":{"type":"string"}},"required":["username","password"]},"phoneNumberArray":{"type":"array","description":"Seznam čísel","items":{"type":"string","description":"číslo pevné linky","minLength":9}}}}