Skip to content
MoreVoiceDevelopers

Retrieve a conference room

GET
/conference_rooms/{id}
import MoreVoice from "@morevoice/sdk";


const mv = new MoreVoice(); // MOREVOICE_API_KEY from the environment


const conferenceRoom = await mv.conferenceRooms.retrieve("room_7Hk2Lm9Qp");
console.log(conferenceRoom);

Returns the ConferenceRoom object. Answers 404 with the code resource_missing when nothing has this ID in this organisation and mode.

Try it in the API playground with a test-mode key.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
<= 200 characters /^room_[0-9A-Za-z]+$/

A conference room ID (room_…).

Header Parameters

Section titled “Header Parameters”
MoreVoice-Version
string
/^\d{4}-\d{2}-\d{2}$/

The API version to use for this request. Defaults to the version the API key is pinned to.

Example
2026-11-01

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json

A conference room: a web link for guests, optional phone dial-in with a PIN, and moderator controls.

object
active
required

Switched off rooms can’t be joined.

boolean
created
required

An ISO-8601 timestamp in UTC.

string format: date-time
dial_in
required

Phone numbers routed to this room (inbound routes).

Array<string>
has_moderator_pin
required
boolean
has_pin
required

Phone participants need a PIN (never returned).

boolean
id
required

A conference room ID (prefix room_).

string
/^room_[0-9A-Za-z]+$/
live
required
Any of:
object
participants
required
integer
>= -9007199254740991 <= 9007199254740991
started_at
required

An ISO-8601 timestamp in UTC.

string format: date-time
livemode
required

true in live mode, false in test mode.

boolean
name
required
string
object
required
string
Allowed value: conference_room
owner_id
required
Any of:

The member who owns the room, or null (created through the API).

string
/^usr_[0-9A-Za-z]+$/
pin_length
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
schedule
required

A scheduled room can be joined from 15 minutes before each occurrence until 2 hours after it ends.

object
end_at
required
Any of:

An ISO-8601 timestamp in UTC.

string format: date-time
recurrence
required

weekdays skips Friday and Saturday.

string
Allowed values: none daily weekly weekdays
start_at
required
Any of:

An ISO-8601 timestamp in UTC.

string format: date-time
timezone
required
string
settings
required
object
ai_note_taker
required

AI meeting notes (summary, decisions, action items) when the room empties.

boolean
announce
required

Join and leave chimes.

boolean
description
required
string
<= 1000 characters
language
required

The language of the phone prompts and invitations.

string
Allowed values: he en
lock_on_start
required

Lock the room as soon as it starts: only moderators can let more people in.

boolean
max_participants
required
integer
>= 2 <= 50
mute_on_entry
required

Members join muted (moderators never).

boolean
record
required

Record the sessions.

boolean
transcribe
required

Transcribe the sessions (needed for AI notes).

boolean
wait_for_moderator
required

Phone callers wait for a moderator before they’re seated.

boolean
updated
required

An ISO-8601 timestamp in UTC.

string format: date-time
Example
{
  "active": true,
  "created": "2026-11-01T09:14:22.000Z",
  "dial_in": [
    "+97233761234"
  ],
  "has_moderator_pin": false,
  "has_pin": true,
  "id": "room_2dXk9QmZ4rTv",
  "live": null,
  "livemode": true,
  "name": "Weekly sales sync",
  "object": "conference_room",
  "owner_id": null,
  "pin_length": 4,
  "schedule": {
    "end_at": "2026-11-03T08:30:00.000Z",
    "recurrence": "weekly",
    "start_at": "2026-11-03T08:00:00.000Z",
    "timezone": "Asia/Jerusalem"
  },
  "settings": {
    "ai_note_taker": true,
    "announce": true,
    "description": "",
    "language": "he",
    "lock_on_start": false,
    "max_participants": 20,
    "mute_on_entry": false,
    "record": true,
    "transcribe": true,
    "wait_for_moderator": false
  },
  "updated": "2026-11-01T09:14:22.000Z"
}

400

Section titled “400”

The request is invalid: a parameter is missing, malformed or unknown, or the version header is unknown.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
  "error": {
    "code": "parameter_missing",
    "doc_url": "https://docs.morevoice.ai/api/errors#parameter-missing",
    "message": "Missing required parameter: to.",
    "param": "to",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "invalid_request_error"
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

401

Section titled “401”

No valid API key was sent.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
  "error": {
    "code": "invalid_api_key",
    "doc_url": "https://docs.morevoice.ai/api/errors#invalid-api-key",
    "message": "Invalid API key.",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "authentication_error"
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

403

Section titled “403”

The key may not do this (a missing scope, a plan limit, or a compliance block).

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
  "error": {
    "code": "missing_scope",
    "doc_url": "https://docs.morevoice.ai/api/errors#missing-scope",
    "message": "This API key lacks the calls:write scope.",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "permission_error"
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

404

Section titled “404”

No object with this ID exists in this organisation and mode.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
  "error": {
    "code": "resource_missing",
    "doc_url": "https://docs.morevoice.ai/api/errors#resource-missing",
    "message": "No such object: 'call_4Gk2'.",
    "param": "id",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "not_found"
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

429

Section titled “429”

Too many requests, or no call capacity right now. Retry after the Retry-After delay.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
  "error": {
    "code": "rate_limited",
    "doc_url": "https://docs.morevoice.ai/api/errors#rate-limited",
    "message": "Too many requests. Retry after 1 second.",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "rate_limit_error"
  }
}

Headers

Section titled “Headers”
Retry-After
integer

Seconds to wait before retrying.

X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

500

Section titled “500”

Something went wrong on MoreVoice’s side. Retry with the same Idempotency-Key.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
  "error": {
    "code": "internal_error",
    "doc_url": "https://docs.morevoice.ai/api/errors#internal-error",
    "message": "Something went wrong on MoreVoice's side.",
    "request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
    "type": "api_error"
  }
}

Headers

Section titled “Headers”
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.