Port Numbers to a Business SIP Trunk

This service is to be exposed by the Octane application. This service will be used by external systems such as the Service Provider and other Telcoinabox systems/sites to port numbers to an existing SIP Trunk service.

This Octane service will be exposed as a SOAP message via the UtbOrder WSDL.

Request

Header Params

Content-Type

string

required

Example:

text/xml; charset=utf-8

Body Params application/xml

Body

object

required

orderCreate

object

required

Example

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
    <ord:orderCreate xmlns:ord="http://order.frontend.ws.utilibill.com.au/">
      <login>
        <userName>username</userName>
        <password>password</password>
      </login>
      <createRequest>
        <custNo>554433</custNo>
        <orderType>SRVC_ORD</orderType>
        <orderAction>PORT_CY_BUS_SIP_TRUNK</orderAction>
        <usageType>CY</usageType>
        <custReqDate>2024-04-26</custReqDate>
        <providerOrderId>123456</providerOrderId>
        <serviceProviderReference>velit dolore</serviceProviderReference>
        <orderItems>
          <cyPortBusSipTrunkReqItem>
            <lineSeqNo>1</lineSeqNo>
            <planNo>123456</planNo>
            <trunkType>SIPTRUNK</trunkType>
            <portType>CAT_A</portType>
            <retailServiceProvider>Telstra</retailServiceProvider>
            <accountNumber>123456</accountNumber>
            <termsAndConditions>true</termsAndConditions>
            <customerAuth>true</customerAuth>
            <portingContact>abc@test.com</portingContact>
            <customerNameForPort>John Doe</customerNameForPort>
            <portingNumbers>
              <serviceNumberRangeStart>61395551234</serviceNumberRangeStart>
              <serviceNumberRangeEnd>61395551234</serviceNumberRangeEnd>
            </portingNumbers>
            <orderItemAddress>
              <property>Treasury Building</property>
              <subAddressType>U</subAddressType>
              <subAddressNo>123</subAddressNo>
              <streetNo>123</streetNo>
              <streetNoSuffix>A</streetNoSuffix>
              <streetNo2>125</streetNo2>
              <streetNo2Suffix>B</streetNo2Suffix>
              <streetName>ABC</streetName>
              <streetNameSuffix>E</streetNameSuffix>
              <streetType>ST</streetType>
              <locality>SYDNEY</locality>
              <postcode>2000</postcode>
              <state>NSW</state>
            </orderItemAddress>
          </cyPortBusSipTrunkReqItem>
        </orderItems>
      </createRequest>
    </ord:orderCreate>
  </soapenv:Body>
</soapenv:Envelope>

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://benzine.telcoinabox.com/tiab/UtbOrder' \
--header 'Content-Type: text/xml; charset=utf-8' \
--data-raw '<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
    <ord:orderCreate xmlns:ord="http://order.frontend.ws.utilibill.com.au/">
      <login>
        <userName>username</userName>
        <password>password</password>
      </login>
      <createRequest>
        <custNo>554433</custNo>
        <orderType>SRVC_ORD</orderType>
        <orderAction>PORT_CY_BUS_SIP_TRUNK</orderAction>
        <usageType>CY</usageType>
        <custReqDate>2024-04-26</custReqDate>
        <providerOrderId>123456</providerOrderId>
        <serviceProviderReference>velit dolore</serviceProviderReference>
        <orderItems>
          <cyPortBusSipTrunkReqItem>
            <lineSeqNo>1</lineSeqNo>
            <planNo>123456</planNo>
            <trunkType>SIPTRUNK</trunkType>
            <portType>CAT_A</portType>
            <retailServiceProvider>Telstra</retailServiceProvider>
            <accountNumber>123456</accountNumber>
            <termsAndConditions>true</termsAndConditions>
            <customerAuth>true</customerAuth>
            <portingContact>abc@test.com</portingContact>
            <customerNameForPort>John Doe</customerNameForPort>
            <portingNumbers>
              <serviceNumberRangeStart>61395551234</serviceNumberRangeStart>
              <serviceNumberRangeEnd>61395551234</serviceNumberRangeEnd>
            </portingNumbers>
            <orderItemAddress>
              <property>Treasury Building</property>
              <subAddressType>U</subAddressType>
              <subAddressNo>123</subAddressNo>
              <streetNo>123</streetNo>
              <streetNoSuffix>A</streetNoSuffix>
              <streetNo2>125</streetNo2>
              <streetNo2Suffix>B</streetNo2Suffix>
              <streetName>ABC</streetName>
              <streetNameSuffix>E</streetNameSuffix>
              <streetType>ST</streetType>
              <locality>SYDNEY</locality>
              <postcode>2000</postcode>
              <state>NSW</state>
            </orderItemAddress>
          </cyPortBusSipTrunkReqItem>
        </orderItems>
      </createRequest>
    </ord:orderCreate>
  </soapenv:Body>
</soapenv:Envelope>'

Responses

🟢200orderCreate response

application/xml

Body

object

required

orderCreateResponse

object

required

Examples

SuccessException

<?xml version="1.0" encoding="UTF-8"?>
<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/" xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
   <SOAP-ENV:Header />
   <S:Body>
      <ns2:orderCreateResponse xmlns:ns2="http://order.frontend.ws.utilibill.com.au/">
         <return>
            <errorCode>0</errorCode>
            <orderId>74705</orderId>
         </return>
      </ns2:orderCreateResponse>
   </S:Body>
</S:Envelope>