Method: spaces.messages.create

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

Aceita os 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 do modo de importação)

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

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

Mensagem enviada com autenticação de app

A imagem a seguir mostra como o Chat atribui uma mensagem quando você usa a autenticação do 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 uma conversa por mensagem.
requestId

string

Opcional. Um ID de solicitação exclusivo para esta mensagem. Especificar um ID de solicitação existente retorna a mensagem criada com esse ID em vez de criar uma nova.
messageReplyOption

enum (MessageReplyOption)

Opcional. Especifica se uma mensagem inicia ou responde a uma conversa. 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 ID 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 ID personalizado válido, mas custom-name não é.
  • Contém até 63 caracteres e apenas letras minúsculas, números e hífens.
  • É exclusivo em um espaço. Um app de chat não pode usar o mesmo ID personalizado para mensagens diferentes.

Para mais detalhes, consulte 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. Outros estados podem ser adicionados no futuro.

Tipos enumerados
MESSAGE_REPLY_OPTION_UNSPECIFIED Padrão. Inicia uma nova conversa. Usar essa 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 não acontecer, 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 linha de execução 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 a quando o usuário humano envia a mensagem usando a interface do Chat: nenhuma notificação é enviada ao remetente humano.
NOTIFICATION_TYPE_FORCE_NOTIFY

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

Requer autenticação do app.
NOTIFICATION_TYPE_SILENT

Silencie a notificação como se os destinatários tivessem ativado o Não perturbe do Chat ou silenciado o espaço.

Requer autenticação do app.