Octane REST API
  1. Mobile
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
        GET
      • Update Data Limit
        POST
      • Transfer Services to Another Pool
        POST
      • Disconnect a Data Pool
        POST
      • Get eSIM Details
        POST
      • Manage eSIM
        POST
    • 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. Mobile

Get eSIM Details

Testing Env
https://benzine.telcoinabox.com/tiab/api
Testing Env
https://benzine.telcoinabox.com/tiab/api
POST
https://benzine.telcoinabox.com/tiab/api
/v1/mobile/resource/getEsimDetails
mobile-esim
Get the details of a SIM resource (Either Physical or eSIM) or retrieve the QR code to download eSIM profile

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Body Params application/json
requestType
enum<string> 
required
Specify the type of data you want the request to return
Allowed values:
QR CodeSIM Details
custno
integer 
optional
Customer Account Number. Either MSN or custno/lineseqno combination is mandatory.
lineseqno
integer 
optional
Service Line Sequence number Either MSN or custno/lineseqno combination is mandatory.
msn
string 
optional
Mobile Service Number Either MSN or custno/lineseqno combination is mandatory.
esimIdentifier
string 
optional
Supply either:
  • SIM Number, or
  • ICCID Number, or
  • PUK Code
orderId
string 
optional
Octane order id provided during service activation/ replace sim request response.
Example
{
    "requestType": "QR Code",
    "custno": 554433,
    "lineseqno": 1,
    "msn": "0400123456",
    "esimIdentifier": "89610147000005027696",
    "orderId": "123456"
}

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/api/v1/mobile/resource/getEsimDetails' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "requestType": "QR Code",
    "custno": 554433,
    "lineseqno": 1,
    "msn": "0400123456",
    "esimIdentifier": "89610147000005027696",
    "orderId": "123456"
}'

Responses

🟢200Success
application/json
Body
errorCode
integer 
required
Will return specific error code if failed to reset eSIM Profile.
errorMessage
string 
required
Detailed error message in case of a failure.
success
boolean 
required
Flag to show success or failure in reset operation.
qrcodeDetails
object 
optional
Returned when response is successful and request type ='QR Code'
iconData
string 
required
Binary Data to generate QR Code icon
iconType
string 
required
Type of image presented on generation E.g. PNG
simDetails
object 
optional
Returned when response is successful and request type ='SIM Details'
activationCode
string 
required
eSIM resource activation code. This code can be used in browser to download eSIM profile.
custNo
integer 
required
eSIM/SIM service associated customer account number
expiry
string  | null 
required
eSIM/SIM Resource details expiry date
extra1
string 
required
eSIM/SIM Resource Identifier - ICCID
extra2
string 
required
eSIM/SIM Resource Identifier - PUC
extra3
string 
required
eSIM/SIM Resource Identifier - IMSI
extra4
string 
required
eSIM Resource Type (System internal flag to identify eSIM type). This attribute is not applicable for Physical SIM.
internalStatus
enum<string> 
required
eSIM/SIM Resource status in Octane system.
Allowed values:
QUEUEDAVAILABLERESERVEDSELECTEDIN_USEQUARANTINEDEXPIREDPORT_IN
lineSeqNo
integer 
required
eSIM/SIM service associated customer account lineseqno
profileState
enum<string> 
required
Provider eSIM profile status.
Allowed values:
AVAILABLEINSTALLEDRELEASEDDOWNLOADEDUNAVAILABLELINKEDERROR
providerStatus
enum<string> 
required
The status from the provider system
Allowed values:
active (a)deassigned (d)reserved (r)
providerStatusDesc
string 
required
Description of providerStatus.
resourceType
enum<string> 
required
Flag to show the queried resource type
Allowed values:
WME_SIMWME_ESIM
resourceValue
string 
required
eSIM/SIM Resource Identifier - ICCID
statusChangedBy
string 
required
Last provider status changed by. (system name)
statusChangedTime
string 
required
Last provider status changed time.
Examples
{
    "errorCode": 0,
    "errorMessage": "Web Method processed successfully",
    "success": true,
    "simDetails": {
        "custNo": 554433,
        "lineSeqNo": 1,
        "resourceType": "WME_ESIM",
        "internalStatus": "IN_USE",
        "statusChangedTime": "2024-03-06T01:00:47.613Z",
        "statusChangedBy": "iabtester237",
        "extra1": "89610147000005109863",
        "extra2": "60718245",
        "extra3": "505015600103021",
        "extra4": "eSimAutoAssigned",
        "expiry": null,
        "resourceValue": "4700000510983",
        "activationCode": "1$sm-v4-017-ppa-gtm.pr.go-esim.com$D439570DC0D5F34FEAC6CFEEAC6BE00D",
        "providerStatusDesc": "A - Active",
        "providerStatus": "a",
        "profileState": "RELEASED"
    }
}
🟠403Invalid access
Modified at 2024-03-21 09:20:28
Previous
Disconnect a Data Pool
Next
Manage eSIM
Built with