Report
This web service provides methods that allow you to report upon text messages and emails sent to and from an account.
The following operations are supported. For a formal definition, please review the Service Description.
-
ByDate
Reports messages sent between specified date strings.Parameter
Notes
Username: Password: ReportType: Provide a valid integer representing one of the report types. The following shows the integers and their corresponding report types: - 1 = StandardBetweenDates.
- 2 = 2wayBetweenDates.
StartDate: Provide a valid date/time string that represents the start date/time of the report. EndDate: Provide a valid date/time string that represents the end date/time of the report. ReportCSV: Provide a string data type output parameter. This will be populated with a CSV standard format string of records containing information about messages sent from an account between the two specified date/times. ResultText: E.g. 5 records were returned. Code: -
ByReference
Reports messages sent from an account depending on the value of the reference field.Parameter
Notes
Username: Password: Reference: This is a unique reference that you set when you send a message. ReportCSV: Provide a string data type output parameter. This will be populated with a CSV standard format string of records containing information about messages sent from the account with a specific reference. ResultText: E.g. 1 record was returned. Code: -
Manual
Reports messages sent. This is a more flexible method for reporting on messages sent or received but requires a greater level of interaction and understanding.Parameter
Notes
Username: Password: ReportType: Provide a valid integer representing one of the report types. The following shows the integers and their corresponding report types: - 1 = StandardBetweenDates.
- 2 = 2wayBetweenDates.
- 3 = ByReference.
- 4 = MessagesToday.
- 5 = MessagesYesterday.
- 6 = MessagesThisMonth.
- 7 = MessagesLastMonth.
- 8 = MessagesSinceLastReques.
Arg1: If you are using ReportType StandardBetweenDates or 2wayBetweenDates this must be set to a valid start date string. If you are using ReportType ByReference this must be set to a valid message reference. If you are using ReportType MessagesToday - MessagesSinceLastRequest this can be set to null. Arg2: If you are using ReportType StandardBetweenDates or 2wayBetweenDates this must be set to a valid end date string. If you are using ReportType ByReference this must be set to null. If you are using ReportType MessagesToday - MessagesSinceLastRequest this can be set to null. ReportCSV: Provide a string data type output parameter. This will be populated with a CSV standard format string of records containing information about messages sent or received. ResultText: E.g. 5 records were returned. Code: -
Standard
Reports messages sent from an account depending on the value of the ReportType field.Parameter
Notes
Username: Password: ReportType: Provide a valid integer representing one of the report types. The following shows the integers and their corresponding report types: - 4 = MessagesToday.
- 5 = MessagesYesterday.
- 6 = MessagesThisMonth.
- 7 = MessagesLastMonth.
- 8 = MessagesSinceLastRequest.
ReportCSV: Provide a string data type output parameter. This will be populated with a CSV standard format string of records containing information about messages sent from an account. ResultText: E.g. 5 records were returned. Code: