Overview

This method is used to initiate the VBT process. If VBT type set as PIN, then PIN will be sent along with Verify message. For other VBT types preset verify message will be sent.

Below is the functionality:

For Active Subscribers
Status will not be changed and verify message will be sent to process VBT.

For Inactive Subscribers
Status of the subscriber will be changed to ‘Under Verification’ and verify message will be sent to process VBT.

For New Subscribers
Status of the subscriber will be set to ‘Under Verification’ and verify message will be sent to process VBT.

 

Syntax

C#

[OperationContractAttribute()]
SBT.API.DataContracts.Admin.WSVerificationResponse RequireVBTWithTransactionTicket(
   string securityToken,
   string orgCode,
   string phone,
   string note,
   string statusUrl
)

WSDL

Production: https://ui.solutionsbytext.com/Sbt.App.SetUp/WSServices/MessageWSService.svc?singlewsdl

Staging: https://test.solutionsbytext.com/Sbt.App.SetUp/WSServices/MessageWSService.svc?singlewsdl

 

Parameters

securityToken

– String[1000] (Required) – SecurityToken to authenticate the user.

orgCode

– String[20] (Required) – Default Organization Code for group the subscription is made. (Send Organization code to subscribe to all groups in the organization or send the group code to subscribe to a single group)

phone

– String[20] (Required) – Phone number with country code that the request VBT will be sent to.

note

– [500] (Optional) – This is a Note ID you can create and pass in the call; it will be returned in statusUrl, callbackUrl and in reports

statusUrl

– String[200] (Optional) – Status URL that can be used to check the status of the message in real time.

 

Return Value

WSVerificationResponse
NAME TYPE DESCRIPTION
Result bool True/False whether the call was successful or not.
ErrorCode int For Success/Failure returns an error number.
Message string Message related to error code.
Pin string Unique PIN generated for VBT. (PIN generated only when VBT type is set as PIN).
TransactionTicket string Transaction ticket generated for tracking the VBT message

 

Examples

C#

 MessageClient messageResult = new MessageClient("MessageWSServiceHttpEndpoint");
            string securityToken = txtToken.Text;
            string orgCode = txtOrgCode.Text;
            string phoneNo = txtMobile.Text;
            string note = txtNote.Text;
            string statusUrl = txtStatusURL.Text;

            WSVerificationResponse wSVerificationResponse = messageResult.RequireVBTWithTransactionTicket(securityToken, orgCode, phoneNo, note, statusUrl);
            if (!wSVerificationResponse.Result)
            {
                //handle error
                lblError.Text = wSVerificationResponse.Message;
            }
            else
            {
                //handle success
                lblError.Text = wSVerificationResponse.Message;
            }

SOAP

Soap  Request 
              
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://SBTService/ServiceContracts/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:RequireVBTWithTransactionTicket>
         <!--Required:-->
         <ser:securityToken>SecurityToken</ser:securityToken>
         <!--Required:-->
         <ser:orgCode>Org Code</ser:orgCode>
         <!--Required:-->
         <ser:phone>Mobile No</ser:phone>
         <!--Optional:-->
         <ser:note>Test Require VBT Note</ser:note>
         <!--Optional:-->
         <ser:statusUrl></ser:statusUrl>
      </ser:RequireVBTWithTransactionTicket>
   </soapenv:Body>
</soapenv:Envelope>

      
Soap Response
              
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
    <s:Body>
        <RequireVBTWithTransactionTicketResponse xmlns="http://SBTService/ServiceContracts/">
            <RequireVBTWithTransactionTicketResult xmlns:a="http://SBTAPIService/DataContract/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
                <a:Result>true</a:Result>
                <a:ErrorCode>1287</a:ErrorCode>
                <a:Message>Subscriber and Verification Details Inserted Successfully</a:Message>
                <a:Pin>Pin</a:Pin>
                <a:TransactionTicket>Transaction Ticket</a:TransactionTicket>
            </RequireVBTWithTransactionTicketResult>
        </RequireVBTWithTransactionTicketResponse>
    </s:Body>
</s:Envelope>

JAVA

MessageWSService srv = new MessageWSService();
IMessage iMessage = srv.getMessageWSServiceHttpEndpoint1();
WSVerificationResponse res = null;

String securityToken = "securityToken";
String orgCode = "orgcode";
String phoneNo = "12345678901";
String note = "note";
String statusUrl = "statusUrl";
try {
	res = iMessage.RequireVBTWithTransactionTicket(securityToken, orgCode, phoneNo, note, statusUrl);

} catch (Throwable e) {
	e.printStackTrace();
}

if(res == null ){
System.out.println("Error::");
return;

}
if (!res.isResult())
{
	//handle error
	System.out.println("ErrorCode::"+res.getErrorCode());
	System.out.println("ErrorMessage::"+res.getMessage());
}
else		{
	//handle success
	System.out.println("Message::"+res.getMessage().getValue());
}

PHP

 
<?php
    $client = new SoapClient("https://ui.solutionsbytext.com/Sbt.App.SetUp/wsservices/MessageWSService.svc?wsdl");
    $param = array( 
    'securityToken',
    'orgCode' => 'orgCode',
    'phone' => '12345678999',
	'note' => 'note',
    'statusUrl' => 'statusUrl'
                  );
    $response = $client->__soapCall('RequireVBTWithTransactionTicket', array($param));
    echo '<pre/>';
    print_r($response);
    if($response->RequireVBTWithTransactionTicketResult->Result){
	echo $response->RequireVBTWithTransactionTicketResult->Message;
	echo $response->RequireVBTWithTransactionTicketResult->Id;
           }
    else {
	echo $response->RequireVBTWithTransactionTicketResult->Message;
         }
?>


REST
Method: POST
URL:
https://ui.solutionsbytext.com/SBT.App.SetUp/RSServices/MessageRSService.svc/RequireVBTWithTransactionTicket
 
JSON Request:
 
{
                "securityToken": "Security Token",
                "orgCode": "Org Code",
                "phone": "Phone Number"
}


JSON Response:
{
    "RequireVBTWithTransactionTicketResult": {
        "Result": true,
        "ErrorCode": 1287,
        "Message": "Subscriber and Verification Details Inserted Successfully",
        "Pin": "Pin",
        "TransactionTicket": "Transaction Ticket"
    }
}



Send Feedback