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

Conversational AI async job status

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

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

This API exposes 1 operation across 1 path, and defines 33 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.

1 operations 1 paths 33 schemas 1 GET

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 Status 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 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

Status 1

Conversational AI async job status

GET
/ai/status/v1/jobs/{jobId}
Get Async Task Status
caiJobStatusGet 1 param → 400404200

Schemas 33

The contract defines 33 schemas that model the data the API accepts and returns. The most detailed are ConversationalInsightsUnitValues (11 properties), UtteranceInsightsObject (7 properties), UtteranceObject (6 properties), TranscribedObject (5 properties). Each schema is shown below with its type and property counts.

InteractionObject
object
3 properties
TranscribedObject
object
5 properties 2 required
UtteranceInsightsUnit
object
3 properties 2 required
SummaryApiOutput
object
2 properties
SummaryApiResponse
WordSegment
object
5 properties 3 required
CaiErrorCodeResponse
object
3 properties 2 required
UtteranceInsightsObject
object
7 properties 3 required
SpeakerInsightsUnit
object
2 properties 2 required
EmotionSegment
object
4 properties 3 required
SpeakerInsightsValuesItems
object
2 properties 2 required
DiarizedObject
object
2 properties 2 required
CaiErrorResponse
object
1 property
WordTimingsUnit
object
3 properties
SpeakerIdentificationObject
object
1 property 1 required
SpeakerInsightsObject
object
2 properties
EmotionApiResponse
object
2 properties
SummaryOutputUnit
object
2 properties
PunctuateApiResponse
DiarizeApiResponse
object
2 properties
AsrApiResponse
object
2 properties
ConversationalInsightsUnitValues
object
11 properties 3 required
SummaryTimingsUnit
object
4 properties 1 required
JobStatusResponse
ConversationalInsightsUnit
object
2 properties 2 required
EmotionObject
array
PunctuateApiOutput
object
2 properties
UtteranceObject
object
6 properties 3 required
DiarizeSegment
object
4 properties 3 required
PunctuateOutput
object
1 property 1 required
SummaryOutput
object
1 property
InteractionApiResponse
object
2 properties
SpeakerIdentifyApiResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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