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 RingOut API

The RingOut API from RingCentral — 2 operation(s) for ringout.

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

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

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

3 operations 2 paths 7 schemas 1 DELETE1 GET1 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 RingOut 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 3

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

RingOut 3
POST
/restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out
Make RingOut Call
createRingOutCall 2 params body → 200
GET
/restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId}
Get RingOut Call Status
readRingOutCallStatus 3 params → 200
DELETE
/restapi/v1.0/account/{accountId}/extension/{extensionId}/ring-out/{ringoutId}
Cancel RingOut Call
deleteRingOutCall 3 params → 204

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are MakeRingOutRequest (5 properties), GetRingOutStatusResponse (3 properties), RingOutStatusInfo (3 properties), MakeRingOutCallerInfoRequestFrom (2 properties). Each schema is shown below with its type and property counts.

MakeRingOutCallerInfoRequestFrom
object
Phone number of a caller. This number corresponds to the 1st leg of a RingOut call. This number can be one of the user's configured forwarding numbers or an ar…
2 properties
MakeRingOutCallerIdInfo
object
Phone number which will be displayed to the called party
1 property
RingOutStatusInfo
object
RingOut status information
3 properties
GetRingOutStatusResponse
object
3 properties
MakeRingOutRequest
object
5 properties 2 required
MakeRingOutCallerInfoRequestTo
object
Phone number of a called party. This number corresponds to the 2nd leg of a RingOut call
1 property
MakeRingOutCountryInfo
object
Optional. Dialing plan country data. If not specified, then an extension home country is applied by default
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-ringout-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