Responses
ReceiveInboundFax
JSON
{"InboundFaxItems":[{"FaxId":"xxx","Pages":"x","ToFaxNumber":"xxx","FromFaxNumber":"8882323562","FromCSID":"8882323562","FaxDateUtc":"3/2/2014 11:37:00 AM","FaxSuccess":"1","Barcodes":{"FirstBarcodePage":0,"TotalPagesWithBarcodes":0,"PagesWithBarcodes":[],"BarcodeItems":[]},"InboundFaxId":"xxx","FaxPages":"4","FaxDateIso":"2014-03-02T11:37:00Z","WatermarkId":"xxx"}],"FaxCount":1,"LastWatermark":"xxx","HasMoreItems":"false","isSuccess":true,"message":"Success"}
XML
ReceiveInboundFaxResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><isSuccess>true</isSuccess><message>Success</message><InboundFaxItems><InboundFaxItem><FaxId>xxx</FaxId><Pages>4</Pages><ToFaxNumber>15125314405</ToFaxNumber><FromFaxNumber>xxx</FromFaxNumber><FromCSID>xxx</FromCSID><FaxDateUtc>3/2/2014 11:37:00AM</FaxDateUtc><FaxSuccess>1</FaxSuccess><Barcodes><FirstBarcodePage>0</FirstBarcodePage><TotalPagesWithBarcodes>0</TotalPagesWithBarcodes><PagesWithBarcodes /><BarcodeItems /></Barcodes><InboundFaxId>xxx</InboundFaxId><FaxPages>4</FaxPages><FaxDateIso>2014-03-02T11:37:00Z</FaxDateIso><WatermarkId>xxx</WatermarkId></InboundFaxItem></InboundFaxItems><FaxCount>1</FaxCount><LastWatermark>xxx</LastWatermark><HasMoreItems>false</HasMoreItems></ReceiveInboundFaxResponse>
SendFax
Note: isSuccess only refers to the request itself being successful or not. True means we received the request and we are processing the fax. False means we did not successfully receive the request. To get the status of the delivery of the fax, you will need to use ReceiveOutboundFax.
JSON
{"SendFaxQueueId":"66A24E61A3E84E51BB3BBA716ABFFAB9","isSuccess":true,"message":"Fax is received and being processed"}
XML
<ResponseMessage> <SendFaxQueueId>11B30EC4597948D59C5FE8C3B2A95102</SendFaxQueueId><isSuccess>true</isSuccess><message>Fax is received and being processed</message></ResponseMessage>
ReceiveOutboundFax
Here's a response with both a successfully delivered fax and a failed fax. Success is indicated by "IsSuccess": true and also by "FaxSuccess":1. The failed fax is indicated by "IsSuccess":false and by "FaxSuccess":0. Failed faxes will also return a ResultCode and a corresponding ErrorCode and ResultMessage to indicate why it failed.
JSON
{{"OutboundFaxItems":[{"SendFaxQueueId":"xxx","IsSuccess":true,"ResultCode":0,"ErrorCode":0,"ResultMessage":"OK","RecipientName":"Test","RecipientFax":"1-8882323562","TrackingCode":"xxx","FaxDateUtc":"2014-03-04T21:04:42Z","FaxId":xxx,"Pages":1,"Attempts":1,"SenderFax":"1-5125314405","BarcodeItems":[{"BarcodeSpacingXAxis":0,"BarcodeSpacingYAxis":0,"BarcodeType":1,"BarcodeMode":1,"BarcodeData":"X1234567890","BarcodeX":100,"BarcodeY":100,"BarcodePage":1,"BarcodeScale":3,"BarcodeWidth":0,"BarcodeHeight":0}],"FaxSuccess":"1","OutboundFaxId":"xxx","FaxPages":"1","FaxDateIso":"2014-03-04T21:04:42Z","WatermarkId":"xxx"},{"SendFaxQueueId":"xxx","IsSuccess":false,"ResultCode":6000,"ErrorCode":1604003,"ResultMessage":"No
Faxtone Detected","RecipientName":"Test","RecipientFax":"1-5125551212","TrackingCode":"Z1234567890","FaxDateUtc":"2014-03-04T21:11:50Z","FaxId":2140304211150997697,"Pages":1,"Attempts":1,"SenderFax":"1-5125314405","BarcodeItems":null,"FaxSuccess":"0","OutboundFaxId":"2140304211150997697","FaxPages":"1","FaxDateIso":"2014-03-04T21:11:50Z","WatermarkId":"2140304211245997698"}],"FaxCount":1,"LastWatermark":"2140304211245997698","HasMoreItems":"false","isSuccess":true,"message":"Success"}
}
XML
<ReceiveOutboundFaxResponse xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"><isSuccess>true</isSuccess><message>Success</message><OutboundFaxItems><RecipientFaxStatus><SendFaxQueueId>xxx</SendFaxQueueId><IsSuccess>true</IsSuccess><ResultCode>0</ResultCode><ErrorCode>0</ErrorCode><ResultMessage>OK</ResultMessage><RecipientName>Test</RecipientName><RecipientFax>1-8882323562</RecipientFax><TrackingCode>Z1234567890</TrackingCode><FaxDateUtc>2014-03-04T21:04:42Z</FaxDateUtc><FaxId>2140304210442997690</FaxId><Pages>1</Pages><Attempts>1</Attempts><SenderFax>1-5125314405</SenderFax><BarcodeItems><BarcodeItem><BarcodeSpacingXAxis>0</BarcodeSpacingXAxis><BarcodeSpacingYAxis>0</BarcodeSpacingYAxis><BarcodeType>1</BarcodeType><BarcodeMode>1</BarcodeMode><BarcodeData>X1234567890</BarcodeData><BarcodeX>100</BarcodeX><BarcodeY>100</BarcodeY><BarcodePage>1</BarcodePage><BarcodeScale>3</BarcodeScale><BarcodeWidth>0</BarcodeWidth><BarcodeHeight>0</BarcodeHeight></BarcodeItem></BarcodeItems><FaxSuccess>1</FaxSuccess><OutboundFaxId>2140304210442997690</OutboundFaxId><FaxPages>1</FaxPages><FaxDateIso>2014-03-04T21:04:42Z</FaxDateIso><WatermarkId>2140304210545997694</WatermarkId></RecipientFaxStatus><RecipientFaxStatus><SendFaxQueueId>D48316AEC97F491986DE8007E45C6CB4</SendFaxQueueId><IsSuccess>true</IsSuccess><ResultCode>0</ResultCode><ErrorCode>0</ErrorCode><ResultMessage>OK</ResultMessage><RecipientName>Test</RecipientName><RecipientFax>1-8882323562</RecipientFax><TrackingCode>Z1234567890</TrackingCode><FaxDateUtc>2014-03-04T21:05:21Z</FaxDateUtc><FaxId>2140304210521997693</FaxId><Pages>1</Pages><Attempts>1</Attempts><SenderFax>1-5125314405</SenderFax><BarcodeItems><BarcodeItem><BarcodeSpacingXAxis>0</BarcodeSpacingXAxis><BarcodeSpacingYAxis>0</BarcodeSpacingYAxis><BarcodeType>1</BarcodeType><BarcodeMode>1</BarcodeMode><BarcodeData>X1234567890</BarcodeData><BarcodeX>100</BarcodeX><BarcodeY>100</BarcodeY><BarcodePage>1</BarcodePage><BarcodeScale>3</BarcodeScale><BarcodeWidth>0</BarcodeWidth><BarcodeHeight>0</BarcodeHeight></BarcodeItem></BarcodeItems><FaxSuccess>1</FaxSuccess><OutboundFaxId>2140304210521997693</OutboundFaxId><FaxPages>1</FaxPages><FaxDateIso>2014-03-04T21:05:21Z</FaxDateIso><WatermarkId>2140304210745997695</WatermarkId></RecipientFaxStatus></OutboundFaxItems><FaxCount>2</FaxCount><LastWatermark>2140304210745997695</LastWatermark><HasMoreItems>false</HasMoreItems></ReceiveOutboundFaxResponse>