Example Request XML
OAuth 2.0 | ![]() |
---|---|
POST /fax/v5 HTTP/1.1 Authorization: Bearer {AccessToken} Content-Type: "application/soap+xml; charset=utf-8" Content-Length: length x-ch-request-id: "{optional unique identifier}" SOAPAction: "" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:FaxWS"> <soap:Body> <SendFaxBroadcast> <UserID>string</UserID> <strPIN></strPIN> <Recipients> <!—One or more repetitions:--> <item> <RecipFaxNumber>string</RecipFaxNumber> <RecipCompany>string</RecipCompany> <RecipTitle>string</RecipTitle> <RecipName>string</RecipName> <RecipSecureCSID>string</RecipSecureCSID> <RecipFirstName>string</RecipFirstName> <RecipLastName>string</RecipLastName> <RecipAddress1>string</RecipAddress1> <RecipAddress2>string</RecipAddress2> <RecipCity>string</RecipCity> <RecipState>string</RecipState> <RecipZipcode>string</RecipZipcode> <RecipCountry>string</RecipCountry> <RecipVoiceNumber>string</RecipVoiceNumber> <RecipField1>string</RecipField1> <RecipField2>string</RecipField2> <RecipField3>string</RecipField3> <RecipField4>string</RecipField4> <RecipField5>string</RecipField5> <RecipField6>string</RecipField6> <RecipField7>string</RecipField7> <RecipField8>string</RecipField8> <RecipField9>string</RecipField9> <RecipField10>string</RecipField10> <RecipField11>string</RecipField11> <RecipField12>string</RecipField12> </item> </Recipients> <FaxJobFiles> <!—One or more repetitions:--> <item> <FileIndex>int</FileIndex> <FileTypeId>int</FileTypeId> <FileData>base64Binary</FileData> </item> </FaxJobFiles> <JobDetails> <JobScheduleStartType>int</JobScheduleStartType> <JobScheduleStartDate>date/time string</JobScheduleStartDate> <JobExpiryDate>date/time string</JobExpiryDate> <ExceptionDestination>string</ExceptionDestination> <SoftwareClient>string</SoftwareClient> <SenderFax>string</SenderFax> <SenderCSID>string</SenderCSID> <SenderName>string</SenderName> <SenderCompany>string</SenderCompany> <SenderPhone>string</SenderPhone> <SenderAddress1>string</SenderAddress1> <SenderAddress2>string</SenderAddress2> <SenderCity>string</SenderCity> <SenderState>string</SenderState> <SenderZip>string</SenderZip> <SenderCountry>string</SenderCountry> <CoverName>string</CoverName> <CoverSubject>string</CoverSubject> <CoverText>string</CoverText> <Resolution>string</Resolution> <UserField1>string</UserField1> <UserField2>string</UserField2> <UserField3>string</UserField3> <UserField4>string</UserField4> <UserField5>string</UserField5> <UserField6>string</UserField6> <UserField7>string</UserField7> <UserField8>string</UserField8> <UserField9>string</UserField9> <UserField10>string</UserField10> <UserField11>string</UserField11> <UserField12>string</UserField12> </JobDetails> </SendFaxBroadcast> </soap:Body> </soap:Envelope> |
Username and password | ![]() |
---|---|
POST /fax/v5 HTTP/1.1 Content-Type: "application/soap+xml; charset=utf-8" Content-Length: length x-ch-request-id: "{optional unique identifier}" SOAPAction: "" <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:FaxWS"> <soap:Body> <SendFaxBroadcast> <UserID>string</UserID> <strPIN>string</strPIN> <Recipients> <!—One or more repetitions:--> <item> <RecipFaxNumber>string</RecipFaxNumber> <RecipCompany>string</RecipCompany> <RecipTitle>string</RecipTitle> <RecipName>string</RecipName> <RecipSecureCSID>string</RecipSecureCSID> <RecipFirstName>string</RecipFirstName> <RecipLastName>string</RecipLastName> <RecipAddress1>string</RecipAddress1> <RecipAddress2>string</RecipAddress2> <RecipCity>string</RecipCity> <RecipState>string</RecipState> <RecipZipcode>string</RecipZipcode> <RecipCountry>string</RecipCountry> <RecipVoiceNumber>string</RecipVoiceNumber> <RecipField1>string</RecipField1> <RecipField2>string</RecipField2> <RecipField3>string</RecipField3> <RecipField4>string</RecipField4> <RecipField5>string</RecipField5> <RecipField6>string</RecipField6> <RecipField7>string</RecipField7> <RecipField8>string</RecipField8> <RecipField9>string</RecipField9> <RecipField10>string</RecipField10> <RecipField11>string</RecipField11> <RecipField12>string</RecipField12> </item> </Recipients> <FaxJobFiles> <!—One or more repetitions:--> <item> <FileIndex>int</FileIndex> <FileTypeId>int</FileTypeId> <FileData>base64Binary</FileData> </item> </FaxJobFiles> <JobDetails> <JobScheduleStartType>int</JobScheduleStartType> <JobScheduleStartDate>date/time string</JobScheduleStartDate> <JobExpiryDate>date/time string</JobExpiryDate> <SenderCSID>string</SenderCSID> <SenderName>string</SenderName> <SenderCompany>string</SenderCompany> <SenderPhone>string</SenderPhone> <SenderAddress1>string</SenderAddress1> <SenderAddress2>string</SenderAddress2> <SenderCity>string</SenderCity> <SenderState>string</SenderState> <SenderZip>string</SenderZip> <SenderCountry>string</SenderCountry> <CoverName>string</CoverName> <CoverSubject>string</CoverSubject> <Resolution>string</Resolution> <UserField1>string</UserField1> <UserField2>string</UserField2> <UserField3>string</UserField3> <UserField4>string</UserField4> <UserField5>string</UserField5> <UserField6>string</UserField6> <UserField7>string</UserField7> <UserField8>string</UserField8> <UserField9>string</UserField9> <UserField10>string</UserField10> <UserField11>string</UserField11> <UserField12>string</UserField12> <ExceptionDestination>string</ExceptionDestination> <SenderFax>string</SenderFax> <SoftwareClient>string</SoftwareClient> <CoverText>string</CoverText> </JobDetails> </SendFaxBroadcast> </soap:Body> </soap:Envelope> |