Send a typing indicator

typing_indicators.send() -> TypingIndicatorSendResponse

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. Not supported in group chats.

ParametersExpand Collapse

from_number: str

The Sendblue phone number you want to send the typing indicator from (E.164 format). This should be the number you use to send messages.

number: str

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

ReturnsExpand Collapse

class TypingIndicatorSendResponse: …

error_message: Optional[str]

The error message if the status is ERROR

number: Optional[str]

The number you evaluated in E.164 format

status: Optional[Literal["SENT", "ERROR"]]

The status of the typing indicator you tried to send

Accepts one of the following:

"SENT"

"ERROR"

Send a typing indicator

import os
from sendblue_api import SendblueAPI

client = SendblueAPI(
    api_key=os.environ.get("SENDBLUE_API_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SENDBLUE_API_API_SECRET"),  # This is the default and can be omitted
)
response = client.typing_indicators.send(
    from_number="+16292925296",
    number="+19998887777",
)
print(response.error_message)

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

Returns Examples

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