CommunicationHub.API

<back to all web services

SendFax

The following routes are available for this service:
POST/Fax/Send
SendFax Parameters:
NameParameterData TypeRequiredDescription
ReceiverbodystringNo
Filebodybyte[]No
SubjectbodystringNo
ReferencebodystringNo
ReceiverNamebodystringNo
SendResponse Parameters:
NameParameterData TypeRequiredDescription
MessageIdformstringNo
SenderformstringNo
ReceiverformstringNo
StatusformStatusNo
ErrorMessageformstringNo
ConfigurationformstringNo
RetryformboolNo
RetryCountformintNo
Status Enum:
accepted
queued
sending
sent
failed
delivered
undelivered
receiving
received
read
pickedup
unknown

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Fax/Send HTTP/1.1 
Host: communicationhub.carelogic-cloud.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Receiver: String,
	File: AA==,
	Subject: String,
	Reference: String,
	ReceiverName: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	MessageId: String,
	Sender: String,
	Receiver: String,
	Status: accepted,
	ErrorMessage: String,
	Configuration: String,
	Retry: False,
	RetryCount: 0
}