Sign in

v1

latestOpenAPI 3.0.3RingCentral API License Agreement2026-08-064871,2921.5 MB
Fax

Create Fax Message

Creates and sends/re-sends a fax message. Re-send can be implemented if sending has failed. Fax attachment size (both single and total) is limited to 50Mb.

post/restapi/v1.0/account/{accountId}/extension/{extensionId}/fax

Path parameters

accountIdstring required

Internal identifier of the RingCentral account (can be set to "~" to indicate that the account associated with current authorization session should be used)

extensionIdstring required

Internal identifier of the RingCentral extension/user (can be set to "~" to indicate that the extension associated with current authorization session should be used)

Response

Fax message

idinteger

Internal identifier of a message

uristring uri

Canonical URI of a message

type'Fax'

Message type - 'Fax'

creationTimestring date-time

Message creation date/time in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z

readStatus'Read' | 'Unread'

Message read status

priority'Normal' | 'High'

Message priority

direction'Inbound' | 'Outbound'

Text message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound

availability'Alive' | 'Deleted' | 'Purged'

Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments are already deleted and the message itself is about to be physically deleted shortly

messageStatus'Queued' | 'Sent' | 'Delivered' | 'DeliveryFailed' | 'SendingFailed' | 'Received'

Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned. If, for outbound message, a status for at least one recipient is 'Queued', then the 'Queued' value is returned. If a status for at least one recipient is 'SendingFailed', then the 'SendingFailed' value is returned. In other cases the 'Sent' status is returned

faxResolution'High' | 'Low'

Fax only. Resolution of a fax message. 'High' for black and white image scanned at 200 dpi, 'Low' for black and white image scanned at 100 dpi

faxPageCountinteger

Page count in a fax message

lastModifiedTimestring date-time

Date/time when the message was modified on server in ISO 8601 format including timezone, for example 2016-03-10T18:07:52.534Z

coverIndexinteger

Cover page identifier. If coverIndex is set to '0' (zero), a cover page is not attached. For a list of available cover page identifiers (1-13) please call the Fax Cover Pages method. If not specified, the default cover page is attached (which is configured in 'Outbound Fax Settings')

coverPageTextstring

Cover page text, entered by a fax sender and printed on a cover page. Maximum length is limited to 1024 symbols

Example response

{
  "to": [
    {
      "phoneNumber": "+18661234567"
    }
  ]
}