Method: conversations.messages.updateReceipt

נשלחת קבלה על הודעה מנציג למשתמש.

בקשת HTTP

PATCH https://businessmessages.googleapis.com/v1/{receipt.name=conversations/*/messages/*/receipt}

בכתובת ה-URL נעשה שימוש בתחביר המרת gRPC.

פרמטרים של נתיב

פרמטרים
receipt.name

string

שם הקבלה, כפי שהוגדר על ידי Business Messages. הפרמטר מקבל את הערך 'שיחות/{messageId}/messages/{messageId}/קבלה'. המזהה {conversationId} הוא המזהה הייחודי של השיחה, ו-{messageId} הוא המזהה הייחודי של ההודעה.

גוף הבקשה

גוף הבקשה מכיל מופע של Receipt.

גוף התגובה

קבלה של ההודעה.

אם הפעולה בוצעה ללא שגיאות, גוף התגובה יכלול נתונים במבנה הבא:

ייצוג JSON 
{
  "name": string,
  "receiptType": enum (ReceiptType)
}
שדות
name

string

שם הקבלה, כפי שהוגדר על ידי Business Messages. הפרמטר מקבל את הערך 'שיחות/{messageId}/messages/{messageId}/קבלה'. המזהה {conversationId} הוא המזהה הייחודי של השיחה, ו-{messageId} הוא המזהה הייחודי של ההודעה.
receiptType

enum (ReceiptType)

סוג קבלה.

היקפי הרשאות

נדרש היקף OAuth הבא:

  • https://www.googleapis.com/auth/businessmessages

למידע נוסף, עיין בסקירה הכללית על OAuth 2.0.

ReceiptType

סוגי קבלות אפשריים.

טיפוסים בני מנייה (enums)
RECEIPT_TYPE_UNSPECIFIED סוג הקבלה לא צוין.
READ ההודעה נקראה.