Method: attachments.create

Crea un allegato per un agente virtuale RCS for Business. Questo metodo supporta i caricamenti diretti di contenuti multimediali e i caricamenti in più parti.

Lo sviluppatore dell'agente fornisce il file binario da caricare.

Per caricare un file binario, invia una richiesta POST HTTP all'URI di caricamento e specifica il file binario come corpo della richiesta POST. Ad esempio, utilizza il flag --upload-file di cURL con il percorso completo del file binario.

Parametri
Parametro Tipo Descrizione Obbligatorio?
uploadType string Specifica il tipo di caricamento. I valori supportati sono media per il caricamento diretto dei file e multipart per il caricamento congiunto di file e metadati. Sì
attachmentOperationSource enum Obbligatorio se uploadType=media. Specifica il motivo del caricamento. Per i valori possibili, consulta AttachmentOperationSource. Solo per i contenuti multimediali
Corpo della richiesta

La struttura del corpo della richiesta dipende dal parametro di query uploadType.

Se uploadType=media:

  • Il corpo della richiesta deve contenere solo i byte del file non elaborati.
  • L'intestazione Content-Type deve essere impostata sul tipo MIME del file. Nota: sono supportati solo i PDF.
  • Il parametro attachmentOperationSource deve essere fornito come parametro di query.

Se uploadType=multipart:

  • Il corpo della richiesta deve essere formattato come multipart/form-data.
  • La richiesta deve contenere due parti:
    • Metadati: un oggetto JSON contenente i metadati di caricamento. Questa parte deve includere attachmentOperationSource.
    • File: i byte del file non elaborati.

Richiesta HTTP

  • URI di caricamento per le richieste di caricamento di contenuti multimediali:
    POST https://businesscommunications.googleapis.com/upload/v1/{parent=brands/*/agents/*}/attachments
  • URI dei metadati per le richieste solo di metadati:
    POST https://businesscommunications.googleapis.com/v1/{parent=brands/*/agents/*}/attachments

L'URL utilizza la sintassi di transcodifica gRPC.

Parametri del percorso

Parametri
parent

string

Obbligatorio. L'identificatore univoco dell'agente. Se l'identificatore del brand è "1234" e l'identificatore dell'agente è "5678", questo parametro viene risolto in "brands/1234/agents/5678".

Corpo della richiesta

Il corpo della richiesta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "attachmentOperationSource": enum (AttachmentOperationSource)
}
Campi
attachmentOperationSource

enum (AttachmentOperationSource)

Obbligatorio. L'origine che ha attivato il caricamento dell'allegato.

Corpo della risposta

Una risorsa allegato con un nome univoco che un agente può utilizzare per identificare l'allegato.

In caso di esito positivo, il corpo della risposta contiene dati con la seguente struttura:

Rappresentazione JSON 
{
  "name": string,
  "gcsUrl": string,
  "displayName": string,
  "description": string,
  "contentType": string,
  "sizeBytes": string,
  "attachmentOperationSource": enum (AttachmentOperationSource),
  "uploadTime": string,
  "uploadError": {
    object (Status)
  }
}
Campi
name

string

Solo output. L'identificatore univoco dell'allegato. Sola lettura. Definito dalla piattaforma.
gcsUrl

string

Solo output. L'URL GCS dell'allegato. Si tratta dell'URL accessibile pubblicamente utilizzato per recuperare l'allegato da GCS.
displayName

string

Facoltativo. Il nome visualizzato dell'allegato.
description

string

Facoltativo. La descrizione testuale dei contenuti dell'allegato. Gli screen reader utilizzano questa descrizione per aiutare gli utenti con disabilità a comprendere i contenuti dell'allegato.
contentType

string

Facoltativo. Il tipo di contenuti dell'allegato.
sizeBytes

string (int64 format)

Solo output. Le dimensioni in byte dell'allegato.
attachmentOperationSource

enum (AttachmentOperationSource)

Obbligatorio. L'origine che ha attivato il caricamento dell'allegato. Specifica il motivo del caricamento. Per i valori possibili, consulta AttachmentOperationSource.
uploadTime

string (Timestamp format)

Solo output. L'ora in cui l'allegato è stato caricato su GCS.

Utilizza RFC 3339, in cui l'output generato è sempre con normalizzazione Z e utilizza 0, 3, 6 o 9 cifre frazionarie. Sono accettati anche offset diversi da "Z". Esempi: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" o "2014-10-02T15:01:23+05:30".
uploadError

object (Status)

Solo output. Il risultato dell'errore, se presente, che si è verificato durante il caricamento dell'allegato.

Ambiti di autorizzazione

Richiede il seguente ambito OAuth:

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

Per saperne di più, consulta la OAuth 2.0 Overview.

AttachmentOperationSource

Elenco delle origini delle operazioni sugli allegati.

Enum
ATTACHMENT_OPERATION_SOURCE_UNSPECIFIED L'origine dell'operazione sull'allegato non è specificata
VERIFICATION_PAGE Pagina di verifica della console.
VERIFICATION_ATTACHMENT_VIA_BC_API Allegato di supporto per la verifica dell'agente, caricato utilizzando l'API Business Communications.