5.13 createVoipService

Owned by Martin Tomec (Unlicensed)
Last updated: pro 21, 2016
2 min read

Provede aktivaci čísla v platformě s režimem placení typu postpaid nebo prepaid a zadaným technickým nastavením. Jedná se o asynchronní operaci, návratovou hodnotu je id žádosti, podle kterého lze sledovat průběh zpracování metodou getRequestList.

VSTUP:

  • numberDetail – detail čísla
    • string number – telefonní číslo
    • string paymentType enum{prepaid, postpaid} – typ placení
    • string customerId – id zákazníka
    • int tariffPlanId – id ceníku
    • date requiredActivationDate (nepovinný) – požadované datum aktivace
    • double credit (nepovinný) – hodnota kreditu v Kč, pouze pro prepaid
    • double monthlyCredit (nepovinný) – kredit automaticky nastavovaný v měsíčních intervalech, pouze pro prepaid
    • date creditExpirationDate (nepovinný) - datum expirace kreditu
    • antifraud
      • profileCurrent
        • int outgoing - aktuální profil odchozích hovorů. (seznam profilů vrací funkce getProfileList)
      • profilePermanent
        • int outgoing - výchozí profil odchozích hovorů. Pouze informativní, nemá vliv na hovory.
      • internationalLimit - denní finanční limit pro hovory do zahraničí
  • provisioningAttributes – parametry pro technické nastavení
    • string password - heslo (povinné pro čísla v ISP platformě)
    • int addressCTUId – 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"
    • firewall (nepovinný) - omezení registrace čísla
      • array permitIp - seznam povolených sítí
        • ip - ip adresa
        • mask - maska sítě
    • bool clir (nepovinný) - true pro aktivaci CLIR (skrytí čísla)


VÝSTUP:

  • int requestId – id žádosti
  • int result - kód chyby
  • string resultText - textový popis chyby


CHYBY:

  • 0 – OK
  • <0 – Dočasná interní chyba
  • 1001 - chybné ID zákazníka
  • 1005 - chybné ID ceníku
  • 1010 - chybné číslo (např. již aktivované)
  • >0 – Jiná chyba vstupních parametrů. Popis chyby je v resultText.

PŘÍKLAD XML ŽÁDOSTI
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:prov="http://www.ipex/ProviderManagement.xsd1" xmlns:urn="urn:api-ipex:providermanagement">
   <soapenv:Header>
      <prov:verifyAccess>
         <accessToken>?</accessToken>
      </prov:verifyAccess>
   </soapenv:Header>
   <soapenv:Body>
      <urn:createVoipService>
         <numberDetail>
            <number>?</number>
            <paymentType>?</paymentType>
            <customerId>?</customerId>
            <tariffPlanId>?</tariffPlanId>
            <requiredActivationDate>?</requiredActivationDate>
            <credit>?</credit>
            <monthlyCredit>?</monthlyCredit>
            <creditExpirationDate>?</creditExpirationDate>
            <antifraud>
               <profileCurrent>
                  <outgoing>?</outgoing>
               </profileCurrent>
               <profilePermanent>
                  <outgoing>?</outgoing>
               </profilePermanent>
               <internationalLimit>?</internationalLimit>
            </antifraud>
         </numberDetail>
         <provisioningAttributes>
            <password>?</password>
            <addressCTUId>?</addressCTUId>
            <codec>?</codec>
            <autoconfigurationPhoneType>?</autoconfigurationPhoneType>
            <mac>?</mac>
            <forward>
               <numPermanent>?</numPermanent>
               <numUnreachable>?</numUnreachable>
               <numBusy>?</numBusy>
               <typePermanent>?</typePermanent>
               <typeUnreachable>?</typeUnreachable>
               <typeBusy>?</typeBusy>
               <delaySeconds>?</delaySeconds>
            </forward>
         </provisioningAttributes>
      </urn:createVoipService>
   </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:createVoipServiceResponse>
         <requestId>42</requestId>
         <result>0</result>
         <resultText></resultText>
      </ns1:createVoipServiceResponse>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>