RCS Typing Indicator (Agent to User)

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.

API Request to indicate the Typing Indicator (Agent to User)

To indicate the typing indicator for agent to user, use the https://rcs-api.<pod>.kaleyra.io/v1/<sid>/rcs/events with the following request method: 

The following is the request format to check RCS capability for single number: 

curl --location 'https://<api_domain>/v1/<sid>/rcs/events' \
--header 'Authorization: Basic <base64-encoded-credentials>' \
--header 'Content-Type: <content-type>' \
--header 'api-key: <api-key>' \
--data '{
    "from": "<from>",
    "to": "<to>", 
    "composing": {}
}'

The following is the sample request that describes how to indicate typing indicator for agent to user:

curl --location 'https://rcs-api.na.kaleyra.io/v1/XXXXX6913850XXXX/rcs/events' \
--header 'Authorization: Basic {BASIC_BASE64}' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'api-key: XXXXX3b8497f58a94e84b671aca43XXXX' \
--data '{
    "from": "kio_rcs",
    "to": "+1XXXXXXXX90", 
    "composing": {}
}'

Following is the list of attributes to be used in the payload to indicate typing indicator for agent to user:

Sample Success Response

The following is the sample success response:

{
    "code": "RCS1002",
    "message": "Event published successfully",
    "data": {
        "requestId": "33ae7082-aa71-4159-a8df-93XXXXXXXX1a",
        "to": "+1XXXXXXXX90",
        "messageId": "f5d689e0-6c01-46d0-XXXX-b2c4XXXXXXf2"
    },
    "error": {}
}
 

Response Fields

The following table outlines the key fields returned in the API response. Each field provides information about the status of the typing indicator event that was published, including identifiers for tracking and delivery reference. These fields help in monitoring and correlating the request with the resulting event.

Sample Failure Response

The following is the sample failure response:

{
    "code": "RCS1004",
    "message": "Event publish failed",
    "data": [],
    "error": {
        "error_code": "PROV_ERROR",
        "error_message": "{\n  \"status\": \"ERROR\",\n  \"errorText\": \"Access Denied\"\n}"
    }
}