GetOutboundActivity
Description
The GetOutboundActivity web service method retrieves a summary of outbound fax activity for an account over a specified time range. This service is essential for users who need to monitor and analyze fax activity efficiently within their organization.
Formal Definition
https://ws.interfax.net/admin.asmx?op=GetOutboundActivity
Input
| Name |
Type |
Comments |
| Username |
String |
The name of the user authenticating to the API. Note: This method can only be used by a primary user, i.e. defined as administrator in the account. |
| Password |
String |
The password for the Username. |
| TimeFrom |
DateTime |
The start of the time range for the activity summary. |
| TimeUntil |
DateTime |
The end of the time range for the activity summary. |
| OnlyMyUser |
Boolean |
If true , the summary will only include the current user’s activity. If false , the summary will include activity for ALL users in the account. |
Output
| Name |
Type |
Comments |
| GetOutboundActivityResult |
Object |
Contains the summary of outbound fax activity and the result code indicating success or failure. |
|
Status |
Integer |
The result code of the operation: 0 for success, otherwise an error code indicating what went wrong. See Error Codes, below. All errors are listed in Appendix A |
|
TimeFrom |
DateTime |
Start of date range |
|
TimeUntil |
DateTime |
End of date range |
|
UserOutboundSummary |
Array |
An array of user-specific outbound activity summaries. |
|
|
Username |
|
Username to which transactions apply |
|
|
TotalFaxes |
Integer |
Total number of faxes sent |
|
|
TotalPages |
Integer |
Total number of pages sent |
|
|
TotalUnits |
Decimal |
Total charge units used for transactions in the time range |
|
|
TotalCost |
Decimal |
Total cost for transactions in the time range |
|
|
MinTransactionID |
Integer |
Lowest TransactionID returned in the query |
|
|
MaxTransactionID |
Integer |
Highest TransactionID returned in the query |
Error Codes
| Value |
Description |
| -150 |
Internal System Error. An exception occurred at any point in the execution of the web service method. |
| -310 |
The user is not a primary user. |
| -1003 |
Authentication error: the user cannot be authenticated when either the username or the password is incorrect OR any other last error occurred when authenticating the user. |
| -2040 |
The provided time range is invalid (i.e., TimeFrom is greater than TimeUntil). |