Send

API Reference

Typing Indicators

Send a typing indicator

client.typingIndicators.send(TypingIndicatorSendParamsbody, RequestOptionsoptions?): error_messageunionnumberstringstatusunionTypingIndicatorSendResponse

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.

Parameters

bodynumberstringTypingIndicatorSendParams

Hide ParametersShow Parameters

numberstring

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

Returns

TypingIndicatorSendResponse

Hide ParametersShow Parameters

error_messageunion

optional

string | null

The error message if the status is ERROR

numberstring

optional

The number you evaluated in E.164 format

statusunion

optional

"SENT" | "ERROR"

The status of the typing indicator you tried to send

Hide ParametersShow Parameters

"SENT"

"ERROR"

HTTPTypeScript

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"
}