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 Call Blocking API

The Call Blocking API from RingCentral — 3 operation(s) for call blocking.

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

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

This API exposes 7 operations across 3 paths, and defines 15 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.

7 operations 3 paths 15 schemas 1 DELETE3 GET1 POST2 PUT

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 Call Blocking 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 7

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

Call Blocking 7
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking
Get Caller Blocking Settings
readCallerBlockingSettings 2 params → 200404500503
PUT
/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking
Update Caller Blocking Settings
updateCallerBlockingSettings 2 params body → 200400404500503
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers
List Blocked/Allowed Phone Numbers
listBlockedAllowedNumbers 5 params → 200400404500503
POST
/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers
Add Blocked/Allowed Number
createBlockedAllowedNumber 2 params body → 200400404500503
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{blockedNumberId}
Get Blocked/Allowed Number
readBlockedAllowedNumber 3 params → 200404500503
PUT
/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{blockedNumberId}
Update Blocked/Allowed Number
updateBlockedAllowedNumber 3 params body → 200400404500503
DELETE
/restapi/v1.0/account/{accountId}/extension/{extensionId}/caller-blocking/phone-numbers/{blockedNumberId}
Delete Blocked/Allowed Number
deleteBlockedAllowedNumber 3 params → 204404500503

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are EnumeratedPagingModel (6 properties), BlockedAllowedPhoneNumberInfo (5 properties), CallerBlockingSettings (4 properties), CallerBlockingSettingsUpdate (4 properties). Each schema is shown below with its type and property counts.

BlockedAllowedPhoneNumbersList
object
List of blocked or allowed phone numbers
4 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 properties 2 required
PageNavigationUri
object
1 property
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
EnumeratedPagingModel
object
6 properties 1 required
PageNavigationModel
object
Links to other pages of the current result set
4 properties
BlockedAllowedPhoneNumberInfo
object
Information on a blocked/allowed phone number
5 properties
AddBlockedAllowedPhoneNumber
object
Updates either blocked or allowed phone number list with a new phone number.
3 properties
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
BlockedCallerGreetingInfo
object
2 properties
CallerBlockingSettingsUpdate
object
Returns the lists of blocked and allowed phone numbers
4 properties
CallerBlockingSettings
object
Returns the lists of blocked and allowed phone numbers
4 properties
BlockedNumberStatusEnum
string
Status of a phone number
PresetInfo
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-call-blocking-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