4.1 getCallHistory

Výpis uskutečněných hovorů podle zadaného filtru. Puvodne funkce VypisHovoruString, VoipexVypisHovoru, VoipexExportHovoru.

VSTUP:

• filtr
  • string number (nepovinný) – hledané číslo
  • int customerId(nepovinný) – id zákazníka
  • string externId (nepovinný) - id z externího systému
  • boolean showVAT (nepovinný) – přidá sloupeček s DPH
  • boolean showUnit (nepovinný) - přidá sloupeček s jednotkami, MB pro data, ks pro SMS
  • boolean showUID (nepovinný) – přidá sloupeček s unikátním ID hovoru (nefunguje u kumulovaných výpisů)
  • boolean showFlags (nepovinný) - přidá sloupeček s flagy
  • boolean showCustomerId (nepovinný) - přidá sloupeček s interním id zákazníka
  • boolean showFreeUnits (nepovinný) - přidá sloupečky s počtem volných jednotek spotřebovaných daným hovorem
• dateTime dateFrom – vypsat od
• dateTime dateTo – vypsat do
• int typHistory – typ výpisu:
  • 1 – odchozí hovory
  • 2 – odchozí zdarma
  • 3 – odchozí zdarma na peering partnery
  • 4 – odchozí placené mobil a pevná
  • 5 – řrí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)
• boolean headers - zobrazení hlavičky v CSV

VÝSTUP:

• string history – výpis ve formátu CSV
• int result - kód chyby
• string resultText - textový popis chyby

CHYBY:

• 0 - OK
• < 0 – Interní chyba. Popis chyby je v resultText.
• > 0 – Chyba vstupních parametrů. Popis chyby je v resultText.
• 1037 – nezadaný časový interval, nebo interval starší než 1 rok zpětně
• 1038 – filtrování dle ID zákazníka zároveň se zobrazením ID zákazníka není podporováno

FORMÁT CSV:

cislo_zakaznika;cislo_volaneho;zona;datum

+cas;odchozi;uskutecneny;stav;flags;delka;cena;pocet

VÝZNAM SLOUPCŮ V HLAVIČCE CSV:

• cislo zakaznika: je 9-místné (nebo 00421+číslo pro slovenská čísla), muže být při přesměrování ve formátu: "<číslo> (<původní>)", kde <původní> je původní číslo volajícího.
• cislo volaneho: je pro čísla v rámci ČR 9-místné, jinak s prefixem
• zona: je textový popis zóny volaného čísla
• datum+cas začátku hovoru
• odchozi: Y pokud jde o odchozí hovor, jinak N
• uskutecneny: Y pokud byl hovor uskutečněn (tzn. nenulová délka)
• stav: textový popis stavu (Prijato/Zmeškáno/Nepřijato/Bez odpovědi/Obsazeno/Zodpovezeno/SMS placena nedorucená/Čekám na potvrzení spojení/ SMS příchozí zdarma)
• flags: pro vnitřní potřebu
• delka:délka nebo hodnota platná pro daný CDR záznam (délka hovoru, počet MB pro data...), jednotky udává následující sloupec jednotka
• jednotka: jednotky pro hodnoty ze sloupce délka
• cena: cena v haléřích
• sazba_dph: sazba DPH v %
• pocet: pro kompatibilitu - zde vždy 1
• cdr_flags: typ záznamu CDR. Informuje do jaké zóny ceníku byl poplatek ve výpisu zařazen
• uid: unikátní identifikátor hovoru

Typy 15-17 zobrazují

CSV: zakaznik;volajici;zona;casove_pasmo;pocet_hovoru;delka;cena;poznamka

• zakaznik - název zákazníka
• volajici - tel. číslo zákazníka
• zona - popis cílové destinace
• casove_pasmo – identifikace časového pásma dle ceníku
• pocet_hovoru - počet hovorů
• delka – zatím má smysl pouze u hovoru. U SMS, Paušálů apod. bude upravena
• cena – v Kč. Počet desetinných míst se bude rozšiřovat
• poznamka – napríklad rozsah období, pokud číslo mělo v daném období více ceníků

FLAGY (CDR_FLAGS):

• C - hovor
• S - SMS
• M - MMS
• D - data
• F - poplatek
• O - ostatní
• P - premium
• R - roaming

Flagy se mužou i kombinovat, takže PRS je hovor na prémiovou linku z roamingu.

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:getCallHistory>
      <filtr>
        <!--Optional:-->
        <number></number>
        <!--Optional:-->
        <customerId></customerId>
        <!--Optional:-->
        <externId></externId>
        <!--Optional:-->
        <showVAT>false</showVAT>
        <!--Optional:-->
        <showUID>false</showUID>
        <!--Optional:-->
        <showFlags>false</showFlags>
        <!--Optional:-->
        <showUnit>false</showUnit>
      </filtr>
      <dateFrom></dateFrom>
      <dateTo></dateTo>
      <typHistory></typHistory>
      <headers></headers>
    </urn:getCallHistory>
  </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:getCallHistoryResponse>
      <history></history>
      <result>0</result>
      <resultText/>
    </ns1:getCallHistoryResponse>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>