JSON API » faxes » faxes/get
Get fax status.
Input parameters
Requires authentication and the send_fax role privilege.
| Name | Type | Description | Required | Default value |
|---|---|---|---|---|
| auth_username | String | Authentication username. | Yes | |
| auth_password | String | Authentication password. | Yes | |
| id | String | ID of fax to get. | Yes |
Responses
| Code | Description |
|---|---|
| 200 | Success. |
| 400 | Invalid input parameters specified. Check the key and message fields for more details. |
| 401 | The authentication details provided are invalid. |
| 402 | Your role does not allow this. |
| 500 | An error occurred within the server. Check the key and message fields for more details. |
Data returned
Status of the fax.
Example: With required parameters
https://www.015pbx.net/local/api/json/faxes/get/?auth_username=user;auth_password=password;id=1579011681_5e1dce61d4c73_59{ "data" : { "status" : "SUCCESS" }, "responses" : [ { "message" : "OK", "key" : "", "code" : 200 } ] }