Start conference recording

POST

api

Account

{auth_id}

Conference

{conference_name}

Record

Start conference recording

curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Record/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "file_format": "mp3",
  "callback_url": "<string>"
}
'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Record/"

payload = {
    "file_format": "mp3",
    "callback_url": "<string>"
}
headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Auth-ID': '<api-key>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({file_format: 'mp3', callback_url: '<string>'})
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Record/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "message": "async api spawned",
  "api_id": "API_REQUEST_ID"
}

POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Record/

Start recording an active conference. The recording captures conference audio and continues until you stop it or the conference ends.

Legal notice - Ensure you comply with local recording consent laws. Consider playing an announcement to participants before starting the recording.

Path parameters

Parameter	Type	Required	Description
`auth_id`	string	Yes	Your Vobiz account ID
`conference_name`	string	Yes	Name of the conference to record

Request parameters

Field	Type	Required	Description
`file_format`	string	No	Recording format. Values: `mp3`, `wav`. Default: `mp3`
`callback_url`	string	No	URL to receive the recording completion callback.

Example requests

curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/MyConf/Record/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json"

curl -X POST https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/MyConf/Record/ \
  -H "X-Auth-ID: YOUR_AUTH_ID" \
  -H "X-Auth-Token: YOUR_AUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "file_format": "wav",
    "callback_url": "https://yourapp.example/recording-complete"
  }'

Response

200 OK

{
  "message": "async api spawned",
  "api_id": "API_REQUEST_ID"
}

The response confirms that Vobiz queued the recording operation. It does not include a recording ID or download URL.

Error responses

Status	Meaning	How to handle
`401 Unauthorized`	Missing/incorrect auth headers or a lowercase path.	Use both auth headers and the PascalCase path.
`404 Not Found`	The conference does not exist (no participant has joined the room yet).	Conferences are created on join via the `<Conference>` XML element - start one before recording. URL-encode names with spaces.

Recording callback

Known limitation: Delivery to callback_url is not currently guaranteed. Do not depend on this callback to obtain a recording ID or recording URL.

Use Stop Conference Recording to stop the active recording. Manage recording retrieval independently because the start response does not provide a file location.

Authorizations

X-Auth-ID

string

header

required

Your Vobiz account Auth ID

X-Auth-Token

string

header

required

Your Vobiz account Auth Token

Path Parameters

auth_id

string

required

Your account Auth ID

Example:

"MA_XXXXXX"

conference_name

string

required

Body

application/json

file_format

enum<string>

default:mp3

Available options:

mp3,

wav

callback_url

string

Response

200 - application/json

Recording request queued

⌘I

Start conference recording

curl --request POST \
  --url https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Record/ \
  --header 'Content-Type: application/json' \
  --header 'X-Auth-ID: <api-key>' \
  --header 'X-Auth-Token: <api-key>' \
  --data '
{
  "file_format": "mp3",
  "callback_url": "<string>"
}
'

import requests

url = "https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Record/"

payload = {
    "file_format": "mp3",
    "callback_url": "<string>"
}
headers = {
    "X-Auth-ID": "<api-key>",
    "X-Auth-Token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-Auth-ID': '<api-key>',
    'X-Auth-Token': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({file_format: 'mp3', callback_url: '<string>'})
};

fetch('https://api.vobiz.ai/api/v1/Account/{auth_id}/Conference/{conference_name}/Record/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "message": "async api spawned",
  "api_id": "API_REQUEST_ID"
}

​Path parameters

​Request parameters

​Example requests

​Response

​Error responses

​Recording callback

Authorizations

Path Parameters

Body

Response

Path parameters

Request parameters

Example requests

Response

Error responses

Recording callback