new_releases Updates: Check the
release notes for new features and product updates.
AgentLaunchEvent
Stay organized with collections
Save and categorize content based on your preferences.
An event that occurred when an agent's launch status is changed.
The AgentLaunchEvent appears in the "data" field of the "message" object that the agent receives from its Pub/Sub subscription. The "data" field is a base64-encoded string that the agent must decode to match the PartnerEvent structure.
| JSON representation |
{
"eventId": string,
"agentId": string,
"botDisplayName": string,
"brandId": string,
"brandDisplayName": string,
"regionId": string,
"oldLaunchState": enum (AgentLaunchEvent.LaunchState),
"newLaunchState": enum (AgentLaunchEvent.LaunchState),
"actingParty": string,
"comment": string,
"sendTime": string
} |
| Fields |
eventId |
string
A unique event ID assigned for the event instance.
|
agentId |
string
The agent's unique identifier. Set by RCS Business Messaging.
|
botDisplayName |
string
The agent's display name.
|
brandId |
string
The brand's unique identifier.
|
brandDisplayName |
string
The brand's display name.
|
regionId |
string
The identifier for the region where the agent's launch is changed. Format: "/v1/regions/{regionId}". For example, "/v1/regions/fi-rcs".
|
oldLaunchState |
enum (AgentLaunchEvent.LaunchState)
Output only. New type of the launch state.
|
newLaunchState |
enum (AgentLaunchEvent.LaunchState)
Output only. Current type of the launch state.
|
actingParty |
string
Acting party.
|
sendTime |
string (Timestamp format)
Output only. Time at which the server 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".
|
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-22 UTC.
[null,null,["Last updated 2025-08-22 UTC."],[],[],null,["# AgentLaunchEvent\n\nAn event that occurred when an agent's launch status is changed.\n\nThe AgentLaunchEvent appears in the \"data\" field of the \"message\" object that the agent receives from its Pub/Sub subscription. The \"data\" field is a base64-encoded string that the agent must decode to match the PartnerEvent structure.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"eventId\": string, \"agentId\": string, \"botDisplayName\": string, \"brandId\": string, \"brandDisplayName\": string, \"regionId\": string, \"oldLaunchState\": enum (/business-communications/rcs-business-messaging/reference/rest/v1/AgentLaunchEvent.LaunchState), \"newLaunchState\": enum (/business-communications/rcs-business-messaging/reference/rest/v1/AgentLaunchEvent.LaunchState), \"actingParty\": string, \"comment\": string, \"sendTime\": string } ``` |\n\n| Fields ||\n|--------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `eventId` | `string` A unique event ID assigned for the event instance. |\n| `agentId` | `string` The agent's unique identifier. Set by RCS Business Messaging. |\n| `botDisplayName` | `string` The agent's display name. |\n| `brandId` | `string` The brand's unique identifier. |\n| `brandDisplayName` | `string` The brand's display name. |\n| `regionId` | `string` The identifier for the region where the agent's launch is changed. Format: \"/v1/regions/{regionId}\". For example, \"/v1/regions/fi-rcs\". |\n| `oldLaunchState` | `enum (`[AgentLaunchEvent.LaunchState](/business-communications/rcs-business-messaging/reference/rest/v1/AgentLaunchEvent.LaunchState)`)` Output only. New type of the launch state. |\n| `newLaunchState` | `enum (`[AgentLaunchEvent.LaunchState](/business-communications/rcs-business-messaging/reference/rest/v1/AgentLaunchEvent.LaunchState)`)` Output only. Current type of the launch state. |\n| `actingParty` | `string` Acting party. |\n| `comment` | `string` Change comment. |\n| `sendTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. Time at which the server 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\"`. |"]]