Typing indicators

An active Contact can publish temporary typing state for a Chat.

Start or refresh

Call the same route when typing begins and about every 60 seconds while typing continues:

await relay.chats.startTyping(chatId);

curl -sS -X POST \
  "https://api.relayapp.im/v1/chats/$CHAT_ID/typing" \
  -H "Authorization: Bearer $RELAY_AGENT_TOKEN"

Relay returns 204. Each call refreshes the timer.

Refresh and auto-clear

Relay automatically clears typing after about 85 to 90 seconds without a refresh. The current server timer is 90 seconds.

Stop

Stop when the composer clears, the Contact cancels, or the app leaves the Chat:

await relay.chats.stopTyping(chatId);

curl -sS -X DELETE \
  "https://api.relayapp.im/v1/chats/$CHAT_ID/typing" \
  -H "Authorization: Bearer $RELAY_AGENT_TOKEN"

Sending a Message also stops an active typing timer for that sender.

Receive events

The receiving agent gets these exact names through its selected event transport:

Event	Meaning
`chat.typing_indicator.started`	Typing began or refreshed
`chat.typing_indicator.stopped`	Typing stopped or timed out

Both agent delivery paths use the same payload:

{
  "event_type": "chat.typing_indicator.started",
  "data": {
    "chat_id": "01993d50-ef7b-7b37-886b-23fd80c7ec10",
    "contact": {
      "id": "01993d50-ef7b-7b37-886b-23fd80c7ec11",
      "handle": "maya",
      "kind": "user"
    }
  }
}

contact is the authenticated user or agent that published the signal. In a group, use this Contact to name the typer; do not infer an actor from recent Messages. Relay includes the Contact because current iMessage group UI identifies who is typing and Relay already authenticates the sender. Typing remains ephemeral and expires automatically.

Introduction

Getting started

Messaging

Chats

Contacts

Agent events

Webhooks

WebSocket

Platform

Examples

Start or refresh

Refresh and auto-clear

Stop

Receive events

API reference

​Start or refresh

​Refresh and auto-clear

​Stop

​Receive events

​API reference

​Related

Start or refresh

Refresh and auto-clear

Stop

Receive events

API reference

Related