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:Header/>
<soap:Body>
<SendFaxEx>
<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>
</item>
</Recipients>
<FaxJobFiles>
<!—One or more repetitions:-->
<item>
<FileIndex>int</FileIndex>
<FileTypeId>int</FileTypeId>
<FileData>base64Binary</FileData>
</item>
</FaxJobFiles>
<JobDetails>
<JobScheduleStartType>Int</JobScheduleStartType>
<JobScheduleStartDate>String</JobScheduleStartDate>
<JobExpiryDate>string</JobExpiryDate>
<SenderCSID>string</SenderCSID>
<SenderName>string</SenderName>
<SenderCompany>string</SenderCompany>
<SenderPhone>string</SenderPhone>
<CoverText>string</CoverText>
<CoverName> string </CoverName>
<CoverSubject>string</CoverSubject>
<ReferenceId>string</ReferenceId>
<Resolution>string</Resolution>
<SenderFax>string</SenderFax>
<SoftwareClient>string</SoftwareClient>
<NotifyType>int</NotifyType>
<NotifyIncludeDeliveredImage>int</NotifyIncludeDeliveredImage>
<NotifyDestination>string</NotifyDestination>
<NotifyAuthUser>string</NotifyAuthUser>
<NotifyAuthPassword>String</NotifyAuthPassword>
</JobDetails>
</SendFaxEx>
</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:Header/>
<soap:Body>
<SendFaxEx>
<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>
</item>
</Recipients>
<FaxJobFiles>
<!—One or more repetitions:-->
<item>
<FileIndex>int</FileIndex>
<FileTypeId>int</FileTypeId>
<FileData>base64Binary</FileData>
</item>
</FaxJobFiles>
<JobDetails>
<JobScheduleStartType>Int</JobScheduleStartType>
<JobScheduleStartDate>String</JobScheduleStartDate>
<JobExpiryDate>string</JobExpiryDate>
<SenderCSID>string</SenderCSID>
<SenderName>string</SenderName>
<SenderCompany>string</SenderCompany>
<SenderPhone>string</SenderPhone>
<CoverText>string</CoverText>
<CoverName> string </CoverName>
<CoverSubject>string</CoverSubject>
<ReferenceId>string</ReferenceId>
<Resolution>string</Resolution>
<SenderFax>string</SenderFax>
<SoftwareClient>string</SoftwareClient>
<NotifyType>int</NotifyType>
<NotifyIncludeDeliveredImage>int</NotifyIncludeDeliveredImage>
<NotifyDestination>string</NotifyDestination>
<NotifyAuthUser>string</NotifyAuthUser>
<NotifyAuthPassword>String</NotifyAuthPassword>
</JobDetails>
</SendFaxEx>
</soap:Body>
</soap:Envelope> | |