Skip to content

Claim a ringing inbound call for one rep

POST
/voice/inbound-calls/{room_name}/claim

FIRST WINS. A second claim on the same call loses, and says so.

This CONNECTS A HUMAN TO A LIVE CALLER. It is the race-resolution step the notification socket exists to drive; calling it from an automation means deciding who answers before a person has seen the call.

Authorizations

Parameters

Path Parameters

room_name
required

The ringing call’s room name.

string
>= 1 characters

The ringing call’s room name.

Query Parameters

sdr_email
required

The rep taking it.

string

The rep taking it.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

One voice object - a collection, an agent, a route, a chat.

Open-shaped: voice adds fields to these bodies on its own release cadence and a dropped-or-added key must not be a 500 in this service.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string