Vypíše seznam čísel podle zadaného filtru. Původně funkce VoipexCislaList.
VSTUP:
- filter
- string number (nepovinný) – číslo
- string status (nepovinný) enum { 'reserved', 'active', 'canceled', 'stopped', 'prepared' } – stav čísla, význam hodnot
- string paymentType (nepovinný), enum { 'prepaid', 'postpaid'}
- int tariffPlanId (nepovinný) – id tarifu
- int customerId (nepovinný) – id zákazníka
- string numberType (nepovinný) enum { 'voice', 'fax', 'mobile' } – typ čísla
- int containerId – id ústředny
- string externId (nepovinný) - pouze pro zpětnou kompatibilitu
- string customerExternId (nepovinný) - id z externího systému
- sorter – nastavení stránkovače
- int page_from (nepovinný) - počet záznamů na stránce
- int page_size (nepovinný) - číslo stránky, kterou chcete načíst
- int detail – typ detailu (není implementován):
- 0=žádný detail
- 1=rozšírené info včetne zákazníka
- 2=včetně zákazníka a diagnostiky telefonního přístroje
- 3=rozšírené info o kredit, expiraci, hostname, heslo, kodek
VÝSTUP:
- numbers[] – pole čísel
- string number - číslo
- string status (nepovinný), enum { 'reserved', 'active', 'canceled', 'stopped', 'prepared' } – stav čísla, význam hodnot
- string paymentType (nepovinný) - režim placení
- string numberType (nepovinný), enum { 'voice', 'fax', 'mobile' } – typ čísla
- int tariffPlanId (nepovinný) – id ceníku
- date createDate (nepovinný) – datum aktivace
- int customerId (nepovinný) – id zákazníka
- string customerName (nepovinný) – jméno zákazníka
- mobile (nepovinný)
- string iccid (nepovinný) - ICCID
- string dataTariffPlan (nepovinný) – datový balíček
- voip (nepovinný)
- string password (nepovinný) - heslo
- int addressCTUId (nepovinný) – adresa umístění čísla (RUIAN kód)
- string codec (nepovinný) – kodek
- autoconfigurationPhoneType (nepovinný) - typ telefonu pro případnou autokonfiguraci
- mac (nepovinný) - MAC adresa telefonu pro případnou autokonfiguraci
- forward (nepovinný)
- typePermanent (nepovinný) - nastavení permanentního přesměrování (off, voicemail, phonenumber)
- typeUnreachable (nepovinný) - nastavení přesměrování při nevyzvednutí a nedostupnosti (off, voicemail, phonenumber)
- typeBusy (nepovinný) - nastavení přesměrování při obsazené lince (off, voicemail, phonenumber)
- delaySeconds (nepovinný) - max. doba vyzvánění
- numPermanent (nepovinný) - nastavení čísla při typu přesměrování "phonenumber"
- numUnreachable (nepovinný) - nastavení čísla při typu přesměrování "phonenumber"
- numBusy (nepovinný) - nastavení čísla při typu přesměrování "phonenumber"
- diagnostics
- string status (nepovinný), enum { 'ok', 'undefined', 'unknown' } – stav registrace
- string ping (nepovinný) – odezva v ms
- double creditAmount (nepovinný) - kredit
- date creditExpirationDate (nepovinný) – expirace kreditu
- string containerHostname (nepovinný) – hostname ústředny
- antifraud (nepovinný)– nastavení antifraudu
- profilCurrent (nepovinný)
- int outgoing (nepovinný) – blokování odchozích hovorů
- int incoming (nepovinný) – blokování příchozích hovorů
- profilPermanent (nepovinný) – stálý profil
- int outgoing (nepovinný) – blokování odchozích hovorů
- int incoming (nepovinný) – blokování příchozích hovorů
- int internationalLimit (nepovinný) – mezinárodní limit hovorného v Kč
- profilCurrent (nepovinný)
- currentAvailableUnits – aktuální dostupné jednotky
- float slot1 – pozice 1
- float slot2 – pozice 2
- float slot3 – pozice 3
- float slot4 – pozice 4
- lastBillingChange - datum poslední změny obchodního nastavení čísla (ceník, typ platby, stav)
- int itemsCount - počet záznamů
- int result - kód chyby
- string resultText - textový popis chyby
...
CHYBY:
- 0 – OK
- >0 – Chyba vstupních parametrů. Popis chyby je v resultText.
- <0 – Interní chyba
PŘÍKLAD XML ŽÁDOSTI
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prov="http://www.ipex/ProviderManagement.xsd1" xmlns:urn="urn:apiipex:providermanagement">
<soapenv:Header>
<prov:verifyAccess>
<accessToken></accessToken>
</prov:verifyAccess>
</soapenv:Header>
<soapenv:Body>
<urn:getNumberList>
<filter>
<!--Optional:-->
<number></number>
<!--Optional:-->
<status></status>
<!--Optional:-->
<paymentType></paymentType>
<!--Optional:-->
<tariffPlanId></tariffPlanId>
<!--Optional:-->
<customerId></customerId>
<!--Optional:-->
<numberType></numberType>
<!--Optional:-->
<containerId></containerId>
<!--Optional:-->
<externId></externId>
<!--Optional:-->
<iccid></iccid>
</filter>
<sorter>
<!--Optional:-->
<page_from></page_from>
<!--Optional:-->
<page_size></page_size>
</sorter>
<detail></detail>
</urn:getNumberList>
</soapenv:Body>
</soapenv:Envelope>
PŘÍKLAD XML ODPOVĚDI
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="urn:api-ipex:providermanagement">
<SOAP-ENV:Body>
<ns1:getNumberListResponse>
<numbers>
<item>
<number></number>
<status></status>
<paymentType></paymentType>
<numberType></numberType>
<tariffPlanId></tariffPlanId>
<createDate></createDate>
<customerId></customerId>
<customerName> </customerName>
<mobile>
<iccid/>
<dataTariffPlan></dataTariffPlan>
</mobile>
<currentAvailableUnits>
<slot1></slot1>
<slot2></slot2>
<slot3></slot3>
<slot4></slot4>
</currentAvailableUnits>
</item>
</numbers>
<itemsCount></itemsCount>
<result>0</result>
<resultText/>
</ns1:getNumberListResponse>
</SOAP-ENV:Body>
</SOAP-ENV:Envelope>