Skip to content

Get a studio

GET
/v1/studios/{studio}
curl --request GET \
--url https://api.caller9.app/v1/studios/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Authorization: Bearer <token>'

Returns the studio’s full configuration.

studio
required
string format: uuid

Studio ID (UUID).

The studio.

Media typeapplication/json
object
studio
required

A studio and its configuration. Boolean settings are returned as integers (0 / 1). Returned by GET/PATCH /v1/studios/{studio} and by the organization studio list/create endpoints.

object
guid
required

Studio ID.

string
name
required
string
organization_guid
required

Owning organization ID.

string
cid_number_guid
required

Number used as outbound caller ID, if set.

string | null
cid_display_name
required

Outbound caller ID name (CNAM-normalized).

string
<= 15 characters
busy_all
required

Busy / Do-Not-Disturb is on.

integer
Allowed values: 0 1
auto_dnd_when_empty
required

Act as Do-Not-Disturb when no operator has the studio open.

integer
Allowed values: 0 1
ring_time
required

Seconds before the ring-timeout action (5–60).

integer
hotline_ring_time
required

Ring time for hotline calls, in seconds (5–60).

integer
ai_assistant_id
required

AI assistant used for screening.

string | null
ai_screening_enabled
required

AI screening capability is enabled.

integer
Allowed values: 0 1
hybrid_count
required

Number of on-air hybrid SIP endpoints.

integer
<= 4
screen_all
required

Every inbound call is screened by the AI assistant.

integer
Allowed values: 0 1
screen_all_station_name
required
string
screen_all_show_description
required
string
screen_all_station_location
required
string
contest_enabled
required

Contest Mode capability is enabled.

integer
Allowed values: 0 1
contest_mode
required

A contest is currently armed.

integer
Allowed values: 0 1
contest_target
required

Default winning caller number (1–110).

integer
contest_backups
required

Default number of backup winners (0–100).

integer
contest_post_timeout_secs
required

Default post-contest window in seconds (10–3600).

integer
ring_timeout_action
required
string
Allowed values: none voicemail forward
voicemail_greeting_type
required
string
Allowed values: tts file
voicemail_greeting_tts
required

Text-to-speech greeting text.

string
voicemail_greeting_voice
required

TTS voice ID; null means the platform default voice.

string | null
voicemail_greeting_r2_key
required

Storage key of the uploaded greeting file, if any.

string | null
voicemail_tts_r2_key
required

Storage key of the cached synthesized TTS greeting, if any.

string | null
voicemail_max_seconds
required

Maximum voicemail length in seconds (5–600).

integer
voicemail_record_message
required

Record a message after the greeting.

integer
Allowed values: 0 1
email_voicemails_enabled
required
integer
Allowed values: 0 1
voicemail_email
required
string | null
delete_after_email
required
integer
Allowed values: 0 1
forward_dest_type
required

Ring-timeout forwarding destination type.

string | null
Allowed values: sip phone
forward_sip_address
required

Set when forward_dest_type is sip.

string | null
forward_phone_number
required

E.164 number; set when forward_dest_type is phone.

string | null
moh_mode
required
string
Allowed values: library file pgm
moh_library_guid
required

Selected library track; null means the platform default.

string | null
moh_r2_key
required

Storage key of the uploaded custom Music on Hold file, if any.

string | null
created_at
required

Creation timestamp (ISO 8601).

string
updated_at
required

Last update timestamp (ISO 8601).

string
deleted_at
required

Always null for studios returned by the API.

string | null

Example

{
"studio": {
"busy_all": 0,
"auto_dnd_when_empty": 0,
"ai_screening_enabled": 0,
"screen_all": 0,
"contest_enabled": 0,
"contest_mode": 0,
"ring_timeout_action": "none",
"voicemail_greeting_type": "tts",
"voicemail_record_message": 0,
"email_voicemails_enabled": 0,
"delete_after_email": 0,
"forward_dest_type": "sip",
"moh_mode": "library"
}
}

Missing, invalid, expired or revoked API key.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Not found, or belongs to another organization.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Too many requests for this API key. Retry after Retry-After seconds.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}
Retry-After
integer

Seconds until the rate-limit window resets.