Method: conversations.messages.updateReceipt

Envia o comprovante de uma mensagem de um agente para um usuário.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
receipt.name

string

O nome do comprovante, conforme definido pelo Business Messages. Resolve para "conversations/{conversationId}/messages/{messageId}/receipt", em que {conversationId} é o ID exclusivo da conversa e {messageId} é o ID exclusivo da mensagem.

Corpo da solicitação

O corpo da solicitação contém uma instância de Receipt.

Corpo da resposta

Um comprovante da mensagem.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON
{
  "name": string,
  "receiptType": enum (ReceiptType)
}
Campos
name

string

O nome do comprovante, conforme definido pelo Business Messages. Resolve para "conversations/{conversationId}/messages/{messageId}/receipt", em que {conversationId} é o ID exclusivo da conversa e {messageId} é o ID exclusivo da mensagem.

receiptType

enum (ReceiptType)

Um tipo de comprovante.

Escopos de autorização

Requer o seguinte escopo OAuth:

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

Para mais informações, consulte a Visão geral do OAuth 2.0.

ReceiptType

Possíveis tipos de comprovantes.

Enums
RECEIPT_TYPE_UNSPECIFIED Tipo de comprovante não especificado.
READ Mensagem lida.