API-referencia a Bot Framework Csatlakozás or szolgáltatáshoz
Megjegyzés:
A REST API nem egyenértékű az SDK-val. A REST API-t a standard REST-kommunikáció engedélyezéséhez biztosítjuk, azonban a Bot Framework használatának előnyben részesített módja az SDK.
A Bot Frameworkben a Bot Csatlakozás or szolgáltatás lehetővé teszi, hogy a robot üzeneteket váltson a felhasználókkal a Bot Framework Portálon konfigurált csatornákon. A szolgáltatás iparági szabványnak megfelelő REST-t és JSON-t használ HTTPS-en keresztül.
Alapszintű URI
Amikor egy felhasználó üzenetet küld a robotnak, a bejövő kérés tartalmaz egy tevékenységobjektumot egy serviceUrl tulajdonsággal, amely meghatározza azt a végpontot, amelyre a robotnak el kell küldenie a választ. A Bot Csatlakozás or szolgáltatás eléréséhez használja az serviceUrl értéket az API-kérések alapszintű URI-jaként.
Ha még nem rendelkezik szolgáltatás URL-címével a csatornához, használja https://smba.trafficmanager.net/teams/ szolgáltatás URL-címként. További információ: beszélgetés és proaktív üzenet létrehozása a Teamsben.
Tegyük fel például, hogy a robot a következő tevékenységet kapja, amikor a felhasználó üzenetet küld a robotnak.
{
"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"
}
A serviceUrl felhasználó üzenetében lévő tulajdonság azt jelzi, hogy a robotnak a végpontnak https://smba.trafficmanager.net/teams/kell elküldenie a válaszát. A szolgáltatás URL-címe lesz az alap URI minden olyan kéréshez, amelyet a robot a beszélgetés kontextusában tapasztal. Ha a robotnak proaktív üzenetet kell küldenie a felhasználónak, mindenképpen mentse a felhasználó értékét serviceUrl.
Az alábbi példa azt a kérést mutatja be, hogy a robot válaszoljon a felhasználó üzenetére.
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..."
}
Fejlécek
Kérésfejlécek
A szabványos HTTP-kérelemfejléceken kívül minden problémás API-kérésnek tartalmaznia kell egy Authorization fejlécet, amely egy hozzáférési jogkivonatot ad meg a robot hitelesítéséhez. Adja meg a Authorization fejlécet a következő formátumban:
Authorization: Bearer ACCESS_TOKEN
A robot hozzáférési jogkivonatának beszerzéséről további információt a robottól a Bot Csatlakozás or szolgáltatásba irányuló kérelmek hitelesítése című témakörben talál.
Válaszfejlécek
A szabványos HTTP-válaszfejléceken kívül minden válasz tartalmaz egy fejlécet X-Correlating-OperationId . Ennek a fejlécnek az értéke egy olyan azonosító, amely megfelel a Bot Framework naplóbejegyzésének, amely a kérés részleteit tartalmazza. Ha hibaüzenet jelenik meg, rögzítenie kell ennek a fejlécnek az értékét. Ha nem tudja önállóan megoldani a problémát, adja meg ezt az értéket a támogatási csapatnak a probléma bejelentésekor megadott információk között.
HTTP-állapotkódok
Az egyes válaszokkal visszaadott HTTP-állapotkód a megfelelő kérés eredményét jelzi.
Megjegyzés:
Az alábbi táblázat a leggyakoribb HTTP-állapotkódokat ismerteti. Néhány hibát a csatorna generál. További információkért előfordulhat, hogy a csatorna fejlesztői dokumentációját kell elolvasnia.
| HTTP-állapotkód | Értelmezés |
|---|---|
| 200 | A kérés sikeres volt. |
| 201 | A kérés sikeres volt. |
| 202 | A kérelem feldolgozásra lett elfogadva. |
| 204 | A kérés sikeres volt, de nem lett visszaadva tartalom. |
| 400 | A kérés helytelen vagy más módon helytelen volt. |
| 401 | A robot még nincs hitelesítve. |
| 403 | A robot nem jogosult a kért művelet végrehajtására. |
| 404 | A kért erőforrás nem található. |
| 405 | A csatorna nem támogatja a kért műveletet. |
| 500 | Belső kiszolgálóhiba történt. |
| 503 | A szolgáltatás átmenetileg nem érhető el. |
Hibák
Minden olyan válasz, amely a 4xx vagy az 5xx tartomány http-állapotkódját adja meg, tartalmaz egy ErrorResponse objektumot a válasz törzsében, amely információt nyújt a hibáról. Ha a 4xx tartományban hibaüzenetet kap, vizsgálja meg az ErrorResponse objektumot a hiba okának azonosításához és a probléma megoldásához a kérés ismételt elküldése előtt.
Beszélgetési műveletek
Ezekkel a műveletekkel beszélgetéseket hozhat létre, üzeneteket küldhet (tevékenységeket), és kezelheti a beszélgetések tartalmát.
Fontos
Nem minden csatorna támogatja az összes végpontot. Azonban minden csatornának támogatnia kell a tevékenységvégpontra adott választ.
Például csak a Direct Line és a webchat támogatja a beszélgetések lekérésének végpontjait.
| Operation | Leírás |
|---|---|
| Beszélgetés létrehozása | Új beszélgetést hoz létre. |
| Tevékenység törlése | Egy meglévő tevékenység törlése. |
| Beszélgetési tag törlése | Eltávolít egy tagot egy beszélgetésből. |
| Tevékenységtagok lekérése | Lekéri a megadott tevékenység tagjait a megadott beszélgetésen belül. |
| Beszélgetési tag lekérése | Lekéri a beszélgetés egy tagjának adatait. |
| Beszélgetési tagok lekérése | Lekéri a megadott beszélgetés tagjait. |
| Beszélgetésoldalas tagok lekérése | Egyszerre egy oldalon lekéri a megadott beszélgetés tagjait. |
| Beszélgetések lekérése | Lekéri azoknak a beszélgetéseknek a listáját, amelyben a robot részt vett. |
| Válasz a tevékenységre | Egy tevékenységet (üzenetet) küld a megadott beszélgetésnek válaszként a megadott tevékenységre. |
| Beszélgetési előzmények küldése | Feltölti a beszélgetésbe a korábbi tevékenységek átiratát. |
| Küldés beszélgetésbe | Tevékenység (üzenet) küldése a megadott beszélgetés végére. |
| Frissítési tevékenység | meglévő tevékenység Frissítések. |
| Melléklet feltöltése a csatornába | Feltölt egy mellékletet közvetlenül egy csatorna blobtárolójába. |
Beszélgetés létrehozása
Új beszélgetést hoz létre.
POST /v3/conversations
| Tartalom | Leírás |
|---|---|
| Kérelem törzse | ConversationParameters objektum |
| Visszatérési érték | ConversationResourceResponse objektum |
Tevékenység törlése
Egyes csatornák lehetővé teszik egy meglévő tevékenység törlését. Ha sikeres, ez a művelet eltávolítja a megadott tevékenységet a megadott beszélgetésből.
DELETE /v3/conversations/{conversationId}/activities/{activityId}
| Tartalom | Leírás |
|---|---|
| Kérelem törzse | n.a. |
| Visszatérési érték | A művelet eredményét jelző HTTP-állapotkód. A válasz törzsében nincs megadva semmi. |
Beszélgetési tag törlése
Eltávolít egy tagot egy beszélgetésből. Ha ez a tag volt a beszélgetés utolsó tagja, a beszélgetés is törlődik.
DELETE /v3/conversations/{conversationId}/members/{memberId}
| Tartalom | Leírás |
|---|---|
| Kérelem törzse | n.a. |
| Visszatérési érték | A művelet eredményét jelző HTTP-állapotkód. A válasz törzsében nincs megadva semmi. |
Tevékenységtagok lekérése
Lekéri a megadott tevékenység tagjait a megadott beszélgetésen belül.
GET /v3/conversations/{conversationId}/activities/{activityId}/members
| Tartalom | Leírás |
|---|---|
| Kérelem törzse | n.a. |
| Visszatérési érték | ChannelAccount-objektumok tömbje |
Beszélgetések lekérése
Lekéri azoknak a beszélgetéseknek a listáját, amelyben a robot részt vett.
GET /v3/conversations?continuationToken={continuationToken}
| Tartalom | Leírás |
|---|---|
| Kérelem törzse | n.a. |
| Visszatérési érték | ConversationsResult objektum |
Beszélgetési tag lekérése
Lekéri egy adott beszélgetés adott tagjának adatait.
GET /v3/conversations/{conversationId}/members/{memberId}
| Tartalom | Leírás |
|---|---|
| Kérelem törzse | n.a. |
| Visszatérési érték | A tag ChannelAccount objektuma. |
Beszélgetési tagok lekérése
Lekéri a megadott beszélgetés tagjait.
GET /v3/conversations/{conversationId}/members
| Tartalom | Leírás |
|---|---|
| Kérelem törzse | n.a. |
| Visszatérési érték | ChannelAccount-objektumok tömbje a beszélgetés tagjai számára. |
Beszélgetésoldalas tagok lekérése
Egyszerre egy oldalon lekéri a megadott beszélgetés tagjait.
GET /v3/conversations/{conversationId}/pagedmembers?pageSize={pageSize}&continuationToken={continuationToken}
| Tartalom | Leírás |
|---|---|
| Kérelem törzse | n.a. |
| Visszatérési érték | PagedMembersResult objektum |
Válasz a tevékenységre
Egy tevékenységet (üzenetet) küld a megadott beszélgetésnek válaszként a megadott tevékenységre. A tevékenység egy másik tevékenységre adott válaszként lesz hozzáadva, ha a csatorna támogatja. Ha a csatorna nem támogatja a beágyazott válaszokat, akkor ez a művelet a Küldés beszélgetésbe funkcióhoz hasonlóan működik.
POST /v3/conversations/{conversationId}/activities/{activityId}
| Tartalom | Leírás |
|---|---|
| Kérelem törzse | Tevékenységobjektum |
| Visszatérési érték | ResourceResponse objektum |
Beszélgetési előzmények küldése
Feltölti a korábbi tevékenységek átiratát a beszélgetésbe, hogy az ügyfél megjeleníthesse őket.
POST /v3/conversations/{conversationId}/activities/history
| Tartalom | Leírás |
|---|---|
| Kérelem törzse | Átirat objektum. |
| Visszatérési érték | ResourceResponse objektum. |
Küldés beszélgetésbe
Egy tevékenységet (üzenetet) küld a megadott beszélgetésnek. A tevékenység hozzá lesz fűzve a beszélgetés végéhez a csatorna időbélyegének vagy szemantikájának megfelelően. Ha egy adott üzenetre szeretne válaszolni a beszélgetésben, használja inkább a Válasz a tevékenységre lehetőséget.
POST /v3/conversations/{conversationId}/activities
| Tartalom | Leírás |
|---|---|
| Kérelem törzse | Tevékenységobjektum |
| Visszatérési érték | ResourceResponse objektum |
Frissítési tevékenység
Egyes csatornák lehetővé teszik egy meglévő tevékenység szerkesztését a robotbeszélgetések új állapotának megfelelően. Eltávolíthatja például a gombokat a beszélgetés egyik üzenetéből, miután a felhasználó az egyik gombra kattintott. Ha sikeres, ez a művelet frissíti a megadott tevékenységet a megadott beszélgetésen belül.
PUT /v3/conversations/{conversationId}/activities/{activityId}
| Tartalom | Leírás |
|---|---|
| Kérelem törzse | Tevékenységobjektum |
| Visszatérési érték | ResourceResponse objektum |
Melléklet feltöltése a csatornába
Feltölt egy mellékletet a megadott beszélgetéshez közvetlenül egy csatorna blobtárolójába. Ez lehetővé teszi az adatok megfelelő tárolóban való tárolását.
POST /v3/conversations/{conversationId}/attachments
| Tartalom | Leírás |
|---|---|
| Kérelem törzse | AttachmentData objektum. |
| Visszatérési érték | ResourceResponse objektum. Az azonosító tulajdonság megadja a mellékletazonosítót, amely a Mellékletinformáció lekérése művelettel és a Melléklet lekérése művelettel használható. |
Mellékletműveletek
Ezekkel a műveletekkel lekérheti a melléklettel kapcsolatos információkat, valamint magának a fájlnak a bináris adatait.
| Operation | Leírás |
|---|---|
| Mellékletadatok lekérése | Információkat kér le a megadott mellékletről, beleértve a fájlnevet, a fájltípust és az elérhető nézeteket (például az eredetit vagy a miniatűrt). |
| Melléklet lekérése | Lekéri a megadott melléklet megadott nézetét bináris tartalomként. |
Mellékletadatok lekérése
Információkat kér le a megadott mellékletről, beleértve a fájlnevet, a típust és az elérhető nézeteket (például az eredetit vagy a miniatűrt).
GET /v3/attachments/{attachmentId}
| Tartalom | Leírás |
|---|---|
| Kérelem törzse | n.a. |
| Visszatérési érték | AttachmentInfo objektum |
Melléklet lekérése
Lekéri a megadott melléklet megadott nézetét bináris tartalomként.
GET /v3/attachments/{attachmentId}/views/{viewId}
| Tartalom | Leírás |
|---|---|
| Kérelem törzse | n.a. |
| Visszatérési érték | A megadott melléklet megadott nézetét képviselő bináris tartalom |
Állapotműveletek (elavult)
A Microsoft Bot Framework State szolgáltatás 2018. március 30-ától megszűnik. Korábban az Azure AI Bot Service-en vagy a Bot Builder SDK-n alapuló robotok alapértelmezett kapcsolatot létesítettek a Microsoft által üzemeltetett szolgáltatással a robotállapot-adatok tárolásához. A robotokat frissíteni kell a saját állapottárolójuk használatához.
| Operation | Leírás |
|---|---|
Set User Data |
Egy adott felhasználó állapotadatait tárolja egy csatornán. |
Set Conversation Data |
Egy adott beszélgetés állapotadatait tárolja egy csatornán. |
Set Private Conversation Data |
Egy adott felhasználó állapotadatait tárolja egy adott beszélgetés kontextusában egy csatornán. |
Get User Data |
Lekéri azokat az állapotadatokat, amelyeket korábban egy adott felhasználó tárolt egy csatornán folytatott összes beszélgetésben. |
Get Conversation Data |
Lekéri azokat az állapotadatokat, amelyeket korábban egy adott beszélgetéshez tároltak egy csatornán. |
Get Private Conversation Data |
Lekéri azokat az állapotadatokat, amelyeket korábban egy adott felhasználó egy adott beszélgetés kontextusában tárolt egy csatornán. |
Delete State For User |
Törli a felhasználó számára korábban tárolt állapotadatokat. |
Schema
A Bot Framework séma határozza meg azokat az objektumokat és azok tulajdonságait, amelyeket a robot a felhasználóval való kommunikációhoz használhat.
| Objektum | Leírás |
|---|---|
| Tevékenységobjektum | A robot és a felhasználó között kicserélt üzenetet definiál. |
| AnimationCard objektum | Olyan kártyát határoz meg, amely képes animált GIF-eket vagy rövid videókat lejátszani. |
| Mellékletobjektum | További információkat határoz meg az üzenetben. A melléklet lehet médiafájl (például hang, videó, kép, fájl) vagy gazdag kártya. |
| AttachmentData objektum | Mellékletadatokat ír le. |
| AttachmentInfo objektum | Egy mellékletet ismertet. |
| AttachmentView objektum | Olyan objektumot határoz meg, amely egy melléklet számára elérhető nézetet jelöl. |
| AudioCard-objektum | Olyan kártyát definiál, amely képes lejátszani egy hangfájlt. |
| CardAction objektum | Meghatároz egy végrehajtandó műveletet. |
| CardImage objektum | Egy kártyán megjelenítendő képet határoz meg. |
| ChannelAccount objektum | Robotot vagy felhasználói fiókot határoz meg a csatornán. |
| ConversationAccount objektum | Egy csatornán belüli beszélgetést határoz meg. |
| ConversationMembers objektum | Meghatározza a beszélgetések tagjait. |
| ConversationParameters objektum | Paraméterek definiálása új beszélgetés létrehozásához |
| ConversationReference objektum | A beszélgetés egy adott pontát határozza meg. |
| ConversationResourceResponse objektum | A Beszélgetés létrehozása parancsra adott választ határozza meg. |
| ConversationsResult objektum | Meghatározza a beszélgetések lekérésére irányuló hívás eredményét. |
| Entitásobjektum | Entitásobjektumot definiál. |
| Hibaobjektum | Hibát határoz meg. |
| ErrorResponse objektum | HTTP API-választ definiál. |
| Tényobjektum | Egy tényeket tartalmazó kulcs-érték pár definiálása. |
| Geokoordináta objektum | Földrajzi helyet határoz meg a Világ geodéziai rendszer (WSG84) koordinátáinak használatával. |
| HeroCard objektum | Nagy képpel, címmel, szöveggel és műveletgombokkal rendelkező kártyát definiál. |
| InnerHttpError objektum | Belső HTTP-hibát képviselő objektum. |
| MediaEventValue objektum | A médiaesemények kiegészítő paramétere. |
| MediaUrl objektum | Meghatározza egy médiafájl forrásának URL-címét. |
| Objektum megemlítése | A beszélgetésben említett felhasználót vagy robotot határozza meg. |
| MessageReaction objektum | Egy üzenetre adott reakciót határoz meg. |
| PagedMembersResult objektum | A Beszélgetésoldalas tagok lekérése által visszaadott tagok lapja. |
| Objektum elhelyezése | Meghatározza a beszélgetésben említett helyet. |
| ReceiptCard objektum | Olyan kártyát határoz meg, amely egy vásárlás nyugtát tartalmaz. |
| ReceiptItem objektum | Egy sorelemet határoz meg egy nyugtán belül. |
| ResourceResponse objektum | Definiál egy erőforrást. |
| SzemanticAction objektum | Programozott műveletre mutató hivatkozást definiál. |
| SignInCard objektum | Olyan kártyát határoz meg, amely lehetővé teszi, hogy a felhasználó bejelentkezjen egy szolgáltatásba. |
| SuggestedActions objektum | Meghatározza azokat a beállításokat, amelyek közül a felhasználó választhat. |
| TextHighlight objektum | Egy másik mezőben lévő tartalom részszűkítésére hivatkozik. |
| ThumbnailCard objektum | Miniatűr képpel, címmel, szöveggel és műveletgombokkal rendelkező kártyát definiál. |
| ThumbnailUrl objektum | Meghatározza a kép forrásának URL-címét. |
| Átirat objektum | A Beszélgetési előzmények küldése funkcióval feltöltendő tevékenységek gyűjteménye. |
| VideoCard-objektum | Meghatároz egy kártyát, amely képes videókat lejátszani. |
Tevékenységobjektum
A robot és a felhasználó között kicserélt üzenetet definiál.
| Tulajdonság | Type | Description |
|---|---|---|
| action | Sztring | Az alkalmazandó vagy alkalmazott művelet. A típustulajdonság használatával határozza meg a művelet környezetét. Ha például a típus contactRelationUpdate, a művelettulajdonság értéke akkor lesz hozzáadva, ha a felhasználó hozzáadta a robotot a partnerlistájához, vagy eltávolítja, ha eltávolította a robotot a partnerlistájából. |
| attachmentLayout | Sztring | Az üzenetben szereplő gazdag kártyamellékletek elrendezése. Az értékek egyike: körhinta, lista. A gazdag kártyamellékletekről további információt a Gazdag kártyamellékletek hozzáadása az üzenetekhez című témakörben talál. |
| Mellékletek | Melléklet[] | Mellékletobjektumok tömbje, amelyek további információkat határoznak meg az üzenetben. Minden melléklet lehet fájl (például hang, videó, kép) vagy egy gazdag kártya. |
| Callerid | Sztring | Egy robot hívóját azonosító IRI-t tartalmazó sztring. Ezt a mezőt nem a vezetéken keresztül kell továbbítani, hanem robotok és ügyfelek töltik ki kriptográfiailag ellenőrizhető adatok alapján, amelyek a hívók identitását érvényesítik (például jogkivonatok). |
| channelData | Object | Csatornaspecifikus tartalmat tartalmazó objektum. Egyes csatornák olyan funkciókat biztosítanak, amelyek további információkat igényelnek, amelyek nem jeleníthetők meg a mellékletséma használatával. Ezekben az esetekben állítsa ezt a tulajdonságot a csatorna dokumentációjában meghatározott csatornaspecifikus tartalomra. További információ: Csatornaspecifikus funkciók implementálása. |
| channelId | Sztring | A csatornát egyedileg azonosító azonosító. A csatorna állítja be. |
| code | Sztring | A beszélgetés befejezését jelző kód. |
| Beszélgetés | ConversationAccount | Egy ConversationAccount objektum, amely meghatározza azt a beszélgetést, amelyhez a tevékenység tartozik. |
| deliveryMode | Sztring | Egy kézbesítési tipp, amely jelzi a címzettnek a tevékenység alternatív kézbesítési útvonalait. Az alábbi értékek egyike: normál, értesítés. |
| Entitások | objektum[] | Az üzenetben említett entitásokat képviselő objektumok tömbje. A tömb objektumai lehetnek Schema.org objektumok. A tömb tartalmazhat például Említés objektumokat, amelyek azonosítják a beszélgetésben említett személyeket, és olyan objektumokat helyeznek el , amelyek azonosítják a beszélgetésben említett helyet. |
| Lejárati | Sztring | Azt az időpontot, amikor a tevékenységet "lejártnak" kell tekinteni, és nem szabad bemutatni a címzettnek. |
| from | ChannelAccount | ChannelAccount objektum, amely meghatározza az üzenet feladóját. |
| historyDisclosed | Boolean | Jelző, amely jelzi, hogy a korábbi adatok nyilvánosságra kerülnek-e. Az alapértelmezett érték hamis. |
| id | Sztring | A csatornán végzett tevékenységet egyedileg azonosító azonosító. |
| Fontos | Sztring | Meghatározza egy tevékenység fontosságát. Az egyik ilyen érték: alacsony, normál, magas. |
| inputHint | Sztring | Az az érték, amely azt jelzi, hogy a robot elfogadja, várja vagy figyelmen kívül hagyja-e a felhasználói bemenetet az üzenet ügyfélnek való elküldése után. Az alábbi értékek egyike: acceptingInput, expectingInput, ignoringInput. |
| Címke | Sztring | A tevékenység leíró címkéje. |
| listenFor | Karakterlánc[] | Azoknak a kifejezéseknek és hivatkozásoknak a listája, amelyeket a beszéd- és nyelvi priming rendszereknek figyelnie kell. |
| Locale | Sztring | A szöveg üzeneten belüli megjelenítéséhez használandó nyelv területi beállítása, formátuma <language>-<country>. A csatorna ezt a tulajdonságot használja a felhasználó nyelvének jelzésére, hogy a robot megjelenítendő sztringeket adjon meg az adott nyelven. Az alapértelmezett érték az EN-US. |
| localTimestamp | Sztring | Az üzenet elküldésének dátuma és időpontja a helyi időzónában ISO-8601 formátumban kifejezve. |
| localTimezone | Sztring | Az üzenet helyi időzónájának nevét tartalmazza, IANA időzóna-adatbázis formátumban kifejezve. Például Amerika/Los_Angeles. |
| membersAdded | ChannelAccount[] | ChannelAccount-objektumok tömbje, amelyek a beszélgetéshez csatlakozó felhasználók listáját jelölik. Csak akkor jelenik meg, ha a tevékenység típusa "conversationUpdate", és a felhasználók csatlakoztak a beszélgetéshez. |
| membersRemoved | ChannelAccount[] | ChannelAccount-objektumok tömbje, amely a beszélgetésből kilépő felhasználók listáját jelöli. Csak akkor jelenik meg, ha a tevékenység típusa "conversationUpdate", és a felhasználók kilépnek a beszélgetésből. |
| név | Sztring | A meghívandó művelet neve vagy az esemény neve. |
| reactionsAdded | MessageReaction[] | A beszélgetéshez hozzáadott reakciók gyűjteménye. |
| reactionsRemoved | MessageReaction[] | A beszélgetésből eltávolított reakciók gyűjteménye. |
| Címzett | ChannelAccount | ChannelAccount objektum, amely megadja az üzenet címzettjének nevét. |
| relatesTo | ConversationReference | A beszélgetés egy adott pontját meghatározó ConversationReference objektum. |
| replyToId | Sztring | Annak az üzenetnek az azonosítója, amelyre az üzenet válaszol. Ha válaszolni szeretne a felhasználó által küldött üzenetre, állítsa be ezt a tulajdonságot a felhasználó üzenetének azonosítójára. Nem minden csatorna támogatja a csoportosított válaszokat. Ezekben az esetekben a csatorna figyelmen kívül hagyja ezt a tulajdonságot, és időrendbe rendezett szemantikával (időbélyeg) fűzi hozzá az üzenetet a beszélgetéshez. |
| szemanticAction | SzemanticAction | Egy SzemanticAction objektum, amely egy programozott műveletre mutató hivatkozást jelöl. |
| serviceUrl | Sztring | A csatorna szolgáltatásvégpontját meghatározó URL-cím. A csatorna állítja be. |
| Beszélni | Sztring | A robot által beszédalapú csatornán elhangzandó szöveg. A robot beszédének különböző jellemzői, például a hang, a sebesség, a hangerő, a kiejtés és a hangmagasság szabályozásához adja meg ezt a tulajdonságot Beszédszintézis korrektúranyelv (SSML) formátumban. |
| suggestedActions | SuggestedActions | Egy SuggestedActions objektum, amely meghatározza azokat a beállításokat, amelyek közül a felhasználó választhat. |
| Összefoglaló | Sztring | Az üzenet által tartalmazott információk összegzése. Egy e-mail csatornán küldött üzenet esetében például ez a tulajdonság megadhatja az e-mail első 50 karakterét. |
| text | Sztring | A felhasználótól a robothoz vagy robothoz küldött üzenet szövege a felhasználónak. A tulajdonság tartalmára vonatkozó korlátozásokról a csatorna dokumentációjában olvashat. |
| textFormat | Sztring | Az üzenet szövegének formátuma. Az alábbi értékek egyike: markdown, plain, xml. A szövegformátumról további információt az Üzenetek létrehozása című témakörben talál. |
| textHighlights | TextHighlight[] | A tevékenység válaszToId értékét tartalmazó szövegtöredékek gyűjteménye. |
| Időbélyeg | Sztring | Az üzenet elküldésének dátuma és időpontja az UTC időzónában ISO-8601 formátumban kifejezve. |
| topicName | Sztring | Annak a beszélgetésnek a témaköre, amelyhez a tevékenység tartozik. |
| type | Sztring | Tevékenység típusa. Ezek egyike: üzenet, contactRelationUpdate, conversationUpdate, gépelés, endOfConversation, esemény, meghívás, deleteUserData, messageUpdate, messageDelete, installationUpdate, messageReaction, javaslat, nyomkövetés, átadás. A tevékenységtípusokról további információt a Tevékenységek áttekintésében talál. |
| value | Object | Nyitott végű érték. |
| valueType | Sztring | A tevékenység értékobjektumának típusa. |
AnimationCard objektum
Olyan kártyát határoz meg, amely képes animált GIF-eket vagy rövid videókat lejátszani.
| Tulajdonság | Type | Description |
|---|---|---|
| Szempont | Boolean | Miniatűr/médiahelyőrző méretaránya. Az engedélyezett értékek a "16:9" és a "4:3". |
| automatikus kiírás | Boolean | Jelölő, amely jelzi, hogy az animált GIF-fájlok listájának lejátszása az utolsó végén történik-e. Állítsa ezt a tulajdonságot igaz értékre az animáció automatikus visszajátszásához; ellenkező esetben hamis. Az alapértelmezett érték igaz. |
| Autosztráda | Boolean | Jelző, amely jelzi, hogy a kártya megjelenésekor automatikusan le szeretné-e játszani az animációt. Állítsa ezt a tulajdonságot igaz értékre az animáció automatikus lejátszásához; ellenkező esetben hamis. Az alapértelmezett érték igaz. |
| Gombok | CardAction[] | CardAction-objektumok tömbje, amelyek lehetővé teszik a felhasználó számára egy vagy több művelet végrehajtását. A csatorna határozza meg a megadható gombok számát. |
| Időtartam | Sztring | A médiatartalom hossza ISO 8601-es időtartamformátumban. |
| rendszerkép | ThumbnailUrl | ThumbnailUrl objektum, amely megadja a kártyán megjelenítendő képet. |
| Média | MediaUrl[] | MediaUrl-objektumok tömbje. Ha ez a mező egynél több URL-címet tartalmaz, az egyes URL-címek azonos tartalom alternatív formátumát képezik. |
| Megosztható | Boolean | Jelző, amely jelzi, hogy az animáció megosztható-e másokkal. Állítsa ezt a tulajdonságot igaz értékre, ha az animáció megosztható, ellenkező esetben hamis. Az alapértelmezett érték igaz. |
| Felirat | Sztring | A kártya címe alatt megjelenítendő felirat. |
| text | Sztring | A kártya címe vagy alcíme alatt megjelenítendő leírás vagy rákérdezés. |
| Cím | Sztring | A kártya címe. |
| value | Object | A kártya kiegészítő paramétere. |
Mellékletobjektum
További információkat határoz meg az üzenetben. A melléklet lehet fájl (például kép, hang vagy videó) vagy egy gazdag kártya.
| Tulajdonság | Type | Description |
|---|---|---|
| Tartalom | Object | A melléklet tartalma. Ha a melléklet gazdag kártya, állítsa ezt a tulajdonságot a rich card objektumra. Ez a tulajdonság és a contentUrl tulajdonság kölcsönösen kizáró jellegűek. |
| contentType | Sztring | A melléklet tartalmának médiatípusa. Médiafájlok esetén állítsa be ezt a tulajdonságot ismert médiatípusokra, például kép/png, hang/wav és video/mp4. Gazdag kártyák esetén állítsa be ezt a tulajdonságot az alábbi szállítóspecifikus típusok egyikére:
|
| contentUrl | Sztring | A melléklet tartalmának URL-címe. Ha például a melléklet egy kép, beállíthatja a contentUrl értéket a kép helyét jelölő URL-címre. A támogatott protokollok a következők: HTTP, HTTPS, Fájl és Adatok. |
| név | Sztring | A melléklet neve. |
| thumbnailUrl | Sztring | Egy miniatűr kép URL-címe, amelyet a csatorna akkor használhat, ha támogatja egy alternatív, kisebb tartalom- vagy contentUrl-formátum használatát. Ha például a contentType-t alkalmazásra/szóraállítja, és a contentUrl értékét a Word-dokumentum helyére állítja, a dokumentumot jelképező miniatűr kép is szerepelhet. A csatorna a miniatűr képét jelenítheti meg a dokumentum helyett. Amikor a felhasználó a képre kattint, a csatorna megnyitja a dokumentumot. |
AttachmentData objektum
Egy melléklet adatait ismerteti.
| Tulajdonság | Type | Description |
|---|---|---|
| név | Sztring | A melléklet neve. |
| originalBase64 | Sztring | Melléklet tartalma. |
| thumbnailBase64 | Sztring | Melléklet miniatűr tartalma. |
| type | Sztring | A melléklet tartalomtípusa. |
AttachmentInfo objektum
Melléklet metaadatai.
| Tulajdonság | Type | Description |
|---|---|---|
| név | Sztring | A melléklet neve. |
| type | Sztring | A melléklet tartalomtípusa. |
| Kilátás nyílik | AttachmentView[] | A melléklet elérhető nézeteit képviselő AttachmentView-objektumok tömbje. |
AttachmentView objektum
Olyan objektumot határoz meg, amely egy melléklet számára elérhető nézetet jelöl.
| Tulajdonság | Type | Description |
|---|---|---|
| Méret | Szám | A fájl mérete. |
| viewId | Sztring | Nézetazonosító. |
AudioCard-objektum
Olyan kártyát definiál, amely képes lejátszani egy hangfájlt.
| Tulajdonság | Type | Description |
|---|---|---|
| Szempont | Sztring | A képtulajdonságban megadott miniatűr méretaránya. Az érvényes értékek: 16:9 és 4:3. |
| automatikus kiírás | Boolean | Jelző, amely jelzi, hogy az utolsó végén visszajátssza-e a hangfájlok listáját. Állítsa ezt a tulajdonságot igaz értékre a hangfájlok automatikus lejátszásához; ellenkező esetben hamis. Az alapértelmezett érték igaz. |
| Autosztráda | Boolean | Jelző, amely jelzi, hogy a kártya megjelenésekor automatikusan le kell-e játszani a hangot. Állítsa ezt a tulajdonságot igaz értékre a hang automatikus lejátszásához; ellenkező esetben hamis. Az alapértelmezett érték igaz. |
| Gombok | CardAction[] | CardAction-objektumok tömbje, amelyek lehetővé teszik a felhasználó számára egy vagy több művelet végrehajtását. A csatorna határozza meg a megadható gombok számát. |
| Időtartam | Sztring | A médiatartalom hossza ISO 8601-es időtartamformátumban. |
| rendszerkép | ThumbnailUrl | ThumbnailUrl objektum, amely megadja a kártyán megjelenítendő képet. |
| Média | MediaUrl[] | MediaUrl-objektumok tömbje. Ha ez a mező egynél több URL-címet tartalmaz, az egyes URL-címek azonos tartalom alternatív formátumát képezik. |
| Megosztható | Boolean | Jelző, amely jelzi, hogy a hangfájlok megoszthatók-e másokkal. Állítsa ezt a tulajdonságot true (igaz) értékre, ha a hang esetleg meg van osztva, ellenkező esetben hamis. Az alapértelmezett érték igaz. |
| Felirat | Sztring | A kártya címe alatt megjelenítendő felirat. |
| text | Sztring | A kártya címe vagy alcíme alatt megjelenítendő leírás vagy rákérdezés. |
| Cím | Sztring | A kártya címe. |
| value | Object | A kártya kiegészítő paramétere. |
CardAction objektum
Kattintásra használható műveletet határoz meg egy gombra kattintva.
| Tulajdonság | Type | Description |
|---|---|---|
| channelData | Sztring | A művelethez társított csatornaspecifikus adatok. |
| displayText | Sztring | A csevegőcsatornában megjelenítendő szöveg, ha a gombra kattint. |
| rendszerkép | Sztring | A gombon megjelenő kép URL-címe a szövegfelirat mellett. |
| text | Sztring | A művelet szövege. |
| Cím | Sztring | A gombon megjelenő szöveges leírás. |
| type | Sztring | Végrehajtandó művelet típusa. Az érvényes értékek listáját a Rich Card-mellékletek hozzáadása az üzenetekhez című témakörben találja. |
| value | Object | A művelet kiegészítő paramétere. A tulajdonság viselkedése a művelet típusától függően változik. További információ: Gazdag kártyamellékletek hozzáadása az üzenetekhez. |
CardImage objektum
Egy kártyán megjelenítendő képet határoz meg.
| Tulajdonság | Type | Description |
|---|---|---|
| Alt | Sztring | A kép leírása. A kisegítő lehetőségek támogatásához adja meg a leírást. |
| Érintse meg | CardAction | CardAction objektum, amely megadja a végrehajtandó műveletet, ha a felhasználó a képre koppint vagy kattint. |
| Url | Sztring | A kép forrásának vagy a kép base64 bináris fájljának URL-címe (például data:image/png;base64,iVBORw0KGgo...). |
ChannelAccount objektum
Robotot vagy felhasználói fiókot határoz meg a csatornán.
| Tulajdonság | Type | Description |
|---|---|---|
| aadObjectId | Sztring | A fiók objektumazonosítója a Microsoft Entra-azonosítón belül. |
| id | Sztring | A csatornán lévő felhasználó vagy robot egyedi azonosítója. |
| név | Sztring | A robot vagy a felhasználó megjeleníthető neve. |
| Szerepet | Sztring | A fiók mögötti entitás szerepe. Felhasználó vagy robot. |
ConversationAccount objektum
Egy csatornán belüli beszélgetést határoz meg.
| Tulajdonság | Type | Description |
|---|---|---|
| aadObjectId | Sztring | A fiók objektumazonosítója a Microsoft Entra-azonosítón belül. |
| conversationType | Sztring | A beszélgetés típusát jelzi olyan csatornákban, amelyek megkülönböztetik a beszélgetéstípusokat (például csoport vagy személyes). |
| id | Sztring | A beszélgetést azonosító azonosító. Az azonosító csatornánként egyedi. Ha a csatorna elindítja a beszélgetést, beállítja ezt az azonosítót; ellenkező esetben a robot beállítja ezt a tulajdonságot arra az azonosítóra, amelyet a beszélgetés indításakor kap vissza a válaszban (lásd: Beszélgetés létrehozása). |
| isGroup | Boolean | Jelző, amely jelzi, hogy a beszélgetés kétnál több résztvevőt tartalmaz-e a tevékenység létrehozásakor. Ha csoportos beszélgetésről van szó, állítsa igaz értékre, ellenkező esetben hamis értékre. Az alapértelmezett érték hamis. |
| név | Sztring | A beszélgetés azonosítására használható megjelenítendő név. |
| Szerepet | Sztring | A fiók mögötti entitás szerepe. Felhasználó vagy robot. |
| tenantId | Sztring | A beszélgetés bérlőazonosítója. |
ConversationMembers objektum
Meghatározza a beszélgetések tagjait.
| Tulajdonság | Type | Description |
|---|---|---|
| id | Sztring | A beszélgetés azonosítója. |
| Tagok | ChannelAccount[] | A beszélgetésben szereplő tagok listája. |
ConversationParameters objektum
Meghatározza az új beszélgetések létrehozásához szükséges paramétereket.
| Tulajdonság | Type | Description |
|---|---|---|
| Tevékenység | Tevékenység | A beszélgetésnek a létrehozáskor küldendő kezdeti üzenet. |
| Bot | ChannelAccount | Az üzenet robothoz való átirányításához szükséges csatornafiókadatok. |
| channelData | Object | Csatornaspecifikus hasznos adatok a beszélgetés létrehozásához. |
| isGroup | Boolean | Azt jelzi, hogy ez csoportos beszélgetés-e. |
| Tagok | ChannelAccount[] | Az üzenetek minden felhasználóhoz való átirányításához szükséges csatornafiók-információk. |
| tenantId | Sztring | A bérlőazonosító, amelyben létre kell hozni a beszélgetést. |
| topicName | Sztring | A beszélgetés témája. Ezt a tulajdonságot csak akkor használja a rendszer, ha egy csatorna támogatja. |
ConversationReference objektum
A beszélgetés egy adott pontát határozza meg.
| Tulajdonság | Type | Description |
|---|---|---|
| activityId | Sztring | Azonosító, amely egyedileg azonosítja az objektum által hivatkozott tevékenységet. |
| Bot | ChannelAccount | ChannelAccount objektum, amely azonosítja a robotot abban a beszélgetésben, amelyekre az objektum hivatkozik. |
| channelId | Sztring | Egy azonosító, amely egyedileg azonosítja az objektum által hivatkozott beszélgetés csatornáját. |
| Beszélgetés | ConversationAccount | Egy ConversationAccount objektum, amely meghatározza az objektum által hivatkozott beszélgetést. |
| serviceUrl | Sztring | Az objektum által hivatkozott beszélgetésben a csatorna szolgáltatásvégpontját meghatározó URL-cím. |
| user | ChannelAccount | ChannelAccount objektum, amely azonosítja az objektum által hivatkozott beszélgetésben szereplő felhasználót. |
ConversationResourceResponse objektum
A Beszélgetés létrehozása parancsra adott választ határozza meg.
| Tulajdonság | Type | Description |
|---|---|---|
| activityId | Sztring | A tevékenység azonosítója, ha el van küldve. |
| id | Sztring | Az erőforrás azonosítója. |
| serviceUrl | Sztring | Szolgáltatásvégpont, ahol a beszélgetéssel kapcsolatos műveletek elvégezhetők. |
ConversationsResult objektum
A Beszélgetések lekérése eredményének meghatározása.
| Tulajdonság | Type | Description |
|---|---|---|
| Beszélgetések | ConversationMembers[] | Az egyes beszélgetések tagjai. |
| continuationToken | Sztring | A folytatási jogkivonat, amely a beszélgetések lekérésére szolgáló későbbi hívásokban használható. |
Entitásobjektum
Egy tevékenységhez kapcsolódó metaadat-objektum.
| Tulajdonság | Type | Description |
|---|---|---|
| type | Sztring | Az entitás típusa (RFC 3987 IRI). |
Hibaobjektum
Hibainformációkat képviselő objektum.
| Tulajdonság | Type | Description |
|---|---|---|
| code | Sztring | Hibakód. |
| innerHttpError | InnerHttpError | A belső HTTP-hibát jelző objektum. |
| üzenet | Sztring | A hiba leírása. |
ErrorResponse objektum
HTTP API-választ definiál.
| Tulajdonság | Type | Description |
|---|---|---|
| Hiba | Hiba | Hibaobjektum, amely információkat tartalmaz a hibáról. |
Tényobjektum
Egy tényeket tartalmazó kulcs-érték pár definiálása.
| Tulajdonság | Type | Description |
|---|---|---|
| key | Sztring | A tény neve. Például: Bejelentkezés. A kulcs címkeként használatos a tény értékének megjelenítésekor. |
| value | Sztring | A tény értéke. Például : 2016. október 10. |
Geokoordináta objektum
Földrajzi helyet határoz meg a Világ geodéziai rendszer (WSG84) koordinátáinak használatával.
| Tulajdonság | Type | Description |
|---|---|---|
| Magasság | Szám | A hely magasságának emelése. |
| Szélesség | Szám | A hely szélessége. |
| Hosszúság | Szám | A hely hosszúsága. |
| név | Sztring | A hely neve. |
| type | Sztring | Az objektum típusa. Mindig geokoordinátákra van állítva. |
HeroCard objektum
Nagy képpel, címmel, szöveggel és műveletgombokkal rendelkező kártyát definiál.
| Tulajdonság | Type | Description |
|---|---|---|
| Gombok | CardAction[] | CardAction-objektumok tömbje, amelyek lehetővé teszik a felhasználó számára egy vagy több művelet végrehajtását. A csatorna határozza meg a megadható gombok számát. |
| Képek | CardImage[] | CardImage objektumok tömbje, amely meghatározza a kártyán megjelenítendő képet. A Fő kép kártya csak egy képet tartalmaz. |
| Felirat | Sztring | A kártya címe alatt megjelenítendő felirat. |
| Érintse meg | CardAction | Egy CardAction-objektum , amely megadja a végrehajtandó műveletet, ha a felhasználó a kártyára koppint vagy kattint. Ez lehet ugyanaz a művelet, mint az egyik gomb vagy egy másik művelet. |
| text | Sztring | A kártya címe vagy alcíme alatt megjelenítendő leírás vagy rákérdezés. |
| Cím | Sztring | A kártya címe. |
InnerHttpError objektum
Belső HTTP-hibát képviselő objektum.
| Tulajdonság | Type | Description |
|---|---|---|
| statusCode | Szám | HTTP-állapotkód a sikertelen kérelemből. |
| Szervezet | Object | Törzs a sikertelen kérelemből. |
MediaEventValue objektum
A médiaesemények kiegészítő paramétere.
| Tulajdonság | Type | Description |
|---|---|---|
| cardValue | Object | Az eseményt létrehozó médiakártya értékmezőjében megadott visszahívási paraméter. |
MediaUrl objektum
Meghatározza egy médiafájl forrásának URL-címét.
| Tulajdonság | Type | Description |
|---|---|---|
| Profil | Sztring | Tipp, amely leírja a média tartalmát. |
| Url | Sztring | A médiafájl forrásának URL-címe. |
Objektum megemlítése
A beszélgetésben említett felhasználót vagy robotot határozza meg.
| Tulajdonság | Type | Description |
|---|---|---|
| Említett | ChannelAccount | ChannelAccount objektum, amely meghatározza az említett felhasználót vagy robotot. Egyes csatornák, például a Slack, beszélgetésenként rendelnek neveket, ezért lehetséges, hogy a robot megemlített neve (az üzenet címzett tulajdonságában) eltérhet a robot regisztrálásakor megadott leírótól. A fiókazonosítók azonban mindkét esetben megegyeznek. |
| text | Sztring | A beszélgetésben említett felhasználó vagy robot. Ha például "@ColorBot válasszon új színt" üzenet, akkor ez a tulajdonság @ColorBot lesz beállítva. Nem minden csatorna állítja be ezt a tulajdonságot. |
| type | Sztring | Az objektum típusa. Mindig a Megemlítés értékre van állítva. |
MessageReaction objektum
Egy üzenetre adott reakciót határoz meg.
| Tulajdonság | Type | Description |
|---|---|---|
| type | Sztring | A reakció típusa. Akár tetszik, akár pluszOne. |
PagedMembersResult objektum
A Beszélgetésoldalas tagok lekérése által visszaadott tagok lapja.
| Tulajdonság | Type | Description |
|---|---|---|
| continuationToken | Sztring | A folytatási jogkivonat, amely a beszélgetésoldalas tagok lekérésére szolgáló későbbi hívásokban használható. |
| Tagok | ChannelAccount[] | Beszélgetési tagok tömbje. |
Objektum elhelyezése
Meghatározza a beszélgetésben említett helyet.
| Tulajdonság | Type | Description |
|---|---|---|
| Cím | Object | Egy hely címe. Ez a tulajdonság lehet egy PostalAddress típusú sztring vagy összetett objektum. |
| Geo | Geokoordináták | Geokoordináta objektum, amely meghatározza a hely földrajzi koordinátáit. |
| hasMap | Object | Térkép a helyre. Ez a tulajdonság lehet egy sztring (URL) vagy egy Térkép típusú összetett objektum. |
| név | Sztring | A hely neve. |
| type | Sztring | Az objektum típusa. Mindig a Hely értékre van állítva. |
ReceiptCard objektum
Olyan kártyát határoz meg, amely egy vásárlás nyugtát tartalmaz.
| Tulajdonság | Type | Description |
|---|---|---|
| Gombok | CardAction[] | CardAction-objektumok tömbje, amelyek lehetővé teszik a felhasználó számára egy vagy több művelet végrehajtását. A csatorna határozza meg a megadható gombok számát. |
| Tények | Tény[] | Tényobjektumok tömbje, amelyek a vásárlással kapcsolatos információkat adják meg. Egy szállodai tartózkodás nyugtájának tényei közé tartozhat például a bejelentkezés dátuma és a kijelentkezés dátuma. A csatorna határozza meg a megadható tények számát. |
| Elemek | Nyugta[] | A megvásárolt elemeket meghatározó ReceiptItem objektumok tömbje |
| Érintse meg | CardAction | Egy CardAction-objektum , amely megadja a végrehajtandó műveletet, ha a felhasználó a kártyára koppint vagy kattint. Ez lehet ugyanaz a művelet, mint az egyik gomb vagy egy másik művelet. |
| Adó | Sztring | Pénznem formátumú sztring, amely meghatározza a vásárlásra alkalmazott adó összegét. |
| Cím | Sztring | A cím a nyugta tetején jelenik meg. |
| Teljes | Sztring | Pénznem formátumú sztring, amely meghatározza a teljes vételárat, beleértve az összes alkalmazandó adót is. |
| Áfa | Sztring | Pénznem formátumú sztring, amely a vételárra alkalmazott hozzáadottérték-adó (ÁFA) összegét határozza meg. |
ReceiptItem objektum
Egy sorelemet határoz meg egy nyugtán belül.
| Tulajdonság | Type | Description |
|---|---|---|
| rendszerkép | CardImage | Egy CardImage objektum, amely a sorelem mellett megjelenítendő miniatűrképet adja meg. |
| Ár | Sztring | Pénznem formátumú sztring, amely az összes megvásárolt egység teljes árát adja meg. |
| Mennyiség | Sztring | Numerikus sztring, amely megadja a megvásárolt egységek számát. |
| Felirat | Sztring | A sorelem címe alatt megjelenítendő alcím. |
| Érintse meg | CardAction | Egy CardAction objektum, amely megadja a végrehajtandó műveletet, ha a felhasználó a sorelemre koppint vagy kattint. |
| text | Sztring | A sorelem leírása. |
| Cím | Sztring | A sorelem címe. |
ResourceResponse objektum
Erőforrás-azonosítót tartalmazó választ definiál.
| Tulajdonság | Type | Description |
|---|---|---|
| id | Sztring | Az erőforrást egyedileg azonosító azonosító. |
SzemanticAction objektum
Programozott műveletre mutató hivatkozást definiál.
SignInCard objektum
Olyan kártyát határoz meg, amely lehetővé teszi, hogy a felhasználó bejelentkezjen egy szolgáltatásba.
| Tulajdonság | Type | Description |
|---|---|---|
| Gombok | CardAction[] | CardAction-objektumok tömbje, amelyek lehetővé teszik a felhasználó számára, hogy bejelentkezhessen egy szolgáltatásba. A csatorna határozza meg a megadható gombok számát. |
| text | Sztring | A bejelentkezési kártyára való felfoglalás leírása vagy kérése. |
SuggestedActions objektum
Meghatározza azokat a beállításokat, amelyek közül a felhasználó választhat.
| Tulajdonság | Type | Description |
|---|---|---|
| Műveletek | CardAction[] | A javasolt műveleteket meghatározó CardAction-objektumok tömbje. |
| to | Karakterlánc[] | Sztringek tömbje, amelyek azon címzettek azonosítóit tartalmazzák, akiknek a javasolt műveleteket meg kell jeleníteni. |
TextHighlight objektum
Egy másik mezőben lévő tartalom részszűkítésére hivatkozik.
| Tulajdonság | Type | Description |
|---|---|---|
| Előfordulása | Szám | A szövegmező előfordulása a hivatkozott szövegben, ha több is létezik. |
| text | Sztring | Meghatározza a kiemelni kívánt szövegrészletet. |
ThumbnailCard objektum
Miniatűr képpel, címmel, szöveggel és műveletgombokkal rendelkező kártyát definiál.
| Tulajdonság | Type | Description |
|---|---|---|
| Gombok | CardAction[] | CardAction-objektumok tömbje, amelyek lehetővé teszik a felhasználó számára egy vagy több művelet végrehajtását. A csatorna határozza meg a megadható gombok számát. |
| Képek | CardImage[] | CardImage-objektumok tömbje, amelyek miniatűr képeket adnak meg a kártyán. A csatorna határozza meg az Ön által megadható miniatűrképek számát. |
| Felirat | Sztring | A kártya címe alatt megjelenítendő felirat. |
| Érintse meg | CardAction | Egy CardAction-objektum , amely megadja a végrehajtandó műveletet, ha a felhasználó a kártyára koppint vagy kattint. Ez lehet ugyanaz a művelet, mint az egyik gomb vagy egy másik művelet. |
| text | Sztring | A kártya címe vagy alcíme alatt megjelenítendő leírás vagy rákérdezés. |
| Cím | Sztring | A kártya címe. |
ThumbnailUrl objektum
Meghatározza a kép forrásának URL-címét.
| Tulajdonság | Type | Description |
|---|---|---|
| Alt | Sztring | A kép leírása. A kisegítő lehetőségek támogatásához adja meg a leírást. |
| Url | Sztring | A kép forrásának vagy a kép base64 bináris fájljának URL-címe (például data:image/png;base64,iVBORw0KGgo...). |
Átirat objektum
A Beszélgetési előzmények küldése funkcióval feltöltendő tevékenységek gyűjteménye.
| Tulajdonság | Type | Description |
|---|---|---|
| Tevékenységek | array | Tevékenységobjektumok tömbje. Mindegyiknek egyedi azonosítóval és időbélyegzővel kell rendelkeznie. |
VideoCard-objektum
Meghatároz egy kártyát, amely képes videókat lejátszani.
| Tulajdonság | Type | Description |
|---|---|---|
| Szempont | Sztring | A videó méretaránya. 16:9 vagy 4:3. |
| automatikus kiírás | Boolean | Jelző, amely jelzi, hogy az utolsó végén visszajátssza-e a videók listáját. Állítsa ezt a tulajdonságot igaz értékre a videók automatikus lejátszásához; ellenkező esetben hamis. Az alapértelmezett érték igaz. |
| Autosztráda | Boolean | Jelző, amely jelzi, hogy a kártya megjelenésekor automatikusan le kell-e játszani a videókat. Állítsa ezt a tulajdonságot igaz értékre a videók automatikus lejátszásához; ellenkező esetben hamis. Az alapértelmezett érték igaz. |
| Gombok | CardAction[] | CardAction-objektumok tömbje, amelyek lehetővé teszik a felhasználó számára egy vagy több művelet végrehajtását. A csatorna határozza meg a megadható gombok számát. |
| Időtartam | Sztring | A médiatartalom hossza ISO 8601-es időtartamformátumban. |
| rendszerkép | ThumbnailUrl | ThumbnailUrl objektum, amely megadja a kártyán megjelenítendő képet. |
| Média | MediaUrl[] | A MediaUrl tömbje. Ha ez a mező egynél több URL-címet tartalmaz, az egyes URL-címek azonos tartalom alternatív formátumát képezik. |
| Megosztható | Boolean | Jelző, amely jelzi, hogy a videók megoszthatók-e másokkal. Állítsa ezt a tulajdonságot igaz értékre, ha a videók megoszthatóak, ellenkező esetben hamis. Az alapértelmezett érték igaz. |
| Felirat | Sztring | A kártya címe alatt megjelenítendő felirat. |
| text | Sztring | A kártya címe vagy alcíme alatt megjelenítendő leírás vagy rákérdezés. |
| Cím | Sztring | A kártya címe. |
| value | Object | A kártya kiegészítő paramétere |