RCS Typing Indicator (Agent to User)

post

https://rcs-api.na.kaleyra.io/v1/{sid}/rcs/events

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

The RCS Typing Indicator (Agent to User) API allows you to indicate when an agent is typing a response to an end user in an RCS conversation. This helps improve user experience by providing real-time feedback during interactions.

Prerequisites

After you sign up, your account will be on the trial version. You must complete the KYC to access all the features in kaleyra.io.
Before you get started, Create an API Key. To view the API Key and the SID, see View API Key and SID.
To send any RCS messages, you must configure the RCS channel in the Kaleyra platform. To configure the RCS channel in your account, please contact your local Kaleyra representative.

Path Params

sid

string

required

Account SID (Security Identifier).

Body Params

Request payload used to indicate the typing indicator for an agent
to user.

Payload used to indicate that an agent is currently typing.

The composing property must be an empty object to trigger the
typing indicator event.

from

string

required

Sender identifier (agent/bot ID configured in Kaleyra RCS channel).

string

required

Recipient mobile number in E.164 format.

composing

object

required

Indicates that the agent is currently typing.

Must be an empty object to trigger the typing indicator event.

Headers

Authorization

string

required

Basic authentication header encoded in Base64 format using
credentials.

api-key

string

required

API key generated from the kaleyra.io account.

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Language

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Prerequisites

200Event published successfully. Sample success response documented by Kaleyra.

defaultEvent publish failed. The Kaleyra documentation provides the failure response body but does not specify an HTTP status code for the failure response.