SBT API & Docs
Reporting

Overview

Returns the carrier lookups done based on the category of Lookup source.

 

Syntax

C#

public WSReportCarrierLookupResponse GetCarrierLookUpDetails(string securityToken, string orgCode, string fromDate, string toDate, string lookup_Type)

WSDL

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

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

Parameters

securityToken

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

orgCode

– String[50] (Required) – Default Organization Code for the company, organization, division or group.

fromDate
– String[20] (Required) – Start date for report of carrier lookups done. Date format is [mm/dd/yyyy hh:mm:ss].

toDate
– String[20] (Required) – End date for report of carrier lookups done. Date format is [mm/dd/yyyy hh:mm:ss].

lookup_Type
– String[10] (Optional) – Type of lookup types to be retrieved. Input numbers from 1 to 6 (1 – API, 2 – MessageDelivery, 3 – VBTWidget, 4 – BulkLookup, 5 – Deactivation, 6 – DualLookup). If no value entered, then all types of lookup data will be displayed.

Note: Date range should only include current and Previous month.

 

Return Value

Get Carrier LookUp Details Response

 

Name Type Description

Result

bool

True/False whether the call was successful or not.

ErrorCode

int

For Success/Failure it returns an error number.

Message

string

Message related to error code.

Response

List

<a:WSReportCarrierLookupRow>

If there are transaction details, then they will be displayed
Group – Org name where carrier lookup done.
SubscriberNo – Phone number of subscriber used for carrier lookup.
FirstName – First Name of the subscriber.
LastName– Last Name of the subscriber.
Carrier – Carrier name of the phone number.
Result – Phone number type. e.g. Mobile, Landline, Invalid etc.
Source – Cause of carrier lookup. e.g. API, MessageDelivery, VBTWidget, BulkLookup, Deactivation, DualLookup.
DateTime– Date and Time of the carrier lookup done.

 

Examples

Back
C#
lblError.Text = "";
ReportClient reportService = new ReportClient("ReportWSServiceHttpEndpoint");
string securityToken = txtToken.Text;
string orgCode = txtOrgCode.Text;
string fromDate = txtFromDate.Text;
string toDate = txtToDate.Text;
string lookupType = txtLookupType.Text;
 
WSReportCarrierLookupResponse wSReportCarrierLookupResponse = reportService.GetCarrierLookUpDetails(securityToken, orgCode, fromDate, toDate, lookupType);
 
if (!wSReportCarrierLookupResponse.Result)
{
	//handle error
	lblError.Text = wSReportCarrierLookupResponse.Message; 
}
else
{
	//handle success
	lblError.Text = wSReportCarrierLookupResponse.Message;
}

 

SOAP
Soap Request 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://SBTService/ServiceContracts/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:GetCarrierLookUpDetails>
         <!--Required:-->
         <ser:securityToken>Security Token</ser:securityToken>
         <!--Required:-->
         <ser:orgCode>Org Code</ser:orgCode>
         <!--Required:-->
         <ser:fromDate>mm/dd/yyyy hh:mm:ss</ser:fromDate>
         <!--Required:-->
         <ser:toDate> mm/dd/yyyy hh:mm:ss </ser:toDate>
         <!--Optional:-->
         <ser:lookup_Type></ser:lookup_Type>
      </ser:GetCarrierLookUpDetails>
   </soapenv:Body>
</soapenv:Envelope>
             
 
Soap Response
 <s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <GetCarrierLookUpDetailsResponse xmlns="http://SBTService/ServiceContracts/">
         <GetCarrierLookUpDetailsResult xmlns:a="http://SBTAPIService/DataContract/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:Result>true</a:Result>
            <a:ErrorCode>1559</a:ErrorCode>
            <a:Message>Successfully retrieved carrier lookup details report.</a:Message>
            <a:Response>
               <a:WSReportCarrierLookupRow>
                  <a:Group>Group Name</a:Group>
                  <a:SubscriberNo>Mobile Number</a:SubscriberNo>
                  <a:FirstName/>
                  <a:LastName/>
                  <a:Carrier>Carrier Name</a:Carrier>
                  <a:Result>Number Type (Mobile/Landline)</a:Result>
                  <a:Source>Lookup Source</a:Source>
                  <a:DateTime>Lookup Date and Time</a:DateTime>
               </a:WSReportCarrierLookupRow>
         </a:Response>
         </GetCarrierLookUpDetailsResult>
      </GetCarrierLookUpDetailsResponse>
   </s:Body>
</s:Envelope>
REST 

Method: GET

URL: https://ui.solutionsbytext.com/SBT.App.SetUp/RSServices/ReportRSService.svc/GetCarrierLookUpDetails?securityToken=SecurityToken&orgCode=Org Code&fromDate=mm:dd:yyyy hh:mm:ss&toDate=mm:dd:yyyy hh:mm:ss &lookup_Type=valid_Lookup_Type

Response:

The response will be in JSON format like below:
 
{"GetCarrierLookUpDetailsResult": {
   "Result": true,
   "ErrorCode": 1559,
   "Message": "Successfully retrieved carrier lookup details report",
   "Response": [{ "List of GetCarrierLookupDetails report details like Group, SubscriberNo, FirstName, LastName, Carrier, Result, Source, DateTime Information will be displayed" }]
   }}