Skip to main content
GET
Get incoming calls
Returns the incoming-call settings of an agent, the same ones the AI Receptionist shows on its Transfers tab.
  • slots gives the mode for business hours (in_hours) and after hours (after_hours). It is null when incoming calls are off. An agent set up before per-slot modes existed returns its single mode in both slots.
  • team_number is shared by both slots. rings is null when it uses the default of 4.
  • status is ready once calls use these settings. Right after a change it is pending, usually for a minute or two.
MCP keys need numbers:read. See AI Receptionist for what each mode does.

Authorizations

X-API-Key
string
header
required

API key for authentication. Keys are prefixed with nxr_live_.

Path Parameters

id
string<uuid>
required

Agent ID (master_workflow in the API). A malformed ID returns 400 invalid_group_id.

Response

Incoming-call settings of the agent.

agent_group_id
string<uuid>
required

Agent ID.

mode
enum<string>
required

Single incoming-call mode. When slots is set, slots decides who answers each call.

Available options:
off,
ai,
ai_human,
forward
number_id
string<uuid> | null
required

The agent's number that receives the calls.

transfer_to
string | null
required

Destination for ai_human or forward; otherwise null.

Pattern: ^\+[1-9]\d{7,14}$
status
enum<string>
required

ready when calls already use these settings. pending while the change is being applied, usually a minute or two. Never treat pending or error as active.

Available options:
ready,
pending,
error,
unconfigured
numbers
object[]
required

Numbers of the account that this agent can use.

linked_numbers
object[]
required

Other numbers whose calls follow these settings.

slots
object | null
required

Who answers during business hours and after hours. Business hours are the Contactability hours of the task where calls start; with no hours set, every call uses in_hours. ai_only: the AI answers and does not transfer when asked for a person. ai_first_team_when_asked: the AI answers and transfers to team_number when the caller asks for a person. human_first_then_ai: team_number rings first, and the AI answers after rings rings if nobody takes the call. team_only: calls go to team_number without the AI. null when incoming calls are off.

team_number
string | null
required

Your team's number, shared by both slots.

Pattern: ^\+[1-9]\d{7,14}$
rings
integer | null
required

Rings before the AI answers in human_first_then_ai. null means the default of 4. Each ring lasts about 6 seconds.

Required range: 1 <= x <= 6
Last modified on October 26, 2026