logo
API docs by Redocly

Cloud recording (1.0)

This is the API reference for Aircore cloud recording.

With cloud recording, you can record audio for a channel🔗 and save it to cloud storage. This feature works with all Aircore SDKs that support audio.

Aircore uploads recordings as .m4a files with AAC encoding.

See the Quickstart🔗 for a sample workflow.

Start a recording

Use this endpoint to start a recording.

To find the recorded file, use a unique value for filename or callback_url in the request body.

Authorizations:
BearerAuth
Request Body schema: application/json
required
object
required
object (Location)

Location for selecting the recording server. To minimize latency, use the most accurate location you can, such as:

  • The client device that started the recording
  • Your closest server
  • The general region of your clients
user_id
required
string

ID for the user who initiated recording.

channel_id
required
string

ID for the channel🔗 to record.

callback_url
string

Unique callback URL for updates on the recording. See callbacks for more info.

Responses

Callbacks

Request samples

Content type
application/json
{
  • "storage": {
    },
  • "location": {
    },
  • "user_id": "4a1c5943-994e-4c2b-a717-7f6ff42c5396",
  • "channel_id": "9a01c703-48db-4101-ad8a-c907f04f0c3a",
  • "callback_url": "https://yourserver.com/recordings?id=2348723149"
}

Response samples

Content type
application/json
{}

Callback payload samples

Callback
Content type
application/json
{}

Stop a recording

Use this endpoint to stop a recording. Recording also stops automatically if all users leave the channel.

This DELETE request stops the recording resource. It does not delete the recording.

The response when you start a recording provides the full URL for this request, including the UNIQUE_IDENTIFIER.

Authorizations:
BearerAuth

Responses