Skip to main content
GET
SMS event stream

Authorizations

Authorization
string
header
required

Agent token (alt_…) or OAuth access token; bound to one agent

Path Parameters

phoneNumberId
string
required

Phone number id

Query Parameters

cursor
string

Resume after this cursor from a previous response; omit to start at the newest event

Pattern: ^\d{1,18}$
limit
integer
Required range: 1 <= x <= 100
wait
number

Seconds to hold the request open waiting for an event (long-poll, at most 25)

Response

Events and the cursor to resume from

events
object[]
required
cursor
string
required

Pass back as cursor to read only newer events