Skip to main content
POST
Show the typing indicator
  • Credential: an API key. A trial key returns 401 unauthorized. See Typing indicators.
  • Line-scoped keys: the list of a line-scoped key is not applied: such a key acts on any chat of the account.
  • Idempotency-Key: not honored. Call the operation again to keep the indicator: it lasts 15 seconds after the last start, until expires_at.
  • Events: none.
  • What reaches the contact: the line’s device shows the indicator when it supports typing indicators and there is a Messages conversation with the contact on the device. Otherwise nothing is shown, and the call still succeeds. On a line with no paired device, and on every shared line, the request is dropped.

Errors

The errors that every operation shares are in Errors.

Authorizations

Authorization
string
header
required

An API key created in the iSnap dashboard, or a trial key, sent as Authorization: Bearer <key>. An API key starts with isnap_live_ or isnap_test_; both act on the same account, lines and billing. A trial key acts on its trial only.

Path Parameters

chat_id
string
required

Chat id: chat_ followed by 25 letters or digits.

Pattern: ^chat_[0-9A-Za-z]{25}$

Body

application/json

An empty object: the request takes no field.

Response

The request to show the typing indicator, accepted for the line's device.

success
enum<boolean>
required

Always true on a success response.

Available options:
true
data
object
required

The result of POST /v1/chats/{chat_id}/typing.

trace_id
string
required

Trace id of the request that produced this response: 32 lowercase hexadecimal characters. Quote it when you report a problem to iSnap.

request_id
string
required

Id of the request that produced this response: req_ followed by 25 letters or digits.