Method: files.create

Przesyła plik, który będzie używany w wiadomościach multimedialnych lub kartach informacyjnych.

Agent podaje adres URL lub plik binarny pliku i (opcjonalnie) adres URL odpowiedniego pliku miniatury. Platforma RBM zapisuje plik w pamięci podręcznej przez 30 dni i zwraca unikalną nazwę, która umożliwia identyfikację pliku podczas wysyłania wiadomości agenta.

Aby przesłać plik binarny, wyślij żądanie HTTP POST do identyfikatora URI przesyłania, pomiń pole fileUrl w treści żądania JSON i określ plik binarny jako treść żądania POST. Na przykład użyj flagi cURL --upload-file z pełną i jednoznaczną ścieżką pliku binarnego.

Żądanie HTTP

  • Identyfikator URI przesyłania dla żądań przesłania multimediów:
    POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
  • Identyfikator URI metadanych dla żądań tylko metadanych:
    POST https://rcsbusinessmessaging.googleapis.com/v1/files

Adres URL używa składni transkodowania gRPC.

Treść żądania

Treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "fileUrl": string,
  "thumbnailUrl": string,
  "contentDescription": string,
  "agentId": string
}
Pola
fileUrl

string

Opcjonalnie. Publicznie dostępny adres URL pliku. Podczas pobierania pliku platforma RBM określa typ MIME pliku w polu content-type w nagłówkach HTTP.

Obsługiwane typy treści graficznych: obraz/jpeg, obraz/jpg, obraz/gif, obraz/png.

Obsługiwane typy treści wideo: video/h263, video/m4v, video/mp4, video/mpeg, video/mpeg4, video/webm.
thumbnailUrl

string

Opcjonalnie. Publicznie dostępny adres URL miniatury odpowiadającej plikowi. Jeśli to pole nie jest ustawione, platforma RBM automatycznie generuje miniaturę z pliku. Podczas pobierania pliku platforma RBM określa typ MIME pliku w polu content-type w nagłówkach HTTP.

Obsługiwane typy treści graficznych: obraz/jpeg, obraz/jpg, obraz/gif, obraz/png.
contentDescription

string

Opcjonalnie. Opis zawartości pliku. Czytniki ekranu używają tego opisu, aby ułatwić osobom niepełnosprawnym zrozumienie zawartości pliku.
agentId

string

To pole jest wymagane. Unikalny identyfikator agenta.

Treść odpowiedzi

Zasób o unikalnej nazwie, którego agent może użyć do zidentyfikowania pliku podczas wysyłania wiadomości.

W przypadku powodzenia treść żądania zawiera dane o następującej strukturze:

Zapis JSON 
{
  "name": string
}
Pola
name

string

Przypisana przez serwer unikalna nazwa zasobu pliku, której agent może użyć do zidentyfikowania pliku podczas wysyłania wiadomości. Format to „pliki/{uid}”, gdzie {uid} to unikalny identyfikator.

Zakresy autoryzacji

Wymaga następującego zakresu OAuth:

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

Więcej informacji znajdziesz w artykule Omówienie protokołu OAuth 2.0.