How to Stop a Fax Using Stop_Fax | Cancel Fax

Deletes a specified queued fax which has not been processed

POST Variables

 

Variable Name	Var Type	Type	Description
action	String	Required	Must be “Stop_Fax”
access_id	Integer	Required	Account Number
access_pwd	String	Required	Password on the user’s account
sFaxDetailsID	Integer	Require*	FaxDetailsID returned from Queue_Fax
sResponseFormat	String	Optional	“XML” or “JSON” – Default is JSON

 

Returned Variables (JSON or XML Encoded)

 

Status	string	“Success” or “Failed”
Result	string	See below for possible values
		Note: If an error is found then the reason for the failure will be in the Result string

 

This function is used for removing a fax from the queue once it has been scheduled. Please note that depending on where the fax is in the process, it is possible to have some pages sent by the time the fax is stopped.

 

 

Possible results are:

 

Status = Success:

• Result:
  • “Fax cancelled but partially sent” – fax was successfully cancelled but
    whatever was in the fax buffer will have been sent.
  • “Fax Cancelled” – the fax was successfully cancelled without any pages being
    sent.

 

Status = Failed

• Result:
  • “Fax transmission completed” – the fax has been sent and the transaction is
    complete
  • “Unable to Cancel Fax” – Fax in the process of conversion and cannot be
    cancelled at this time – you can try again in 10 seconds.
  • “File not found – Please try again” – Fax could not be found at this time – you can try again in 5 seconds.

 

 

Examples

PHP using cURL

 

PHP using SRFax Object