- Richiesta HTTP
- Parametri di percorso
- Parametri di query
- Corpo della richiesta
- Corpo della risposta
- Ambiti di autorizzazione
- MessageReplyOption
- CreateMessageNotificationOptions
- NotificationType
- Fai una prova!
Crea un messaggio in uno spazio di Google Chat. Per un esempio, vedi Invia 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.createhttps://www.googleapis.com/auth/chat.messageshttps://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 che utilizzi nella richiesta.
L'immagine seguente mostra come Chat attribuisce un messaggio quando utilizzi l'autenticazione dell'app. Chat mostra l'app di Chat come mittente del messaggio. Il contenuto del messaggio può includere testo (text), schede (cardsV2) e widget accessori (accessoryWidgets).
La seguente immagine mostra come Chat attribuisce un messaggio quando utilizzi l'autenticazione utente. Chat mostra l'utente come mittente del messaggio e attribuisce l'app di Chat al messaggio visualizzandone il nome. Il contenuto del messaggio può contenere solo testo (text).
La dimensione massima del messaggio, inclusi i contenuti, è di 32.000 byte.
Per le richieste di webhook, la risposta non contiene il messaggio completo. La risposta compila solo i campi name e thread.name, oltre alle informazioni presenti nella richiesta.
Richiesta HTTP
POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages
L'URL utilizza la sintassi di transcodifica gRPC.
Parametri di percorso
| Parametri | |
|---|---|
parent |
Obbligatorio. Il nome della risorsa dello spazio in cui creare un messaggio. Formato: |
Parametri di query
| Parametri | |
|---|---|
threadKey |
Facoltativo. Ritirato: utilizza |
requestId |
Facoltativo. Un ID univoco per questa richiesta. Si consiglia un UUID casuale. Se specifichi un ID richiesta, la richiesta diventa idempotente, il che garantisce che più richieste identiche con lo stesso ID richiesta generino la creazione di un solo messaggio. Le richieste successive con lo stesso ID richiesta restituiscono il messaggio esistente e non lo aggiornano, anche se i dettagli richiesti differiscono dallo stato attuale. Per utilizzare questo campo in modo efficace:
|
messageReplyOption |
Facoltativo. Specifica se un messaggio avvia un thread o risponde a un thread. Funzionalità supportata 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 |
Facoltativo. Un ID personalizzato per un messaggio. Consente alle app di 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 Il valore di questo campo deve soddisfare i seguenti requisiti:
Per maggiori dettagli, vedi Assegnare un nome a un messaggio. |
createMessageNotificationOptions |
Facoltativo. Controlla il comportamento delle notifiche quando il messaggio viene pubblicato. Per scoprire di più, consulta Forza le notifiche o invia 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.bothttps://www.googleapis.com/auth/chat.importhttps://www.googleapis.com/auth/chat.messageshttps://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. Se utilizzi questa opzione, vengono ignorati tutti i thread ID o inclusi. |
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD |
Crea il messaggio come risposta al thread specificato da thread ID o . In caso contrario, il messaggio avvia un nuovo thread. |
REPLY_MESSAGE_OR_FAIL |
Crea il messaggio come risposta al thread specificato da thread ID o . Se viene utilizzato un nuovo threadKey, viene creato un nuovo thread. Se la creazione del messaggio non va a buon fine, viene restituito un errore NOT_FOUND. |
CreateMessageNotificationOptions
Opzioni per il comportamento delle notifiche quando viene pubblicato il messaggio.
| Rappresentazione JSON |
|---|
{
"notificationType": enum ( |
| Campi | |
|---|---|
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 la UI di Chat: non viene inviata alcuna notifica al mittente umano. |
NOTIFICATION_TYPE_INCLUDE_HUMAN_CREATOR |
Viene inviata una notifica (notifiche push, notifiche via email e così via) all'utente che ha creato il messaggio (ad esempio, l'utente la cui autenticazione è stata utilizzata per creare il messaggio) e il messaggio viene contrassegnato come non letto. Questa azione non eseguirà l'override delle impostazioni di notifica utente esistenti per lo spazio. Ad esempio, se l'utente ha scelto di non ricevere notifiche per uno spazio, non le riceverà anche se questa opzione è impostata. Richiede l'autenticazione utente. |
NOTIFICATION_TYPE_FORCE_NOTIFY |
Forza la notifica ai destinatari. In questo modo, vengono ignorate 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 |
Non inviare notifiche ai destinatari e non contrassegnare il messaggio come da leggere. Questo comportamento è simile a quello dell'utente che disattiva l'audio della conversazione o attiva la modalità Non disturbare di Chat. Richiede l'autenticazione dell'app. |