VFMWebService


Click here for a complete list of operations.

ScheduleFaxBroadcast

This method schedules a fax broadcast. The list of FaxNumbers should be passed in comma-delimited, with the country code specified on ALL fax numbers (e.g. U.S. numbers should always begin with a 1). Do not put 011 in front of international numbers. If SkipDuplicateNumbers is set to True, duplicates will be eliminated prior to sending. FaxHeaderCompany and FaxHeaderFaxNumber specify what company name and fax number will appear in the header line of the fax. ListRemovalInstructions specifies what text should appear at the bottom of each fax page (if any). Passing in empty strings for any of these last three parameters will result in the default settings on the account being used.

Test

The test form is only available for requests from the local machine.

SOAP

The following is a sample SOAP request and response. The placeholders shown need to be replaced with actual values.

POST /vfmWebService.asmx HTTP/1.1
Host: client.myvfm.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://norskmessaging.com/VFM/ScheduleFaxBroadcast"

<?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>
    <ScheduleFaxBroadcast xmlns="http://norskmessaging.com/VFM/">
      <UserName>string</UserName>
      <Password>string</Password>
      <StartDateTime>dateTime</StartDateTime>
      <Reference>string</Reference>
      <FaxNumbers>string</FaxNumbers>
      <FileType>fftWord or fftExcel or fftText or fftRichText or fftJPEG or fftBitmap or fftPowerPoint or fftPublisher or fftTIFF or fftAcrobat or fftHTML or fftPNG</FileType>
      <File>base64Binary</File>
      <FileSize>int</FileSize>
      <Resolution>frStandard or frFine</Resolution>
      <SkipDuplicateNumbers>boolean</SkipDuplicateNumbers>
      <NotifyByEmailWhenComplete>boolean</NotifyByEmailWhenComplete>
      <FaxHeaderCompany>string</FaxHeaderCompany>
      <FaxHeaderFaxNumber>string</FaxHeaderFaxNumber>
      <ListRemovalInstructions>string</ListRemovalInstructions>
    </ScheduleFaxBroadcast>
  </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>
    <ScheduleFaxBroadcastResponse xmlns="http://norskmessaging.com/VFM/">
      <ScheduleFaxBroadcastResult>string</ScheduleFaxBroadcastResult>
      <BatchID>int</BatchID>
      <Estimate>double</Estimate>
      <ResultCode>brcSuccessful or brcUsernamePasswordIncorrect or brcNoAccountPaymentOption or brcInvalidOrCorruptFile or brcErrorInFaxNumberList or brcFileConversionFailure or brcUnknownFailure</ResultCode>
    </ScheduleFaxBroadcastResponse>
  </soap:Body>
</soap:Envelope>