EP
This web service provides methods that allow you to report upon the status of contacts in an emergency.
The following operations are supported. For a formal definition, please review the Service Description.
-
ByAccount
Reports messages received from address book contacts by group name or group ID.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: - 10 = ByAccount.
- 11 = ByAccountBetweenDates.
Shared: Provide a string value of 'True' or 'False'. Set this parameter to 'True' if you are stating that you are using a shared 2-way number. Set this parameter to 'False' if you are stating that you are using a private 2-way number. GroupType: Provide a valid integer group type. This can be set to one of the following: - 1 = GroupID.
- 2 = GroupName.
Group: Provide a valid group name or group ID from your address book. StartDate: Provide a valid date/time string that represents the start date/time of the report. If you select the report type ByAccount you can set this parameter to null. EndDate: Provide a valid date/time string that represents the end date/time of the report. If you select the report type ByAccount you can set this parameter 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 all of contacts that have sent a message to the emergency planning number. ResultText: E.g. 3 records were returned. Code: -
ByNumber
Reports messages received from a specified number since a specified date string.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: - 12 = ByNumber.
Shared: Provide a boolean string value of 'True' or 'False'. Set this parameter to 'True' if you are stating that you are using a shared 2-way number. Set this parameter to 'False' if you are stating that you are using a private 2-way number. InboundNumber: Provide a valid mobile device number. This should be a mobile device number you think has sent messages to your 2-way number. StartDate: Provide a valid date/time string that represents the start 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 all of contacts that have sent a message to the emergency planning number. ResultText: E.g. 3 records were returned. Code: