Octane REST API
  1. ConnectYou
Octane REST API
  • Getting Started
    • API Access & Authentication
    • API Rate Limiting
  • Integration Guides
    • Payment Integration
    • CDR Integration
    • Test Environment Data Sets
    • Mobile Flows
      • Activate Postpaid Mobile (New MSN - Physical SIM)
      • Activate Postpaid (Port MSN - Physical SIM)
      • Activate Postpaid Mobile (New MSN - eSIM)
      • Activate Postpaid (Port MSN - eSIM)
      • Reset eSIM Profile
      • Mobile Data Pool Flow
    • ConnectYou Flows
      • ConnectYou Business SIP Trunk Activate Flow
      • ConnectYou Business SIP Trunk Reactivate Direct Indials Flow
      • ConnectYou Unite Calling Activate Flow
    • NBN Flows
      • NBN Activate Flow
      • NBN Plan Change Flow
      • NBN Termination Flow
      • NBN Reschedule Appointment Flow
      • NBN Withdraw Order Flow
      • Run NBN Diagnostic Test Flow
      • Run NBN Service Health Check Flow
  • API Documentation
    • Customer
      • Add Customer
      • Get Customer Detail
      • List Customers
      • Update Customer
      • Set Customer Direct Debit
      • Send Welcome Email
    • Payment Method
      • List Payment Methods
      • Add Payment Method
      • Update Payment Method
      • Delete Payment Method
    • Transaction
      • List Transactions
      • Make Payment
      • Add Misc Adjustment
      • List Bounced Transactions
    • Plan
    • Service
      • List Services for a Customer
      • Get Service Detail by LineSeqNo
    • Mobile
      • Notification
        • Get Notification Settings
        • Update Notification Settings
      • Get Data Pool
      • Update Data Limit
      • Transfer Services to Another Pool
      • Disconnect a Data Pool
      • Get eSIM Details
      • Manage eSIM
    • Address
      • Search for an Address
      • Search for an Address V2
    • Service Qualification
      • Perform Service Qualification Check
    • Order
      • v1
        • Create Order (NBN Activation)
        • Create Order (NBN Modification)
        • Create Order (NBN Disconnection)
        • Cancel (NBN Activation) Order
        • Get Order Detail (NBN)
        • List Orders (NBN)
    • Enquiry
      • Create Enquiry (NBN Diagnostic Test / Service Health Check)
      • Get Enquiry Detail
      • List Enquiries
    • Appointment
      • Query Appointment Timeslots
      • Book Appointment
    • NBN
      • Get Available Diagnostic Tests
    • Attachment
  • API Documentation (Legacy APIs)
    • WSDL Summary
    • API Guide
      • Account Charges
        • Add a Recurring Charge
        • Get Recurring Charge Details
        • Add a Manual Charge
      • ConnectYou
        • Create a Number Reservation
          POST
        • Get Available Numbers
          POST
        • queryResiEndPointService
          POST
        • Query a Business SIP Trunk Service
          POST
        • Get Zone Detail
          POST
        • Get Number Detail
          POST
      • Contact Log
        • Get Contact Log Types
        • Add a Contact Log
        • Update a Contact Log
        • Query Contact Logs
      • Device
        • getSupplierStockDetail
        • getSupplierProduct
        • getSupplierFreightOption
        • orderDevice
      • Mobile
        • Get Mobile Provisioning Product Catalogue
        • Query a Mobile Service
        • Query Mobile Add Ons
        • Query Mobile Feature Settings
        • Query Mobile Balance
      • Notifications
        • createNotification
        • notificationManageTemplate
      • Pooled Resource
        • Reserve a Resource
        • Unreserve a Resource
        • Select a Resource
        • Query Resource
      • Order
        • Mobile Order
          • Create a Mobile Service (New Number)
          • Create a Mobile Service (Port In Number)
          • Create a Pre-Activation Mobile Order (New Number)
          • Bar/Unbar/Disconnect a Mobile Service
          • Change Mobile Rate Plan
          • Change a Mobile Number
          • Replace a SIM Card
          • Modify Mobile Feature(s)
          • Modify Mobile Feature Setting(s)
          • Change Excess Spend Limit
          • Add a Once-off Bolt On
          • Add a Recurring Bolt On Pack
          • Remove a Recurring Bolt On Pack
        • Mobile (Data Pool) Order
          • Create a Data Pool
          • Add Consumers to Data Pool
          • Remove Consumers from Data Pool
        • ConnectYou (SIP Trunk) Order
          • Create a New Business SIP Trunk
          • Bar/Unbar International Calls on a Business SIP Trunk
          • Suspend Business SIP Trunk
          • Unsuspend Business SIP Trunk
          • Deactivate Business SIP Trunk
          • Port Numbers to a Business SIP Trunk
          • Configure Business SIP Trunk
        • Other Rated Order
          • Create an Other Rated Service
          • Change Access of an Other Rated Service
        • Create an Order
        • Cancel an Order
        • Query an Order
        • Reset an Order
      • Statements & Billing
        • Get a List of Customer Bills
        • Get Charge Item Detail for a Bill
        • Get a Single Bill PDF for a Customer
        • Get a Summary of a Bill
      • Unbilled Calls
        • Query Summary of Unbilled Calls & Charges
        • Query Detail of Unbilled Calls & Charges
      • OTP
        • Manage OTP (Get & Verify OTP)
    • Reference Data
  1. ConnectYou

