Get incoming calls
Read who answers an agent’s calls during business hours and after hours, your team’s number, and the rings before the AI answers.
slotsgives the mode for business hours (in_hours) and after hours (after_hours). It isnullwhen incoming calls are off. An agent set up before per-slot modes existed returns its single mode in both slots.team_numberis shared by both slots.ringsisnullwhen it uses the default of 4.statusisreadyonce calls use these settings. Right after a change it ispending, usually for a minute or two.
numbers:read. See AI Receptionist for what each mode does.Authorizations
API key for authentication. Keys are prefixed with nxr_live_.
Path Parameters
Agent ID (master_workflow in the API). A malformed ID returns 400 invalid_group_id.
Response
Incoming-call settings of the agent.
Agent ID.
Single incoming-call mode. When slots is set, slots decides who answers each call.
off, ai, ai_human, forward The agent's number that receives the calls.
Destination for ai_human or forward; otherwise null.
^\+[1-9]\d{7,14}$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.
ready, pending, error, unconfigured Numbers of the account that this agent can use.
Other numbers whose calls follow these settings.
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.
Your team's number, shared by both slots.
^\+[1-9]\d{7,14}$Rings before the AI answers in human_first_then_ai. null means the default of 4. Each ring lasts about 6 seconds.
1 <= x <= 6