How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

RingCentral High Volume SMS API

The High Volume SMS API from RingCentral — 7 operation(s) for high volume sms.

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

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

This API exposes 8 operations across 7 paths, and defines 19 schemas. It is described by OpenAPI 3.2.0, 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.

8 operations 7 paths 19 schemas 6 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
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 High Volume SMS 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 8

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

High Volume SMS 8
GET
/restapi/v1.0/account/{accountId}/a2p-sms/statuses
List A2P SMS Statuses
aggregateA2PSMSStatuses 6 params → 200400401404500
GET
/restapi/v1.0/account/{accountId}/a2p-sms/messages
List A2P SMS Messages
listA2PSMS 9 params → 200400401404500
GET
/restapi/v1.0/account/{accountId}/a2p-sms/messages/{messageId}
Get A2P SMS
readA2PSMS 2 params → 200400401404500
GET
/restapi/v1.0/account/{accountId}/a2p-sms/opt-outs
List Opted Out Numbers
readA2PSMSOptOuts 6 params → 200400401404500
POST
/restapi/v1.0/account/{accountId}/a2p-sms/opt-outs/bulk-assign
Add Opt-In/Out Numbers
addA2PSMSOptOuts 1 param body → 200400500
POST
/restapi/v1.0/account/{accountId}/a2p-sms/batches
Send A2P SMS
createA2PSMS 1 param body → 201400401500
GET
/restapi/v1.0/account/{accountId}/a2p-sms/batches
List A2P SMS Batches
listA2PBatches 7 params → 200400401404500
GET
/restapi/v1.0/account/{accountId}/a2p-sms/batches/{batchId}
Get A2P SMS Batch
readA2PBatch 2 params → 200400401404500

Schemas 19

The contract defines 19 schemas that model the data the API accepts and returns. The most detailed are MessageDetailsResponse (12 properties), MessageListMessageResponse (12 properties), MessageBatchResponse (9 properties), MessageStatusesResponse (5 properties). Each schema is shown below with its type and property counts.

MessageBatchCreateRequest
object
Batch of A2P SMS messages. This object provides specification to send message(s) to many recipients. It contains top-level attributes, such as text which apply…
3 properties 2 required
OptOutBulkAssignResponse
object
The results of adding opt-outs and opt-ins
2 properties
MessageStatusesResponse
object
The messages status object with details of each status
5 properties
SmsStatusEnum
string
Current status of a message
MessageStatusCounts
object
Message status parameters
3 properties
PagingResource
object
Pagination details
5 properties
ASGErrorResponse
object
Error response
2 properties 2 required
SmsDirectionEnum
string
Direction of the SMS message
OptOutBulkAssignRequest
object
Consists of from field and optOuts and optIns lists. Both optOuts and optIns can be empty but not simultaneously - at least one of the lists must be entered."
3 properties 1 required
OptOutBulkAssignFailedEntry
object
Represents a failure of adding opt-out / opt-in. A pair of a recipient phone number and an error message
2 properties
MessageCreateRequest
object
Single individual SMS resource
2 properties 1 required
BatchListResponse
object
The list of batches retrieved for an account and other filter criteria such as fromPhoneNumber, date specified in the request.
2 properties
MessageListResponse
object
List of messages retrieved for an account and other filter criteria such as batchId and fromPhoneNumber specified in the request
2 properties
MessageListMessageResponse
object
The short detail of the message in the get batch response
12 properties
OptOutResponse
object
Opt-out record
4 properties
MessageBatchResponse
object
Batch of A2P SMS messages. This object provides a specification to send message(s) to many recipients. It contains top-level attributes which apply to all mess…
9 properties
OptOutListResponse
object
The list of opt outs
2 properties
MessageDetailsResponse
object
Complete details of the message
12 properties
RejectedRecipientResponseResource
object
The rejected recipient details
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-high-volume-sms-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
Where this information came from

This is an independent, third-party profile of RingCentral High Volume SMS API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.