Messages > rcs

Send Typing Indicator

Send a typing indicator from an RCS agent to a recipient.

This endpoint allows RCS agents to display a typing indicator to recipients. The indicator is a message bubble with animated typing dots like this: <img src="https://server.trypinnacle.app/storage/v1/object/public/pinnacle-public-assets/ios-typing-indicator.png" alt="Typing Indicator" style="display: inline; height: 1.5em; vertical-align: middle; margin: 0 4px;" />

Use Case: Typing indicators are especially useful for providing feedback to users while the agent is thinking or generating a response that may take some time, creating a more engaging conversational experience.

Expiration: Typing indicators automatically expire after around 20 seconds or when the agent sends a message, whichever comes first.

Frequency: You can send typing indicators as many times as needed, though only one will be displayed at a time. Sending multiple typing indicators will extend the duration of the current indicator.

Note: Typing indicators are best-effort hints, not delivery-guaranteed state. The platform is allowed to coalesce or drop them, and the client UI decides when to show/hide.

post/messages/send/typing

Request

  • Base URL: https://api.pinnacle.sh
  • URL: https://api.pinnacle.sh/messages/send/typing
  • Auth: API key in header PINNACLE-API-KEY

Request body

agentIdstring required

The unique identifier of the RCS agent sending the typing indicator. <br>

Format: agent_ followed by alphanumeric characters (e.g., agent_pinnacle).

tostring required

The recipient's phone number in E.164 format. <br>

Must include country code with a leading plus sign (e.g., +14155551234).

Response

Successfully sent the typing indicator.

successboolean required

Indicates whether the typing indicator was successfully sent.

agentIdstring required

The RCS agent that sent the typing indicator.

recipientstring required

The recipient's phone number that received the typing indicator.

startedAtstring date-time required

Timestamp when the typing indicator was started (ISO 8601 format).

endedAtstring date-time required

Timestamp when the typing indicator will automatically expire (ISO 8601 format). <br>

This is typically one minute after startedAt unless a message is sent first.

Changes

No recorded changes to this operation across all 1 revision of this API.