REST Resource: attachments

Recurso: Attachment

Um recurso de anexo com um nome exclusivo que um agente pode usar para identificar o anexo.

Representação JSON
{
  "name": string,
  "gcsUrl": string,
  "displayName": string,
  "description": string,
  "contentType": string,
  "sizeBytes": string,
  "attachmentOperationSource": enum (AttachmentOperationSource),
  "uploadTime": string,
  "uploadError": {
    object (Status)
  }
}
Campos
name

string

Apenas saída. O identificador exclusivo do anexo. Somente leitura. Definido pela plataforma.

gcsUrl

string

Apenas saída. O URL do GCS do anexo. Esse é o URL de acesso público usado para buscar o anexo no GCS.

displayName

string

Opcional. Nome de exibição do anexo.

description

string

Opcional. Descrição textual do conteúdo do anexo. Os leitores de tela usam essa descrição para ajudar os usuários com deficiência a entender o que o anexo contém.

contentType

string

Opcional. O tipo de conteúdo do anexo.

sizeBytes

string (int64 format)

Apenas saída. Tamanho em bytes do anexo.

attachmentOperationSource

enum (AttachmentOperationSource)

Obrigatório. A origem que acionou o upload do anexo.

Obrigatório se uploadType=media. Especifica o motivo do upload. Consulte AttachmentOperationSource para conferir os valores possíveis.

uploadTime

string (Timestamp format)

Apenas saída. A hora em que o anexo foi enviado ao GCS.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

uploadError

object (Status)

Apenas saída. Resultado de erro, se houver, que ocorreu durante o upload do anexo.

AttachmentOperationSource

Lista de origens de operações de anexos.

Tipos enumerados
ATTACHMENT_OPERATION_SOURCE_UNSPECIFIED A operação de anexo não foi especificada
VERIFICATION_PAGE Página de verificação do console.
VERIFICATION_ATTACHMENT_VIA_BC_API Anexo de suporte para verificação de agente, enviado usando a API Business Communications.

Status

O tipo Status define um modelo de erro lógico que é adequado a diferentes ambientes de programação, incluindo APIs REST e RPC. É usado por gRPC. Cada mensagem Status contém três partes de dados: código do erro, mensagem de erro e detalhes do erro.

É possível descobrir mais sobre esse modelo de erro e como trabalhar com ele no Guia de design de API.

Representação JSON
{
  "code": integer,
  "message": string,
  "details": [
    {
      "@type": string,
      field1: ...,
      ...
    }
  ]
}
Campos
code

integer

O código de status, que precisa ser um valor de tipo enumerado de google.rpc.Code.

message

string

Uma mensagem de erro em inglês para o desenvolvedor. Qualquer mensagem de erro para o usuário precisa ser localizada e enviada no campo google.rpc.Status.details, ou localizada pelo cliente.

details[]

object

Uma lista de mensagens com os detalhes do erro. Há um conjunto comum de tipos de mensagens para as APIs usarem.

Um objeto contendo campos de um tipo arbitrário. Um campo adicional "@type" contém uma URI que identifica o tipo. Exemplo: { "id": 1234, "@type": "types.example.com/standard/id" }.

Métodos

create

Cria um anexo para um agente do RCS for Business.