Method: files.create

Przesyła plik do użycia w wiadomościach z multimediami lub wiadomościach z kartą multimedialną.

Agent udostępnia adres URL lub plik binarny pliku oraz (opcjonalnie) adres URL odpowiedniego pliku miniatury.

Ważne: ze względu na prywatność i bezpieczeństwo użytkowników platforma RBM pobiera i przetwarza pliki multimedialne oraz PDF z podanych adresów URL, zanim przekaże je użytkownikowi. Zapobiega to śledzeniu agenta za pomocą niepowtarzalnych adresów URL. Dlatego nie przesyłaj dużej liczby niepowtarzalnych adresów URL. Platforma RBM nie obsługuje tego, niezależnie od tego, czy adresy URL wskazują na te same czy na różne pliki. Używaj tego samego adresu URL dla identycznych plików.

Platforma RBM przechowuje plik w pamięci podręcznej przez 60 dni i zwraca niepowtarzalną nazwę, której możesz użyć do identyfikacji pliku podczas wysyłania wiadomości do 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 jako treść żądania POST podaj plik binarny. Użyj np. parametru --upload-file w curlu z pełną ścieżką do pliku binarnego.

Żądanie HTTP

  • Identyfikator URI przesyłania – dotyczy żądań przesyłania multimediów:
    POST https://rcsbusinessmessaging.googleapis.com/upload/v1/files
  • Identyfikator URI metadanych, w przypadku żądań tylko z metadanymi:
    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,
  "agentId": string
}
Pola
fileUrl

string

Opcjonalnie: Publicznie dostępny URL pliku. Platforma RBM określa typ MIME pliku na podstawie pola content-type w nagłówkach HTTP podczas pobierania pliku. RBM obsługuje obrazy, dźwięk, filmy i pliki PDF.

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

Obsługiwane typy treści audio: audio/aac, audio/mp3, audio/mpeg, audio/mpg, audio/mp4, audio/mp4-latm, audio/3gpp, application/ogg, audio/ogg.

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

Obsługiwane typy treści PDF: application/pdf.
thumbnailUrl

string

Opcjonalnie: Dostępny publicznie adres URL miniatury odpowiadającej plikowi. Jeśli to pole nie jest ustawione, platforma RBM automatycznie wygeneruje miniaturę z pliku. Podczas pobierania pliku platforma RBM określa typ MIME pliku na podstawie pola „content-type” w nagłówkach HTTP.

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

string

Wymagany. Unikalny identyfikator agenta.

Treść odpowiedzi

Zasób pliku o unikalnej nazwie, którego agent może użyć do identyfikacji 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 identyfikacji pliku podczas wysyłania wiadomości. Format to „files/{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 OAuth 2.0 Overview.