Method: spaces.messages.create

Cria uma mensagem em um espaço do Google Chat. Para ver um exemplo, consulte Enviar uma mensagem.

Oferece suporte aos seguintes tipos de autenticação:

  • Autenticação do app com o escopo de autorização:
    • https://www.googleapis.com/auth/chat.bot
  • Autenticação do usuário com um dos seguintes escopos de autorização:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (somente espaços no modo de importação)

O Chat atribui o remetente da mensagem de maneira diferente, dependendo do tipo de autenticação que você usa na solicitação.

A imagem a seguir mostra como o Chat atribui uma mensagem quando você usa a autenticação de app. O Chat mostra o app do Chat como o remetente da mensagem. O conteúdo da mensagem pode ter texto (text), cards (cardsV2) e widgets acessórios (accessoryWidgets).

Mensagem enviada com autenticação do app

A imagem a seguir mostra como o Chat atribui uma mensagem quando você usa a autenticação de usuário. O Chat mostra o usuário como o remetente da mensagem e atribui o app do Chat à mensagem mostrando o nome dele. O conteúdo da mensagem só pode conter texto (text).

Mensagem enviada com autenticação do usuário

O tamanho máximo da mensagem, incluindo o conteúdo, é de 32.000 bytes.

Para solicitações de webhook, a resposta não contém a mensagem completa. A resposta preenche apenas os campos name e thread.name, além das informações que estavam na solicitação.

Solicitação HTTP

POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages

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

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. O nome do recurso do espaço em que uma mensagem será criada.

Formato: spaces/{space}

Parâmetros de consulta

Parâmetros
threadKey
(deprecated)

string

Opcional. Descontinuado: use thread.thread_key. ID da conversa. Aceita até 4.000 caracteres. Para iniciar ou adicionar a uma conversa, crie uma mensagem e especifique um threadKey ou o thread.name. Para ver um exemplo de uso, consulte Iniciar ou responder a um agrupamento de mensagens.

requestId

string

Opcional. Um ID exclusivo para essa solicitação. Recomendamos um UUID aleatório. Especificar um ID de solicitação torna a solicitação idempotente, o que garante que várias solicitações idênticas com o mesmo ID resultem na criação de apenas uma mensagem. As solicitações subsequentes com o mesmo ID retornam a mensagem atual e não a atualizam, mesmo que os detalhes solicitados sejam diferentes do estado atual.

Para usar esse campo de forma eficaz:

  • Verifique se as solicitações subsequentes são idênticas e usam as mesmas credenciais de autenticação da solicitação original.
  • Se uma mensagem já tiver sido criada com o ID de solicitação fornecido, a solicitação vai retornar essa mensagem. A mensagem retornada pode não estar totalmente preenchida. A API repete a mensagem na sua solicitação com os nomes de recursos atribuídos pelo sistema preenchidos. Para recuperar os metadados mais recentes da mensagem, chame messages.get.
  • Reutilizar um ID de solicitação com um usuário autenticado diferente resulta em um erro.
messageReplyOption

enum (MessageReplyOption)

Opcional. Especifica se uma mensagem inicia uma conversa ou responde a uma. Compatível apenas com espaços nomeados.

Ao responder às interações do usuário, esse campo é ignorado. Para interações em uma conversa, a resposta é criada na mesma conversa. Caso contrário, a resposta será criada como uma nova conversa.

messageId

string

Opcional. Um código personalizado para uma mensagem. Permite que os apps do Chat recebam, atualizem ou excluam uma mensagem sem precisar armazenar o ID atribuído pelo sistema no nome do recurso da mensagem (representado no campo name da mensagem).

O valor desse campo precisa atender aos seguintes requisitos:

  • Começa com client-. Por exemplo, client-custom-name é um código personalizado válido, mas custom-name não é.
  • Contém até 63 caracteres e apenas letras minúsculas, números e hifens.
  • É exclusivo em um espaço. Um app do Chat não pode usar o mesmo código personalizado para mensagens diferentes.

Veja mais detalhes em Nomear uma mensagem.

createMessageNotificationOptions

object (CreateMessageNotificationOptions)

Opcional. Controla o comportamento da notificação quando a mensagem é postada. Para saber mais, consulte Forçar notificações ou enviar mensagens silenciosas.

Corpo da solicitação

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

Corpo da resposta

Se a solicitação for bem-sucedida, o corpo da resposta incluirá uma instância de Message.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

Para mais informações, consulte o guia de autorização.

MessageReplyOption

Especifica como responder a uma mensagem. Mais estados podem ser adicionados no futuro.

Tipos enumerados
MESSAGE_REPLY_OPTION_UNSPECIFIED Padrão. Inicia uma nova conversa. O uso dessa opção ignora qualquer thread ID ou threadKey incluído.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Cria a mensagem como uma resposta à conversa especificada por thread ID ou threadKey. Se isso falhar, a mensagem vai iniciar uma nova conversa.
REPLY_MESSAGE_OR_FAIL Cria a mensagem como uma resposta à conversa especificada por thread ID ou threadKey. Se um novo threadKey for usado, uma nova conversa será criada. Se a criação da mensagem falhar, um erro NOT_FOUND será retornado.

CreateMessageNotificationOptions

Opções para o comportamento da notificação quando a mensagem é postada.

Representação JSON
{
  "notificationType": enum (NotificationType)
}
Campos
notificationType

enum (NotificationType)

O tipo de notificação da mensagem.

NotificationType

As opções de tipos de notificação para a mensagem.

Tipos enumerados
NOTIFICATION_TYPE_NONE Comportamento padrão. O comportamento da notificação é semelhante ao de quando o usuário humano envia a mensagem usando a interface do Chat: nenhuma notificação é enviada ao remetente humano.
NOTIFICATION_TYPE_INCLUDE_HUMAN_CREATOR

Uma notificação (push, por e-mail etc.) é enviada ao usuário que criou a mensagem (por exemplo, o usuário cuja autenticação foi usada para criar a mensagem), e a mensagem é marcada como não lida.

Isso não vai substituir as configurações de notificação do usuário para o espaço. Por exemplo, se o usuário tiver escolhido não receber notificações de um espaço, ele não será notificado, mesmo que essa opção esteja definida.

Requer autenticação do usuário.

NOTIFICATION_TYPE_FORCE_NOTIFY

Forçar a notificação dos destinatários. Isso ignora as configurações de notificação de espaço dos usuários e as configurações de Não Perturbe do Chat. Essa opção não ignora as configurações do modo Não Perturbe no dispositivo.

Exige autenticação do app.

NOTIFICATION_TYPE_SILENT

Não notificar os destinatários nem marcar a mensagem como não lida. Isso funciona de forma semelhante a silenciar a conversa ou ativar o modo Não perturbe do Chat.

Exige autenticação do app.