1. Tasks
  2. Send Typing Indicator

Tasks

Send Typing Indicator

Sends a typing indicator to a platform to let the recipient know a message is incoming

Basic usage

Task to send a typing indicator on WhatsApp.

editor
        {
  "tasktype": "send_typing_indicator",
  "params": {
    "platform": "whatsapp",
    "whatsapp": {
      "message_ids": [
        "~~stub.data._incoming_whatsapp_data.whatsapp_body.id",
      ]
    }
  }
}

      

Parameters

platform
required
string

The platform to send a typing indicator on. Currently the only available option is: whatsapp.


whatsapp
required
object

The WhatsApp parameters for the task.


WhatsApp Parameters

Parameters required for sending a typing indicator on WhatsApp

INFO

Unlike WhatsApp messages which send to a contact. Typing indicators are sent using a message_id from an incoming message. To get the message_id of the most recent incoming message on a stub use ~~stub.data._incoming_whatsapp_data.whatsapp_body.id

The WhatsApp typing indicator will display for 25 seconds or until a message has been sent to the recipient.

message_ids
required
array

The message ids to send the typing indicator for. The message id must come from an incoming message. To send a typing indicator to the most recent reply to the stub use ~~stub.data._incoming_whatsapp_data.whatsapp_body.id

whatsapp_profile_name
optional
string

The name of the WhatsApp profile to send the typing indicator from. If no whatsapp_profile_name is specified, the typing indicator will be sent by the default WhatsApp profile of the org.


WhatsApp Read Receipts

When sending a typing indicator on WhatsApp, all previous messages in the conversation will be marked as Read.

WhatsApp Typing Indicator Result

editor
        "send_typing_indicator": {
  "success": true,
  "payload": [
    {
      "message_id": "[Message_ID]"
    }
  ],
},


      

Properties

message_id

An array of all the message_ids that have received a typing indicator.