Method: files.create

Sube un archivo para usarlo en mensajes de tarjetas enriquecidas o multimedia.

El agente proporciona la URL o el archivo binario del archivo y, de manera opcional, la URL del archivo de miniatura correspondiente.

Importante: Para proteger la privacidad y la seguridad de los usuarios, la plataforma de RBM descarga y procesa archivos multimedia y PDF de las URLs proporcionadas antes de entregarlos al usuario. Esto evita el seguimiento de agentes por URLs únicas. Por lo tanto, no envíes un gran volumen de URLs únicas. La plataforma de RBM no admite esto, ya sea que las URLs apunten al mismo archivo o a archivos diferentes. Usa la misma URL para archivos idénticos.

La plataforma de RBM almacena en caché el archivo durante 60 días y muestra un nombre único que puedes usar para identificarlo cuando envíes mensajes a los agentes.

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

Solicitud HTTP

  • URI de carga para las solicitudes de carga de medios:
    POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
  • URI de metadatos para las solicitudes de metadatos únicamente:
    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,
  "agentId": string
}
Campos
fileUrl

string

Opcional. Es la URL del archivo disponible de forma pública. La plataforma de RBM determina el tipo de MIME del archivo a partir del campo de tipo de contenido en los encabezados HTTP cuando recupera el archivo. La RBM admite imágenes, audio, video y archivos PDF.

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

Tipos de contenido de audio admitidos: audio/aac, audio/mp3, audio/mpeg, audio/mpg, audio/mp4, audio/mp4-latm, audio/3gpp, application/ogg y audio/ogg.

Tipos de contenido de video admitidos: video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm.

Tipos de contenido de PDF admitidos: application/pdf.

Nota: La URL del archivo puede tener 1 redireccionamiento. Las URLs de los archivos redireccionados deben ser de acceso público. Los redireccionamientos no son compatibles con las URLs de archivos en CreateAgentMessageRequest.
thumbnailUrl

string

Opcional. Es la URL de acceso público de la miniatura correspondiente al archivo. Si no se configura 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 de tipo de contenido en los encabezados HTTP cuando recupera el archivo.

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

string

Obligatorio. Es el identificador único del agente.

Cuerpo de la respuesta

Es 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

Es el nombre único asignado por el servidor al 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 OAuth 2.0 Overview.