new_releases עדכונים: בדקו את
נתוני הגרסה כדי לגלות תכונות חדשות ועדכוני מוצרים.
ServerEvent
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
אירוע שקרה בצד השרת שקשור לשיחה בין נציג לבין משתמש.
לדוגמה, אם הבוט מגדיר זמן חיים (TTL) להודעה והזמן הזה מסתיים, האירוע הזה יופעל כדי להודיע לשותף שההודעה מהבוט הסתיימה.
האירוע ServerEvent מופיע בשדה data של האובייקט message שהסוכן מקבל מהמינוי שלו ל-Pub/Sub. השדה 'data' הוא מחרוזת בקידוד Base64 שהסוכן צריך לפענח כדי להתאים למבנה ServerEvent.
| ייצוג ב-JSON |
{
"phoneNumber": string,
"agentId": string,
"messageId": string,
"eventType": enum (ServerEvent.EventType),
"eventId": string,
"sendTime": string
} |
| שדות |
phoneNumber |
string
מספר הטלפון (בפורמט E.164) של המשתמש שהיה מעורב באירוע.
|
agentId |
string
המזהה הייחודי של הסוכן. מוגדר על ידי RCS Business Messaging.
|
messageId |
string
מזהה ההודעה ב-RCS שמשויך לאירוע.
|
eventType |
enum (ServerEvent.EventType)
סוג האירוע.
|
eventId |
string
מזהה אירוע ייחודי שהוקצה למופע האירוע.
|
sendTime |
string (Timestamp format)
השעה שבה השרת שולח את האירוע. הפלט שנוצר תמיד יהיה בפורמט RFC 3339, עם נורמליזציה של Z ושימוש ב-0, 3, 6 או 9 ספרות אחרי הנקודה. אפשר להשתמש גם בהיסטים אחרים מלבד Z. דוגמאות: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" או "2014-10-02T15:01:23+05:30".
|
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-08-22 (שעון UTC).
[null,null,["עדכון אחרון: 2025-08-22 (שעון UTC)."],[[["\u003cp\u003eServerEvents are notifications about occurrences related to conversations between agents and users, such as when a bot message's TTL expires.\u003c/p\u003e\n"],["\u003cp\u003eThese events are delivered within the "data" field of a "message" object in a Pub/Sub subscription, requiring base64 decoding by the agent.\u003c/p\u003e\n"],["\u003cp\u003eEach ServerEvent contains fields such as \u003ccode\u003ephoneNumber\u003c/code\u003e, \u003ccode\u003eagentId\u003c/code\u003e, \u003ccode\u003emessageId\u003c/code\u003e, \u003ccode\u003eeventType\u003c/code\u003e, \u003ccode\u003eeventId\u003c/code\u003e, and \u003ccode\u003esendTime\u003c/code\u003e to provide specific context.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eeventType\u003c/code\u003e field specifies the type of the event, while \u003ccode\u003esendTime\u003c/code\u003e indicates the server's event dispatch time in RFC 3339 format.\u003c/p\u003e\n"],["\u003cp\u003eThe information is structured in a JSON format that contains information regarding the server event and it's corresponding data.\u003c/p\u003e\n"]]],[],null,["# ServerEvent\n\nAn event that occurred server side that is related to a conversation between an agent and a user.\n\nFor example, if the bot sets a TTL for the message and the TTL expires, this event will be fired to notify the partner that the bot message timed out.\n\nThe ServerEvent 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 ServerEvent structure.\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"phoneNumber\": string, \"agentId\": string, \"messageId\": string, \"eventType\": enum (/business-communications/rcs-business-messaging/reference/rest/v1/ServerEvent.EventType), \"eventId\": string, \"sendTime\": string } ``` |\n\n| Fields ||\n|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `phoneNumber` | `string` Phone number (in E.164 format) of the user involved in the event. |\n| `agentId` | `string` The agent's unique identifier. Set by RCS Business Messaging. |\n| `messageId` | `string` The RCS message ID of the message that is associated with the event. |\n| `eventType` | `enum (`[ServerEvent.EventType](/business-communications/rcs-business-messaging/reference/rest/v1/ServerEvent.EventType)`)` Type of the event. |\n| `eventId` | `string` A unique event ID assigned for the event instance. |\n| `sendTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` 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\"`. |"]]
