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

The Call Control API from RingCentral — 21 operation(s) for call control.

RingCentral Call Control 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 Control. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 24 operations across 21 paths, and defines 46 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.

24 operations 21 paths 46 schemas 2 DELETE2 GET2 PATCH18 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 Call Control 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 24

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

Call Control 24
POST
/restapi/v1.0/account/{accountId}/telephony/call-out
Make CallOut
createCallOutCallSession 1 param body → 201503
POST
/restapi/v1.0/account/{accountId}/telephony/conference
Start Conference Call Session
createConferenceCallSession 1 param → 201403404409500503
GET
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}
Get Call Session Status
readCallSessionStatus 4 params → 200403404500503
DELETE
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}
Drop Call Session
deleteCallSession 2 params → 204403404500503
POST
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/bring-in
Bring-In Call Party
createCallPartyWithBringIn 2 params body → 201400403404409500503
GET
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}
Get Call Party Status
readCallPartyStatus 3 params → 200403404500503
DELETE
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}
Delete Call Party
deleteCallParty 3 params → 204403404500503
PATCH
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}
Update Call Party
updateCallParty 3 params body → 200400403404409500503
POST
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/unhold
Un-hold Call Party
unholdCallParty 3 params → 200403404409500503
POST
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/park
Call Park
callParkParty 3 params → 201400403404409500503
POST
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/flip
Call Flip on Party
callFlipParty 3 params body → 200400403404409500503
POST
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/reply
Reply with Text
replyParty 3 params body → 200400403404409500503
POST
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/bridge
Bridge Call Party
bridgeCallParty 3 params body → 200400403404409500503
POST
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/ignore
Ignore Call in Queue
ignoreCallInQueue 3 params body → 204400403404409500503
POST
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/supervise
Supervise Call Party
superviseCallParty 3 params body → 201400404409500503
POST
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/reject
Reject Call Party
rejectParty 3 params → 204400403404409500503
POST
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/recordings
Create Recording
startCallRecording 3 params → 201400403404409500503
PATCH
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/recordings/{recordingId}
Pause/Resume Recording
pauseResumeCallRecording 5 params body → 200400403404409500503
POST
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/answer
Answer Call Party
answerCallParty 3 params body → 200400403404409500503
POST
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/transfer
Transfer Call Party
transferCallParty 3 params body → 200400403404409500503
POST
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/hold
Hold Call Party
holdCallParty 3 params body → 200403404409500503
POST
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/pickup
Pickup Call
pickupCallParty 3 params body → 201400403404409500503
POST
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/parties/{partyId}/forward
Forward Call Party
forwardCallParty 3 params body → 200400403404409500503
POST
/restapi/v1.0/account/{accountId}/telephony/sessions/{telephonySessionId}/supervise
Supervise Call Session
superviseCallSession 2 params body → 201400403404409500503

Schemas 46

The contract defines 46 schemas that model the data the API accepts and returns. The most detailed are ForwardCallPartyResponse (13 properties), CallParty (13 properties), PartySuperviseResponse (10 properties), SuperviseCallSessionResponse (10 properties). Each schema is shown below with its type and property counts.

TelephonySessionsEventPartyInfo
object
7 properties
CallPartyInfo
object
3 properties
PartySuperviseResponse
object
10 properties
PartyUpdateRequest
object
1 property
ExtensionTelephonySessionsEvent
object
6 properties
ParkInfo
object
Call park information
1 property
PartyInfo
object
4 properties
CallSession
object
1 property
CallPartyReply
object
2 properties
CallRecordingUpdate
object
1 property
CallPartyFlip
object
1 property
TransferTarget
object
Identifier of a call party the call will be transferred to. Only one of these parameters: phoneNumber, voicemail, extensionNumber or parkOrbit must be specifie…
4 properties
TelephonySessionsEventBody
object
Notification payload body
7 properties
ParameterizedErrorResponseModel
object
Standard error response which may include parameterized errors
1 property 1 required
MakeCallOutRequest
object
3 properties 2 required
IgnoreRequestBody
object
1 property 1 required
AnswerTarget
object
1 property
PeerInfo
object
Peer session/party details. Valid in 'Gone' state of a call
3 properties
MobilePickupData
object
5 properties
PartySuperviseRequest
object
5 properties 3 required
CountryId
integer
Optional. Dialing plan country data. If not specified, then extension home country is applied by default.
PartyUpdateInfo
object
Party update data
2 properties
ApiError
object
Generalized API error structure suitable for any error type
2 properties 2 required
ForwardTarget
object
Identifier of a call party the call will be forwarded to. Only one of these parameters: phoneNumber, voicemail or extensionNumber must be specified, otherwise…
3 properties
CallParty
object
Information on a party of a call session
13 properties
AccountTelephonySessionsEvent
object
6 properties
OwnerInfo
object
Deprecated. Information on a call owner
2 properties
CallRecording
object
2 properties
ReplyParty
object
9 properties
RecordingInfo
object
2 properties
ApiErrorResponseModel
object
Standard error response model which is returned in case of any unsuccessful operation
1 property 1 required
CallSessionStatusInfo
object
5 properties
MakeCallOutCallerInfoRequestFrom
object
Instance id of the caller. It corresponds to the 1st leg of the CallOut call.
1 property
SuperviseCallSessionResponse
object
10 properties
ReplyWithPattern
object
3 properties
AddPartyRequest
object
2 properties 2 required
BridgeTargetRequest
object
2 properties 2 required
MakeCallOutCallerInfoRequestTo
object
Phone number of the called party. This number corresponds to the 2nd leg of a CallOut call
2 properties
CallSessionObject
object
Call session information
5 properties
OriginInfo
object
Session origin details
1 property
HoldCallPartyRequest
object
1 property
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…
PickupTarget
object
1 property 1 required
ForwardCallPartyResponse
object
Information on a party of a call session
13 properties
CallStatusInfo
object
Status data of a call session
4 properties
SuperviseCallSessionRequest
object
5 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ringcentral-call-control-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 Call Control 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.