Manage OTP (Get & Verify OTP)

Testing Env

https://benzine.telcoinabox.com/tiab

POST

/UtbOTP

otp

UtbOTP:manageOTP

This endpoint can be used to trigger an OTP to be sent to an End Customer, and to validate an OTP provided by an End Customer.
The payload proides options to do this by either passing the request as GetOTP (send the OTP to the End Customer), and VerifyOTP (verify the OTP received by the customer).

Request

Header Params

Content-Type

string

required

Example:

text/xml; charset=utf-8

Body Params application/xml

Body

object

required

manageOTP

object

required

Example

<?xml version="1.0" encoding="UTF-8"?>
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
  <soapenv:Body>
    <otp:manageOtp xmlns:otp="http://otp.frontend.ws.utilibill.com.au/">
      <login>
        <userName>username</userName>
        <password>password</password>
      </login>
      <manageOtpRequest>
        <requestType>getOtp</requestType>
        <verifyOTP>
          <operationType>Port</operationType>
          <method>SMS</method>
          <custNo>554433</custNo>
          <destinationType>Authorised Person</destinationType>
          <destinationCategory>Phone (Mobile)</destinationCategory>
          <destination>0404949494</destination>
          <reason>R5</reason>
        </verifyOTP>
        <getOTP>
          <transactionId>C2D0440A-7333-4F53-A5BA-D7483C2F9838</transactionId>
          <code>576578</code>
        </getOTP>
      </manageOtpRequest>
    </otp:manageOtp>
  </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/UtbOTP' \
--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>
    <otp:manageOtp xmlns:otp="http://otp.frontend.ws.utilibill.com.au/">
      <login>
        <userName>username</userName>
        <password>password</password>
      </login>
      <manageOtpRequest>
        <requestType>getOtp</requestType>
        <verifyOTP>
          <operationType>Port</operationType>
          <method>SMS</method>
          <custNo>554433</custNo>
          <destinationType>Authorised Person</destinationType>
          <destinationCategory>Phone (Mobile)</destinationCategory>
          <destination>0404949494</destination>
          <reason>R5</reason>
        </verifyOTP>
        <getOTP>
          <transactionId>C2D0440A-7333-4F53-A5BA-D7483C2F9838</transactionId>
          <code>576578</code>
        </getOTP>
      </manageOtpRequest>
    </otp:manageOtp>
  </soapenv:Body>
</soapenv:Envelope>'

Responses

🟢200OK (Get OTP)

application/xml

Body

object

required

manageOtpResponse

object

required

Examples

Success (Get OTP)Success (Verify OTP)Code Expired

<?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:manageOtpResponse xmlns:ns2="http://otp.frontend.ws.utilibill.com.au/">
            <return>
                <getOtp>
                    <attemptLimit>3</attemptLimit>
                    <expireAt>2024-03-21 13:19:13.754213531</expireAt>
                    <otpId>01hsfck5ztfhfjvtzvf15vxhyt</otpId>
                    <transactionId>1BC1AD4C-7300-4FA6-B38D-98ADD51F2939</transactionId>
                </getOtp>
            </return>
        </ns2:manageOtpResponse>
    </S:Body>
</S:Envelope>

🔴500manageOtp fault - Exception

Modified at 2024-10-15 08:17:04

Query Detail of Unbilled Calls & Charges

Manage OTP (Get & Verify OTP)

UtbOTP:manageOTP#

Request

Request samples

Responses

UtbOTP:manageOTP