Knowledgebase:
SMSReport
Posted by Mohammad Rahhal, Last modified by Rawan Al Hourani on 17 October 2017 12:20 PM

Syntax

 Public Function SMSReport (ClientID As Integer, FromDate As String, ToDate As String,TransTag As String) As CallingResultsEnum

This function used to get the SMS report that shows you the details of each SMS sent in your whole system or for a certain account(s)/office(s). After SMSReport executes the ReportDataReceived event fire.

Parameters

Parameter Description 
ClientID The report will show sent SMS details for all accounts under this client.
FromDate Specify the duration.
Date in this format “DD/MM/YYYY HH:NN:SS”
“” means from beginning
ToDate Specify the duration.
Date in this format “DD/MM/YYYY HH:NN:SS”
“” means till now
TransTag  String value used to mark the requested report when the result came from server

Return value
Return value of type CallingResultsEnum, if the request sent to server successfully it will return SuccessResult

Sample

 Private Sub SmsRep_Click (ByVal sender As System.Object, ByVal e As System.EventArgs) Handles SmsRep.Click

            ‘BOAPI is a predefined variable as CVertexBOAPI10  

             Dim Result As CallingResultsEnum

             Result= BOAPI. SMSReport (BOAPI.RootID, "", "" ,"")

 End Sub

Results  
The result of this report contains many details, the following table shows each column description:

Data row Index Column Name Description 
1 Date/Time Shows the date and time for each SMS sent to your client(s) under the group that you have chosen for the generated report
2 ClientID The client ID for each sent SMS
3 Mobile The mobile number that the SMS was sent to
4 Message The content of each sent SMS
5 Status The Status of each sent SMS (Sent”2”/ Failed”3”)
6 SMS type The Type for each sent SMS
1 means Statement SMS
2 means Normal SMS
3 means Prices SMS
7 TransTag  The same string which sent through the requested report.

See Also


VertexFX Backoffice API Index

(0 vote(s))
Helpful
Not helpful

Comments (0)
Post a new comment
 
 
Full Name:
Email:
Comments:
CAPTCHA Verification 
 
Please enter the text you see in the image into the textbox below (we use this to prevent automated submissions).

Help Desk Software by Hybrid Solutions