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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Kin Lane

Chat with Kin

AI assistant · trained on my blog

RingCentral

RingCentral High Volume SMS API

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

Provider Profile APIs.io OpenAPI GitHub

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.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.

8 operations 7 paths 19 schemas 6 GET2 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
Contact
RingCentral Developers Support
License
RingCentral API License Agreement
Terms of Service
View terms
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 MessageListMessageResponse (12 properties), MessageDetailsResponse (12 properties), MessageBatchResponse (9 properties), PagingResource (5 properties). Each schema is shown below with its type and property counts.

OptOutListResponse
object
The list of opt outs
2 properties
SmsDirectionEnum
string
Direction of the SMS message
RejectedRecipientResponseResource
object
The rejected recipient details
4 properties
MessageStatusesResponse
object
The messages status object with details of each status
5 properties
MessageCreateRequest
object
Single individual SMS resource
2 properties 1 required
OptOutBulkAssignResponse
object
The results of adding opt-outs and opt-ins
2 properties
OptOutResponse
object
Opt-out record
4 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
MessageDetailsResponse
object
Complete details of the message
12 properties
MessageStatusCounts
object
Message status parameters
3 properties
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
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
ASGErrorResponse
object
Error response
2 properties 2 required
MessageListMessageResponse
object
The short detail of the message in the get batch response
12 properties
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
PagingResource
object
Pagination details
5 properties
BatchListResponse
object
The list of batches retrieved for an account and other filter criteria such as fromPhoneNumber, date specified in the request.
2 properties
OptOutBulkAssignFailedEntry
object
Represents a failure of adding opt-out / opt-in. A pair of a recipient phone number and an error message
2 properties
SmsStatusEnum
string
Current status of a message

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
AE Profile APIs.io
RingCentral Team Messaging API
AE Profile APIs.io
RingCentral Video API
AE Profile APIs.io
RingCentral Fax API
AE Profile APIs.io
RingCentral Data API
AE Profile APIs.io
RingCentral Audio and Video AI API
AE Profile APIs.io
RingCentral Call Log API
AE Profile APIs.io
RingCentral Call Analytics API
AE Profile APIs.io
RingCentral Presence API
AE Profile APIs.io
RingCentral Voicemail API
AE Profile APIs.io
RingCentral Provisioning API
AE Profile APIs.io
RingCentral Webhooks and Subscriptions API
AE Profile APIs.io
#High Volume SMS
← Back to R APIs
API Details
ID
ringcentral:ringcentral-high-volume-sms-api
Server
https://platform.ringcentral.com
Provider
RingCentral
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network