Skip to content
Get Started

Lines

Sendblue line configuration and health state

Get line state snapshot
GET/api/v2/lines/state
ModelsExpand Collapse
LineState object { assignment, sendblue_number, status, 4 more }
assignment: "assigned" or "shared" or "grace_period"
One of the following:
"assigned"
"shared"
"grace_period"
sendblue_number: string
status: "ONLINE" or "OFFLINE" or "DEGRADED" or "UNKNOWN"
One of the following:
"ONLINE"
"OFFLINE"
"DEGRADED"
"UNKNOWN"
worker_id: string
degraded_since: optional string
effective_until: optional string
status_changed_at: optional string
LineGetStateResponse object { data, snapshot_at, status }
data: array of LineState { assignment, sendblue_number, status, 4 more }
assignment: "assigned" or "shared" or "grace_period"
One of the following:
"assigned"
"shared"
"grace_period"
sendblue_number: string
status: "ONLINE" or "OFFLINE" or "DEGRADED" or "UNKNOWN"
One of the following:
"ONLINE"
"OFFLINE"
"DEGRADED"
"UNKNOWN"
worker_id: string
degraded_since: optional string
effective_until: optional string
status_changed_at: optional string
snapshot_at: string
status: "OK"

LinesCall Forwarding

Sendblue line configuration and health state

Get call forwarding for a line
GET/api/lines/{sendblue_number}/call-forwarding
Set call forwarding for a line
PUT/api/lines/{sendblue_number}/call-forwarding
Clear call forwarding for a line
DELETE/api/lines/{sendblue_number}/call-forwarding
ModelsExpand Collapse
CallForwardingRetrieveResponse object { forwarding_number, sendblue_number }
forwarding_number: string

The number calls are forwarded to, or null if not set

sendblue_number: string

The Sendblue phone number (E.164)

CallForwardingUpdateResponse object { forwarding_number, sendblue_number }
forwarding_number: string

The number calls are forwarded to, or null if not set

sendblue_number: string

The Sendblue phone number (E.164)

CallForwardingDeleteResponse object { forwarding_number, sendblue_number }
forwarding_number: string

The number calls are forwarded to, or null if not set

sendblue_number: string

The Sendblue phone number (E.164)