v4

OpenAPI 3.1.02026-08-0255174167.5 KB
messages

Set a typing indicator

Starts or stops a typing indicator shown to the recipient, as if someone were composing a message from your number.

iMessage numbers show it; standard (SMS) numbers ignore it. SMS has no typing concept, so for a standard from-number the request succeeds and does nothing — the response is identical either way, letting you call this unconditionally before a send.

The indicator is fire-and-forget: nothing is persisted and no event is emitted. Delivering a message or reaction from the same number clears the indicator natively on the recipient's device — platform behavior, not Dial's; start again after a send if you're still composing. Dial itself never clears it: send value: false when you stop composing without sending. (A stale indicator may also clear on its own device-side.) Free of charge.

post/api/v1/typing

Headers

Authorizationstring required

Your Dial API key, sent as Authorization: Bearer sk_live_...

Request body

toNumberstring required

Recipient phone number in E.164 format.

valueboolean required

true shows the typing indicator; false clears it.

fromNumberstring required

The Dial number the indicator appears from, referenced flexibly: a phone-number ID, one of your numbers in E.164 format, or a number's nickname. A nickname shared by more than one of your numbers is rejected with 400; a ref that matches none of your numbers returns 404.

Response

Indicator set (or silently ignored for a from-number without typing support).

okboolean