Dokumentacja interfejsu API dla usługi Bot Framework Połączenie or
Uwaga
Interfejs API REST nie jest odpowiednikiem zestawu SDK. Interfejs API REST umożliwia standardową komunikację REST, jednak preferowaną metodą interakcji z platformą Bot Framework jest zestaw SDK.
W ramach platformy Bot Framework usługa Bot Połączenie or umożliwia botowi wymianę komunikatów z użytkownikami w kanałach skonfigurowanych w portalu Bot Framework. Usługa używa standardowego interfejsu REST i formatu JSON za pośrednictwem protokołu HTTPS.
Podstawowy identyfikator URI
Gdy użytkownik wyśle komunikat do bota, żądanie przychodzące zawiera obiekt Działania z właściwością określającą serviceUrl punkt końcowy, do którego bot powinien wysłać jego odpowiedź. Aby uzyskać dostęp do usługi Bot Połączenie or, użyj serviceUrl wartości jako podstawowego identyfikatora URI dla żądań interfejsu API.
Jeśli nie masz jeszcze adresu URL usługi dla kanału, użyj https://smba.trafficmanager.net/teams/ go jako adresu URL usługi. Aby uzyskać więcej informacji, zobacz , jak utworzyć konwersację i proaktywny komunikat w usłudze Teams.
Załóżmy na przykład, że bot otrzymuje następujące działanie, gdy użytkownik wyśle wiadomość do bota.
{
"type": "message",
"id": "bf3cc9a2f5de...",
"timestamp": "2016-10-19T20:17:52.2891902Z",
"serviceUrl": "https://smba.trafficmanager.net/teams/",
"channelId": "channel's name/id",
"from": {
"id": "1234abcd",
"name": "user's name"
},
"conversation": {
"id": "abcd1234",
"name": "conversation's name"
},
"recipient": {
"id": "12345678",
"name": "bot's name"
},
"text": "Haircut on Saturday"
}
Właściwość serviceUrl w komunikacie użytkownika wskazuje, że bot powinien wysłać odpowiedź do punktu końcowego https://smba.trafficmanager.net/teams/. Adres URL usługi będzie podstawowym identyfikatorem URI dla wszelkich kolejnych żądań, które bot będzie wystawiał w kontekście tej konwersacji. Jeśli bot będzie musiał wysłać użytkownikowi proaktywny komunikat, pamiętaj, aby zapisać wartość serviceUrl.
W poniższym przykładzie pokazano żądanie, że bot ma problemy z odpowiedzią na komunikat użytkownika.
POST https://smba.trafficmanager.net/teams/v3/conversations/abcd1234/activities/bf3cc9a2f5de...
Authorization: Bearer eyJhbGciOiJIUzI1Ni...
Content-Type: application/json
{
"type": "message",
"from": {
"id": "12345678",
"name": "bot's name"
},
"conversation": {
"id": "abcd1234",
"name": "conversation's name"
},
"recipient": {
"id": "1234abcd",
"name": "user's name"
},
"text": "I have several times available on Saturday!",
"replyToId": "bf3cc9a2f5de..."
}
Nagłówki
Nagłówki żądań
Oprócz standardowych nagłówków żądań HTTP każde żądanie interfejsu API, którego dotyczy problem, musi zawierać Authorization nagłówek określający token dostępu do uwierzytelniania bota. Authorization Określ nagłówek przy użyciu tego formatu:
Authorization: Bearer ACCESS_TOKEN
Aby uzyskać szczegółowe informacje na temat uzyskiwania tokenu dostępu dla bota, zobacz Uwierzytelnianie żądań od bota do usługi Bot Połączenie or.
Nagłówki odpowiedzi
Oprócz standardowych nagłówków odpowiedzi HTTP każda odpowiedź będzie zawierać X-Correlating-OperationId nagłówek. Wartość tego nagłówka to identyfikator odpowiadający wpisowi dziennika platformy Bot Framework, który zawiera szczegółowe informacje o żądaniu. Po otrzymaniu odpowiedzi na błąd należy przechwycić wartość tego nagłówka. Jeśli nie możesz niezależnie rozwiązać problemu, dołącz tę wartość do informacji podanych zespołowi pomocy technicznej podczas zgłaszania problemu.
Kody stanu HTTP
Kod stanu HTTP zwracany z każdą odpowiedzią wskazuje wynik odpowiedniego żądania.
Uwaga
W poniższej tabeli opisano najbardziej typowe kody stanu HTTP. Niektóre błędy są generowane przez kanał. Aby uzyskać więcej informacji, może być konieczne przeczytanie dokumentacji dewelopera kanału.
| Kod stanu HTTP | Znaczenie |
|---|---|
| 200 | Żądanie zakończyło się pomyślnie. |
| 201 | Żądanie zakończyło się pomyślnie. |
| 202 | Żądanie zostało zaakceptowane do przetworzenia. |
| 204 | Żądanie zakończyło się pomyślnie, ale nie została zwrócona żadna zawartość. |
| 400 | Żądanie zostało źle sformułowane lub w inny sposób niepoprawne. |
| 401 | Bot nie jest jeszcze uwierzytelniony. |
| 403 | Bot nie jest autoryzowany do wykonywania żądanej operacji. |
| 404 | Żądany zasób nie został znaleziony. |
| 405 | Kanał nie obsługuje żądanej operacji. |
| 500 | Wystąpił wewnętrzny błąd serwera. |
| 503 | Usługa jest tymczasowo niedostępna. |
błędy
Każda odpowiedź określająca kod stanu HTTP w zakresie 4xx lub 5xx będzie zawierać obiekt ErrorResponse w treści odpowiedzi zawierającej informacje o błędzie. Jeśli w zakresie 4xx pojawi się odpowiedź o błędzie, sprawdź obiekt ErrorResponse , aby zidentyfikować przyczynę błędu i rozwiązać problem przed ponownym przesłaniem żądania.
Operacje konwersacji
Te operacje umożliwiają tworzenie konwersacji, wysyłanie wiadomości (działań) i zarządzanie zawartością konwersacji.
Ważne
Nie wszystkie kanały obsługują wszystkie punkty końcowe. Jednak wszystkie kanały powinny obsługiwać odpowiedź na punkt końcowy działania .
Na przykład tylko bezpośrednia linia i czat internetowy obsługują punkt końcowy pobierania konwersacji.
| Działanie | opis |
|---|---|
| Tworzenie konwersacji | Tworzy nową konwersację. |
| Działanie usuwania | Usuwa istniejące działanie. |
| Usuwanie członka konwersacji | Usuwa członka z konwersacji. |
| Pobieranie członków działań | Pobiera członków określonego działania w określonej konwersacji. |
| Pobieranie członka konwersacji | Pobiera szczegółowe informacje o członka konwersacji. |
| Pobieranie członków konwersacji | Pobiera członków określonej konwersacji. |
| Pobieranie członków strony konwersacji | Pobiera członków określonej konwersacji po jednej stronie naraz. |
| Pobieranie konwersacji | Pobiera listę konwersacji, w których uczestniczył bot. |
| Odpowiadanie na działanie | Wysyła działanie (wiadomość) do określonej konwersacji jako odpowiedź na określone działanie. |
| Wysyłanie historii konwersacji | Przekazuje transkrypcję poprzednich działań do konwersacji. |
| Wyślij do konwersacji | Wysyła działanie (wiadomość) na koniec określonej konwersacji. |
| Działanie aktualizacji | Aktualizacje istniejącego działania. |
| Przekazywanie załącznika do kanału | Przekazuje załącznik bezpośrednio do magazynu obiektów blob kanału. |
Tworzenie konwersacji
Tworzy nową konwersację.
POST /v3/conversations
| Zawartość | opis |
|---|---|
| Treść żądania | Obiekt ConversationParameters |
| Zwroty | Obiekt ConversationResourceResponse |
Działanie usuwania
Niektóre kanały umożliwiają usunięcie istniejącego działania. Jeśli operacja zakończy się pomyślnie, ta operacja usunie określone działanie z określonej konwersacji.
DELETE /v3/conversations/{conversationId}/activities/{activityId}
| Zawartość | opis |
|---|---|
| Treść żądania | nie dotyczy |
| Zwroty | Kod stanu HTTP wskazujący wynik operacji. Nic nie jest określone w treści odpowiedzi. |
Usuwanie członka konwersacji
Usuwa członka z konwersacji. Jeśli ten członek był ostatnim członkiem konwersacji, konwersacja zostanie również usunięta.
DELETE /v3/conversations/{conversationId}/members/{memberId}
| Zawartość | opis |
|---|---|
| Treść żądania | nie dotyczy |
| Zwroty | Kod stanu HTTP wskazujący wynik operacji. Nic nie jest określone w treści odpowiedzi. |
Pobieranie członków działań
Pobiera członków określonego działania w określonej konwersacji.
GET /v3/conversations/{conversationId}/activities/{activityId}/members
| Zawartość | opis |
|---|---|
| Treść żądania | nie dotyczy |
| Zwroty | Tablica obiektów ChannelAccount |
Pobieranie konwersacji
Pobiera listę konwersacji, w których uczestniczył bot.
GET /v3/conversations?continuationToken={continuationToken}
| Zawartość | opis |
|---|---|
| Treść żądania | nie dotyczy |
| Zwroty | Obiekt ConversationResult |
Pobieranie członka konwersacji
Pobiera szczegółowe informacje o określonym elemencie konwersacji.
GET /v3/conversations/{conversationId}/members/{memberId}
| Zawartość | opis |
|---|---|
| Treść żądania | nie dotyczy |
| Zwroty | Obiekt ChannelAccount dla elementu członkowskiego. |
Pobieranie członków konwersacji
Pobiera członków określonej konwersacji.
GET /v3/conversations/{conversationId}/members
| Zawartość | opis |
|---|---|
| Treść żądania | nie dotyczy |
| Zwroty | Tablica obiektów ChannelAccount dla członków konwersacji. |
Pobieranie członków strony konwersacji
Pobiera członków określonej konwersacji po jednej stronie naraz.
GET /v3/conversations/{conversationId}/pagedmembers?pageSize={pageSize}&continuationToken={continuationToken}
| Zawartość | opis |
|---|---|
| Treść żądania | nie dotyczy |
| Zwroty | Obiekt PagedMembersResult |
Odpowiadanie na działanie
Wysyła działanie (wiadomość) do określonej konwersacji jako odpowiedź na określone działanie. Działanie zostanie dodane jako odpowiedź na inne działanie, jeśli kanał go obsługuje. Jeśli kanał nie obsługuje zagnieżdżonych odpowiedzi, ta operacja zachowuje się jak Wyślij do konwersacji.
POST /v3/conversations/{conversationId}/activities/{activityId}
| Zawartość | opis |
|---|---|
| Treść żądania | Obiekt Działania |
| Zwroty | Obiekt ResourceResponse |
Wysyłanie historii konwersacji
Przekazuje transkrypcję poprzednich działań do konwersacji, aby klient mógł je renderować.
POST /v3/conversations/{conversationId}/activities/history
| Zawartość | opis |
|---|---|
| Treść żądania | Obiekt transkrypcji. |
| Zwroty | Obiekt ResourceResponse . |
Wyślij do konwersacji
Wysyła działanie (wiadomość) do określonej konwersacji. Działanie zostanie dołączone na końcu konwersacji zgodnie ze znacznikami czasu lub semantykami kanału. Aby odpowiedzieć na określoną wiadomość w konwersacji, zamiast tego użyj opcji Odpowiedz na działanie .
POST /v3/conversations/{conversationId}/activities
| Zawartość | opis |
|---|---|
| Treść żądania | Obiekt Działania |
| Zwroty | Obiekt ResourceResponse |
Działanie aktualizacji
Niektóre kanały umożliwiają edytowanie istniejącego działania w celu odzwierciedlenia nowego stanu konwersacji bota. Możesz na przykład usunąć przyciski z wiadomości w konwersacji po kliknięciu jednego z przycisków przez użytkownika. Jeśli operacja się powiedzie, ta operacja aktualizuje określone działanie w ramach określonej konwersacji.
PUT /v3/conversations/{conversationId}/activities/{activityId}
| Zawartość | opis |
|---|---|
| Treść żądania | Obiekt Działania |
| Zwroty | Obiekt ResourceResponse |
Przekazywanie załącznika do kanału
Przekazuje załącznik do określonej konwersacji bezpośrednio do magazynu obiektów blob kanału. Dzięki temu można przechowywać dane w zgodnym magazynie.
POST /v3/conversations/{conversationId}/attachments
| Zawartość | opis |
|---|---|
| Treść żądania | Obiekt AttachmentData. |
| Zwroty | Obiekt ResourceResponse . Właściwość id określa identyfikator załącznika, który może być używany z operacją Pobieranie informacji o załączniku i operacją Pobierz załącznik . |
Operacje na załącznikach
Użyj tych operacji, aby pobrać informacje o załączniku, a także dane binarne dla samego pliku.
| Działanie | opis |
|---|---|
| Pobieranie informacji o załączniku | Pobiera informacje o określonym załączniku, w tym nazwę pliku, typ pliku i dostępne widoki (na przykład oryginalne lub miniatury). |
| Pobieranie załącznika | Pobiera określony widok określonego załącznika jako zawartość binarną. |
Pobieranie informacji o załączniku
Pobiera informacje o określonym załączniku, w tym nazwę pliku, typ i dostępne widoki (na przykład oryginalne lub miniatury).
GET /v3/attachments/{attachmentId}
| Zawartość | opis |
|---|---|
| Treść żądania | nie dotyczy |
| Zwroty | Obiekt AttachmentInfo |
Pobieranie załącznika
Pobiera określony widok określonego załącznika jako zawartość binarną.
GET /v3/attachments/{attachmentId}/views/{viewId}
| Zawartość | opis |
|---|---|
| Treść żądania | nie dotyczy |
| Zwroty | Zawartość binarna reprezentująca określony widok określonego załącznika |
Operacje stanu (przestarzałe)
Usługa Microsoft Bot Framework State została wycofana od 30 marca 2018 r. Wcześniej boty oparte na usłudze Azure AI Bot Service lub zestawie SDK bot builder miały domyślne połączenie z tą usługą hostowaną przez firmę Microsoft w celu przechowywania danych stanu bota. Aby korzystać z własnego magazynu stanu, boty muszą zostać zaktualizowane.
| Działanie | opis |
|---|---|
Set User Data |
Przechowuje dane stanu określonego użytkownika w kanale. |
Set Conversation Data |
Przechowuje dane stanu dla określonej konwersacji w kanale. |
Set Private Conversation Data |
Przechowuje dane stanu określonego użytkownika w kontekście określonej konwersacji w kanale. |
Get User Data |
Pobiera dane stanu, które wcześniej były przechowywane dla określonego użytkownika we wszystkich konwersacjach w kanale. |
Get Conversation Data |
Pobiera dane stanu, które wcześniej były przechowywane dla określonej konwersacji w kanale. |
Get Private Conversation Data |
Pobiera dane stanu, które wcześniej były przechowywane dla określonego użytkownika w kontekście określonej konwersacji w kanale. |
Delete State For User |
Usuwa dane stanu, które wcześniej były przechowywane dla użytkownika. |
Schemat
Schemat platformy Bot Framework definiuje obiekty i ich właściwości, których bot może używać do komunikowania się z użytkownikiem.
| Obiekt | opis |
|---|---|
| Obiekt działania | Definiuje komunikat wymieniany między botem a użytkownikiem. |
| Obiekt AnimationCard | Definiuje kartę, która może odtwarzać animowane pliki GIF lub krótkie filmy wideo. |
| Obiekt załącznika | Definiuje dodatkowe informacje do uwzględnienia w komunikacie. Załącznik może być plikiem multimedialnym (na przykład audio, wideo, obrazem, plikiem) lub kartą sformatowaną. |
| Obiekt AttachmentData | Opisuje dane załącznika. |
| Obiekt AttachmentInfo | Opisuje załącznik. |
| Obiekt AttachmentView | Definiuje obiekt reprezentujący dostępny widok załącznika. |
| Obiekt AudioCard | Definiuje kartę, która może odtwarzać plik audio. |
| CardAction, obiekt | Definiuje akcję do wykonania. |
| Obiekt CardImage | Definiuje obraz do wyświetlenia na karcie. |
| Obiekt ChannelAccount | Definiuje bota lub konto użytkownika w kanale. |
| Obiekt ConversationAccount | Definiuje konwersację w kanale. |
| ConversationMembers, obiekt | Definiuje członków konwersacji. |
| Obiekt ConversationParameters | Definiowanie parametrów do tworzenia nowej konwersacji |
| ConversationReference, obiekt | Definiuje konkretny punkt w konwersacji. |
| ConversationResourceResponse, obiekt | Definiuje odpowiedź na tworzenie konwersacji. |
| ConversationResult, obiekt | Definiuje wynik wywołania metody Uzyskiwanie konwersacji. |
| Obiekt jednostki | Definiuje obiekt jednostki. |
| Błąd obiektu | Definiuje błąd. |
| ErrorResponse, obiekt | Definiuje odpowiedź interfejsu API HTTP. |
| Obiekt faktów | Definiuje parę klucz-wartość zawierającą fakt. |
| Obiekt GeoCoordinates | Definiuje lokalizację geograficzną przy użyciu współrzędnych World Geodetic System (WSG84). |
| Obiekt HeroCard | Definiuje kartę z dużym obrazem, tytułem, tekstem i przyciskami akcji. |
| InnerHttpError, obiekt | Obiekt reprezentujący wewnętrzny błąd HTTP. |
| MediaEventValue, obiekt | Parametr dodatkowy dla zdarzeń multimedialnych. |
| MediaUrl, obiekt | Definiuje adres URL źródła pliku multimedialnego. |
| Obiekt wzmianki | Definiuje użytkownika lub bota, który został wymieniony w konwersacji. |
| MessageReaction, obiekt | Definiuje reakcję na komunikat. |
| PagedMembersResult, obiekt | Strona członków zwróconych przez członków strony konwersacji. |
| Umieść obiekt | Definiuje miejsce, które zostało wymienione w konwersacji. |
| Obiekt ReceiptCard | Definiuje kartę zawierającą potwierdzenie zakupu. |
| Obiekt ReceiptItem | Definiuje element wiersza w ramach potwierdzenia. |
| ResourceResponse, obiekt | Definiuje zasób. |
| SemanticAction, obiekt | Definiuje odwołanie do akcji programowej. |
| SignInCard, obiekt | Definiuje kartę, która umożliwia użytkownikowi logowanie się do usługi. |
| Sugerowany obiekt Actions | Definiuje opcje, z których użytkownik może wybrać. |
| TextHighlight, obiekt | Odwołuje się do podciągu zawartości w innym polu. |
| Obiekt ThumbnailCard | Definiuje kartę z przyciskami miniatury, tytułu, tekstu i akcji. |
| ThumbnailUrl, obiekt | Definiuje adres URL źródła obrazu. |
| Obiekt transkrypcji | Kolekcja działań do przekazania przy użyciu funkcji Wyślij historię konwersacji. |
| Obiekt VideoCard | Definiuje kartę, która może odtwarzać filmy wideo. |
Obiekt działania
Definiuje komunikat wymieniany między botem a użytkownikiem.
| Właściwość | Pisz | Opis |
|---|---|---|
| action | Ciąg | Akcja, która ma zostać zastosowana lub która została zastosowana. Użyj właściwości type, aby określić kontekst akcji. Na przykład jeśli typem jest contactRelationUpdate, wartość właściwości akcji zostanie dodana , jeśli użytkownik dodał bota do listy kontaktów, lub usunąć , jeśli usunął bota z listy kontaktów. |
| attachmentLayout | Ciąg | Układ bogatych załączników kart, które zawiera komunikat. Jedna z następujących wartości: karuzeli, lista. Aby uzyskać więcej informacji na temat zaawansowanych załączników kart, zobacz Dodawanie rozbudowanych załączników kart do wiadomości. |
| Załączniki | Załącznik[] | Tablica obiektów załączników, które definiują dodatkowe informacje do uwzględnienia w komunikacie. Każdy załącznik może być plikiem (na przykład audio, wideo, obrazem) lub bogatą kartą. |
| Callerid | Ciąg | Ciąg zawierający IRI identyfikujący obiekt wywołujący bota. To pole nie jest przeznaczone do przesyłania za pośrednictwem przewodu, ale zamiast tego jest wypełniane przez boty i klientów na podstawie kryptograficznie weryfikowalnych danych, które potwierdzają tożsamość wywołujących (na przykład tokeny). |
| channelData | Obiekt | Obiekt zawierający zawartość specyficzną dla kanału. Niektóre kanały udostępniają funkcje, które wymagają dodatkowych informacji, których nie można przedstawić przy użyciu schematu załącznika. W takich przypadkach ustaw tę właściwość na zawartość specyficzną dla kanału zgodnie z definicją w dokumentacji kanału. Aby uzyskać więcej informacji, zobacz Implementowanie funkcji specyficznych dla kanału. |
| channelId | Ciąg | Identyfikator, który jednoznacznie identyfikuje kanał. Ustaw według kanału. |
| kod | Ciąg | Kod wskazujący, dlaczego konwersacja została zakończona. |
| Konwersacji | KonwersacjaKonto | Obiekt ConversationAccount, który definiuje konwersację, do której należy działanie. |
| deliveryMode | Ciąg | Wskazówka dostarczania sygnalizowana alternatywnym ścieżkom dostarczania odbiorcy dla działania. Jedna z następujących wartości: normalna, powiadomienie. |
| encje | object[] | Tablica obiektów reprezentujących jednostki wymienione w komunikacie. Obiekty w tej tablicy mogą być dowolnym obiektem Schema.org . Na przykład tablica może zawierać obiekty Wzmianki , które identyfikują osobę, która została wymieniona w konwersacji i obiekty Place identyfikujące miejsce wymienione w konwersacji. |
| Wygaśnięcia | Ciąg | Czas, w którym działanie powinno być uznawane za "wygasłe" i nie powinno być prezentowane odbiorcy. |
| from | Konto kanału | Obiekt ChannelAccount, który określa nadawcę wiadomości. |
| historyDisclosed | Wartość logiczna | Flaga wskazująca, czy historia jest ujawniana. Wartość domyślna to false. |
| id | Ciąg | Identyfikator, który jednoznacznie identyfikuje działanie w kanale. |
| Znaczenie | Ciąg | Definiuje znaczenie działania. Jedna z następujących wartości: niska, normalna, wysoka. |
| inputHint | Ciąg | Wartość wskazująca, czy bot akceptuje, oczekuje lub ignoruje dane wejściowe użytkownika po dostarczeniu komunikatu do klienta. Jedna z następujących wartości: akceptowanieinput, oczekiwanieInput, ignorowanieinput. |
| Etykiety | Ciąg | Etykieta opisowa działania. |
| listenFor | Ciąg[] | Lista fraz i odwołań, które powinny nasłuchiwać systemów programowania mowy i języka. |
| Ustawień regionalnych | Ciąg | Ustawienia regionalne języka, który powinien być używany do wyświetlania tekstu w wiadomości w formacie <language>-<country>. Kanał używa tej właściwości do wskazania języka użytkownika, aby bot mógł określić ciągi wyświetlane w tym języku. Wartość domyślna to en-US. |
| localTimestamp | Ciąg | Data i godzina wysłania komunikatu w lokalnej strefie czasowej wyrażonej w formacie ISO-8601 . |
| localTimezone | Ciąg | Zawiera nazwę lokalnej strefy czasowej komunikatu wyrażonej w formacie bazy danych strefy czasowej IANA. Na przykład Ameryka/Los_Angeles. |
| członkowieDodaj | ChannelAccount[] | Tablica obiektów ChannelAccount reprezentujących listę użytkowników, którzy dołączyli do konwersacji. Prezentowanie tylko wtedy, gdy typ działania to "conversationUpdate", a użytkownicy dołączyli do konwersacji. |
| elementy członkowskieUsuwane | ChannelAccount[] | Tablica obiektów ChannelAccount reprezentujących listę użytkowników, którzy opuścili konwersację. Prezentowanie tylko wtedy, gdy typ działania to "conversationUpdate", a użytkownicy opuścili konwersację. |
| name | String | Nazwa operacji do wywołania lub nazwy zdarzenia. |
| reakcjeDodaj | MessageReaction[] | Kolekcja reakcji dodanych do konwersacji. |
| reakcjeRemoved | MessageReaction[] | Kolekcja reakcji usuniętych z konwersacji. |
| Odbiorcy | Konto kanału | Obiekt ChannelAccount, który określa adresata wiadomości. |
| relatesTo | KonwersacjaReferencja | Obiekt ConversationReference, który definiuje konkretny punkt w konwersacji. |
| replyToId | Ciąg | Identyfikator wiadomości, do której odpowiada ta wiadomość. Aby odpowiedzieć na wiadomość wysłaną przez użytkownika, ustaw tę właściwość na identyfikator wiadomości użytkownika. Nie wszystkie kanały obsługują odpowiedzi wątkowe. W takich przypadkach kanał zignoruje tę właściwość i użyje semantyki uporządkowanej czasowej (sygnatury czasowej), aby dołączyć wiadomość do konwersacji. |
| semanticAction | SemanticAction | Obiekt SemanticAction reprezentujący odwołanie do akcji programowej. |
| serviceUrl | Ciąg | Adres URL określający punkt końcowy usługi kanału. Ustaw według kanału. |
| Mówić | Ciąg | Tekst używany przez bota w kanale obsługującym mowę. Aby kontrolować różne cechy mowy bota, takie jak głos, szybkość, głośność, wymowa i pitch, określ tę właściwość w formacie SSML (Speech Synthesis Markup Language). |
| sugerowane Actions | Sugerowane wyrażenia | Obiekt SuggestedActions , który definiuje opcje, z których użytkownik może wybrać. |
| Krótki opis | Ciąg | Podsumowanie informacji zawartych w komunikacie. Na przykład w przypadku wiadomości wysyłanej w kanale poczty e-mail ta właściwość może określać pierwsze 50 znaków wiadomości e-mail. |
| text | Ciąg | Tekst wiadomości wysyłanej od użytkownika do bota lub bota do użytkownika. Zapoznaj się z dokumentacją kanału, aby uzyskać limity nałożone na zawartość tej właściwości. |
| Textformat | Ciąg | Format tekstu wiadomości. Jedna z następujących wartości: markdown, plain, xml. Aby uzyskać szczegółowe informacje o formacie tekstowym, zobacz Tworzenie komunikatów. |
| textHighlights | TextHighlight[] | Kolekcja fragmentów tekstu do wyróżnienia, gdy działanie zawiera wartość replyToId . |
| Sygnatury czasowej | Ciąg | Data i godzina wysłania wiadomości w strefie czasowej UTC wyrażonej w formacie ISO-8601 . |
| nazwa tematu | Ciąg | Temat konwersacji, do której należy działanie. |
| type | Ciąg | Typ działania. Jedna z następujących wartości: message, contactRelationUpdate, conversationUpdate, typing, endOfConversation, event, invoke, deleteUserData, messageUpdate, messageDelete, installationUpdate, messageReaction, suggestion, trace, handoff. Aby uzyskać szczegółowe informacje o typach działań, zobacz Omówienie działań. |
| wartość | Obiekt | Wartość typu open-ended. |
| Valuetype | Ciąg | Typ obiektu wartości działania. |
Obiekt AnimationCard
Definiuje kartę, która może odtwarzać animowane pliki GIF lub krótkie filmy wideo.
| Właściwość | Pisz | Opis |
|---|---|---|
| Aspekt | Wartość logiczna | Współczynnik proporcji symbolu zastępczego miniatury/multimediów. Dozwolone wartości to "16:9" i "4:3". |
| autoloop | Wartość logiczna | Flaga wskazująca, czy odtworzyć listę animowanych plików GIF po zakończeniu ostatniego. Ustaw tę właściwość na wartość true , aby automatycznie odtwarzać animację; w przeciwnym razie wartość false. Wartość domyślna to true. |
| autostart | Wartość logiczna | Flaga wskazująca, czy automatycznie odtwarzać animację po wyświetleniu karty. Ustaw tę właściwość na true , aby automatycznie odtwarzać animację; w przeciwnym razie wartość false. Wartość domyślna to true. |
| Przyciski | CardAction[] | Tablica obiektów CardAction , które umożliwiają użytkownikowi wykonywanie co najmniej jednej akcji. Kanał określa liczbę przycisków, które można określić. |
| Długość | Ciąg | Długość zawartości multimedialnej w formacie czasu trwania ISO 8601. |
| Obrazu | ThumbnailUrl | Obiekt ThumbnailUrl , który określa obraz do wyświetlenia na karcie. |
| Media | MediaUrl[] | Tablica obiektów MediaUrl . Jeśli to pole zawiera więcej niż jeden adres URL, każdy adres URL jest alternatywnym formatem tej samej zawartości. |
| Współużytkowania | Wartość logiczna | Flaga wskazująca, czy animacja może być udostępniana innym osobom. Ustaw tę właściwość na wartość true , jeśli animacja może być udostępniona; w przeciwnym razie wartość false. Wartość domyślna to true. |
| Napisów | Ciąg | Podtytuł do wyświetlenia pod tytułem karty. |
| text | Ciąg | Opis lub monit o wyświetlenie pod tytułem lub podtytułem karty. |
| title | Ciąg | Tytuł karty. |
| wartość | Obiekt | Parametr dodatkowy dla tej karty. |
Obiekt załącznika
Definiuje dodatkowe informacje do uwzględnienia w komunikacie. Załącznik może być plikiem (takim jak obraz, dźwięk lub wideo) lub bogatą kartą.
| Właściwość | Pisz | Opis |
|---|---|---|
| Zawartości | Obiekt | Zawartość załącznika. Jeśli załącznik jest kartą bogatą, ustaw tę właściwość na obiekt karty wzbogaconej. Ta właściwość i właściwość contentUrl wzajemnie się wykluczają. |
| Contenttype | Ciąg | Typ nośnika zawartości w załączniku. W przypadku plików multimedialnych ustaw tę właściwość na znane typy multimediów, takie jak image/png, audio/wav i video/mp4. Dla zaawansowanych kart ustaw tę właściwość na jeden z następujących typów specyficznych dla dostawcy:
|
| contentUrl | Ciąg | Adres URL zawartości załącznika. Jeśli na przykład załącznik jest obrazem, możesz ustawić wartość contentUrl na adres URL reprezentujący lokalizację obrazu. Obsługiwane protokoły to: HTTP, HTTPS, File i Data. |
| name | String | Nazwa załącznika. |
| thumbnailUrl | Ciąg | Adres URL do obrazu miniatury, którego kanał może użyć, jeśli obsługuje on użycie alternatywnej, mniejszej formy zawartości lub contentUrl. Jeśli na przykład ustawisz właściwość contentType na wartość application/word i ustawisz wartość contentUrl na lokalizację dokumentu programu Word, możesz dołączyć obraz miniatury reprezentujący dokument. Kanał może wyświetlać obraz miniatury zamiast dokumentu. Gdy użytkownik kliknie obraz, kanał otworzy dokument. |
Obiekt AttachmentData
Opisuje dane załącznika.
| Właściwość | Pisz | opis |
|---|---|---|
| name | String | Nazwa załącznika. |
| originalBase64 | Ciąg | Zawartość załącznika. |
| thumbnailBase64 | Ciąg | Zawartość miniatury załącznika. |
| type | Ciąg | Typ zawartości załącznika. |
Obiekt AttachmentInfo
Metadane załącznika.
| Właściwość | Pisz | opis |
|---|---|---|
| name | String | Nazwa załącznika. |
| type | Ciąg | Typ zawartości załącznika. |
| Widoki | AttachmentView[] | Tablica obiektów AttachmentView reprezentujących dostępne widoki załącznika. |
Obiekt AttachmentView
Definiuje obiekt reprezentujący dostępny widok załącznika.
| Właściwość | Pisz | Opis |
|---|---|---|
| Rozmiar | Liczba | Rozmiar pliku. |
| viewId | Ciąg | Identyfikator widoku. |
Obiekt AudioCard
Definiuje kartę, która może odtwarzać plik audio.
| Właściwość | Pisz | Opis |
|---|---|---|
| Aspekt | Ciąg | Współczynnik proporcji miniatury określonej we właściwości obrazu . Prawidłowe wartości to 16:9 i 4:3. |
| autoloop | Wartość logiczna | Flaga wskazująca, czy należy odtworzyć listę plików audio po zakończeniu ostatniego. Ustaw tę właściwość na wartość true , aby automatycznie odtwarzać pliki audio; w przeciwnym razie wartość false. Wartość domyślna to true. |
| autostart | Wartość logiczna | Flaga wskazująca, czy automatycznie odtwarzać dźwięk po wyświetleniu karty. Ustaw tę właściwość na true , aby automatycznie odtwarzać dźwięk; w przeciwnym razie wartość false. Wartość domyślna to true. |
| Przyciski | CardAction[] | Tablica obiektów CardAction , które umożliwiają użytkownikowi wykonywanie co najmniej jednej akcji. Kanał określa liczbę przycisków, które można określić. |
| Długość | Ciąg | Długość zawartości multimedialnej w formacie czasu trwania ISO 8601. |
| Obrazu | ThumbnailUrl | Obiekt ThumbnailUrl , który określa obraz do wyświetlenia na karcie. |
| Media | MediaUrl[] | Tablica obiektów MediaUrl . Jeśli to pole zawiera więcej niż jeden adres URL, każdy adres URL jest alternatywnym formatem tej samej zawartości. |
| Współużytkowania | Wartość logiczna | Flaga wskazująca, czy pliki dźwiękowe mogą być udostępniane innym osobom. Ustaw tę właściwość na wartość true , jeśli dźwięk może być udostępniony; w przeciwnym razie wartość false. Wartość domyślna to true. |
| Napisów | Ciąg | Podtytuł do wyświetlenia pod tytułem karty. |
| text | Ciąg | Opis lub monit o wyświetlenie pod tytułem lub podtytułem karty. |
| title | Ciąg | Tytuł karty. |
| wartość | Obiekt | Parametr dodatkowy dla tej karty. |
CardAction, obiekt
Definiuje akcję klikalną za pomocą przycisku.
| Właściwość | Pisz | Opis |
|---|---|---|
| channelData | Ciąg | Dane specyficzne dla kanału skojarzone z tą akcją. |
| displayText | Ciąg | Tekst wyświetlany w kanale informacyjnym czatu po kliknięciu przycisku. |
| Obrazu | Ciąg | Adres URL obrazu wyświetlany na przycisku obok etykiety tekstowej. |
| text | Ciąg | Tekst akcji. |
| title | Ciąg | Opis tekstu wyświetlany na przycisku. |
| type | Ciąg | Typ akcji do wykonania. Aby uzyskać listę prawidłowych wartości, zobacz Dodawanie zaawansowanych załączników kart do wiadomości. |
| wartość | Obiekt | Parametr dodatkowy dla akcji. Zachowanie tej właściwości będzie się różnić w zależności od typu akcji. Aby uzyskać więcej informacji, zobacz Dodawanie rozbudowanych załączników kart do wiadomości. |
Obiekt CardImage
Definiuje obraz do wyświetlenia na karcie.
| Właściwość | Pisz | Opis |
|---|---|---|
| Alt | Ciąg | Opis obrazu. Należy dołączyć opis do obsługi ułatwień dostępu. |
| Dotknij | CardAction | Obiekt CardAction, który określa akcję do wykonania, jeśli użytkownik naciągnie lub kliknie obraz. |
| Adres url | Ciąg | Adres URL do źródła obrazu lub pliku binarnego base64 obrazu (na przykład data:image/png;base64,iVBORw0KGgo...). |
Obiekt ChannelAccount
Definiuje bota lub konto użytkownika w kanale.
| Właściwość | Pisz | Opis |
|---|---|---|
| aadObjectId | Ciąg | Identyfikator obiektu tego konta w ramach identyfikatora entra firmy Microsoft. |
| id | Ciąg | Unikatowy identyfikator użytkownika lub bota w tym kanale. |
| name | String | Przyjazna dla wyświetlania nazwa bota lub użytkownika. |
| Roli | Ciąg | Rola jednostki za kontem. Użytkownik lub bot. |
Obiekt ConversationAccount
Definiuje konwersację w kanale.
| Właściwość | Pisz | Opis |
|---|---|---|
| aadObjectId | Ciąg | Identyfikator obiektu tego konta w ramach identyfikatora entra firmy Microsoft. |
| typ konwersacji | Ciąg | Wskazuje typ konwersacji w kanałach, które rozróżniają typy konwersacji (na przykład grupę lub osobistą). |
| id | Ciąg | Identyfikator identyfikujący konwersację. Identyfikator jest unikatowy dla kanału. Jeśli kanał uruchamia konwersację, ustawia ten identyfikator; W przeciwnym razie bot ustawia tę właściwość na identyfikator, który jest zwracany w odpowiedzi po rozpoczęciu konwersacji (zobacz Tworzenie konwersacji). |
| isGroup | Wartość logiczna | Flaga wskazująca, czy konwersacja zawiera więcej niż dwóch uczestników w momencie wygenerowania działania. Ustaw wartość true , jeśli jest to konwersacja grupowa; w przeciwnym razie wartość false. Wartość domyślna to false. |
| name | String | Nazwa wyświetlana, która może służyć do identyfikowania konwersacji. |
| Roli | Ciąg | Rola jednostki za kontem. Użytkownik lub bot. |
| tenantId | Ciąg | Identyfikator dzierżawy tej konwersacji. |
ConversationMembers, obiekt
Definiuje członków konwersacji.
| Właściwość | Pisz | Opis |
|---|---|---|
| id | Ciąg | Identyfikator konwersacji. |
| Członków | ChannelAccount[] | Lista członków w tej konwersacji. |
Obiekt ConversationParameters
Definiuje parametry tworzenia nowej konwersacji.
| Właściwość | Pisz | Opis |
|---|---|---|
| Działania | Activity | Początkowa wiadomość do wysłania do konwersacji po jej utworzeniu. |
| Bot | Konto kanału | Informacje o koncie kanału potrzebne do kierowania komunikatu do bota. |
| channelData | Obiekt | Ładunek specyficzny dla kanału do tworzenia konwersacji. |
| isGroup | Wartość logiczna | Wskazuje, czy jest to konwersacja grupowa. |
| Członków | ChannelAccount[] | Informacje o koncie kanału potrzebne do kierowania komunikatu do każdego użytkownika. |
| tenantId | Ciąg | Identyfikator dzierżawy, w którym należy utworzyć konwersację. |
| nazwa tematu | Ciąg | Temat konwersacji. Ta właściwość jest używana tylko wtedy, gdy kanał go obsługuje. |
ConversationReference, obiekt
Definiuje konkretny punkt w konwersacji.
| Właściwość | Pisz | opis |
|---|---|---|
| Activityid | String | Identyfikator, który jednoznacznie identyfikuje działanie, do którego odwołuje się ten obiekt. |
| Bot | Konto kanału | Obiekt ChannelAccount, który identyfikuje bota w konwersacji, do którego odwołuje się ten obiekt. |
| channelId | Ciąg | Identyfikator, który jednoznacznie identyfikuje kanał w konwersacji, do którego odwołuje się ten obiekt. |
| Konwersacji | KonwersacjaKonto | Obiekt ConversationAccount, który definiuje konwersację, do którego odwołuje się ten obiekt. |
| serviceUrl | Ciąg | Adres URL określający punkt końcowy usługi kanału w konwersacji, do którego odwołuje się ten obiekt. |
| użytkownik | Konto kanału | Obiekt ChannelAccount, który identyfikuje użytkownika w konwersacji, do którego odwołuje się ten obiekt. |
ConversationResourceResponse, obiekt
Definiuje odpowiedź na tworzenie konwersacji.
| Właściwość | Pisz | opis |
|---|---|---|
| Activityid | String | Identyfikator działania, jeśli zostanie wysłany. |
| id | Ciąg | Identyfikator zasobu. |
| serviceUrl | Ciąg | Punkt końcowy usługi, w którym mogą być wykonywane operacje dotyczące konwersacji. |
ConversationResult, obiekt
Definiuje wynik pobierania konwersacji.
| Właściwość | Pisz | Opis |
|---|---|---|
| Rozmowy | ConversationMembers[] | Członkowie w każdej konwersacji. |
| continuationToken | Ciąg | Token kontynuacji, który może być używany w kolejnych wywołaniach do pobierania konwersacji. |
Obiekt jednostki
Obiekt metadanych odnoszący się do działania.
| Właściwość | Pisz | Opis |
|---|---|---|
| type | Ciąg | Typ tej jednostki (RFC 3987 IRI). |
Błąd obiektu
Obiekt reprezentujący informacje o błędzie.
| Właściwość | Pisz | Opis |
|---|---|---|
| kod | Ciąg | Kod błędu. |
| innerHttpError | InnerHttpError | Obiekt reprezentujący wewnętrzny błąd HTTP. |
| message | Ciąg | Opis błędu. |
ErrorResponse, obiekt
Definiuje odpowiedź interfejsu API HTTP.
| Właściwość | Pisz | Opis |
|---|---|---|
| Błąd | Błąd | Obiekt Error zawierający informacje o błędzie. |
Obiekt faktów
Definiuje parę klucz-wartość zawierającą fakt.
| Właściwość | Pisz | Opis |
|---|---|---|
| key | Ciąg | Nazwa faktu. Na przykład zaewidencjonuj. Klucz jest używany jako etykieta podczas wyświetlania wartości faktu. |
| wartość | Ciąg | Wartość faktu. Na przykład 10 października 2016 r. |
Obiekt GeoCoordinates
Definiuje lokalizację geograficzną przy użyciu współrzędnych World Geodetic System (WSG84).
| Właściwość | Pisz | Opis |
|---|---|---|
| Wysokość | Liczba | Podniesienie poziomu lokalizacji. |
| Szerokość geograficzna | Liczba | Szerokość geograficzna lokalizacji. |
| Długość geograficzna | Liczba | Długość geograficzna lokalizacji. |
| name | String | Nazwa lokalizacji. |
| type | Ciąg | Typ tego obiektu. Zawsze ustaw wartość GeoCoordinates. |
Obiekt HeroCard
Definiuje kartę z dużym obrazem, tytułem, tekstem i przyciskami akcji.
| Właściwość | Pisz | Opis |
|---|---|---|
| Przyciski | CardAction[] | Tablica obiektów CardAction , które umożliwiają użytkownikowi wykonywanie co najmniej jednej akcji. Kanał określa liczbę przycisków, które można określić. |
| Obrazów | CardImage[] | Tablica obiektów CardImage , które określają obraz do wyświetlenia na karcie. Karta Hero zawiera tylko jeden obraz. |
| Napisów | Ciąg | Podtytuł do wyświetlenia pod tytułem karty. |
| Dotknij | CardAction | Obiekt CardAction, który określa akcję do wykonania, jeśli użytkownik naciągnie lub kliknie kartę. Może to być ta sama akcja co jeden z przycisków lub innej akcji. |
| text | Ciąg | Opis lub monit o wyświetlenie pod tytułem lub podtytułem karty. |
| title | Ciąg | Tytuł karty. |
InnerHttpError, obiekt
Obiekt reprezentujący wewnętrzny błąd HTTP.
| Właściwość | Pisz | Opis |
|---|---|---|
| Statuscode | Liczba | Kod stanu HTTP z żądania, który zakończył się niepowodzeniem. |
| treść | Obiekt | Treść żądania, które zakończyło się niepowodzeniem. |
MediaEventValue, obiekt
Parametr dodatkowy dla zdarzeń multimedialnych.
| Właściwość | Pisz | Opis |
|---|---|---|
| cardValue | Obiekt | Parametr wywołania zwrotnego określony w polu wartości karty multimedialnej, która pochodzi z tego zdarzenia. |
MediaUrl, obiekt
Definiuje adres URL źródła pliku multimedialnego.
| Właściwość | Pisz | Opis |
|---|---|---|
| Profil | Ciąg | Wskazówka opisując zawartość nośnika. |
| Adres url | Ciąg | Adres URL do źródła pliku multimedialnego. |
Obiekt wzmianki
Definiuje użytkownika lub bota, który został wymieniony w konwersacji.
| Właściwość | Pisz | Opis |
|---|---|---|
| Wymienione | Konto kanału | Obiekt ChannelAccount określający użytkownika lub wymienionego bota. Niektóre kanały, takie jak Slack, przypisują nazwy na konwersację, więc możliwe, że nazwa bota (we właściwości adresata wiadomości) może różnić się od uchwytu określonego podczas rejestrowania bota. Jednak identyfikatory kont dla obu będą takie same. |
| text | Ciąg | Użytkownik lub bot, jak wspomniano w konwersacji. Jeśli na przykład komunikat to "@ColorBot wybierz mi nowy kolor", ta właściwość zostanie ustawiona na @ColorBot. Nie wszystkie kanały ustawiają tę właściwość. |
| type | Ciąg | Typ tego obiektu. Zawsze ustaw wartość Wzmianka. |
MessageReaction, obiekt
Definiuje reakcję na komunikat.
| Właściwość | Pisz | Opis |
|---|---|---|
| type | Ciąg | Typ reakcji. Lub plusOne. |
PagedMembersResult, obiekt
Strona członków zwróconych przez członków strony konwersacji.
| Właściwość | Pisz | Opis |
|---|---|---|
| continuationToken | Ciąg | Token kontynuacji, który może być używany w kolejnych wywołaniach do pobierania członków strony konwersacji. |
| Członków | ChannelAccount[] | Tablica członków konwersacji. |
Umieść obiekt
Definiuje miejsce, które zostało wymienione w konwersacji.
| Właściwość | Pisz | Opis |
|---|---|---|
| Adres | Obiekt | Adres miejsca. Ta właściwość może być ciągiem lub obiektem złożonym typu PostalAddress. |
| Geo | Geokoordyny | Obiekt GeoKoordinates , który określa współrzędne geograficzne miejsca. |
| hasMap | Obiekt | Mapuj na miejsce. Ta właściwość może być ciągiem (adresem URL) lub obiektem złożonym typu Mapa. |
| name | String | Nazwa miejsca. |
| type | Ciąg | Typ tego obiektu. Zawsze ustaw wartość Place (Umieść). |
Obiekt ReceiptCard
Definiuje kartę zawierającą potwierdzenie zakupu.
| Właściwość | Pisz | Opis |
|---|---|---|
| Przyciski | CardAction[] | Tablica obiektów CardAction , które umożliwiają użytkownikowi wykonywanie co najmniej jednej akcji. Kanał określa liczbę przycisków, które można określić. |
| Fakty | Fakt[] | Tablica obiektów faktów określających informacje o zakupie. Na przykład lista faktów dotyczących potwierdzenia pobytu w hotelu może zawierać datę zameldowania i datę zameldowania. Kanał określa liczbę faktów, które można określić. |
| Elementy | ReceiptItem[] | Tablica obiektów ReceiptItem określających zakupione elementy |
| Dotknij | CardAction | Obiekt CardAction, który określa akcję do wykonania, jeśli użytkownik naciągnie lub kliknie kartę. Może to być ta sama akcja co jeden z przycisków lub innej akcji. |
| Podatku | Ciąg | Ciąg sformatowany w walucie, który określa kwotę podatku zastosowanego do zakupu. |
| title | Ciąg | Tytuł wyświetlany w górnej części paragonu. |
| Łącznych | Ciąg | Ciąg w formacie waluty określający łączną cenę zakupu, w tym wszystkie obowiązujące podatki. |
| Podatku vat | Ciąg | Ciąg sformatowany w walucie, który określa kwotę podatku od wartości dodanej (VAT) zastosowanego do ceny zakupu. |
Obiekt ReceiptItem
Definiuje element wiersza w ramach potwierdzenia.
| Właściwość | Pisz | Opis |
|---|---|---|
| Obrazu | CardImage | Obiekt CardImage, który określa obraz miniatury do wyświetlenia obok elementu wiersza. |
| Cena | Ciąg | Ciąg sformatowany w walucie określający łączną cenę wszystkich zakupionych jednostek. |
| Ilość | Ciąg | Ciąg liczbowy określający liczbę zakupionych jednostek. |
| Napisów | Ciąg | Podtytuł, który ma być wyświetlany pod tytułem elementu wiersza. |
| Dotknij | CardAction | Obiekt CardAction, który określa akcję do wykonania, jeśli użytkownik naciągnie lub kliknie element wiersza. |
| text | Ciąg | Opis elementu wiersza. |
| title | Ciąg | Tytuł elementu wiersza. |
ResourceResponse, obiekt
Definiuje odpowiedź zawierającą identyfikator zasobu.
| Właściwość | Pisz | Opis |
|---|---|---|
| id | Ciąg | Identyfikator, który jednoznacznie identyfikuje zasób. |
SemanticAction, obiekt
Definiuje odwołanie do akcji programowej.
| Właściwość | Pisz | Opis |
|---|---|---|
| encje | Obiekt | Obiekt, w którym wartość każdej właściwości jest obiektem jednostki . |
| id | Ciąg | Identyfikator tej akcji. |
| state | Ciąg | Stan tej akcji. Dozwolone wartości: start, kontynuuj, gotowe. |
SignInCard, obiekt
Definiuje kartę, która umożliwia użytkownikowi logowanie się do usługi.
| Właściwość | Pisz | Opis |
|---|---|---|
| Przyciski | CardAction[] | Tablica obiektów CardAction , które umożliwiają użytkownikowi logowanie się do usługi. Kanał określa liczbę przycisków, które można określić. |
| text | Ciąg | Opis lub monit o dołączenie do karty logowania. |
Sugerowany obiekt Actions
Definiuje opcje, z których użytkownik może wybrać.
| Właściwość | Pisz | Opis |
|---|---|---|
| Działania | CardAction[] | Tablica obiektów CardAction , które definiują sugerowane akcje. |
| to | Ciąg[] | Tablica ciągów zawierających identyfikatory adresatów, którym powinny być wyświetlane sugerowane akcje. |
TextHighlight, obiekt
Odwołuje się do podciągu zawartości w innym polu.
| Właściwość | Pisz | Opis |
|---|---|---|
| Wystąpienia | Liczba | Wystąpienie pola tekstowego w tekście, do których odwołuje się odwołanie, jeśli istnieje wiele. |
| text | Ciąg | Definiuje fragment tekstu do wyróżnienia. |
Obiekt ThumbnailCard
Definiuje kartę z przyciskami miniatury, tytułu, tekstu i akcji.
| Właściwość | Pisz | Opis |
|---|---|---|
| Przyciski | CardAction[] | Tablica obiektów CardAction , które umożliwiają użytkownikowi wykonywanie co najmniej jednej akcji. Kanał określa liczbę przycisków, które można określić. |
| Obrazów | CardImage[] | Tablica obiektów CardImage , które określają obrazy miniatur do wyświetlenia na karcie. Kanał określa liczbę obrazów miniatur, które można określić. |
| Napisów | Ciąg | Podtytuł do wyświetlenia pod tytułem karty. |
| Dotknij | CardAction | Obiekt CardAction, który określa akcję do wykonania, jeśli użytkownik naciągnie lub kliknie kartę. Może to być ta sama akcja co jeden z przycisków lub innej akcji. |
| text | Ciąg | Opis lub monit o wyświetlenie pod tytułem lub podtytułem karty. |
| title | Ciąg | Tytuł karty. |
ThumbnailUrl, obiekt
Definiuje adres URL źródła obrazu.
| Właściwość | Pisz | Opis |
|---|---|---|
| Alt | Ciąg | Opis obrazu. Należy dołączyć opis do obsługi ułatwień dostępu. |
| Adres url | Ciąg | Adres URL do źródła obrazu lub pliku binarnego base64 obrazu (na przykład data:image/png;base64,iVBORw0KGgo...). |
Obiekt transkrypcji
Kolekcja działań do przekazania przy użyciu funkcji Wyślij historię konwersacji.
| Właściwość | Pisz | Opis |
|---|---|---|
| Działania | tablica | Tablica obiektów Działania . Każda z nich powinna mieć unikatowy identyfikator i znacznik czasu. |
Obiekt VideoCard
Definiuje kartę, która może odtwarzać filmy wideo.
| Właściwość | Pisz | Opis |
|---|---|---|
| Aspekt | Ciąg | Współczynnik proporcji wideo. 16:9 lub 4:3. |
| autoloop | Wartość logiczna | Flaga wskazująca, czy odtworzyć listę filmów wideo po zakończeniu ostatniego. Ustaw tę właściwość na wartość true , aby automatycznie odtwarzać filmy wideo; w przeciwnym razie wartość false. Wartość domyślna to true. |
| autostart | Wartość logiczna | Flaga wskazująca, czy automatycznie odtwarzać filmy wideo po wyświetleniu karty. Ustaw tę właściwość na wartość true , aby automatycznie odtwarzać filmy wideo; w przeciwnym razie wartość false. Wartość domyślna to true. |
| Przyciski | CardAction[] | Tablica obiektów CardAction , które umożliwiają użytkownikowi wykonywanie co najmniej jednej akcji. Kanał określa liczbę przycisków, które można określić. |
| Długość | Ciąg | Długość zawartości multimedialnej w formacie czasu trwania ISO 8601. |
| Obrazu | ThumbnailUrl | Obiekt ThumbnailUrl , który określa obraz do wyświetlenia na karcie. |
| Media | MediaUrl[] | Tablica mediaUrl. Jeśli to pole zawiera więcej niż jeden adres URL, każdy adres URL jest alternatywnym formatem tej samej zawartości. |
| Współużytkowania | Wartość logiczna | Flaga wskazująca, czy filmy wideo mogą być udostępniane innym osobom. Ustaw tę właściwość na wartość true , jeśli filmy wideo mogą być udostępniane; w przeciwnym razie wartość false. Wartość domyślna to true. |
| Napisów | Ciąg | Podtytuł do wyświetlenia pod tytułem karty. |
| text | Ciąg | Opis lub monit o wyświetlenie pod tytułem lub podtytułem karty. |
| title | Ciąg | Tytuł karty. |
| wartość | Obiekt | Parametr dodatkowy dla tej karty |