SBT API & Docs
Reporting

Reporting Limits:

1 connection per 15 minutes

No connections from 12:00AM to 2:00AM Central Time

Overview

Returns the messages received for a group, division, or organization. 

Syntax

C#

[OperationContractAttribute()] 
SBT.API.DataContracts.Common.WSReportInboundMessagesResponse InboundMessages( 
   string securityToken,
   string orgCode,
   string fromDate,
   string toDate
)

 

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 company,organization, division or group.

fromDate

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

toDate

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

 Note: Date range should include only current and previous month. For beyond previous month data, please use ArchiveInboundMessages service.

Return Value

WSReportInboundMessagesResponse

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 message.
Response List <WSReportInboundMessageRow>

If there are transaction details then they will be displayed

Group – Org name to which the message was received.

Code – Communication code from which message was received.

Phone – Phone number the message originated from.

Message – Actual message that was received.

ModeOfCommunication – Unique ID of Subscriber. (Note: recommend not to use this field. Instead use UniqueID field)

MessageCategory – Category of received message e.g. 2 way, VBT, Keyword etc.

MessageSubCategory – Sub Category of received message e.g. HELP, STOP, STOPALL, MMS.

TimeStamp – Date and time the message was received from sender.

UniqueID – UniqueID of the Subscriber

TransactionTicket– Unique ticket for inbound message

Note – Note of previously received message from platform

 

Examples

Back

C#

lblError.Text = "";
ReportClient reportService = new ReportClient("ReportWSServiceHttpEndpoint");
    string securityToken = txtToken.Text; ;
    string orgCode = txtOrgCode.Text;
    string fromDate = dtFromDate.Text;
    string toDate = dtToDate.Text;

    WSReportInboundMessagesResponse wSReportInboundMessagesResponse = reportService.InboundMessages(securityToken, orgCode, fromDate, toDate);
        if (!wSReportInboundMessagesResponse.Result)
            {
                //handle error
                lblError.Text = wSReportInboundMessagesResponse.Message;
            }
        else
            {
                //handle success
                lblError.Text = wSReportInboundMessagesResponse.Message;
            }

 

SOAP

Soap Request 
 
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://SBTService/ServiceContracts/">
   <soapenv:Header/>
   <soapenv:Body>
      <ser:InboundMessages>
         <!--Required:-->
         <ser:securityToken>Security Token</ser:securityToken>
         <!--Required:-->
         <ser:orgCode>Org code</ser:orgCode>
         <!--Required:-->
         <ser:fromDate>From Date</ser:fromDate>
         <!--Required:-->
         <ser:toDate>To Date</ser:toDate>
      </ser:InboundMessages>
   </soapenv:Body>
</soapenv:Envelope>

            
 Soap Response
             
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
   <s:Body>
      <InboundMessagesResponse xmlns="http://SBTService/ServiceContracts/">
         <InboundMessagesResult xmlns:a="http://SBTAPIService/DataContract/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:Result>true</a:Result>
            <a:ErrorCode>1440</a:ErrorCode>
            <a:Message>Successfully retrieved inbound messages report</a:Message>
            <a:Response>
               <a:WSReportInboundMessageRow>
                  <a:Group>Group Name</a:Group>
                  <a:Code>Comm. Code</a:Code>
                  <a:Phone>Phone Number</a:Phone>
                  <a:Message>I need help</a:Message>
                  <a:ModeOfCommunication>Unique ID</a:ModeOfCommunication>
                  <a:MessageCategory>Inbound Message</a:MessageCategory>
                  <a:MessageSubCategory>NA</a:MessageSubCategory>
                  <a:TimeStamp>4/4/2017 2:44:19 AM</a:TimeStamp>
                  <a:UniqueID>Unique ID of Subscriber</a:UniqueID>
                  <a:TransactionTicket>Inbound message ticket ID</a:TransactionTicket>
                  <a:Note/>
               </a:WSReportInboundMessageRow>
	   </a:Response>
         </InboundMessagesResult>
      </InboundMessagesResponse>
   </s:Body>
</s:Envelope>

JAVA

  ReportWSService srv = new ReportWSService();
  IReport iReport = srv.getReportWSServiceHttpEndpoint1();
  WSReportInboundMessagesResponse res = null;
		
  String securityToken = "SecurityToken";
  String orgCode = "orgCode";
  String fromDate = "08/22/2013";
  String toDate = "09/22/2013";

  try {
	    res = iReport.inboundMessages(securityToken, orgCode, fromDate, toDate);

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

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

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

PHP

<?php
    $client = new SoapClient("https://ui.solutionsbytext.com/Sbt.App.SetUp/WSServices/ReportWSService.svc?wsdl");
   $param = array(
	'securityToken' => 'securityToken',
	'orgCode' => 'orgCode',
	'fromDate' => '08/22/2013',
	'toDate' => '10/22/2013'
);

$response = $client->__soapCall('InboundMessages', array($param));
echo '<pre/>';
print_r($response);
if($response->InboundMessagesResult->Result){
	echo 'Message: '.$response->InboundMessagesResult->Message;
}
else {
	echo 'Message: '.$response->InboundMessagesResult->Message;
}
?>

REST

Method: GET

URL:  https://ui.solutionsbytext.com/SBT.App.SetUp/RSServices/ReportRSService.svc/InboundMessages?securityToken=safdsfs&orgCode=dfsf&fromDate=01/31/2015 00:00:00&toDate=01/30/2016 00:00:00

Response:

The response will be in JSON format like below:

{" InboundMessagesResult": {
   "Result": true,
   "ErrorCode": 1440,
   "Message": " Successfully retrieved inbound messages report",
   "Response": { "List<WSReportInboundMessageRow> response –
                              Inbound Message details like Code,Group,Message etc. Information will display" }
   }}

 

Send Feedback