RingCentral SMS Templates API is one of 88 APIs that RingCentral publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include SMS Templates. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
10 operations
across 4 paths,
and defines 10 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.
10 operations4 paths10 schemas2 DELETE4 GET2 POST2 PUT
Metadata
The identity and technical contract details declared by the specification.
RingCentral SMS Templates 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 10
Across 4 paths, the API surfaces 10 operations — 2 DELETE, 4 GET, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.
The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are MessageTemplateResponse (5 properties), MessageTemplateRequest (3 properties), ApiError (2 properties), Site (2 properties). Each schema is shown below with its type and property counts.
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property1 required
MessageTemplatesListResponse
object
1 property
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property1 required
TemplateInfo
object
Text message template information
1 property1 required
VisibilityType
string
Specifies if a template is available on a user (Personal) or a company (Company) level
Site
object
Specifies a site that message template is associated with. Supported only if the Sites feature is enabled. The default is main-site value.
2 properties
MessageTemplateResponse
object
5 properties
ApiErrorWithParameter
The error model with additional attributes which can be used for HTTP 400/409 This is a deprecated model: "ApiError" model can be used instead with arbitrary a…
ApiError
object
Generalized API error structure suitable for any error type
2 properties2 required
MessageTemplateRequest
object
3 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
