Create a New Business SIP Trunk

Prod Env

https://api-octane.telcoinabox.com.au/tiabwsv2

POST

/UtbOrder

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 create a new Business SIP Trunk ServiceType on a customer account in Octane. Note that this API can be used to create SIP trunks for the following products: Business SIP Trunk, Unite Calling, Unite Calling Thin, Advanced PBX. See the Integration Guides for more details on how to add each particular service.

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

Request

Header Params

Body Params application/xml

Examples

Responses

🟢200orderCreate response

application/xml

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api-octane.telcoinabox.com.au/tiabwsv2/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>48726330</custNo>
        <orderType>SRVC_ORD</orderType>
        <orderAction>ADD_CY_BUS_SIP_TRUNK</orderAction>
        <usageType>CY</usageType>
        <custReqDate>2024-04-25</custReqDate>
        <providerOrderId>123456</providerOrderId>
        <serviceProviderReference>ABC123</serviceProviderReference>
        <orderItems>
          <cyNewBusSipTrunkReqItem>
            <serviceType>SIPTRUNK</serviceType>
            <lineType>B</lineType>
            <lineName>Joes Mobile Phone</lineName>
            <department>Sales Team</department>
            <planNo>12345</planNo>
            <serviceTerm>12</serviceTerm>
            <ipndAddress>
              <streetNo>9787</streetNo>
              <streetName>Angel</streetName>
              <streetType>ST</streetType>
              <suburb>SYDNEY</suburb>
              <postcode>2000</postcode>
              <state>NSW</state>
            </ipndAddress>
            <externalReference>DEF789</externalReference>
            <timeZone>Australia/Adelaide</timeZone>
            <lineSelectionMethod>FAILOVER_LOWEST_AVAILABLE</lineSelectionMethod>
            <routingPrefixId>0 - 0NSN</routingPrefixId>
            <serviceLocation>3 NSW/ACT</serviceLocation>
            <maxCalls>22</maxCalls>
            <packageId>4</packageId>
            <trunkType>SIPTRUNK</trunkType>
            <wholesalePlanNo>123456</wholesalePlanNo>
            <binding>
              <authenticationMethod>USERNAME_PASSWORD</authenticationMethod>
              <routingActionNumber>1</routingActionNumber>
            </binding>
            <dids>
              <countryCode>AUSTRALIA</countryCode>
              <rangeType>AU_GEO_NUMBER</rangeType>
              <rangeSize>ONE</rangeSize>
              <zoneId>1</zoneId>
              <subZoneId>1</subZoneId>
            </dids>
            </cyNewBusSipTrunkReqItem>
        </orderItems>
      </createRequest>
    </ord:orderCreate>
  </soapenv:Body>
</soapenv:Envelope>'

Response Example

Success

<?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>

Modified at 2024-05-15 06:07:06

Remove Consumers from Data Pool

Bar/Unbar International Calls on a Business SIP Trunk