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
[OperationContractAttribute()] SBT.API.DataContracts.Admin.WSVerificationResponse RequireVBT( 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). |
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.RequireVBT(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:RequireVBT> <!--Required:--> <ser:securityToken>Security Token</ser:securityToken> <!--Required:--> <ser:orgCode>Org Code</ser:orgCode> <!--Required:--> <ser:phone>Phone Number</ser:phone> <!--Optional:--> <ser:note>test note</ser:note> <!--Optional:--> <ser:statusUrl>Status URL</ser:statusUrl> </ser:RequireVBT> </soapenv:Body> </soapenv:Envelope> Soap Response <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/"> <s:Body> <RequireVBTResponse xmlns="http://SBTService/ServiceContracts/"> <RequireVBTResult z:Id="i1" xmlns:a="http://SBTAPIService/DataContract/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/"> <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> </RequireVBTResult> </RequireVBTResponse> </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.RequireVBT(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('RequireVBT', array($param)); echo '<pre/>'; print_r($response); if($response->RequireVBTResult->Result){ echo $response->RequireVBTResult->Message; echo $response->RequireVBTResult->Id; } else { echo $response->RequireVBTResult->Message; } ?>
REST
Method: POST
URL: https://ui.solutionsbytext.com/SBT.App.SetUp/RSServices/MessageRSService.svc/RequireVBT
Sample C# Code:
var requestdata = new { securityToken = "validsecurityToken", orgCode = "orgCode", phone = "1234567891", note = "note", statusUrl = "statusURL" }; string data2 = JsonConvert.SerializeObject(requestdata).ToString(); System.Net.WebClient webClient = new System.Net.WebClient(); webClient.Headers["Content-type"] = "application/json"; webClient.Encoding = Encoding.UTF8; var strRequireVBTResponse = webClient.UploadString("https://ui.solutionsbytext.com/SBT.App.SetUp/RSServices/MessageRSService.svc/RequireVBT", "POST", data2); Note:“strRequireVBTResponse” contains the output response as return values
Response:
The response will be in JSON format like below: {" RequireVBTResult": { "Result": true, "ErrorCode": 1287, "Message": " Subscriber and Verification Details Inserted Successfully", “PIN”: " 1567981" }}
Send Feedback