Method: files.create

Sube un archivo para usarlo en mensajes de tarjeta enriquecida o multimedia.

El agente proporciona la URL o el objeto binario del archivo y, de manera opcional, la URL del archivo de miniatura correspondiente. La plataforma de RBM almacena en caché el archivo durante 30 días y muestra un nombre único que puedes usar para identificar el archivo cuando envías mensajes de agente.

Para subir un archivo binario, realiza una solicitud HTTP POST al URI de carga, omite el campo fileUrl del cuerpo de la solicitud JSON y especifica el objeto binario como el cuerpo de la solicitud POST. Por ejemplo, usa la marca cURL --upload-file con la ruta de archivo completamente calificada del archivo binario.

Solicitud HTTP

  • URI de carga para solicitudes de carga de contenido multimedia:
    POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
  • URI de metadatos, para solicitudes solo de metadatos:
    POST https://rcsbusinessmessaging.googleapis.com/v1/files

La URL usa la sintaxis de la transcodificación gRPC.

Cuerpo de la solicitud

El cuerpo de la solicitud contiene datos con la siguiente estructura:

Representación JSON 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "contentDescription": string,
  "agentId": string
}
Campos
fileUrl

string

Opcional. Es la URL del archivo disponible públicamente. La plataforma de RBM determina el tipo de MIME del archivo a partir del campo content-type de los encabezados HTTP cuando se recupera el archivo.

Tipos de contenido de imagen admitidos: image/jpeg, image/jpg, image/gif o image/png.

Tipos de contenido de video compatibles: video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4 y video/webm.
thumbnailUrl

string

Opcional. Es la URL disponible públicamente de la miniatura que corresponde al archivo. Si no estableces este campo, la plataforma de RBM generará automáticamente una miniatura a partir del archivo. La plataforma de RBM determina el tipo de MIME del archivo a partir del campo content-type de los encabezados HTTP cuando se recupera el archivo.

Tipos de contenido de imagen admitidos: image/jpeg, image/jpg, image/gif o image/png.
contentDescription

string

Opcional. Es la descripción de texto del contenido del archivo. Los lectores de pantalla utilizan esta descripción para ayudar a los usuarios con discapacidades a comprender el contenido del archivo.
agentId

string

Obligatorio. El identificador único del agente.

Cuerpo de la respuesta

Un recurso de archivo con un nombre único que un agente puede usar para identificar el archivo cuando envía mensajes.

Si se ejecuta correctamente, el cuerpo de la respuesta contendrá datos con la siguiente estructura:

Representación JSON 
{
  "name": string
}
Campos
name

string

Nombre único asignado por el servidor del recurso de archivo, que un agente puede usar para identificar el archivo cuando envía mensajes. El formato es "files/{uid}", en el que {uid} es un ID único.

Permisos de autorización

Requiere el siguiente alcance de OAuth:

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

Para obtener más información, consulta la Descripción general de OAuth 2.0.