Send a Fax and Retrieve the Sent Document
A 3-step recipe with RingCentral. We can help you get access.
Recipe · 3 steps
Send a Fax and Retrieve the Sent Document
with RingCentral
Send a fax, confirm transmission, and archive the sent document.
- Create the outbound fax. The attachment and cover page fields are submitted as multipart/form-data, which is the only content type this operation accepts.
- Read the fax back from the message store to inspect the aggregated transmission status. Repeat this step while the fax is still queued.
- Download the transmitted fax document from the message store so it can be archived alongside the transmission record.
What you'll need to have ready
- accountId: Internal identifier of the RingCentral account. Use "~" for the account associated with the current authorization session.
- extensionId: Internal identifier of the sending extension. Use "~" for the extension associated with the current authorization session.
- toPhoneNumber: Recipient fax number in E.164 format (e.g. +15551234567).
- attachment: The document to fax (PDF, DOC, TIFF, etc.), sent as a multipart file part.
- faxResolution: Fax resolution, either "High" or "Low".
- coverIndex: Index of the cover page template to use. Omit or set to 0 for no cover page.
- coverPageText: Text rendered onto the cover page.
- sendTime: Optional scheduled send time (ISO 8601). When omitted the fax is sent immediately.
For your developer
Arazzo workflow ringcentral:send-fax-confirm-delivery, 3 operations: createFaxMessage → readMessage → readMessageContent. Specs on APIs.io.