Typing Started Indicator Interaction
Sends a TypingStartedIndicator interaction event from the client side to Salesforce when an end user is typing a message.
This API applies to the following products:
- Bring Your Own Channel for Messaging
- Bring Your Own Channel for Contact Center as a Service
This API is available in version 61.0 and later.
The TypingStartedIndicator interaction is displayed as a typing icon in the messaging session of the Service Console, indicating to the rep that the end user is typing. As soon as the user starts typing, the “typing started indicator” event is sent to Salesforce, which in turn displays a typing icon in the messaging session.
The BYO demo connector sample implementation in GitHub is configured to check for the “typing started indicator” event when the user starts typing, and then check every five seconds after that. At each check, if the user is still typing, Salesforce displays the typing icon in the messaging session. The sample implementation is also configured to dismiss the typing icon two seconds after it appears. Use the sample implementation to customize the frequency of the checks. You can also customize when the typing icon is dismissed using the TypingStoppedIndicator interaction.
Salesforce doesn’t perform any other actions related to this interaction.
v1/interactions
POST
Authorization: Bearer <Salesforce access token>
String. Standard header. The authorization token, where \<token\> is the JSON Web Token (JWT). Required.
Content-Type: <Request body format>
String. Standard header. The format of the request body. Valid format is multipart/form-data. Required.
OrgId: <Salesforce Org Id>
String. Standard header. The 15-character Org ID of the Salesforce org. Required.
AuthorizationContext: <ConversationChannel Definition developer name>
String. Standard header. The ConversationChannelDefinition developer name in the format {prefix}_{ConversationChannelDefinitionName}. The prefix must match the developer name prefix of the corresponding connected app. For example, Partner1_ChannelDefinition1. Required.
RequestId: <GUID>
String. Standard header. A globally unique ID (GUID). Required.
For example,
| Property Name | Type | Description | Required |
|---|---|---|---|
| to | string | The channel address identifier. This is the globally unique ID for the conversation channel (MessagingChannel.ChannelAddressIdentifier). | Yes |
| from | string | The end user client identifier. This value comes from the partner system and can be up to 240 characters long. | Yes |
| interactions | array | A list of interactions that are initiated by a messaging or voice rep or end user. | Yes |
| interactions.timestamp | boolean | The date and time when the interaction was received by the Salesforce server. | Yes |
| interactions.interactionType | string | The type of interaction. Possible values include: - EntryInteraction to represent the type of interaction, such as an inbound message, a message sent failure, or a typing start or stop indicator. - AttachmentInteraction to represent a file attachment that comes within the inbound messaging request. | Yes |
| interactions.payload | array | The interaction payload. | Yes |
| interactions.payload.id | string | The unique ID for the interaction. | Yes |
| interaction.payload.entryType | string | The conversation entry type. Valid values are: - Message–When a conversation participant sends a message. - TypingStartedIndicator–When a conversation participant starts typing. - TypingStoppedIndicator–When a conversation participant stops typing. - MessageDeliveryFailed–When a message fails to send. | Yes |
| interaction.payload.timestamp | boolean | The date and time when the conversation participant started typing. | Yes |
- GitHub: Interaction Service APIs
- GitHub: BYO Demo Connector