10/15/18 21:15 PM  

Fax - Send Fax Web API (FaxOut API) | RingCentral

« Go Back

Article

 
SummaryWhat is the FaxOut API?
Details

Send Fax Web API is based on a single HTTP POST request with multipart/form-data body through which un-rendered fax data is passed to the web. An appropriate response containing request execution result should be returned back to requesting application. The response only says if the fax has been accepted or not. Sending status will be provided to user by email. HTTPS protocol is proposed for using with Send Fax Web API for better security.
 

1. Request format

List of recipients, documents, send options etc are considered as separate multipart/form-data body-parts of the request body.
 
FieldDescription 
UsernameDescription:Represents user phone number and extension
Possible values: 
Format:ASCII string in full format that includes the country code <phonenumber>[*<extension>.]. If a user uses master account then extension part is not passed.
Number of occurrences:one
PasswordDescription:Represents user password
Possible values: 
Format:ASCII string
Number of occurrences:no more then one
RecipientDescription:Represents single fax recipient and consists of pair phone number and name
Possible values:Recipient number is mandatory, recipient name is optional.
Format:ASCII string, passed as in following format: <recipient number>|<recipient name> ("|" character is a separator)
Number of occurrences:more or equal then one
CoverpageDescription:Name of fax cover page.
Possible values:- None. Cover page is not used
- Default. Default cover page
- <Name> - name of a cover page. Should correspond to one of the cover pages installed on rendering server.
If parameter is not specified or its value is empty then default cover page will be used. There should only one coverpage parameter in request.
Format:ASCII string
Number of occurrences:no more then one
CoverpagetextDescription:Represents text printed on fax cover page.
Possible values: 
Format:ASCII string.
Number of occurrences:no more then one
ResolutionDescription:Represents resolution in which fax will be sent to recipients.
Possible values:- Low
- High
Format:ASCII string.
Number of occurrences:no more then one
SendtimeDescription:Schedule time.
Possible values:GMT time in format dd:mm:yy hh:mm If parameter is not specified or invalid then send time is considered to current time so fax will be send as soon as possible.
Format:ASCII string.
Number of occurrences:no more then one
AttachmentDescription:Document to be faxed.
Possible values:Original document file name must be passed in the filename field of the body-part header.
Format:Binary stream.
Number of occurrences:any.
 

2. Response format

Response returns request processing status as an integer value. Possible value can be on of the following:
0 - Successful
1 - Authorization failed
2 - Faxing is prohibited for the account
3 - No recipients specified
4 - No fax data specified
5 - Generic error

 

Request body example

Content-Type: multipart/form-data; boundary=---------------------------7d54b1fee05aa

-----------------------------7d54b1fee05aa
Content-Disposition: form-data; name="Username"

15556090455
-----------------------------7d54b1fee05aa
Content-Disposition: form-data; name="Password"

qwerty
-----------------------------7d54b1fee05aa
Content-Disposition: form-data; name="Attachment"; filename="C:\example.doc"
<Document content is here>
-----------------------------7d54b1fee05aa
Content-Disposition: form-data; name="Recipient"

5556465589|John Doe
-----------------------------7d54b1fee05aa
Content-Disposition: form-data; name="Recipient"

5555568552|John Smith
-----------------------------7d54b1fee05aa
Content-Disposition: form-data; name="Coverpagetext"

This is a test fax from web
-----------------------------7d54b1fee05aa--
Response
0
 

RingCentral API Guide

You will find useful references and detailed information to help you get started working in the RingCentral Connect Platform and create your own RingCentral powered app on the RingCentral Developers page

To get detailed, step-by-step instructions for setting up the FAX API, open the RingCentral Developer Guide, and then look for Fax under the Messages section.

See Also:
Fax Frequently Asked Questions 
Fax Troubleshooting Checklist 
Resolving Partially Received Faxes 
Ranking100
Was this information helpful?
Yes
No
Somewhat

Tell us why and what can we do to improve this information