Sign in
Calls

Initiate Screening

Initiate call screening.

This endpoint initiates an outbound Twilio call to the screening phone number. The recipient will hear a TTS prompt with the caller's name and reason, and can press 1 to accept or 2 to decline.

Requires agent token authentication.

Returns:

  • screening_id: UUID to poll for status
  • status: Initial status (pending)
post/calls/screening/initiate

Request body

call_idstring uuid required

The call ID this screening is for

caller_namestring required

Name of the caller to announce

call_reasonstring nullable

Reason for the call to announce (optional for known contacts)

is_known_contactboolean

Whether this caller is a known contact - uses different announcement

special_callerboolean

Whether this caller is a special caller (judge, court staff, new client) - bypasses availability blocks

Response

Successful Response

screening_idstring uuid required

The ID of the screening request

statusstring required

Current status of the screening (pending)

Changes

No recorded changes to this endpoint across all 2 revisions of this API.