Skip to content

List studio SIP endpoints

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

Registration details (including passwords) for the studio’s on-air hybrid endpoints and, in pgm Music on Hold mode, its hold endpoint. Configure these in your SIP hybrid / codec hardware. Browser (WebRTC) operator credentials are not included.

studio
required
string format: uuid

Studio ID (UUID).

SIP endpoints, ordered by role.

Media typeapplication/json
object
sip_endpoints
required
Array<object>

SIP registration credentials for a studio endpoint. created_at is included when listing; the organization studio-create response returns the same object without it.

object
role
required

hybrid_1 … hybrid_4 (on-air hybrids) or hold (program feed for Music on Hold in pgm mode).

string
/^(hybrid_[1-4]|hold)$/
sip_username
required
string
sip_uri
required
string
sip_password
required

SIP registration password.

string
created_at

Creation timestamp (ISO 8601).

string

Example

{
"sip_endpoints": [
{
"role": "hybrid_1"
}
]
}

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.