Octane REST API
  1. API Documentation (Legacy APIs)
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
        • Get Available Numbers
        • queryResiEndPointService
        • Query a Business SIP Trunk Service
        • Get Zone Detail
        • Get Number Detail
      • 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. API Documentation (Legacy APIs)

WSDL Summary

WSDL NameDescriptionTest EndpointProduction Endpoint
UtbCustomerWeb service allows you to add new customers into Octane, as well as retrieve and update information of existing customers.https://benzine.telcoinabox.com/tiab/UtbCustomer?wsdlhttps://api-octane.telcoinabox.com.au/tiabwsv2/UtbCustomer?wsdl
UtbContactWeb service allows you to add contact logs in Octane, as well as retrieve and update existing contact logs. The web service also allows you to manage your notification templates and create email notifications to Customers.https://benzine.telcoinabox.com/tiab/UtbContact?wsdlhttps://api-octane.telcoinabox.com.au/tiabwsv2/UtbContact?wsdl
UtbStatementWeb service allows you to retrieve statement and line item details for your customers.https://benzine.telcoinabox.com/tiab/UtbStatement?wsdlhttps://api-octane.telcoinabox.com.au/tiabwsv2/UtbStatement?wsdl
UtbChargeWeb service allows you to add one-off or recurring charges to a Customer account or Service, and view details of any added charges.https://benzine.telcoinabox.com/tiab/UtbCharge?wsdlhttps://api-octane.telcoinabox.com.au/tiabwsv2/UtbCharge?wsdl
UtbCallWeb service allows you to pull details for any unbilled calls of your services.https://benzine.telcoinabox.com/tiab/UtbCall?wsdlhttps://api-octane.telcoinabox.com.au/tiabwsv2/UtbCall?wsdl
UtbPooledResourceWeb service allows you to reserve, allocate, release and view pooled resources in Octane. Pooled resources currently include MSNs and SIMs for Mobile, and IP Addresses for NBN.https://benzine.telcoinabox.com/tiab/UtbPooledResource?wsdlhttps://api-octane.telcoinabox.com.au/tiabwsv2/UtbPooledResource?wsdl
UtbOrderWeb service allows you to place orders into Octane to provision new services/products, and make changes to existing ones. This API is used for ordering most Products other than PSTN, DSL and NBN.https://benzine.telcoinabox.com/tiab/UtbOrder?wsdlhttps://api-octane.telcoinabox.com.au/tiabwsv2/UtbOrder?wsdl
UtbMobileWeb service allows you to query the details of your active Mobile services.https://benzine.telcoinabox.com/tiab/UtbMobile?wsdlhttps://api-octane.telcoinabox.com.au/tiabwsv2/UtbMobile?wsdl
UtbConnectYouHostedVoiceWeb service allows you to query the details of your active ConnectYou PBX, SIP Trunk and Resi Endpoint services.https://benzine.telcoinabox.com/tiab/UtbConnectYouHostedVoice?wsdlhttps://api-octane.telcoinabox.com.au/tiabwsv2/UtbConnectYouHostedVoice?wsdl
Modified at 2024-05-03 02:01:14
Previous
Get Available Diagnostic Tests
Next
Add a Recurring Charge
Built with