שליחת קבלה על הודעה מנציג למשתמש.
בקשת HTTP
PATCH https://businessmessages.googleapis.com/v1/{receipt.name=conversations/*/messages/*/receipt}
בכתובת ה-URL נעשה שימוש בתחביר המרת קידוד של gRPC.
פרמטרים של נתיב
| פרמטרים | |
|---|---|
receipt.name |
שם הקבלה, כפי שהוגדר על ידי Business Messages. הפרמטר מקבל את הערך "שיחות/{conversationId}/messages/{messageId}/קבלה", כאשר {conversationId} הוא המזהה הייחודי של השיחה ו-{messageId} הוא המזהה הייחודי של ההודעה. |
גוף הבקשה
גוף הבקשה מכיל מופע של Receipt.
גוף התשובה
קבלה של ההודעה.
אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכיל נתונים במבנה הבא:
| ייצוג JSON |
|---|
{
"name": string,
"receiptType": enum ( |
| שדות | |
|---|---|
name |
שם הקבלה, כפי שהוגדר על ידי Business Messages. הפרמטר מקבל את הערך "שיחות/{conversationId}/messages/{messageId}/קבלה", כאשר {conversationId} הוא המזהה הייחודי של השיחה ו-{messageId} הוא המזהה הייחודי של ההודעה. |
receiptType |
סוג קבלה. |
היקפי ההרשאות
נדרש היקף ההרשאות הבא של OAuth:
https://www.googleapis.com/auth/businessmessages
למידע נוסף, קראו את המאמר סקירה כללית של OAuth 2.0.
ReceiptType
סוגי קבלות אפשריים.
| טיפוסים בני מנייה (enum) | |
|---|---|
RECEIPT_TYPE_UNSPECIFIED |
סוג הקבלה לא צוין. |
READ |
ההודעה נקראה. |