new_releases Mises à jour : Consultez les
notes de version pour découvrir les nouvelles fonctionnalités et les mises à jour du produit.
UserEvent
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Événement survenu sur le client RCS de l'utilisateur et lié à une conversation avec l'agent.
Par exemple, un événement peut indiquer que l'utilisateur est en train de saisir du texte ou qu'il a lu un message précédent de l'agent.
L'UserEvent apparaît dans le champ "data" de l'objet "message" que l'agent reçoit de son abonnement Google Pub/Sub. Le champ "data" est une chaîne encodée en base64 que l'agent doit décoder pour correspondre à la structure UserEvent.
| Représentation JSON |
{
"senderPhoneNumber": string,
"eventType": enum (UserEvent.EventType),
"eventId": string,
"messageId": string,
"sendTime": string,
"agentId": string
} |
| Champs |
senderPhoneNumber |
string
Numéro de téléphone (au format E.164) de l'utilisateur concerné par l'événement.
|
eventType |
enum (UserEvent.EventType)
Type d'événement.
|
eventId |
string
ID d'événement unique, attribué par le client RCS de l'utilisateur qui envoie l'événement.
|
messageId |
string
ID du message associé à l'événement. Par exemple, un message qui a été distribué au client RCS de l'utilisateur ou lu par celui-ci. Ce champ est renseigné pour les événements DELIVERED et READ.
|
sendTime |
string (Timestamp format)
Heure à laquelle le client RCS envoie l'événement. Utilise la norme RFC 3339, où la sortie générée utilise le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
|
agentId |
string
Identifiant unique de l'agent. Défini par RCS Business Messaging.
|
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/08/22 (UTC).
[null,null,["Dernière mise à jour le 2025/08/22 (UTC)."],[[["\u003cp\u003eUserEvents indicate user actions within an RCS conversation with an agent, such as typing or reading a message.\u003c/p\u003e\n"],["\u003cp\u003eThese events are transmitted to the agent within the base64-encoded "data" field of the "message" object from Google Pub/Sub.\u003c/p\u003e\n"],["\u003cp\u003eThe UserEvent structure includes details like \u003ccode\u003esenderPhoneNumber\u003c/code\u003e, \u003ccode\u003eeventType\u003c/code\u003e, \u003ccode\u003eeventId\u003c/code\u003e, \u003ccode\u003emessageId\u003c/code\u003e, \u003ccode\u003esendTime\u003c/code\u003e, and \u003ccode\u003eagentId\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003emessageId\u003c/code\u003e specifies the message associated with the event, which is only populated for DELIVERED and READ event types.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esendTime\u003c/code\u003e field details when the event occurred, formatted according to RFC 3339.\u003c/p\u003e\n"]]],[],null,["# UserEvent\n\nAn event that occurred on the user's RCS client and was related to a conversation with the agent.\n\nFor instance, an event can indicate that the user is typing or that an earlier message from the agent was read by the user.\n\nThe UserEvent appears in the \"data\" field of the \"message\" object that the agent receives from its Google Pub/Sub subscription. The \"data\" field is a base64-encoded string that the agent must decode to match the UserEvent structure.\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"senderPhoneNumber\": string, \"eventType\": enum (/business-communications/rcs-business-messaging/reference/rest/v1/UserEvent.EventType), \"eventId\": string, \"messageId\": string, \"sendTime\": string, \"agentId\": string } ``` |\n\n| Fields ||\n|---------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `senderPhoneNumber` | `string` Phone number (in E.164 format) of the user involved in the event. |\n| `eventType` | `enum (`[UserEvent.EventType](/business-communications/rcs-business-messaging/reference/rest/v1/UserEvent.EventType)`)` Type of the event. |\n| `eventId` | `string` A unique event ID, assigned by the sending user's RCS client. |\n| `messageId` | `string` The ID of the message that is associated with the event. For example, a message that was delivered to the user's RCS client or read by the user. This field is populated for DELIVERED and READ events. |\n| `sendTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Time at which RCS client sends the event. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than \"Z\" are also accepted. Examples: `\"2014-10-02T15:01:23Z\"`, `\"2014-10-02T15:01:23.045123456Z\"` or `\"2014-10-02T15:01:23+05:30\"`. |\n| `agentId` | `string` The agent's unique identifier. Set by RCS Business Messaging. |"]]
