SendFaxAPI
Click here for a complete list of operations.
SentFaxes
Test
The test form is only available for requests from the local machine.SOAP 1.1
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /fax/sendfaxapi.asmx HTTP/1.1 Host: sendfax-api.gofax.com.au Content-Type: text/xml; charset=utf-8 Content-Length: length SOAPAction: "http://www.gofax.com.au/SentFaxes" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <SentFaxes xmlns="http://www.gofax.com.au/"> <token>guid</token> </SentFaxes> </soap:Body> </soap:Envelope>
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <soap:Body> <SentFaxesResponse xmlns="http://www.gofax.com.au/"> <SentFaxesResult> <SendFaxAttachmentDetail> <ID>int</ID> <SendFaxTransmissionID>int</SendFaxTransmissionID> <Status>string</Status> <FileName>string</FileName> <Error>boolean</Error> <TransmissionID>int</TransmissionID> <ConversionID>int</ConversionID> <ConversionComplete>boolean</ConversionComplete> <ConversionStart>dateTime</ConversionStart> <ConversionFinish>dateTime</ConversionFinish> <FromAddress>string</FromAddress> <ToNumber>string</ToNumber> <ClientID>int</ClientID> <TransmissionDate>dateTime</TransmissionDate> <Pages>int</Pages> <TransmissionStart>dateTime</TransmissionStart> <TransmissionComplete>dateTime</TransmissionComplete> <SendTo>string</SendTo> <SendHQ>boolean</SendHQ> <Charge>decimal</Charge> <DeleteData>boolean</DeleteData> <RetryDate>dateTime</RetryDate> <ConversionSize>int</ConversionSize> <Retries>int</Retries> <Subject>string</Subject> <TaskState>int</TaskState> </SendFaxAttachmentDetail> <SendFaxAttachmentDetail> <ID>int</ID> <SendFaxTransmissionID>int</SendFaxTransmissionID> <Status>string</Status> <FileName>string</FileName> <Error>boolean</Error> <TransmissionID>int</TransmissionID> <ConversionID>int</ConversionID> <ConversionComplete>boolean</ConversionComplete> <ConversionStart>dateTime</ConversionStart> <ConversionFinish>dateTime</ConversionFinish> <FromAddress>string</FromAddress> <ToNumber>string</ToNumber> <ClientID>int</ClientID> <TransmissionDate>dateTime</TransmissionDate> <Pages>int</Pages> <TransmissionStart>dateTime</TransmissionStart> <TransmissionComplete>dateTime</TransmissionComplete> <SendTo>string</SendTo> <SendHQ>boolean</SendHQ> <Charge>decimal</Charge> <DeleteData>boolean</DeleteData> <RetryDate>dateTime</RetryDate> <ConversionSize>int</ConversionSize> <Retries>int</Retries> <Subject>string</Subject> <TaskState>int</TaskState> </SendFaxAttachmentDetail> </SentFaxesResult> </SentFaxesResponse> </soap:Body> </soap:Envelope>
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
POST /fax/sendfaxapi.asmx HTTP/1.1 Host: sendfax-api.gofax.com.au Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <SentFaxes xmlns="http://www.gofax.com.au/"> <token>guid</token> </SentFaxes> </soap12:Body> </soap12:Envelope>
HTTP/1.1 200 OK Content-Type: application/soap+xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope"> <soap12:Body> <SentFaxesResponse xmlns="http://www.gofax.com.au/"> <SentFaxesResult> <SendFaxAttachmentDetail> <ID>int</ID> <SendFaxTransmissionID>int</SendFaxTransmissionID> <Status>string</Status> <FileName>string</FileName> <Error>boolean</Error> <TransmissionID>int</TransmissionID> <ConversionID>int</ConversionID> <ConversionComplete>boolean</ConversionComplete> <ConversionStart>dateTime</ConversionStart> <ConversionFinish>dateTime</ConversionFinish> <FromAddress>string</FromAddress> <ToNumber>string</ToNumber> <ClientID>int</ClientID> <TransmissionDate>dateTime</TransmissionDate> <Pages>int</Pages> <TransmissionStart>dateTime</TransmissionStart> <TransmissionComplete>dateTime</TransmissionComplete> <SendTo>string</SendTo> <SendHQ>boolean</SendHQ> <Charge>decimal</Charge> <DeleteData>boolean</DeleteData> <RetryDate>dateTime</RetryDate> <ConversionSize>int</ConversionSize> <Retries>int</Retries> <Subject>string</Subject> <TaskState>int</TaskState> </SendFaxAttachmentDetail> <SendFaxAttachmentDetail> <ID>int</ID> <SendFaxTransmissionID>int</SendFaxTransmissionID> <Status>string</Status> <FileName>string</FileName> <Error>boolean</Error> <TransmissionID>int</TransmissionID> <ConversionID>int</ConversionID> <ConversionComplete>boolean</ConversionComplete> <ConversionStart>dateTime</ConversionStart> <ConversionFinish>dateTime</ConversionFinish> <FromAddress>string</FromAddress> <ToNumber>string</ToNumber> <ClientID>int</ClientID> <TransmissionDate>dateTime</TransmissionDate> <Pages>int</Pages> <TransmissionStart>dateTime</TransmissionStart> <TransmissionComplete>dateTime</TransmissionComplete> <SendTo>string</SendTo> <SendHQ>boolean</SendHQ> <Charge>decimal</Charge> <DeleteData>boolean</DeleteData> <RetryDate>dateTime</RetryDate> <ConversionSize>int</ConversionSize> <Retries>int</Retries> <Subject>string</Subject> <TaskState>int</TaskState> </SendFaxAttachmentDetail> </SentFaxesResult> </SentFaxesResponse> </soap12:Body> </soap12:Envelope>