Create a studio
const url = 'https://api.caller9.app/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/studios';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"name":"example","hybrid_count":0,"cid_display_name":"example","ai_assistant_id":"example"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.caller9.app/v1/organizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/studios \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "name": "example", "hybrid_count": 0, "cid_display_name": "example", "ai_assistant_id": "example" }'Creates a studio and provisions one SIP endpoint per on-air hybrid. SIP passwords are returned only in this response. Demo and Basic plans are limited to one studio and one hybrid. Requires a full-access key.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Organization ID (UUID). Must be the organization that owns the API key.
Request Bodyrequired
Section titled “Request Bodyrequired”object
Number of on-air hybrid SIP endpoints to provision. Maximum 1 on Demo and Basic plans, 4 otherwise.
Caller ID name for outbound calls. Normalized to CNAM (uppercase letters, digits, ., , and spaces, max 15 characters). Defaults to the studio name.
Telnyx AI Assistant ID used for AI screening.
Responses
Section titled “Responses”The created studio and its SIP credentials.
object
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
Studio ID.
Owning organization ID.
Number used as outbound caller ID, if set.
Outbound caller ID name (CNAM-normalized).
Busy / Do-Not-Disturb is on.
Act as Do-Not-Disturb when no operator has the studio open.
Seconds before the ring-timeout action (5–60).
Ring time for hotline calls, in seconds (5–60).
AI assistant used for screening.
AI screening capability is enabled.
Number of on-air hybrid SIP endpoints.
Every inbound call is screened by the AI assistant.
Contest Mode capability is enabled.
A contest is currently armed.
Default winning caller number (1–110).
Default number of backup winners (0–100).
Default post-contest window in seconds (10–3600).
Text-to-speech greeting text.
TTS voice ID; null means the platform default voice.
Storage key of the uploaded greeting file, if any.
Storage key of the cached synthesized TTS greeting, if any.
Maximum voicemail length in seconds (5–600).
Record a message after the greeting.
Ring-timeout forwarding destination type.
Set when forward_dest_type is sip.
E.164 number; set when forward_dest_type is phone.
Selected library track; null means the platform default.
Storage key of the uploaded custom Music on Hold file, if any.
Creation timestamp (ISO 8601).
Last update timestamp (ISO 8601).
Always null for studios returned by the API.
SIP credentials for a newly created studio. The password is only returned once.
object
Endpoint role, hybrid_1…hybrid_4.
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" }}The request was invalid.
object
Human-readable error message.
Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).
Example generated
{ "error": "example", "code": "example"}Missing, invalid, expired or revoked API key.
object
Human-readable error message.
Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).
Example generated
{ "error": "example", "code": "example"}The key isn’t allowed to do this (e.g. a read-only key making a change).
object
Human-readable error message.
Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).
Example generated
{ "error": "example", "code": "example"}Not found, or belongs to another organization.
object
Human-readable error message.
Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).
Example generated
{ "error": "example", "code": "example"}Blocked by the organization’s plan.
object
Which cap was hit, e.g. studios, numbers, ai_screening, trunk_channels.
Example
{ "error": "plan_limit"}Too many requests for this API key. Retry after Retry-After seconds.
object
Human-readable error message.
Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).
Example generated
{ "error": "example", "code": "example"}Headers
Section titled “Headers”Seconds until the rate-limit window resets.