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

Conversational AI audio processing APIs

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

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

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

8 operations 5 paths 24 schemas 1 DELETE2 GET1 PATCH4 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 Audio 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 8

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

Audio 8

Conversational AI audio processing APIs

GET
/ai/audio/v1/enrollments
List Enrolled Speakers
caiEnrollmentsList 3 params → 400200
POST
/ai/audio/v1/enrollments
Create Speaker Enrollment
caiEnrollmentsCreate body → 400409201
GET
/ai/audio/v1/enrollments/{speakerId}
Get Speaker Enrollment Status
caiEnrollmentsGet 1 param → 400404200
DELETE
/ai/audio/v1/enrollments/{speakerId}
Delete Speaker Enrollment
caiEnrollmentsDelete 1 param → 400404410204
PATCH
/ai/audio/v1/enrollments/{speakerId}
Update Speaker Enrollment
caiEnrollmentsUpdate 1 param body → 400404201
POST
/ai/audio/v1/async/speech-to-text
Speech to Text Conversion
caiSpeechToText 1 param body → 202400
POST
/ai/audio/v1/async/speaker-diarize
Speaker Diarization
caiSpeakerDiarize 1 param body → 202400
POST
/ai/audio/v1/async/speaker-identify
Speaker Identification
caiSpeakerIdentify 1 param body → 202400

Schemas 24

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

TranscribedObject
object
5 properties 2 required
WordSegment
object
5 properties 3 required
CaiErrorCodeResponse
object
3 properties 2 required
PagingSchema
object
3 properties 3 required
CaiAsyncApiResponse
object
1 property
ContentInput
object
1 property
DiarizedObject
object
2 properties 2 required
DiarizeInput
SpeechContextPhrasesInput
object
1 property 1 required
CaiErrorResponse
object
1 property
WordTimingsUnit
object
3 properties
SpeakerIdentificationObject
object
1 property 1 required
EnrollmentPatchInput
object
3 properties 2 required
IdentifyInput
1 required
DiarizeApiResponse
object
2 properties
AsrApiResponse
object
2 properties
UtteranceObject
object
6 properties 3 required
EnrollmentInput
3 required
ListEnrolledSpeakers
object
2 properties 2 required
AudioInput
2 required
DiarizeSegment
object
4 properties 3 required
AsrInput
EnrollmentStatus
object
5 properties 3 required
SpeakerIdentifyApiResponse
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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