Query a Business SIP Trunk Service

Testing
Testing Env
https://benzine.telcoinabox.com/tiab
Testing Env
https://benzine.telcoinabox.com/tiab
POST
https://benzine.telcoinabox.com/tiab
/UtbConnectYouHostedVoice
connectyou

UtbConnectYouHostedVoice:queryBusSipTrunkService#

The purpose of this Interface Contract (IC) is to capture the high-level interface requirements for the method to be exposed by Octane which will retrieve service detail from Connect for the ConnectYou Hosted Voice product.
This Octane service will be exposed as a SOAP message via the UtbConnectYouHostedVoice WSDL.

Request

Header Params
Content-Type
string 
required
Example:
text/xml; charset=utf-8
Body Params application/xml
Body
object 
required
queryBusSipTrunkService
object 
required
Example
<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
    <ser:queryBusSipTrunkService xmlns:ser="http://connectyou.hostedvoice.frontend.ws.utilibill.com.au/">
      <login>
        <userName>username</userName>
        <password>password</password>
      </login>
      <requestDetail>
        <requestDetail>
          <custno>55433</custno>
          <lineseqno>1</lineseqno>
        </requestDetail>
      </requestDetail>
    </ser:queryBusSipTrunkService>
  </soapenv:Body>
</soapenv:Envelope>

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://benzine.telcoinabox.com/tiab/UtbConnectYouHostedVoice' \
--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>
    <ser:queryBusSipTrunkService xmlns:ser="http://connectyou.hostedvoice.frontend.ws.utilibill.com.au/">
      <login>
        <userName>username</userName>
        <password>password</password>
      </login>
      <requestDetail>
        <requestDetail>
          <custno>55433</custno>
          <lineseqno>1</lineseqno>
        </requestDetail>
      </requestDetail>
    </ser:queryBusSipTrunkService>
  </soapenv:Body>
</soapenv:Envelope>'

Responses

