Send

API Reference

Typing Indicators

Send a typing indicator

client.typingIndicators.send(TypingIndicatorSendParams { number } body, RequestOptionsoptions?): TypingIndicatorSendResponse { error_message, number, status }

post/api/send-typing-indicator

Send an indication that you are typing to a user. This shows up as the animated three dots on the recipient's device. Only available for existing chats and not supported in group chats.

ParametersExpand Collapse

body: TypingIndicatorSendParams { number }

number: string

The number you want to send a typing indicator to (E.164 format)

ReturnsExpand Collapse

TypingIndicatorSendResponse { error_message, number, status }

error_message?: string | null

The error message if the status is ERROR

number?: string

The number you evaluated in E.164 format

status?: "SENT" | "ERROR"

The status of the typing indicator you tried to send

Accepts one of the following:

"SENT"

"ERROR"

Send a typing indicator

typescript

• http
• typescript
• python

import SendblueAPI from 'sendblue';

const client = new SendblueAPI({
  apiKey: 'My API Key',
  apiSecret: 'My API Secret',
});

const response = await client.typingIndicators.send({ number: '+19998887777' });

console.log(response.error_message);

200 example

{
  "error_message": null,
  "number": "+19998887777",
  "status": "SENT"
}

Returns Examples

200 example

{
  "error_message": null,
  "number": "+19998887777",
  "status": "SENT"
}