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 Pager Messages API

The Pager Messages API from RingCentral — 1 operation(s) for pager messages.

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

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

This API exposes 1 operation across 1 path, and defines 14 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.

1 operations 1 paths 14 schemas 1 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 Pager Messages 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 1

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

Pager Messages 1
POST
/restapi/v1.0/account/{accountId}/extension/{extensionId}/company-pager
Create Internal Text Message
createInternalTextMessage 2 params body → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are GetInternalTextMessageInfoResponse (17 properties), MessageStoreCallerInfoResponseTo (9 properties), MessageAttachmentInfo (9 properties), MessageStoreCallerInfoResponseFrom (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…
MessageStoreCallerInfoResponseTo
object
9 properties
MessageAttachmentTypeEnum
string
Type of message attachment
MessageStoreCallerInfoResponseFrom
object
Sender information
5 properties
MessagePriorityEnum
string
Message priority
GetInternalTextMessageInfoResponse
object
17 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…
MessageAttachmentInfo
object
9 properties
FaxErrorCodeEnum
string
CreateInternalTextMessageRequest
object
4 properties 1 required
MessageReadStatusEnum
string
Message read status
PagerCallerInfoRequest
object
Sender of a pager message.
2 properties
ConversationInfo
object
SMS and Pager only. Information about a conversation the message belongs to
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-pager-messages-api-openapi.yml Raw ↑

Other APIs RingCentral publishes across the network.

RingCentral SMS API
RingCentral Team Messaging API
RingCentral Video API
RingCentral Fax 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