🟢200queryBusSipTrunkService response
application/xml
Body
S:Body
object 
required
ns2:queryBusSipTrunkServiceResponse
object 
required
Example
<?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:queryBusSipTrunkServiceResponse xmlns:ns2="http://connectyou.hostedvoice.frontend.ws.utilibill.com.au/">
            <return>
                <errorCode>0</errorCode>
                <errorMessage>Web method processed successfully</errorMessage>
                <serviceDetail>
                    <createdAt>2024-04-26T13:02:26</createdAt>
                    <customerRefNumber>4</customerRefNumber>
                    <endCustomerDetails>51815 - TIABCY-382700</endCustomerDetails>
                    <externalReference></externalReference>
                    <id>123942</id>
                    <rangePrefix>Business Trunk (61872288534)</rangePrefix>
                    <rangeSize>ONE</rangeSize>
                    <rangeStart>Business Trunk (61872288534)</rangeStart>
                    <rangeEnd>Business Trunk (61872288534)</rangeEnd>
                    <rangeType>BUSINESS_TRUNK</rangeType>
                    <rangeStatus>ALLOCATED</rangeStatus>
                    <rangeOwnershipStatus>OWNED</rangeOwnershipStatus>
                    <rangeStatusTs>2024-04-26T13:33:15</rangeStatusTs>
                    <serviceCategory>VOIP</serviceCategory>
                    <serviceLinkId>0</serviceLinkId>
                    <serviceStatus>ENABLED</serviceStatus>
                    <updatedAt>2024-04-26T13:33:15</updatedAt>
                    <customerDetails>
                        <description>Reseller A</description>
                    </customerDetails>
                    <servicesLostWSList />
                    <providerDetails>
                        <provider>METASWITCH</provider>
                        <serviceSubCategory>BUSINESS_SIP_TRUNK</serviceSubCategory>
                    </providerDetails>
                    <zoneWS />
                    <subZonesWS />
                    <serviceData>
                        <recordType>3</recordType>
                        <accountTypeId>2</accountTypeId>
                        <metaswitchProductPackageId>4</metaswitchProductPackageId>
                        <billingAccountRefNumber>20450</billingAccountRefNumber>
                        <servicePlanId>1283</servicePlanId>
                        <subscriptionRefNumber>51815</subscriptionRefNumber>
                        <subscriptionDescription>TIABCY-382700</subscriptionDescription>
                        <metaBusinessGroupName>TIABCY-382700_51815</metaBusinessGroupName>
                        <endPointId>81482</endPointId>
                        <countryCode>AUSTRALIA</countryCode>
                        <goldNumberBool>false</goldNumberBool>
                        <id>0</id>
                        <ipndAddressId>15380</ipndAddressId>
                        <outboundProxy>siptrunk.connectyou.net.au</outboundProxy>
                        <businessTrunkProvisioningId>1</businessTrunkProvisioningId>
                        <businessTrunkResourceGroup>61872288534</businessTrunkResourceGroup>
                        <directoryNumber>61872288534</directoryNumber>
                    </serviceData>
                    <bindings>
                        <binding>
                            <name>PBX.556566.TIABCY-382700_51815.4083</name>
                            <authenticationMethod>USERNAME_PASSWORD</authenticationMethod>
                            <port>0</port>
                            <username>0872288534</username>
                            <transportPortocol>UDP</transportPortocol>
                            <routingActionNumber>1</routingActionNumber>
                            <bindingConfig>
                                <sipUserName>0872288534</sipUserName>
                                <sipPassword>RqMqIDHb7503</sipPassword>
                                <mediaGatewayModel>Default Hosted Business Trunk SIP Trunk Profile</mediaGatewayModel>
                                <pollPeerDevice>false</pollPeerDevice>
                            </bindingConfig>
                        </binding>
                    </bindings>
                    <dids>
                        <didDetail>
                            <createdAt>2020-01-20T17:20:05</createdAt>
                            <customerRefNumber>4</customerRefNumber>
                            <endCustomerDetails>51815 - TIABCY-382700</endCustomerDetails>
                            <externalReference>382700</externalReference>
                            <id>107826</id>
                            <rangeEnd>61872288697</rangeEnd>
                            <rangeOwnershipStatus>OWNED</rangeOwnershipStatus>
                            <rangePrefix>61872288697</rangePrefix>
                            <rangeSize>ONE</rangeSize>
                            <rangeStart>61872288697</rangeStart>
                            <rangeStatus>ALLOCATED</rangeStatus>
                            <rangeStatusTs>2024-04-26T13:02:26</rangeStatusTs>
                            <rangeType>AU_GEO_NUMBER</rangeType>
                            <serviceCategory>VOIP</serviceCategory>
                            <serviceLinkId>123942</serviceLinkId>
                            <serviceStatus>ENABLED</serviceStatus>
                            <updatedAt>2024-04-26T13:03:35</updatedAt>
                            <zoneWS>
                                <name>Adelaide</name>
                            </zoneWS>
                            <subZonesWS>
                                <name>Adelaide (Broad Geo Service)</name>
                            </subZonesWS>
                        </didDetail>
                        <groupDetail />
                        <customerDetails>
                            <description>Reseller A</description>
                        </customerDetails>
                        <providerDetails>
                            <provider>METASWITCH</provider>
                            <serviceSubCategory>DIDS_WHITE_LABEL</serviceSubCategory>
                        </providerDetails>
                        <zoneWS>
                            <id>1</id>
                            <name>Adelaide</name>
                            <countryId>AUSTRALIA</countryId>
                            <tag>NULL</tag>
                            <viewOrder>1</viewOrder>
                        </zoneWS>
                        <subZonesWS>
                            <id>1</id>
                            <name>Adelaide (Broad Geo Service)</name>
                            <zoneId>1</zoneId>
                            <tag>BGS</tag>
                            <timeZoneName>Australia/Adelaide</timeZoneName>
                        </subZonesWS>
                        <serviceData>
                            <recordType>6</recordType>
                            <accountTypeId>2</accountTypeId>
                            <metaswitchProductPackageId>0</metaswitchProductPackageId>
                            <billingAccountRefNumber>20450</billingAccountRefNumber>
                            <servicePlanId>1283</servicePlanId>
                            <subscriptionRefNumber>-</subscriptionRefNumber>
                            <subscriptionDescription>-</subscriptionDescription>
                            <metaBusinessGroupName>-</metaBusinessGroupName>
                            <endPointId>0</endPointId>
                            <countryCode>AUSTRALIA</countryCode>
                            <goldNumberBool>true</goldNumberBool>
                            <id>null</id>
                            <ipndAddressId>null</ipndAddressId>
                        </serviceData>
                    </dids>
                    <switchDetail>
                        <lineSelectionMethod>LOWEST_AVAILABLE</lineSelectionMethod>
                        <callingPartyNumber></callingPartyNumber>
                        <callingNumberConnectedLineIDScreening>OWNED_DN</callingNumberConnectedLineIDScreening>
                        <totalCallsLimit>LIMITED</totalCallsLimit>
                        <maximumCalls>22</maximumCalls>
                        <timeZone>Australia/Adelaide</timeZone>
                        <pbxPlaysRingback>false</pbxPlaysRingback>
                        <pbxPlaysDialtone>false</pbxPlaysDialtone>
                        <createTwinnedBGNumberBlock>false</createTwinnedBGNumberBlock>
                        <lineClassCode17>0 - 0NSN</lineClassCode17>
                        <lineClassCode19>2 NSW ACT</lineClassCode19>
                        <lineClassCode20>0 - Bar high-risk countries</lineClassCode20>
                    </switchDetail>
                </serviceDetail>
                <success>true</success>
            </return>
        </ns2:queryBusSipTrunkServiceResponse>
    </S:Body>
</S:Envelope>
Modified at 2024-04-26 04:46:06
Previous
queryResiEndPointService
Next
Get Zone Detail
Built with