---
title: "Create Fax Message"
method: POST
path: "/restapi/v1.0/account/{accountId}/extension/{extensionId}/fax"
tags: ["Fax"]
---

# Create Fax Message

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

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.

## Path parameters

- `accountId` string, required
- `extensionId` string, required

## Response `200`

Fax message

- FaxResponse
  - `id` integer — Internal identifier of a message
  - `uri` string, uri — Canonical URI of a message
  - `type` 'Fax' — Message type - 'Fax'
  - `from` MessageStoreCallerInfoResponseFrom — Sender information
    - `extensionNumber` string — Extension short number (usually 3 or 4 digits). This property is filled when parties communicate by means of short internal numbers, for example when calling to other extension or sending/receiving Company Pager message
    - `extensionId` string — Internal identifier of an extension
    - `location` string — Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)
    - `name` string — Symbolic name associated with a party. If the phone does not belong to the known extension, only the location is returned, the name is not determined then
    - `phoneNumber` string — Phone number of a party. Usually it is a plain number including country and area code like 18661234567. But sometimes it could be returned from database with some formatting applied, for example (866)123-4567. This property is filled in all cases where parties communicate by means of global phone numbers, for example when calling to direct numbers or sending/receiving SMS
  - `to` FaxResponseTo[] — Recipient information
    - `recipientId` string — Internal identifier of a fax recipient
    - `phoneNumber` string — Phone number in E.164 (with '+' sign) format
    - `name` string — Name of a fax recipient listed on a fax cover page
    - `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
    - `location` string — Contains party location (city, state) if one can be determined from phoneNumber. This property is filled only when phoneNumber is not empty and server can calculate location information from it (for example, this information is unavailable for US toll-free numbers)
  - `creationTime` string, 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
  - `attachments` MessageAttachmentInfoIntId[] — List of message attachments
    - `id` integer — Internal identifier of a message attachment
    - `uri` string, uri — Canonical URI of a message attachment
    - `type` 'AudioRecording' | 'AudioTranscription' | 'Text' | 'SourceDocument' | 'RenderedDocument' | 'MmsAttachment' — Type of message attachment
    - `contentType` string — MIME type for a given attachment, for instance 'audio/wav'
    - `filename` string — Name of a file attached
    - `size` integer — Size of an attachment in bytes
  - `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
  - `faxPageCount` integer — Page count in a fax message
  - `lastModifiedTime` string, 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
  - `coverIndex` integer — 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')
  - `coverPageText` string — Cover page text, entered by a fax sender and printed on a cover page. Maximum length is limited to 1024 symbols

---

[API](https://skmtc.net/ringcentral/apis/ringcentral-api.md) · [All operations](https://skmtc.net/ringcentral/apis/ringcentral-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ringcentral/ringcentral-api/revisions/8d602198ec97/schema)