Skip to content

Pause, resume, or stop a parallel-dialer session

PATCH
/voice/dialer/sessions/{session_id}/status

Lifecycle hook for a dialer session.

  • PAUSED pauses an active session.
  • COMPLETED ends the session (one-way; reopen requires the voice frontend’s manual-dial flow).

To RESUME a paused session use POST /voice/dialer/sessions/{id}/resume — the voice service rejects a PATCH to ACTIVE (the resume flow is a fresh start-session call), so ACTIVE is rejected here with a 422 that points at the correct endpoint rather than forwarding an opaque 400.

FAILED is reserved for system use and is rejected here.

Authorizations

Parameters

Path Parameters

session_id
required

Session UUID.

string
>= 1 characters

Session UUID.

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Body for pause / resume / stop on a parallel-dialer session.

The voice service treats a status PATCH as the lifecycle hook:

  • ACTIVE resumes a paused session.
  • PAUSED pauses an active session.
  • COMPLETED ends the session - one-way, can be re-opened only via manual-dial (which we do not expose here).
  • FAILED is reserved for system use; we reject it on the public surface so a caller cannot mis-mark a session.
object
status
required

One of “ACTIVE” (resume), “PAUSED” (pause), “COMPLETED” (stop).

string

Responses

200

Successful Response

object
data
required

Echo of voice’s SessionUpdateResponse for the public surface.

object
created_at
Any of:
from_phone
Any of:
string
message
Any of:
string
name
Any of:
string
org_id
Any of:
string
session_id
required
string
session_metadata
Any of:
object
key
additional properties
any
status
required
string
total_calls
integer
updated_at
Any of:
user_email
Any of:
string
user_id
Any of:
string
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