Skip to main content
PUT
Turn the AI receptionist on or off
Required scope: AGENTS_WRITE

Behavior

Puts the AI receptionist on the line or takes it off, and returns the whole configuration with the new status.
  • ACTIVE: the receptionist answers incoming calls.
  • FORWARDING: it does not, and calls go to your business phone instead.
This reprograms how a live line routes real calls. It is deliberately its own endpoint, so a configuration write can never flip it by accident. Configure the receptionist fully before switching it on, and confirm with a person before calling it.
Turning the receptionist off forwards calls to your workspace’s business phone number, so one has to be set. That number is not the receptionist’s business_phone and is not writable through this API.

Errors

  • 400 AGENT_NO_FORWARDING_NUMBER: FORWARDING was requested and no business phone is set on the workspace. Until one is, the receptionist can only stay ACTIVE.
  • 409 AGENT_LINE_NOT_ASSIGNED: the line has no phone number assigned, so it can neither answer nor forward.
  • 404 PHONE_NUMBER_NOT_FOUND: the number is not one you have access to.

Authorizations

Authorization
string
header
required

Path Parameters

number
string
required

Allo phone number in E.164 format

Example:

"+14155551234"

Body

application/json
status
enum<string>
required

ACTIVE puts the receptionist on the line. FORWARDING takes it off and sends calls to your business phone.

Available options:
ACTIVE,
FORWARDING

Response

The configuration, with the new status

data
object

The whole configuration of one line's AI receptionist.