Referenční informace k rozhraní API pro službu Bot Framework Připojení or
Poznámka:
Rozhraní REST API neodpovídá sadě SDK. Rozhraní REST API je poskytováno tak, aby umožňovalo standardní komunikaci REST, ale upřednostňovanou metodou interakce s bot Frameworkem je sada SDK.
Služba Bot Připojení or v rámci služby Bot Framework umožňuje robotovi vyměňovat zprávy s uživateli na kanálech nakonfigurovaných na portálu Bot Framework. Služba používá oborový standard REST a JSON přes HTTPS.
Základní identifikátor URI
Když uživatel odešle do robota zprávu, obsahuje příchozí požadavek objekt aktivity s serviceUrl vlastností, která určuje koncový bod, do kterého by robot měl odeslat odpověď. Pokud chcete získat přístup ke službě robota Připojení or, použijte serviceUrl hodnotu jako základní identifikátor URI pro požadavky rozhraní API.
Pokud ještě nemáte adresu URL služby pro kanál, použijte https://smba.trafficmanager.net/teams/ ji jako adresu URL služby. Další informace najdete v tématu vytvoření konverzace a proaktivní zprávy v Teams.
Předpokládejme například, že robot obdrží následující aktivitu, když uživatel odešle do robota zprávu.
{
"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"
}
Vlastnost serviceUrl ve zprávě uživatele označuje, že robot by měl odeslat odpověď na koncový bod https://smba.trafficmanager.net/teams/. Adresa URL služby bude základní identifikátor URI pro všechny následné požadavky, které robot vydává v kontextu této konverzace. Pokud robot bude muset odeslat proaktivní zprávu uživateli, nezapomeňte uložit hodnotu serviceUrl.
Následující příklad ukazuje požadavek, aby robot mohl reagovat na zprávu uživatele.
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..."
}
Hlavičky
Záhlaví žádosti
Kromě standardních hlaviček požadavků HTTP musí každý požadavek rozhraní API, který vydáte, obsahovat hlavičku Authorization , která určuje přístupový token pro ověření robota. Authorization Zadejte záhlaví pomocí tohoto formátu:
Authorization: Bearer ACCESS_TOKEN
Podrobnosti o tom, jak získat přístupový token robota, najdete v tématu Ověření požadavků z robota do služby robota Připojení or.
Hlavičky odpovědi
Kromě standardních hlaviček odpovědí HTTP bude každá odpověď obsahovat hlavičku X-Correlating-OperationId . Hodnota této hlavičky je ID, které odpovídá položce protokolu služby Bot Framework, která obsahuje podrobnosti o požadavku. Když se zobrazí chybová odpověď, měli byste zaznamenat hodnotu této hlavičky. Pokud se vám nedaří problém nezávisle vyřešit, uveďte tuto hodnotu do informací, které poskytnete týmu podpory při hlášení problému.
Stavové kódy HTTP
Stavový kód HTTP vrácený s každou odpovědí označuje výsledek odpovídajícího požadavku.
Poznámka:
Následující tabulka popisuje nejběžnější stavové kódy HTTP. Kanál generuje některé chyby. Další informace možná budete muset přečíst v dokumentaci pro vývojáře kanálu.
| Stavový kód HTTP | Význam |
|---|---|
| 200 | Požadavek byl úspěšný. |
| 201 | Požadavek byl úspěšný. |
| 202 | Žádost byla přijata ke zpracování. |
| 204 | Požadavek byl úspěšný, ale nebyl vrácen žádný obsah. |
| 400 | Požadavek byl poškozený nebo jinak nesprávný. |
| 401 | Robot ještě není ověřený. |
| 403 | Robot nemá oprávnění k provedení požadované operace. |
| 404 | Požadovaný prostředek nebyl nalezen. |
| 405 | Kanál nepodporuje požadovanou operaci. |
| 500 | Došlo k vnitřní chybě serveru. |
| 503 | Služba je dočasně nedostupná. |
Chyby
Každá odpověď, která určuje stavový kód HTTP v rozsahu 4xx nebo 5xx, bude obsahovat objekt ErrorResponse v těle odpovědi, který poskytuje informace o chybě. Pokud se v oblasti 4xx zobrazí chybová odpověď, zkontrolujte objekt ErrorResponse a zjistěte příčinu chyby a vyřešte problém před opětovným odesláním požadavku.
Operace konverzací
Pomocí těchto operací můžete vytvářet konverzace, posílat zprávy (aktivity) a spravovat obsah konverzací.
Důležité
Ne všechny kanály podporují všechny koncové body. Všechny kanály by ale měly podporovat odpověď na koncový bod aktivity .
Například jenom Direct Line a Webový chat podporují koncový bod získání konverzací.
| Operace | Popis |
|---|---|
| Vytvoření konverzace | Vytvoří novou konverzaci. |
| Aktivita odstranění | Odstraní existující aktivitu. |
| Odstranění člena konverzace | Odebere člena z konverzace. |
| Získání členů aktivit | Získá členy zadané aktivity v zadané konverzaci. |
| Získání člena konverzace | Získá podrobnosti o členu konverzace. |
| Získání členů konverzace | Získá členy zadané konverzace. |
| Získání členů se stránkovanými konverzacemi | Získá členy zadané konverzace po jedné stránce. |
| Získání konverzací | Získá seznam konverzací, kterých se robot zúčastnil. |
| Odpověď na aktivitu | Odešle aktivitu (zprávu) do zadané konverzace jako odpověď na zadanou aktivitu. |
| Odeslat historii konverzací | Nahraje do konverzace přepis minulých aktivit. |
| Odeslání do konverzace | Odešle aktivitu (zprávu) na konec zadané konverzace. |
| Aktivita aktualizace | Aktualizace existující aktivitu. |
| Nahrání přílohy do kanálu | Nahraje přílohu přímo do úložiště objektů blob kanálu. |
Vytvoření konverzace
Vytvoří novou konverzaci.
POST /v3/conversations
| Obsah | Popis |
|---|---|
| Text požadavku | Objekt ConversationParameters |
| Vrácení | A ConversationResourceResponse – objekt |
Aktivita odstranění
Některé kanály umožňují odstranit existující aktivitu. V případě úspěchu tato operace odebere zadanou aktivitu ze zadané konverzace.
DELETE /v3/conversations/{conversationId}/activities/{activityId}
| Obsah | Popis |
|---|---|
| Text požadavku | Není k dispozici |
| Vrácení | Stavový kód HTTP, který označuje výsledek operace. V textu odpovědi se nic neurčuje. |
Odstranění člena konverzace
Odebere člena z konverzace. Pokud byl tento člen posledním členem konverzace, konverzace se odstraní také.
DELETE /v3/conversations/{conversationId}/members/{memberId}
| Obsah | Popis |
|---|---|
| Text požadavku | Není k dispozici |
| Vrácení | Stavový kód HTTP, který označuje výsledek operace. V textu odpovědi se nic neurčuje. |
Získání členů aktivit
Získá členy zadané aktivity v zadané konverzaci.
GET /v3/conversations/{conversationId}/activities/{activityId}/members
| Obsah | Popis |
|---|---|
| Text požadavku | Není k dispozici |
| Vrácení | Pole objektů ChannelAccount |
Získání konverzací
Získá seznam konverzací, kterých se robot zúčastnil.
GET /v3/conversations?continuationToken={continuationToken}
| Obsah | Popis |
|---|---|
| Text požadavku | Není k dispozici |
| Vrácení | A ConversationsResult – objekt |
Získání člena konverzace
Získá podrobnosti o konkrétním členu konkrétní konverzace.
GET /v3/conversations/{conversationId}/members/{memberId}
| Obsah | Popis |
|---|---|
| Text požadavku | Není k dispozici |
| Vrácení | Objekt ChannelAccount člena. |
Získání členů konverzace
Získá členy zadané konverzace.
GET /v3/conversations/{conversationId}/members
| Obsah | Popis |
|---|---|
| Text požadavku | Není k dispozici |
| Vrácení | Pole objektů ChannelAccount pro členy konverzace. |
Získání členů se stránkovanými konverzacemi
Získá členy zadané konverzace po jedné stránce.
GET /v3/conversations/{conversationId}/pagedmembers?pageSize={pageSize}&continuationToken={continuationToken}
| Obsah | Popis |
|---|---|
| Text požadavku | Není k dispozici |
| Vrácení | A PagedMembersResult – objekt |
Odpověď na aktivitu
Odešle aktivitu (zprávu) do zadané konverzace jako odpověď na zadanou aktivitu. Aktivita se přidá jako odpověď na jinou aktivitu, pokud ji kanál podporuje. Pokud kanál nepodporuje vnořené odpovědi, tato operace se chová jako Odeslat do konverzace.
POST /v3/conversations/{conversationId}/activities/{activityId}
| Obsah | Popis |
|---|---|
| Text požadavku | Objekt Aktivity |
| Vrácení | A ResourceResponse – objekt |
Odeslání historie konverzací
Nahraje do konverzace přepis minulých aktivit, aby je klient mohl vykreslit.
POST /v3/conversations/{conversationId}/activities/history
| Obsah | Popis |
|---|---|
| Text požadavku | Objekt přepisu. |
| Vrácení | A ResourceResponse objekt. |
Odeslání do konverzace
Odešle aktivitu (zprávu) do zadané konverzace. Aktivita se připojí ke konci konverzace podle časového razítka nebo sémantiky kanálu. Pokud chcete odpovědět na konkrétní zprávu v rámci konverzace, použijte místo toho odpověď na aktivitu .
POST /v3/conversations/{conversationId}/activities
| Obsah | Popis |
|---|---|
| Text požadavku | Objekt Aktivity |
| Vrácení | A ResourceResponse – objekt |
Aktivita aktualizace
Některé kanály umožňují upravit existující aktivitu tak, aby odrážela nový stav konverzace robota. Tlačítka ze zprávy v konverzaci můžete například odebrat poté, co uživatel klikne na jedno z tlačítek. V případě úspěchu tato operace aktualizuje zadanou aktivitu v zadané konverzaci.
PUT /v3/conversations/{conversationId}/activities/{activityId}
| Obsah | Popis |
|---|---|
| Text požadavku | Objekt Aktivity |
| Vrácení | A ResourceResponse – objekt |
Nahrání přílohy do kanálu
Nahraje přílohu pro zadanou konverzaci přímo do úložiště objektů blob kanálu. To umožňuje ukládat data do vyhovujícího úložiště.
POST /v3/conversations/{conversationId}/attachments
| Obsah | Popis |
|---|---|
| Text požadavku | Objekt AttachmentData . |
| Vrácení | A ResourceResponse objekt. Vlastnost ID určuje ID přílohy, které lze použít s operací Získat informace o příloze a operace Získat přílohu. |
Operace přílohy
Pomocí těchto operací můžete načíst informace o příloze i binární data samotného souboru.
| Operace | Popis |
|---|---|
| Získat informace o příloze | Získá informace o zadané příloze, včetně názvu souboru, typu souboru a dostupných zobrazení (například původní nebo miniatury). |
| Získat přílohu | Získá zadané zobrazení zadané přílohy jako binární obsah. |
Získání informací o příloze
Získá informace o zadané příloze, včetně názvu souboru, typu a dostupných zobrazení (například původní nebo miniatury).
GET /v3/attachments/{attachmentId}
| Obsah | Popis |
|---|---|
| Text požadavku | Není k dispozici |
| Vrácení | Objekt AttachmentInfo |
Získat přílohu
Získá zadané zobrazení zadané přílohy jako binární obsah.
GET /v3/attachments/{attachmentId}/views/{viewId}
| Obsah | Popis |
|---|---|
| Text požadavku | Není k dispozici |
| Vrácení | Binární obsah, který představuje zadané zobrazení zadané přílohy |
Stavové operace (zastaralé)
Služba Microsoft Bot Framework State service se od 30. března 2018 vyřadí z provozu. Dříve roboti postavení na službě Azure AI Bot Service nebo sadě Bot Builder SDK měli výchozí připojení k této službě hostované Microsoftem pro ukládání dat o stavu robota. Roboti budou muset aktualizovat, aby používali vlastní úložiště stavu.
| Operace | Popis |
|---|---|
Set User Data |
Ukládá stavová data pro konkrétního uživatele v kanálu. |
Set Conversation Data |
Ukládá stavová data pro konkrétní konverzaci v kanálu. |
Set Private Conversation Data |
Ukládá stavová data pro konkrétního uživatele v kontextu konkrétní konverzace v kanálu. |
Get User Data |
Načte stavová data, která byla dříve uložena pro konkrétního uživatele ve všech konverzacích v kanálu. |
Get Conversation Data |
Načte stavová data, která byla dříve uložena pro konkrétní konverzaci v kanálu. |
Get Private Conversation Data |
Načte stavová data, která byla dříve uložena pro konkrétního uživatele v kontextu konkrétní konverzace v kanálu. |
Delete State For User |
Odstraní stavová data, která byla dříve uložena pro uživatele. |
Schéma
Schéma služby Bot Framework definuje objekty a jejich vlastnosti, které může robot použít ke komunikaci s uživatelem.
| Objekt | Popis |
|---|---|
| Objekt aktivity | Definuje zprávu, která se vyměňuje mezi robotem a uživatelem. |
| Objekt AnimationCard | Definuje kartu, která může přehrávat animované GIFy nebo krátká videa. |
| Objekt Přílohy | Definuje další informace, které se mají zahrnout do zprávy. Příloha může být mediální soubor (například zvuk, video, obrázek, soubor) nebo bohatou kartu. |
| Objekt AttachmentData | Popisuje data přílohy. |
| Objekt AttachmentInfo | Popisuje přílohu. |
| AttachmentView – objekt | Definuje objekt, který představuje dostupné zobrazení přílohy. |
| Objekt AudioCard | Definuje kartu, která může přehrát zvukový soubor. |
| CardAction – objekt | Definuje akci, která se má provést. |
| CardImage – objekt | Definuje obrázek, který se má zobrazit na kartě. |
| ChannelAccount – objekt | Definuje robota nebo uživatelský účet v kanálu. |
| Objekt ConversationAccount | Definuje konverzaci v kanálu. |
| Objekt ConversationMembers | Definuje členy konverzace. |
| ConversationParameters – objekt | Definování parametrů pro vytvoření nové konverzace |
| ConversationReference – objekt | Definuje konkrétní bod v konverzaci. |
| ConversationResourceResponse – objekt | Definuje odpověď na vytvoření konverzace. |
| ConversationsResult – objekt | Definuje výsledek volání pro získání konverzací. |
| Objekt entity | Definuje objekt entity. |
| Objekt chyby | Definuje chybu. |
| ErrorResponse – objekt | Definuje odpověď rozhraní HTTP API. |
| Objekt faktů | Definuje pár klíč-hodnota, který obsahuje fakt. |
| Objekt GeoCoordinates | Definuje zeměpisné umístění pomocí souřadnic WSG84 (World Geodetic System). |
| Objekt HeroCard | Definuje kartu s velkým obrázkem, nadpisem, textem a tlačítky akcí. |
| InnerHttpError – objekt | Objekt představující vnitřní chybu HTTP |
| Objekt MediaEventValue | Doplňkový parametr pro události médií. |
| Objekt MediaUrl | Definuje adresu URL zdroje mediálního souboru. |
| Objekt zmínky | Definuje uživatele nebo robota, který byl zmíněn v konverzaci. |
| MessageReaction – objekt | Definuje reakci na zprávu. |
| PagedMembersResult – objekt | Stránka členů vrácená získáním členů se stránkou Konverzace |
| Umístit objekt | Definuje místo, které bylo zmíněno v konverzaci. |
| Objekt ReceiptCard | Definuje kartu, která obsahuje potvrzení o nákupu. |
| Objekt ReceiptItem | Definuje řádkovou položku v rámci potvrzení. |
| ResourceResponse – objekt | Definuje prostředek. |
| SémanticAction – objekt | Definuje odkaz na programovou akci. |
| SignInCard – objekt | Definuje kartu, která uživateli umožní přihlásit se ke službě. |
| Objekt SuggestedActions | Definuje možnosti, ze kterých si uživatel může vybrat. |
| TextHighlight – objekt | Odkazuje na podřetěr obsahu v jiném poli. |
| Objekt ThumbnailCard | Definuje kartu s miniaturou, nadpisem, textem a tlačítky akcí. |
| Objekt ThumbnailUrl | Definuje adresu URL zdroje obrázku. |
| Objekt přepisu | Kolekce aktivit, které se mají nahrát pomocí historie konverzací. |
| Objekt VideoCard | Definuje kartu, která může přehrávat videa. |
Objekt aktivity
Definuje zprávu, která se vyměňuje mezi robotem a uživatelem.
| Vlastnost | Typ | Popis |
|---|---|---|
| action | Řetězec | Akce, která se má použít nebo byla použita. Pomocí vlastnosti typu určete kontext akce. Pokud je například typemcontactRelationUpdate, hodnota vlastnosti akce by se přidala , pokud uživatel přidal robota do seznamu kontaktů nebo pokud odstranil robota ze seznamu kontaktů. |
| attachmentLayout | Řetězec | Rozložení příloh s bohatou kartou, které zpráva obsahuje. Jedna z těchto hodnot: karusel, seznam. Další informace o přílohách s bohatými kartami najdete v tématu Přidání příloh s bohatými kartami do zpráv. |
| Přílohy | Příloha[] | Pole objektů Přílohy, které definují další informace, které se mají zahrnout do zprávy. Každá příloha může být soubor (například zvuk, video, obrázek) nebo bohatá karta. |
| Callerid | Řetězec | Řetězec obsahující IRI identifikující volajícího robota. Toto pole není určeno k přenosu přes drát, ale místo toho je naplněno roboty a klienty na základě kryptograficky ověřitelných dat, která uplatňují identitu volajících (například tokeny). |
| channelData | Objekt | Objekt, který obsahuje obsah specifický pro kanál. Některé kanály poskytují funkce, které vyžadují další informace, které nelze reprezentovat pomocí schématu přílohy. V těchto případech nastavte tuto vlastnost na obsah specifický pro kanál, jak je definováno v dokumentaci kanálu. Další informace najdete v tématu Implementace funkcí specifických pro kanály. |
| channelId | Řetězec | ID, které jednoznačně identifikuje kanál. Nastavte kanál. |
| kód | Řetězec | Kód označující, proč konverzace skončila. |
| Konverzace | ConversationAccount | Objekt ConversationAccount , který definuje konverzaci, do které aktivita patří. |
| deliveryMode | Řetězec | Tip doručení, který signalizují alternativní cesty doručení pro aktivitu příjemce. Jedna z těchto hodnot: normální, oznámení. |
| entities | object[] | Pole objektů, které představují entity, které byly zmíněny ve zprávě. Objekty v tomto poli mohou být libovolným objektem Schema.org . Pole může například obsahovat objekty zmínky , které identifikují někoho, kdo byl zmíněn v konverzaci, a umístit objekty, které identifikují místo, které bylo zmíněno v konverzaci. |
| Vypršení platnosti | Řetězec | Čas, kdy má být aktivita považována za "vypršela", a neměla by být předána příjemci. |
| od | ChannelAccount | Objekt ChannelAccount , který určuje odesílatele zprávy. |
| historyDisclosed | Logické | Příznak označující, zda je historie zpřístupněna nebo není. Výchozí hodnotou je false. |
| id | Řetězec | ID, které jednoznačně identifikuje aktivitu v kanálu. |
| Význam | Řetězec | Definuje důležitost aktivity. Jedna z těchto hodnot: nízká, normální, vysoká. |
| inputHint | Řetězec | Hodnota, která označuje, jestli robot přijímá, očekává nebo ignoruje uživatelský vstup po doručení zprávy klientovi. Jedna z těchto hodnot: acceptingInput, expectingInput, ignoringInput. |
| Popisek | Řetězec | Popisný popisek aktivity |
| listenFor | Řetězec[] | Seznam frázíachch |
| locale | Řetězec | Národní prostředí jazyka, který by měl být použit k zobrazení textu ve zprávě ve formátu <language>-<country>. Kanál tuto vlastnost používá k označení jazyka uživatele, aby robot mohl určit zobrazované řetězce v daném jazyce. Výchozí hodnota je en-US. |
| localTimestamp | Řetězec | Datum a čas odeslání zprávy v místním časovém pásmu vyjádřený ve formátu ISO-8601 . |
| localTimezone | Řetězec | Obsahuje název místního časového pásma zprávy vyjádřené ve formátu databáze IANA Time Zone. Například Amerika/Los_Angeles. |
| membersAdded | ChannelAccount[] | Pole objektů ChannelAccount, které představují seznam uživatelů, kteří se připojili ke konverzaci. Prezentovat pouze v případě, že typ aktivity je "conversationUpdate" a uživatelé se připojili ke konverzaci. |
| membersRemoved | ChannelAccount[] | Pole objektů ChannelAccount, které představují seznam uživatelů, kteří opustili konverzaci. Prezentovat pouze v případě, že typ aktivity je "conversationUpdate" a uživatelé opustili konverzaci. |
| Jméno | Řetězec | Název operace, která se má vyvolat, nebo název události. |
| reakcePřidáno | MessageReaction[] | Kolekce reakcí přidaných do konverzace. |
| reakceRemoved | MessageReaction[] | Kolekce reakcí odebraných z konverzace. |
| Příjemce | ChannelAccount | Objekt ChannelAccount , který určuje příjemce zprávy. |
| relatesTo | ConversationReference | Objekt ConversationReference , který definuje konkrétní bod v konverzaci. |
| replyToId | Řetězec | ID zprávy, na kterou tato zpráva odpovídá. Chcete-li odpovědět na zprávu, kterou uživatel odeslal, nastavte tuto vlastnost na ID zprávy uživatele. Ne všechny kanály podporují odpovědi s vlákny. V těchto případech kanál tuto vlastnost ignoruje a použije sémantiku seřazenou podle času (časové razítko) k připojení zprávy ke konverzaci. |
| sémanticAction | Sémantické akce | SémanticAction objekt, který představuje odkaz na programovou akci. |
| serviceUrl | Řetězec | Adresa URL, která určuje koncový bod služby kanálu. Nastavte kanál. |
| Mluvit | Řetězec | Text mluvený robotem v kanálu s podporou řeči Pokud chcete řídit různé charakteristiky řeči robota, jako je hlas, rychlost, hlasitost, výslovnost a výška, zadejte tuto vlastnost ve formátu SSML (Speech Synthesis Markup Language). |
| Navrhované akce | Navrhované akce | Objekt SuggestedActions , který definuje možnosti, ze kterých si uživatel může vybrat. |
| Shrnutí | Řetězec | Shrnutí informací, které zpráva obsahuje Například u zprávy odeslané v e-mailovém kanálu může tato vlastnost zadat prvních 50 znaků e-mailové zprávy. |
| text | Řetězec | Text zprávy odesílané od uživatele do robota nebo robota uživateli Omezení stanovená obsahem této vlastnosti najdete v dokumentaci kanálu. |
| Textformat | Řetězec | Formát textu zprávy Jedna z těchto hodnot: markdown, plain, xml. Podrobnosti o textovém formátu najdete v tématu Vytváření zpráv. |
| TextHighlights | TextHighlight[] | Kolekce fragmentů textu, které se zvýrazní, když aktivita obsahuje hodnotu replyToId . |
| Časové razítko | Řetězec | Datum a čas odeslání zprávy v časovém pásmu UTC vyjádřené ve formátu ISO-8601 |
| topicName | Řetězec | Téma konverzace, do které aktivita patří. |
| type | Řetězec | Typ aktivity Jedna z těchto hodnot: message, contactRelationUpdate, conversationUpdate, typeing, endOfConversation, event, invoke, deleteUserData, messageUpdate, messageDelete, installationUpdate, messageReaction, suggestion, trace, handoff. Podrobnosti o typech aktivit najdete v tématu Přehled aktivit. |
| value | Objekt | Hodnota s otevřenou koncem |
| Valuetype | Řetězec | Typ objektu hodnoty aktivity. |
Objekt AnimationCard
Definuje kartu, která může přehrávat animované GIFy nebo krátká videa.
| Vlastnost | Typ | Popis |
|---|---|---|
| Aspekt | Logické | Poměr stran zástupného symbolu miniatury a média Povolené hodnoty jsou 16:9 a 4:3. |
| autoloop | Logické | Příznak označující, jestli se má po skončení posledního konce přehrát seznam animovaných GIFů. Nastavte tuto vlastnost na hodnotu true , aby se animace automaticky přehrála. V opačném případě nepravda. Výchozí hodnota je true. |
| Autostart | Logické | Příznak označující, jestli se má při zobrazení karty automaticky přehrát animace. Nastavte tuto vlastnost na hodnotu true , aby se animace automaticky přehrála. V opačném případě nepravda. Výchozí hodnota je true. |
| Tlačítka | CardAction[] | Pole objektů CardAction, které uživateli umožňují provádět jednu nebo více akcí. Kanál určuje počet tlačítek, která můžete zadat. |
| Doba trvání | Řetězec | Délka multimediálního obsahu ve formátu ISO 8601. |
| Obrázek | ThumbnailUrl | Objekt ThumbnailUrl , který určuje obrázek, který se má na kartě zobrazit. |
| Media | MediaUrl[] | Pole objektů MediaUrl. Pokud toto pole obsahuje více než jednu adresu URL, je každá adresa URL alternativním formátem stejného obsahu. |
| Sdílet | Logické | Příznak označující, jestli se animace může sdílet s ostatními. Tuto vlastnost nastavte na hodnotu true , pokud může být animace sdílena, jinak nepravda. Výchozí hodnota je true. |
| Titulků | Řetězec | Podnadpis, který se má zobrazit pod názvem karty. |
| text | Řetězec | Popis nebo výzva k zobrazení pod názvem nebo podnadpisem karty |
| title | Řetězec | Název karty. |
| value | Objekt | Doplňkový parametr pro tuto kartu. |
Objekt Přílohy
Definuje další informace, které se mají zahrnout do zprávy. Přílohou může být soubor (například obrázek, zvuk nebo video) nebo karta s bohatým obsahem.
| Vlastnost | Typ | Popis |
|---|---|---|
| Obsah | Objekt | Obsah přílohy. Pokud je příloha bohatou kartou, nastavte tuto vlastnost na objekt s formátem karty. Tato vlastnost a vlastnost contentUrl se vzájemně vylučují. |
| Contenttype | Řetězec | Typ média obsahu v příloze. U mediálních souborů nastavte tuto vlastnost na známé typy médií, jako jsou obrázky/png, zvuk/wav a video/mp4. U karet s formátováním nastavte tuto vlastnost na jeden z těchto typů specifických pro dodavatele:
|
| contentUrl | Řetězec | Adresa URL obsahu přílohy Pokud je například příloha obrázkem, můžete nastavit contentUrl na adresu URL, která představuje umístění obrázku. Podporované protokoly jsou: HTTP, HTTPS, File a Data. |
| Jméno | Řetězec | Název přílohy |
| thumbnailUrl | Řetězec | Adresa URL miniatury obrázku, který kanál může použít, pokud podporuje alternativní, menší formu obsahu nebo obsahu. Pokud například nastavíte contentType na aplikaci nebo word a nastavíte contentUrl na umístění wordového dokumentu, můžete zahrnout miniaturu, která představuje dokument. Kanál může místo dokumentu zobrazit miniaturu obrázku. Když uživatel klikne na obrázek, kanál by dokument otevřel. |
Objekt AttachmentData
Popisuje data přílohy.
| Vlastnost | Typ | Popis |
|---|---|---|
| Jméno | Řetězec | Název přílohy |
| originalBase64 | Řetězec | Obsah přílohy |
| thumbnailBase64 | Řetězec | Obsah miniatury přílohy |
| type | Řetězec | Typ obsahu přílohy |
Objekt AttachmentInfo
Metadata přílohy
| Vlastnost | Typ | Popis |
|---|---|---|
| Jméno | Řetězec | Název přílohy |
| type | Řetězec | Typ obsahu přílohy |
| Zobrazení | AttachmentView[] | Pole AttachmentView objektů, které představují dostupná zobrazení pro přílohu. |
AttachmentView – objekt
Definuje objekt, který představuje dostupné zobrazení přílohy.
| Vlastnost | Typ | Popis |
|---|---|---|
| Velikost | Počet | Velikost souboru. |
| viewId | Řetězec | ID zobrazení. |
Objekt AudioCard
Definuje kartu, která může přehrát zvukový soubor.
| Vlastnost | Typ | Popis |
|---|---|---|
| Aspekt | Řetězec | Poměr stran miniatury zadané ve vlastnosti obrázku Platné hodnoty jsou 16:9 a 4:3. |
| autoloop | Logické | Příznak označující, jestli se má po skončení posledního záznamu přehrát seznam zvukových souborů. Nastavte tuto vlastnost na hodnotu true , aby se automaticky přehrály zvukové soubory, jinak nepravda. Výchozí hodnota je true. |
| Autostart | Logické | Příznak označující, jestli se má při zobrazení karty automaticky přehrát zvuk. Nastavte tuto vlastnost na hodnotu true , aby se zvuk automaticky přehrál. V opačném případě nepravda. Výchozí hodnota je true. |
| Tlačítka | CardAction[] | Pole objektů CardAction, které uživateli umožňují provádět jednu nebo více akcí. Kanál určuje počet tlačítek, která můžete zadat. |
| Doba trvání | Řetězec | Délka multimediálního obsahu ve formátu ISO 8601. |
| Obrázek | ThumbnailUrl | Objekt ThumbnailUrl , který určuje obrázek, který se má na kartě zobrazit. |
| Media | MediaUrl[] | Pole objektů MediaUrl. Pokud toto pole obsahuje více než jednu adresu URL, je každá adresa URL alternativním formátem stejného obsahu. |
| Sdílet | Logické | Příznak označující, jestli se zvukové soubory můžou sdílet s ostatními. Tuto vlastnost nastavte na hodnotu true , pokud je možné sdílet zvuk, jinak nepravda. Výchozí hodnota je true. |
| Titulků | Řetězec | Podnadpis, který se má zobrazit pod názvem karty. |
| text | Řetězec | Popis nebo výzva k zobrazení pod názvem nebo podnadpisem karty |
| title | Řetězec | Název karty. |
| value | Objekt | Doplňkový parametr pro tuto kartu. |
CardAction – objekt
Definuje akci, na které lze kliknout, pomocí tlačítka.
| Vlastnost | Typ | Popis |
|---|---|---|
| channelData | Řetězec | Data specifická pro kanály přidružená k této akci. |
| displayText | Řetězec | Text, který se má zobrazit v informačním kanálu chatu, pokud na tlačítko kliknete. |
| Obrázek | Řetězec | Adresa URL obrázku, která se zobrazí na tlačítku vedle textového popisku |
| text | Řetězec | Text akce |
| title | Řetězec | Textový popis, který se zobrazí na tlačítku. |
| type | Řetězec | Typ akce, která se má provést. Seznam platných hodnot najdete v tématu Přidání příloh s bohatou kartou do zpráv. |
| value | Objekt | Doplňkový parametr akce. Chování této vlastnosti se bude lišit podle typu akce. Další informace naleznete v tématu Přidání bohatých příloh karet do zpráv. |
CardImage – objekt
Definuje obrázek, který se má zobrazit na kartě.
| Vlastnost | Typ | Popis |
|---|---|---|
| Alt | Řetězec | Popis obrázku Měli byste zahrnout popis podpory přístupnosti. |
| Klepněte | CardAction | CardAction objekt, který určuje akci, která se má provést, pokud uživatel klepne nebo klikne na obrázek. |
| Adresu url | Řetězec | Adresa URL ke zdroji obrázku nebo binárnímu souboru base64 obrázku (například data:image/png;base64,iVBORw0KGgo...). |
ChannelAccount – objekt
Definuje robota nebo uživatelský účet v kanálu.
| Vlastnost | Typ | Popis |
|---|---|---|
| aadObjectId | Řetězec | ID objektu tohoto účtu v rámci Microsoft Entra ID. |
| id | Řetězec | Jedinečné ID uživatele nebo robota v tomto kanálu |
| Jméno | Řetězec | Zobrazovaný název robota nebo uživatele |
| Roli | Řetězec | Role entity za účtem Buď uživatel , nebo robot. |
Objekt ConversationAccount
Definuje konverzaci v kanálu.
| Vlastnost | Typ | Popis |
|---|---|---|
| aadObjectId | Řetězec | ID objektu tohoto účtu v rámci Microsoft Entra ID. |
| conversationType | Řetězec | Označuje typ konverzace v kanálech, které rozlišují mezi typy konverzací (například skupina nebo osobní). |
| id | Řetězec | ID, které identifikuje konverzaci. ID je jedinečné pro každý kanál. Pokud kanál zahájí konverzaci, nastaví toto ID; V opačném případě robot nastaví tuto vlastnost na ID, které se vrátí v odpovědi při spuštění konverzace (viz Vytvoření konverzace). |
| isGroup | Logické | Příznak označující, jestli konverzace obsahuje více než dva účastníky v době vygenerování aktivity. Pokud se jedná o skupinovou konverzaci, nastavte hodnotu true , jinak nepravda. Výchozí hodnota je false. |
| Jméno | Řetězec | Zobrazované jméno, které lze použít k identifikaci konverzace. |
| Roli | Řetězec | Role entity za účtem Buď uživatel , nebo robot. |
| tenantId | Řetězec | ID tenanta této konverzace. |
Objekt ConversationMembers
Definuje členy konverzace.
| Vlastnost | Typ | Popis |
|---|---|---|
| id | Řetězec | ID konverzace. |
| Členy | ChannelAccount[] | Seznam členů v této konverzaci |
ConversationParameters – objekt
Definuje parametry pro vytvoření nové konverzace.
| Vlastnost | Typ | Popis |
|---|---|---|
| Činnosti | Aktivita | Počáteční zpráva, která se má odeslat do konverzace při jejím vytvoření. |
| Bot | ChannelAccount | Informace o účtu kanálu potřebné ke směrování zprávy do robota |
| channelData | Objekt | Datová část specifická pro kanál pro vytvoření konverzace. |
| isGroup | Logické | Určuje, jestli se jedná o skupinovou konverzaci. |
| Členy | ChannelAccount[] | Informace o účtu kanálu potřebné ke směrování zprávy každému uživateli |
| tenantId | Řetězec | ID tenanta, ve kterém se má konverzace vytvořit. |
| topicName | Řetězec | Téma konverzace Tato vlastnost se používá pouze v případě, že ji kanál podporuje. |
ConversationReference – objekt
Definuje konkrétní bod v konverzaci.
| Vlastnost | Typ | Description |
|---|---|---|
| activityId | Řetězec | ID, které jednoznačně identifikuje aktivitu, na kterou tento objekt odkazuje. |
| Bot | ChannelAccount | Objekt ChannelAccount, který identifikuje robota v konverzaci, na kterou tento objekt odkazuje. |
| channelId | Řetězec | ID, které jednoznačně identifikuje kanál v konverzaci, na který tento objekt odkazuje. |
| Konverzace | ConversationAccount | Objekt ConversationAccount , který definuje konverzaci, na kterou tento objekt odkazuje. |
| serviceUrl | Řetězec | Adresa URL, která určuje koncový bod služby kanálu v konverzaci, na kterou tento objekt odkazuje. |
| Uživatel | ChannelAccount | Objekt ChannelAccount, který identifikuje uživatele v konverzaci, na kterou tento objekt odkazuje. |
ConversationResourceResponse – objekt
Definuje odpověď na vytvoření konverzace.
| Vlastnost | Typ | Description |
|---|---|---|
| activityId | Řetězec | ID aktivity, pokud je odesláno. |
| id | Řetězec | ID prostředku. |
| serviceUrl | Řetězec | Koncový bod služby, kde se můžou provádět operace související s konverzací. |
ConversationsResult – objekt
Definuje výsledek funkce Získat konverzace.
| Vlastnost | Typ | Popis |
|---|---|---|
| Konverzace | ConversationMembers[] | Členové v každé konverzaci. |
| pokračováníToken | Řetězec | Token pro pokračování, který lze použít v následných voláních funkce Získat konverzace. |
Objekt entity
Objekt metadat, který se týká aktivity.
| Vlastnost | Typ | Popis |
|---|---|---|
| type | Řetězec | Typ této entity (RFC 3987 IRI). |
Objekt chyby
Objekt představující informace o chybě
| Vlastnost | Typ | Popis |
|---|---|---|
| kód | Řetězec | Kód chyby |
| innerHttpError | InnerHttpError | Objekt představující vnitřní chybu HTTP |
| message | Řetězec | Popis chyby. |
ErrorResponse – objekt
Definuje odpověď rozhraní HTTP API.
| Vlastnost | Typ | Popis |
|---|---|---|
| Chyba | Chyba | Objekt Error , který obsahuje informace o chybě. |
Objekt faktů
Definuje pár klíč-hodnota, který obsahuje fakt.
| Vlastnost | Typ | Popis |
|---|---|---|
| key | Řetězec | Název faktu. Například vrácení se změnami. Klíč se používá jako popisek při zobrazení hodnoty faktu. |
| value | Řetězec | Hodnota faktu. Například 10. října 2016. |
Objekt GeoCoordinates
Definuje zeměpisné umístění pomocí souřadnic WSG84 (World Geodetic System).
| Vlastnost | Typ | Popis |
|---|---|---|
| Zvýšení | Počet | Zvýšení polohy. |
| Šířky | Počet | Zeměpisná šířka místa. |
| Délky | Počet | Zeměpisná délka umístění. |
| Jméno | Řetězec | Název umístění |
| type | Řetězec | Typ tohoto objektu. Vždy je nastaveno na GeoCoordinates. |
Objekt HeroCard
Definuje kartu s velkým obrázkem, nadpisem, textem a tlačítky akcí.
| Vlastnost | Typ | Popis |
|---|---|---|
| Tlačítka | CardAction[] | Pole objektů CardAction, které uživateli umožňují provádět jednu nebo více akcí. Kanál určuje počet tlačítek, která můžete zadat. |
| Obrázky | CardImage[] | Pole objektů CardImage, které určuje obrázek, který se má na kartě zobrazit. Karta Hero obsahuje jenom jeden obrázek. |
| Titulků | Řetězec | Podnadpis, který se má zobrazit pod názvem karty. |
| Klepněte | CardAction | Objekt CardAction, který určuje akci, která se má provést, pokud uživatel klepne nebo klikne na kartu. Může se jednat o stejnou akci jako jedno z tlačítek nebo jiné akce. |
| text | Řetězec | Popis nebo výzva k zobrazení pod názvem nebo podnadpisem karty |
| title | Řetězec | Název karty. |
InnerHttpError – objekt
Objekt představující vnitřní chybu HTTP
| Vlastnost | Typ | Popis |
|---|---|---|
| Statuscode | Počet | Stavový kód HTTP z neúspěšného požadavku. |
| tělo | Objekt | Text z neúspěšné žádosti |
Objekt MediaEventValue
Doplňkový parametr pro události médií.
| Vlastnost | Typ | Popis |
|---|---|---|
| cardValue | Objekt | Parametr zpětného volání zadaný v poli hodnoty na kartě média, která pochází z této události. |
Objekt MediaUrl
Definuje adresu URL zdroje mediálního souboru.
| Vlastnost | Typ | Popis |
|---|---|---|
| Profil | Řetězec | Tip, který popisuje obsah média. |
| Adresu url | Řetězec | Adresa URL ke zdroji mediálního souboru. |
Objekt zmínky
Definuje uživatele nebo robota, který byl zmíněn v konverzaci.
| Vlastnost | Typ | Popis |
|---|---|---|
| Uvedené | ChannelAccount | Objekt ChannelAccount, který určuje uživatele nebo robota, který byl zmíněn. Některé kanály, jako je Slack, přiřazují jména pro každou konverzaci, takže je možné, že se uvedené jméno vašeho robota (ve vlastnosti příjemce zprávy) může lišit od popisovače, který jste zadali při registraci robota. ID účtu pro oba jsou ale stejná. |
| text | Řetězec | Uživatel nebo robot, jak je uvedeno v konverzaci. Pokud je například zpráva @ColorBot vybrat novou barvu, bude tato vlastnost nastavená na @ColorBot. Ne všechny kanály tuto vlastnost nastavily. |
| type | Řetězec | Typ tohoto objektu. Vždy je nastavená na zmínku. |
MessageReaction – objekt
Definuje reakci na zprávu.
| Vlastnost | Typ | Popis |
|---|---|---|
| type | Řetězec | Typ reakce. Buď jako nebo plusOne. |
PagedMembersResult – objekt
Stránka členů vrácená získáním členů se stránkou Konverzace
| Vlastnost | Typ | Popis |
|---|---|---|
| pokračováníToken | Řetězec | Token pro pokračování, který lze použít v následných voláních na získání členů stránky konverzace. |
| Členy | ChannelAccount[] | Pole členů konverzace |
Umístit objekt
Definuje místo, které bylo zmíněno v konverzaci.
| Vlastnost | Typ | Popis |
|---|---|---|
| Adresu | Objekt | Adresa místa. Tato vlastnost může být řetězec nebo složitý objekt typu PostalAddress. |
| Geo | GeoCoordinates | GeoCoordinates objekt, který určuje zeměpisné souřadnice místa. |
| hasMap | Objekt | Namapovat na místo. Tato vlastnost může být řetězec (URL) nebo složitý objekt typu Map. |
| Jméno | Řetězec | Název místa. |
| type | Řetězec | Typ tohoto objektu. Vždy je nastaveno na Místo. |
Objekt ReceiptCard
Definuje kartu, která obsahuje potvrzení o nákupu.
| Vlastnost | Typ | Popis |
|---|---|---|
| Tlačítka | CardAction[] | Pole objektů CardAction, které uživateli umožňují provádět jednu nebo více akcí. Kanál určuje počet tlačítek, která můžete zadat. |
| Fakta | Fakt[] | Pole objektů faktů, které určují informace o nákupu. Seznam faktů pro potvrzení o pobytu v hotelu může například zahrnovat datum přihlášení a datum rezervace. Kanál určuje počet faktů, které můžete zadat. |
| Položky | ReceiptItem[] | Pole objektů ReceiptItem, které určují zakoupené položky |
| Klepněte | CardAction | Objekt CardAction, který určuje akci, která se má provést, pokud uživatel klepne nebo klikne na kartu. Může se jednat o stejnou akci jako jedno z tlačítek nebo jiné akce. |
| Daňové | Řetězec | Řetězec formátovaný měnou, který určuje částku daně uplatněnou na nákup. |
| title | Řetězec | Název zobrazený v horní části potvrzení. |
| total | Řetězec | Řetězec formátovaný měnou, který určuje celkovou nákupní cenu včetně všech příslušných daní. |
| Dph | Řetězec | Řetězec formátovaný měnou, který určuje částku daně z přidané hodnoty (DPH) použitou na nákupní cenu. |
Objekt ReceiptItem
Definuje řádkovou položku v rámci potvrzení.
| Vlastnost | Typ | Popis |
|---|---|---|
| Obrázek | CardImage | Objekt CardImage, který určuje miniaturu obrázku, který se má zobrazit vedle položky řádku. |
| Cena | Řetězec | Řetězec formátovaný měnou, který určuje celkovou cenu všech zakoupených jednotek. |
| Množství | Řetězec | Číselný řetězec, který určuje počet zakoupených jednotek. |
| Titulků | Řetězec | Pod nadpisem položky řádku se zobrazí pod podnadpis. |
| Klepněte | CardAction | CardAction objekt, který určuje akci, která se má provést, pokud uživatel klepne nebo klikne na položku řádku. |
| text | Řetězec | Popis řádkové položky |
| title | Řetězec | Název řádkové položky |
ResourceResponse – objekt
Definuje odpověď, která obsahuje ID prostředku.
| Vlastnost | Typ | Popis |
|---|---|---|
| id | Řetězec | ID, které jednoznačně identifikuje prostředek. |
SémanticAction – objekt
Definuje odkaz na programovou akci.
| Vlastnost | Typ | Popis |
|---|---|---|
| entities | Objekt | Objekt, kde hodnota každé vlastnosti je objekt Entity . |
| id | Řetězec | ID této akce. |
| state | Řetězec | Stav této akce. Povolené hodnoty: začátek, pokračování, hotovo. |
SignInCard – objekt
Definuje kartu, která uživateli umožní přihlásit se ke službě.
| Vlastnost | Typ | Popis |
|---|---|---|
| Tlačítka | CardAction[] | Pole objektů CardAction, které uživateli umožňují přihlásit se ke službě. Kanál určuje počet tlačítek, která můžete zadat. |
| text | Řetězec | Popis nebo výzva k zahrnutí na přihlašovací kartu |
Objekt SuggestedActions
Definuje možnosti, ze kterých si uživatel může vybrat.
| Vlastnost | Typ | Popis |
|---|---|---|
| Akce | CardAction[] | Pole objektů CardAction, které definují navrhované akce. |
| to | Řetězec[] | Pole řetězců obsahující ID příjemců, kterým se mají navrhované akce zobrazit. |
TextHighlight – objekt
Odkazuje na podřetěr obsahu v jiném poli.
| Vlastnost | Typ | Popis |
|---|---|---|
| Výskyt | Počet | Výskyt textového pole v odkazovaném textu, pokud existuje více. |
| text | Řetězec | Definuje fragment textu, který se má zvýraznit. |
Objekt ThumbnailCard
Definuje kartu s miniaturou, nadpisem, textem a tlačítky akcí.
| Vlastnost | Typ | Popis |
|---|---|---|
| Tlačítka | CardAction[] | Pole objektů CardAction, které uživateli umožňují provádět jednu nebo více akcí. Kanál určuje počet tlačítek, která můžete zadat. |
| Obrázky | CardImage[] | Pole objektů CardImage, které určují miniatury obrázků, které se mají na kartě zobrazit. Kanál určuje počet obrázků miniatur, které můžete zadat. |
| Titulků | Řetězec | Podnadpis, který se má zobrazit pod názvem karty. |
| Klepněte | CardAction | Objekt CardAction, který určuje akci, která se má provést, pokud uživatel klepne nebo klikne na kartu. Může se jednat o stejnou akci jako jedno z tlačítek nebo jiné akce. |
| text | Řetězec | Popis nebo výzva k zobrazení pod názvem nebo podnadpisem karty |
| title | Řetězec | Název karty. |
Objekt ThumbnailUrl
Definuje adresu URL zdroje obrázku.
| Vlastnost | Typ | Popis |
|---|---|---|
| Alt | Řetězec | Popis obrázku Měli byste zahrnout popis podpory přístupnosti. |
| Adresu url | Řetězec | Adresa URL ke zdroji obrázku nebo binárnímu souboru base64 obrázku (například data:image/png;base64,iVBORw0KGgo...). |
Objekt přepisu
Kolekce aktivit, které se mají nahrát pomocí historie konverzací.
| Vlastnost | Typ | Popis |
|---|---|---|
| Činnosti | pole | Pole objektů aktivity . Každý z nich by měl mít jedinečné ID a časové razítko. |
Objekt VideoCard
Definuje kartu, která může přehrávat videa.
| Vlastnost | Typ | Popis |
|---|---|---|
| Aspekt | Řetězec | Poměr stran videa Buď 16:9 , nebo 4:3. |
| autoloop | Logické | Příznak označující, jestli se má po skončení posledního záznamu přehrát seznam videí. Nastavte tuto vlastnost na true , aby se videa automaticky přehrála. V opačném případě nepravda. Výchozí hodnota je true. |
| Autostart | Logické | Příznak označující, jestli se mají videa při zobrazení karty automaticky přehrávat. Nastavte tuto vlastnost na hodnotu true , aby se videa automaticky přehrála. V opačném případě nepravda. Výchozí hodnota je true. |
| Tlačítka | CardAction[] | Pole objektů CardAction, které uživateli umožňují provádět jednu nebo více akcí. Kanál určuje počet tlačítek, která můžete zadat. |
| Doba trvání | Řetězec | Délka multimediálního obsahu ve formátu ISO 8601. |
| Obrázek | ThumbnailUrl | Objekt ThumbnailUrl , který určuje obrázek, který se má na kartě zobrazit. |
| Media | MediaUrl[] | Pole mediaUrl. Pokud toto pole obsahuje více než jednu adresu URL, je každá adresa URL alternativním formátem stejného obsahu. |
| Sdílet | Logické | Příznak označující, jestli se videa můžou sdílet s ostatními. Tuto vlastnost nastavte na true , pokud mohou být videa sdílena, jinak nepravda. Výchozí hodnota je true. |
| Titulků | Řetězec | Podnadpis, který se má zobrazit pod názvem karty. |
| text | Řetězec | Popis nebo výzva k zobrazení pod názvem nebo podnadpisem karty |
| title | Řetězec | Název karty. |
| value | Objekt | Doplňkový parametr pro tuto kartu |