Gets the details of an outbound fax identified by its id.
GET fw/Apps/StoneFax/WebAPI/Faxes/Outbound/{id}
Name | Type | Required | Description | Default | Example |
---|---|---|---|---|---|
id | string | required | The id of the fax | null | IAS-N1_d53957a4-c6fa-4a89-9198-f32da47e6a58_0 |
Fax info have been returned.
Response body is a JSON object representing outbound fax data:
Name | Type | Description |
---|---|---|
fax | Fax | The outbound fax data |
Name | Type | Description |
---|---|---|
faxId | string | The fax id |
username | string | The username of the user the fax belongs to |
subject | string | The fax subject |
recipient | Recipient[] | The fax recipients |
status | Status |
The status of the fax. Possible values are:
|
detailedStatus | string | A more detailed version of the fax status |
numberOfPages | int | The number of fax pages |
serverName | string | The name of the server that sent the fax |
submitTime | DateTime | The time when the fax has been submitted to the system (ISO 8601) |
startTime | DateTime | The time when the fax sending was started (ISO 8601) |
endTime | DateTime | The time when the fax sending was concluded (ISO 8601) |
failureReason | string | The possible failure reason |
Q931Code | int | The Q931 Code representing the possible failure reason |
size | int | Size in bytes of the fax |
Name | Type | Description |
---|---|---|
name | string | The complete name (first and last name) of the recipient |
faxNumber | string | The recipient's fax number |
GET fw/Apps/StoneFax/WebAPI/Faxes/Outbound/IAS-N1_d53957a4-c6fa-4a89-9198-f32da47e6a58_0