Skip to main content
GET
Get a translation room
Host details include session.can_call. It is true when the assistant has a connected outgoing phone number. Use this value to enable phone controls; false or a missing value keeps them disabled. An incoming-only number does not enable callbacks. Destination, credit and calling-limit checks still run when a call is requested. Guest and list responses omit this host capability. Dial-in is independent: session.dial_in.number contains an eligible incoming number assigned to the assistant, or null when none is connected. The room code is displayed after the host starts the room and remains available with the number. Speaker 1 then calls the number and enters all six digits, including any leading zero. Guest responses omit the number and code. An outgoing connection is required only for participants receiving a call. Creating and starting Translate rooms requires the Translate Agent mode to be included in the workspace’s current plan. Existing room details remain readable after a later plan change.

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access within the workspace's available capabilities.

Path Parameters

id
string<uuid>
required

Query Parameters

after
integer

Last received phrase sequence; returns up to 200 newer active-session phrases.

Required range: x >= 0

Response

Success

data
object
required