We will be winding down Google Business Messages on July 31, 2024. Read more
here.
Method: conversations.messages.updateReceipt
Stay organized with collections
Save and categorize content based on your preferences.
Sends a receipt for a message from an agent to a user.
HTTP request
PATCH https://businessmessages.googleapis.com/v1/{receipt.name=conversations/*/messages/*/receipt}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
receipt.name |
string
The name of the receipt, as set by Business Messages. Resolves to "conversations/{conversationId}/messages/{messageId}/receipt", where {conversationId} is the unique ID for the conversation and {messageId} is the unique ID for the message.
|
Request body
The request body contains an instance of Receipt.
Response body
A receipt of the message.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"name": string,
"receiptType": enum (ReceiptType)
} |
| Fields |
name |
string
The name of the receipt, as set by Business Messages. Resolves to "conversations/{conversationId}/messages/{messageId}/receipt", where {conversationId} is the unique ID for the conversation and {messageId} is the unique ID for the message.
|
receiptType |
enum (ReceiptType)
A receipt type.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/businessmessages
For more information, see the OAuth 2.0 Overview.
ReceiptType
| Enums |
RECEIPT_TYPE_UNSPECIFIED |
Unspecified receipt type. |
READ |
Message read. |
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 2024-11-14 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-11-14 UTC."],[[["\u003cp\u003eSends a receipt to a user confirming an agent's message was received.\u003c/p\u003e\n"],["\u003cp\u003eUses a PATCH request to the specified URL with the receipt information in the request body.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003ehttps://www.googleapis.com/auth/businessmessages\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eThe response body contains the receipt details, including its name and type (read or unspecified).\u003c/p\u003e\n"],["\u003cp\u003eReceipt types indicate whether the message was read by the user or remains unacknowledged.\u003c/p\u003e\n"]]],[],null,["# Method: conversations.messages.updateReceipt\n\nSends a receipt for a message from an agent to a user.\n\n### HTTP request\n\n`PATCH https://businessmessages.googleapis.com/v1/{receipt.name=conversations/*/messages/*/receipt}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `receipt.name` | `string` The name of the receipt, as set by Business Messages. Resolves to \"conversations/{conversationId}/messages/{messageId}/receipt\", where {conversationId} is the unique ID for the conversation and {messageId} is the unique ID for the message. |\n\n### Request body\n\nThe request body contains an instance of [Receipt](/business-communications/business-messages/reference/rest/v1/conversations.messages/updateReceipt#body.Receipt).\n\n### Response body\n\nA receipt of the message.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"receiptType\": enum (/business-communications/business-messages/reference/rest/v1/conversations.messages/updateReceipt#ReceiptType) } ``` |\n\n| Fields ||\n|---------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` The name of the receipt, as set by Business Messages. Resolves to \"conversations/{conversationId}/messages/{messageId}/receipt\", where {conversationId} is the unique ID for the conversation and {messageId} is the unique ID for the message. |\n| `receiptType` | `enum (`[ReceiptType](/business-communications/business-messages/reference/rest/v1/conversations.messages/updateReceipt#ReceiptType)`)` A receipt type. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/businessmessages`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2).\n\nReceiptType\n-----------\n\nPossible receipt types.\n\n| Enums ||\n|----------------------------|---------------------------|\n| `RECEIPT_TYPE_UNSPECIFIED` | Unspecified receipt type. |\n| `READ` | Message read. |"]]