Method: spaces.messages.create

Crea un messaggio in uno spazio di Chat di Google. Per un esempio, vedi Inviare un messaggio.

Supporta i seguenti tipi di autenticazione:

  • Autenticazione dell'app con l'ambito di autorizzazione:
    • https://www.googleapis.com/auth/chat.bot
  • Autenticazione utente con uno dei seguenti ambiti di autorizzazione:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (solo spazi in modalità di importazione)

Chat attribuisce il mittente del messaggio in modo diverso a seconda del tipo di autenticazione utilizzato nella richiesta.

L'immagine seguente mostra come Chat attribuisce un messaggio quando utilizzi l'autenticazione dell'app. Chat mostra l'app Chat come mittente del messaggio. Il contenuto del messaggio può contenere testo (text), schede (cardsV2) e widget accessori (accessoryWidgets).

Messaggio inviato con l'autenticazione dell'app

L'immagine seguente mostra come Chat attribuisce un messaggio quando utilizzi l'autenticazione utente. Chat mostra l'utente come mittente del messaggio e attribuisce l'app Chat al messaggio visualizzandone il nome. Il contenuto del messaggio può contenere solo testo (text).

Messaggio inviato con l'autenticazione utente

La dimensione massima del messaggio, inclusi i contenuti, è di 32.000 byte.

Per le richieste webhook, la risposta non contiene il messaggio completo. La risposta popola solo i campi name e thread.name, oltre alle informazioni contenute nella richiesta.

Richiesta HTTP

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

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. Il nome della risorsa dello spazio in cui creare un messaggio.

Formato: spaces/{space}

Parametri di query

Parametri
threadKey
(deprecated)

string

Facoltativo. Obsoleto: utilizza thread.thread_key. ID del thread. Supporta fino a 4000 caratteri. Per avviare o aggiungere un thread, crea un messaggio e specifica un threadKey o thread.name. Per un esempio di utilizzo, vedi Avviare o rispondere a un thread di messaggi.
requestId

string

Facoltativo. Un ID richiesta univoco per questo messaggio. Se specifichi un ID richiesta esistente, viene restituito il messaggio creato con quell'ID anziché crearne uno nuovo.
messageReplyOption

enum (MessageReplyOption)

Facoltativo. Specifica se un messaggio avvia un thread o risponde a uno. Supportato solo negli spazi con un nome.

Quando rispondi alle interazioni degli utenti, questo campo viene ignorato. Per le interazioni all'interno di un thread, la risposta viene creata nello stesso thread. In caso contrario, la risposta viene creata come un nuovo thread.
messageId

string

Facoltativo. Un ID personalizzato per un messaggio. Consente alle app Chat di recuperare, aggiornare o eliminare un messaggio senza dover memorizzare l'ID assegnato dal sistema nel nome della risorsa del messaggio (rappresentato nel campo name del messaggio).

Il valore di questo campo deve soddisfare i seguenti requisiti:

  • Inizia con client-. Ad esempio, client-custom-name è un ID personalizzato valido, ma custom-name non lo è.
  • Contiene fino a 63 caratteri e solo lettere minuscole, numeri e trattini.
  • È univoco all'interno di uno spazio. Un'app Chat non può utilizzare lo stesso ID personalizzato per messaggi diversi.

Per maggiori dettagli, vedi Assegnare un nome a un messaggio.
createMessageNotificationOptions

object (CreateMessageNotificationOptions)

Facoltativo. Controlla il comportamento delle notifiche quando il messaggio viene pubblicato. Per saperne di più, vedi Forzare le notifiche o inviare messaggi silenziosi.

Corpo della richiesta

Il corpo della richiesta contiene un'istanza di Message.

Corpo della risposta

In caso di esito positivo, il corpo della risposta contiene un'istanza di Message appena creata.

Ambiti di autorizzazione

Richiede uno dei seguenti ambiti 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

Per ulteriori informazioni, consulta la guida all'autorizzazione.

MessageReplyOption

Specifica come rispondere a un messaggio. In futuro potrebbero essere aggiunti altri stati.

Enum
MESSAGE_REPLY_OPTION_UNSPECIFIED Predefinita. Avvia un nuovo thread. L'utilizzo di questa opzione ignora qualsiasi thread ID o threadKey incluso.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD Crea il messaggio come risposta al thread specificato da thread ID o threadKey. Se non riesce, il messaggio avvia un nuovo thread.
REPLY_MESSAGE_OR_FAIL Crea il messaggio come risposta al thread specificato da thread ID o threadKey. Se viene utilizzato un nuovo threadKey, viene creato un nuovo thread. Se la creazione del messaggio non riesce, viene restituito un errore NOT_FOUND.

CreateMessageNotificationOptions

Opzioni per il comportamento delle notifiche quando il messaggio viene pubblicato.

Rappresentazione JSON 
{
  "notificationType": enum (NotificationType)
}
Campi
notificationType

enum (NotificationType)

Il tipo di notifica per il messaggio.

NotificationType

Le opzioni dei tipi di notifica per il messaggio.

Enum
NOTIFICATION_TYPE_NONE Comportamento predefinito. Il comportamento delle notifiche è simile a quello che si verifica quando l'utente umano invia il messaggio utilizzando l'interfaccia utente di Chat: non viene inviata alcuna notifica al mittente umano.
NOTIFICATION_TYPE_FORCE_NOTIFY

Forza la notifica ai destinatari. Questa opzione ignora le impostazioni di notifica dello spazio degli utenti e le impostazioni Non disturbare di Chat. Questa opzione non ignora le impostazioni Non disturbare a livello di dispositivo.

Richiede l'autenticazione dell'app.
NOTIFICATION_TYPE_SILENT

Silenzia la notifica come se i destinatari avessero attivato la funzionalità Non disturbare di Chat o avessero silenziato lo spazio.

Richiede l'autenticazione dell'app.