Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RingCentral Fax API

The Fax API from RingCentral — 2 operation(s) for fax.

RingCentral Fax API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Fax. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 2 operations across 2 paths, and defines 16 schemas. It is described by OpenAPI 3.0.3, at version 1.0.58-20240529-47eda8bd.

Requests are made against 4 base URLs: https://platform.ringcentral.com, https://media.ringcentral.com, https://platform.devtest.ringcentral.com, https://platform.devtest.ringcentral.com.

2 operations 2 paths 16 schemas 1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0.58-20240529-47eda8bd
Servers
https://platform.ringcentral.com
https://media.ringcentral.com
https://platform.devtest.ringcentral.com
https://platform.devtest.ringcentral.com
Authentication
OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 1

RingCentral Fax API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2) using the authorizationCode flow. By default, every request must be authenticated.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Fax 2
POST
/restapi/v1.0/account/{accountId}/extension/{extensionId}/fax
Create Fax Message
createFaxMessage 2 params body → 200
GET
/restapi/v1.0/dictionary/fax-cover-page
List Fax Cover Pages
listFaxCoverPages 2 params → 200

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are FaxResponse (17 properties), EnumeratedPagingModel (6 properties), MessageAttachmentInfoIntId (6 properties), FaxResponseTo (5 properties). Each schema is shown below with its type and property counts.

MessageDirectionEnum
string
Text message direction. Note that for some message types not all directions are allowed. For example voicemail messages can be only inbound
MessageAvailabilityEnum
string
Message availability status. Message in 'Deleted' state is still preserved with all its attachments and can be restored. 'Purged' means that all attachments ar…
MessageAttachmentInfoIntId
object
6 properties
EnumeratedPagingModel
object
6 properties 1 required
PageNavigationUri
object
1 property
FaxCoverPageInfo
object
2 properties
ListFaxCoverPagesResponse
object
4 properties
MessageStoreCallerInfoResponseFrom
object
Sender information
5 properties
MessageStatusEnum
string
Message status. Different message types may have different allowed status values. For outbound faxes the aggregated message status is returned. If, for outboun…
MessagePriorityEnum
string
Message priority
PageNavigationModel
object
Links to other pages of the current result set
4 properties
MessageReadStatusEnum
string
Message read status
FaxResponseTo
object
5 properties
FaxResponse
object
17 properties
FaxRequestTo
object
2 properties
FaxResolutionEnum
string
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-fax-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Data API
RingCentral Audio and Video AI API
RingCentral Call Log API
RingCentral Call Analytics API
RingCentral Presence API
RingCentral Voicemail API
RingCentral Provisioning API
RingCentral Webhooks and Subscriptions API
RingCentral Contact Center API