Aracılığıyla paylaş

Bot Framework Bağlan or hizmeti için API başvurusu

  • Makale

Dekont

REST API, SDK ile eşdeğer değildir. STANDART REST iletişimine izin vermek için REST API sağlanır, ancak Bot Framework ile etkileşim kurmanın tercih edilen yöntemi SDK'dır.

Bot Framework'te Bot Bağlan or hizmeti, botunuzun Bot Framework Portalı'nda yapılandırılan kanallarda kullanıcılarla ileti alışverişinde bulunmasını sağlar. Hizmet, HTTPS üzerinden endüstri standardı REST ve JSON kullanır.

Temel URI

Kullanıcı botunuza bir ileti gönderdiğinde, gelen istek botunuzun yanıtını göndermesi gereken uç noktayı belirten özelliği olan bir serviceUrl Etkinlik nesnesi içerir. Bot Bağlan veya serviceUrl hizmetine erişmek için değerini API istekleri için temel URI olarak kullanın.

Kanal için bir hizmet URL'niz yoksa hizmet URL'si olarak kullanın https://smba.trafficmanager.net/teams/ . Daha fazla bilgi için bkz . Teams'de bir konuşma ve proaktif ileti oluşturma.

Örneğin, kullanıcı bota bir ileti gönderdiğinde botunuzun aşağıdaki etkinliği aldığını varsayalım.

{
    "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"
}

serviceUrl Kullanıcının iletisindeki özelliği, botunun yanıtını uç noktaya https://smba.trafficmanager.net/teams/göndermesi gerektiğini belirtir. Hizmet URL'si, botun bu konuşma bağlamında dağıtacağı sonraki isteklerin temel URI'si olacaktır. Botunuzun kullanıcıya proaktif bir ileti göndermesi gerekiyorsa değerini kaydettiğinizden serviceUrlemin olun.

Aşağıdaki örnek, botunun kullanıcının iletisine yanıt vermek için sorun verdiği isteği gösterir.

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..."
}

Üst Bilgiler

İstek üst bilgileri

Standart HTTP isteği üst bilgilerine ek olarak, yayımladığınız her API isteğinin botunuzun kimliğini doğrulamak için bir erişim belirteci belirten bir üst bilgi içermesi Authorization gerekir. Authorization Üst bilgiyi şu biçimi kullanarak belirtin:

Authorization: Bearer ACCESS_TOKEN

Botunuz için erişim belirteci alma hakkında ayrıntılı bilgi için bkz. Botunuzdan Bot Bağlan veya hizmetine yönelik isteklerin kimliğini doğrulama.

Yanıt üst bilgileri

Standart HTTP yanıt üst bilgilerine ek olarak, her yanıt bir X-Correlating-OperationId üst bilgi içerir. Bu üst bilginin değeri, istekle ilgili ayrıntıları içeren Bot Framework günlük girişine karşılık gelen bir kimliktir. Bir hata yanıtı aldığınızda, bu üst bilginin değerini yakalamanız gerekir. Sorunu bağımsız olarak çözemiyorsanız, sorunu bildirirken Destek ekibine sağladığınız bilgilere bu değeri ekleyin.

HTTP durum kodu

Her yanıtla birlikte döndürülen HTTP durum kodu, ilgili isteğin sonucunu gösterir.

Dekont

Aşağıdaki tabloda en yaygın HTTP durum kodları açıklanmaktadır. Kanal tarafından bazı hatalar oluşturulur. Daha fazla bilgi için kanalın geliştirici belgelerini okumanız gerekebilir.

HTTP durum kodu Anlamı
200 İstek başarılı oldu.
201 İstek başarılı oldu.
202 İstek işlenmek üzere kabul edildi.
204 İstek başarılı oldu, ancak hiçbir içerik döndürülmedi.
400 İstek yanlış biçimlendirilmiş veya başka bir şekilde yanlış.
401 Bot henüz doğrulanmadı.
403 Bot, istenen işlemi gerçekleştirme yetkisine sahip değil.
404 İstenen kaynak bulunamadı.
405 Kanal istenen işlemi desteklemiyor.
500 bir iç sunucu hatası oluştu.
503 Hizmet geçici olarak kullanılamıyor.

Hatalar

4xx aralığında veya 5xx aralığında bir HTTP durum kodu belirten herhangi bir yanıt, yanıtın gövdesinde hata hakkında bilgi sağlayan bir ErrorResponse nesnesi içerir. 4xx aralığında bir hata yanıtı alırsanız, hatanın nedenini belirlemek için ErrorResponse nesnesini inceleyin ve isteği yeniden göndermeden önce sorununuzu çözün.

Konuşma işlemleri

Konuşma oluşturmak, ileti göndermek (etkinlikler) ve konuşmaların içeriğini yönetmek için bu işlemleri kullanın.

Önemli

Tüm kanallar tüm uç noktaları desteklemez. Ancak tüm kanalların etkinlik uç noktasını yanıtlamayı desteklemesi gerekir.

Örneğin, yalnızca Direct Line ve Web Sohbeti konuşma alma uç noktasını destekler.

Operation Tanım
Konuşma Oluştur Yeni bir konuşma oluşturur.
Silme etkinliği Mevcut bir etkinliği siler.
Konuşma üyesini silme Bir üyeyi konuşmadan kaldırır.
Etkinlik üyelerini alma Belirtilen konuşma içinde belirtilen etkinliğin üyelerini alır.
Konuşma üyesi alma Bir konuşmanın üyesiyle ilgili ayrıntıları alır.
Konuşma üyelerini alma Belirtilen konuşmanın üyelerini alır.
Konuşma sayfalı üyeleri alma Belirtilen konuşmanın üyelerini bir kerede bir sayfa alır.
Konuşmaları alma Botun katıldığı konuşmaların listesini alır.
Etkinliği yanıtlama Belirtilen konuşmaya, belirtilen etkinliğe yanıt olarak bir etkinlik (ileti) gönderir.
Konuşma Geçmişi Gönder Geçmiş etkinliklerin dökümünü konuşmaya yükler.
Konuşmaya gönder Belirtilen konuşmanın sonuna bir etkinlik (ileti) gönderir.
Etkinliği güncelleştirme Mevcut bir etkinliği Güncelleştirmeler.
Eki kanala yükleme Bir eki doğrudan kanalın blob depolama alanına yükler.

Konuşma oluşturma

Yeni bir konuşma oluşturur.

POST /v3/conversations
İçerik Tanım
İstek gövdesi ConversationParameters nesnesi
İadeler ConversationResourceResponse nesnesi

Silme etkinliği

Bazı kanallar mevcut bir etkinliği silmenize olanak sağlar. Başarılı olursa, bu işlem belirtilen etkinliği belirtilen konuşmadan kaldırır.

DELETE /v3/conversations/{conversationId}/activities/{activityId}
İçerik Tanım
İstek gövdesi yok
İadeler İşlemin sonucunu gösteren HTTP Durum kodu. Yanıtın gövdesinde hiçbir şey belirtilmez.

Konuşma üyesini silme

Bir üyeyi konuşmadan kaldırır. Bu üye konuşmanın son üyesiyse, konuşma da silinir.

DELETE /v3/conversations/{conversationId}/members/{memberId}
İçerik Tanım
İstek gövdesi yok
İadeler İşlemin sonucunu gösteren HTTP Durum kodu. Yanıtın gövdesinde hiçbir şey belirtilmez.

Etkinlik üyelerini alma

Belirtilen konuşma içinde belirtilen etkinliğin üyelerini alır.

GET /v3/conversations/{conversationId}/activities/{activityId}/members
İçerik Tanım
İstek gövdesi yok
İadeler ChannelAccount nesneleri dizisi

Konuşmaları alma

Botun katıldığı konuşmaların listesini alır.

GET /v3/conversations?continuationToken={continuationToken}
İçerik Tanım
İstek gövdesi yok
İadeler ConversationsResult nesnesi

Konuşma üyesi alma

Belirli bir konuşmanın belirli bir üyesiyle ilgili ayrıntıları alır.

GET /v3/conversations/{conversationId}/members/{memberId}
İçerik Tanım
İstek gövdesi yok
İadeler Üye için bir ChannelAccount nesnesi.

Konuşma üyelerini alma

Belirtilen konuşmanın üyelerini alır.

GET /v3/conversations/{conversationId}/members
İçerik Tanım
İstek gövdesi yok
İadeler Konuşmanın üyeleri için bir ChannelAccount nesneleri dizisi.

Konuşma sayfalı üyeleri alma

Belirtilen konuşmanın üyelerini bir kerede bir sayfa alır.

GET /v3/conversations/{conversationId}/pagedmembers?pageSize={pageSize}&continuationToken={continuationToken}
İçerik Tanım
İstek gövdesi yok
İadeler PagedMembersResult nesnesi

Etkinliği yanıtlama

Belirtilen konuşmaya, belirtilen etkinliğe yanıt olarak bir etkinlik (ileti) gönderir. Kanal destekliyorsa etkinlik başka bir etkinliğe yanıt olarak eklenir. Kanal iç içe yanıtları desteklemiyorsa, bu işlem Konuşmaya Gönder gibi davranır.

POST /v3/conversations/{conversationId}/activities/{activityId}
İçerik Tanım
İstek gövdesi Activity nesnesi
İadeler ResourceResponse nesnesi

Konuşma geçmişini gönderme

İstemcinin bunları işleyebilmesi için geçmiş etkinliklerin dökümünü konuşmaya yükler.

POST /v3/conversations/{conversationId}/activities/history
İçerik Tanım
İstek gövdesi Transkript nesnesi.
İadeler ResourceResponse nesnesi.

Konuşmaya gönder

Belirtilen konuşmaya bir etkinlik (ileti) gönderir. Etkinlik, kanalın zaman damgasına veya semantiğine göre konuşmanın sonuna eklenir. Konuşmadaki belirli bir iletiyi yanıtlamak için bunun yerine Etkinliği Yanıtla'yı kullanın.

POST /v3/conversations/{conversationId}/activities
İçerik Tanım
İstek gövdesi Activity nesnesi
İadeler ResourceResponse nesnesi

Etkinliği güncelleştirme

Bazı kanallar, bot konuşmasının yeni durumunu yansıtacak şekilde mevcut bir etkinliği düzenlemenize olanak sağlar. Örneğin, kullanıcı düğmelerden birine tıkladıktan sonra konuşmadaki bir iletideki düğmeleri kaldırabilirsiniz. Başarılı olursa, bu işlem belirtilen konuşma içinde belirtilen etkinliği güncelleştirir.

PUT /v3/conversations/{conversationId}/activities/{activityId}
İçerik Tanım
İstek gövdesi Activity nesnesi
İadeler ResourceResponse nesnesi

Eki kanala yükleme

Belirtilen konuşmanın ekini doğrudan kanalın blob depolama alanına yükler. Bu, verileri uyumlu bir depoda depolamanızı sağlar.

POST /v3/conversations/{conversationId}/attachments
İçerik Tanım
İstek gövdesi Bir AttachmentData nesnesi.
İadeler ResourceResponse nesnesi. id özelliği, Ek bilgilerini al işlemi ve Eki al işlemiyle kullanılabilecek ek kimliğini belirtir.

Ek işlemleri

Bir ek ve dosyanın kendisi için ikili veriler hakkında bilgi almak için bu işlemleri kullanın.

Operation Tanım
Ek Bilgilerini Al Belirtilen ek hakkında dosya adı, dosya türü ve kullanılabilir görünümler (örneğin, özgün veya küçük resim) gibi bilgileri alır.
Ek Al Belirtilen ekin belirtilen görünümünü ikili içerik olarak alır.

Ek bilgilerini alma

Belirtilen ek hakkında dosya adı, tür ve kullanılabilir görünümler (örneğin, özgün veya küçük resim) gibi bilgileri alır.

GET /v3/attachments/{attachmentId}
İçerik Tanım
İstek gövdesi yok
İadeler Bir AttachmentInfo nesnesi

Ek alma

Belirtilen ekin belirtilen görünümünü ikili içerik olarak alır.

GET /v3/attachments/{attachmentId}/views/{viewId}
İçerik Tanım
İstek gövdesi yok
İadeler Belirtilen ekin belirtilen görünümünü temsil eden ikili içerik

Durum işlemleri (kullanım dışı)

Microsoft Bot Framework State hizmeti 30 Mart 2018 itibarıyla kullanımdan kaldırılmıştır. Daha önce Azure AI Bot Hizmeti veya Bot Builder SDK'sı üzerinde oluşturulan botların bot durumu verilerini depolamak için Microsoft tarafından barındırılan bu hizmete varsayılan bağlantısı vardı. Botların kendi durum depolamalarını kullanacak şekilde güncelleştirilmiş olması gerekir.

Operation Tanım
Set User Data Belirli bir kullanıcının durum verilerini bir kanalda depolar.
Set Conversation Data Belirli bir konuşmanın durum verilerini bir kanalda depolar.
Set Private Conversation Data Belirli bir kullanıcının durum verilerini kanaldaki belirli bir konuşma bağlamında depolar.
Get User Data Kanaldaki tüm konuşmalarda belirli bir kullanıcı için daha önce depolanmış olan durum verilerini alır.
Get Conversation Data Kanaldaki belirli bir konuşma için daha önce depolanmış olan durum verilerini alır.
Get Private Conversation Data Kanaldaki belirli bir konuşma bağlamında belirli bir kullanıcı için daha önce depolanmış olan durum verilerini alır.
Delete State For User Daha önce bir kullanıcı için depolanmış olan durum verilerini siler.

Şema

Bot Framework şeması, botunuzun bir kullanıcıyla iletişim kurmak için kullanabileceği nesneleri ve özelliklerini tanımlar.

Nesne Tanım
Etkinlik nesnesi Bot ve kullanıcı arasında değiş tokuş edilen bir ileti tanımlar.
AnimationCard nesnesi Animasyonlu GIF'leri veya kısa videoları oynatabilen bir kart tanımlar.
Ek nesnesi İletiye eklenecek ek bilgileri tanımlar. Ek bir medya dosyası (örneğin, ses, video, görüntü, dosya) veya zengin bir kart olabilir.
AttachmentData nesnesi Ek verilerini açıklar.
AttachmentInfo nesnesi Eki açıklar.
AttachmentView nesnesi Ek için kullanılabilir bir görünümü temsil eden bir nesne tanımlar.
AudioCard nesnesi Ses dosyasını yürütebilen bir kart tanımlar.
CardAction nesnesi Gerçekleştirilecek eylemi tanımlar.
CardImage nesnesi Kartta görüntülenecek görüntüyü tanımlar.
ChannelAccount nesnesi Kanalda bir bot veya kullanıcı hesabı tanımlar.
ConversationAccount nesnesi Kanaldaki bir konuşmayı tanımlar.
ConversationMembers nesnesi Konuşmanın üyelerini tanımlar.
ConversationParameters nesnesi Yeni konuşma oluşturmak için parametreler tanımlama
ConversationReference nesnesi Konuşmadaki belirli bir noktayı tanımlar.
ConversationResourceResponse nesnesi Konuşma Oluştur'a bir yanıt tanımlar.
ConversationsResult nesnesi Konuşma alma çağrısının sonucunu tanımlar.
Varlık nesnesi Varlık nesnesini tanımlar.
Hata nesnesi Bir hata tanımlar.
ErrorResponse nesnesi BIR HTTP API yanıtı tanımlar.
Olgu nesnesi Olgu içeren bir anahtar-değer çifti tanımlar.
GeoCoordinates nesnesi Dünya Jeodetik Sistem (WSG84) koordinatlarını kullanarak bir coğrafi konum tanımlar.
HeroCard nesnesi Büyük resim, başlık, metin ve eylem düğmeleri olan bir kart tanımlar.
InnerHttpError nesnesi İç HTTP hatasını temsil eden nesne.
MediaEventValue nesnesi Medya olayları için ek parametre.
MediaUrl nesnesi Bir medya dosyasının kaynağının URL'sini tanımlar.
Bahsetme nesnesi Konuşmada bahsedilen bir kullanıcı veya bot tanımlar.
MessageReaction nesnesi İletiye bir tepki tanımlar.
PagedMembersResult nesnesi Konuşma Sayfalı Üyeleri Al tarafından döndürülen üyelerin sayfası.
Nesne yerleştir Konuşmada bahsedilen bir yeri tanımlar.
ReceiptCard nesnesi Satın alma için makbuz içeren bir kart tanımlar.
ReceiptItem nesnesi Alış irsaliyesi içindeki bir satır öğesini tanımlar.
ResourceResponse nesnesi Bir kaynağı tanımlar.
SemanticAction nesnesi Programlı bir eyleme başvuru tanımlar.
SignInCard nesnesi Kullanıcının bir hizmette oturum açmasına olanak tanıyan bir kart tanımlar.
SuggestedActions nesnesi Bir kullanıcının seçebileceği seçenekleri tanımlar.
TextHighlight nesnesi Başka bir alandaki içeriğin alt dizesini ifade eder.
ThumbnailCard nesnesi Küçük resim resmi, başlık, metin ve eylem düğmeleri içeren bir kart tanımlar.
ThumbnailUrl nesnesi Görüntünün kaynağının URL'sini tanımlar.
Transkript nesnesi Konuşma Geçmişi Gönder kullanılarak karşıya yüklenecek etkinlikler koleksiyonu.
VideoCard nesnesi Video oynatabilen bir kart tanımlar.

Etkinlik nesnesi

Bot ve kullanıcı arasında değiş tokuş edilen bir ileti tanımlar.

Özellik Tür Tanım
action String Uygulanacak veya uygulanan eylem. Eylemin bağlamını belirlemek için type özelliğini kullanın. Örneğin, type contactRelationUpdate ise, kullanıcı botunuzu kişi listesine eklediyse eylem özelliğinin değeri eklenir veya botunuzu kişi listesinden kaldırdıysa kaldırılır.
attachmentLayout String İletinin içerdiği zengin kart eklerinin düzeni. Bu değerlerden biri: döngü, liste. Zengin kart ekleri hakkında daha fazla bilgi için bkz . İletilere zengin kart ekleri ekleme.
Ekleri Ek[] İletiye eklenecek ek bilgileri tanımlayan Ek nesneleri dizisi. Her ek bir dosya (örneğin, ses, video, görüntü) veya zengin bir kart olabilir.
callerId String Bir botun çağıranı tanımlayan bir IRI içeren dize. Bu alan, kablo üzerinden iletilmesi amaçlanmamıştır, ancak bunun yerine çağıranların kimliğini onaylayan şifreli olarak doğrulanabilir verilere (örneğin belirteçler) dayalı olarak botlar ve istemciler tarafından doldurulur.
channelData Nesne Kanala özgü içerik içeren bir nesne. Bazı kanallar, ek şeması kullanılarak temsil edilmeyecek ek bilgiler gerektiren özellikler sağlar. Bu durumlar için, bu özelliği kanalın belgelerinde tanımlandığı gibi kanala özgü içeriğe ayarlayın. Daha fazla bilgi için bkz . Kanala özgü işlevselliği uygulama.
channelId String Kanalı benzersiz olarak tanımlayan bir kimlik. Kanala göre ayarlayın.
kod String Konuşmanın neden sona erdiğini gösteren kod.
Konuşma ConversationAccount Etkinliğin ait olduğu konuşmayı tanımlayan bir ConversationAccount nesnesi.
deliveryMode String Alıcıya etkinliğin alternatif teslim yollarını belirten bir teslim ipucu. Bu değerlerden biri: normal, bildirim.
varlıklar object[] İletide bahsedilen varlıkları temsil eden nesne dizisi. Bu dizideki nesneler herhangi bir Schema.org nesnesi olabilir. Örneğin, dizi konuşmada bahsedilen birini tanımlayan Bahsetme nesnelerini ve konuşmada bahsedilen bir yeri tanımlayan Nesneleri yerleştir'i içerebilir.
Sona erme String Etkinliğin "süresi dolmuş" olarak kabul edilmesi ve alıcıya sunulmaması gereken saat.
kaynak ChannelAccount İletinin gönderenini belirten bir ChannelAccount nesnesi.
historyDisclosed Boolean Geçmişin açıklanıp açıklanmadığını gösteren bayrak. Varsayılan değer yanlış'tır.
id String Kanaldaki etkinliği benzersiz olarak tanımlayan kimlik.
Önemi String Etkinliğin önemini tanımlar. Bu değerlerden biri: düşük, normal, yüksek.
inputHint String İleti istemciye teslim edildikten sonra botunuzun kullanıcı girişini kabul ettiğini, beklediğini veya yoksaydığını gösteren değer. Bu değerlerden biri: acceptingInput, expectingInput, yoksaymaInput.
label String Etkinlik için açıklayıcı bir etiket.
listenFor Dize[] Konuşma ve dil hazırlama sistemlerinin dinlemesi gereken tümceciklerin ve başvuruların listesi.
yerel ayar String İletideki metni biçiminde görüntülemek için kullanılması gereken dilin yerel ayarı <language>-<country>. Kanal, kullanıcının dilini belirtmek için bu özelliği kullanır, böylece botunuz bu dilde görüntü dizeleri belirtebilir. Varsayılan değer en-US'dir.
localTimestamp String İletinin yerel saat diliminde gönderildiği tarih ve saat, ISO-8601 biçiminde ifade edilir.
localTimezone String İletinin IANA Saat Dilimi veritabanı biçiminde ifade edilen yerel saat diliminin adını içerir. Örneğin, Amerika/Los_Angeles.
membersAdded ChannelAccount[] Konuşmaya katılan kullanıcıların listesini temsil eden ChannelAccount nesneleri dizisi. Yalnızca etkinlik türü "conversationUpdate" ise ve kullanıcılar konuşmaya katıldıysa sunulur.
membersRemoved ChannelAccount[] Konuşmayı bırakan kullanıcıların listesini temsil eden ChannelAccount nesneleri dizisi. Yalnızca etkinlik türü "conversationUpdate" ise ve kullanıcılar konuşmayı bıraktıysa sunar.
Adı String Çağrılacak işlemin adı veya olayın adı.
reactionsAdded MessageReaction[] Konuşmaya eklenen tepkilerin koleksiyonu.
reactionsRemoved MessageReaction[] Tepkilerin toplanması konuşmadan kaldırıldı.
Alıcı ChannelAccount İletinin alıcısını belirten bir ChannelAccount nesnesi.
relatesTo ConversationReference Konuşmadaki belirli bir noktayı tanımlayan ConversationReference nesnesi.
replyToId String Bu iletinin yanıtladığı iletinin kimliği. Kullanıcının gönderdiği bir iletiyi yanıtlamak için bu özelliği kullanıcının iletisinin kimliği olarak ayarlayın. Tüm kanallar yazışma yanıtlarını desteklemez. Böyle durumlarda kanal bu özelliği yoksayar ve iletinin konuşmaya eklenmesi için sıralı zaman semantiği (zaman damgası) kullanır.
semantikAction SemantikAction Programlı bir eyleme başvuru gösteren SemanticAction nesnesi.
serviceUrl String Kanalın hizmet uç noktasını belirten URL. Kanala göre ayarlayın.
Konuşa String Konuşma özellikli bir kanalda botunuz tarafından konuşulacak metin. Botunuzun konuşmasının ses, hız, ses düzeyi, söyleniş ve ses düzeyi gibi çeşitli özelliklerini denetlemek için bu özelliği Konuşma Sentezi biçimlendirme dili (SSML) biçiminde belirtin.
suggestedActions SuggestedActions Kullanıcının seçebileceği seçenekleri tanımlayan Bir SuggestedActions nesnesi.
Özet String İletinin içerdiği bilgilerin özeti. Örneğin, e-posta kanalında gönderilen bir ileti için bu özellik e-posta iletisinin ilk 50 karakterini belirtebilir.
text String Kullanıcıdan bota veya bottan kullanıcıya gönderilen iletinin metni. Bu özelliğin içeriğine uygulanan sınırlar için kanalın belgelerine bakın.
Metinbiçimi String İleti metninin biçimi. Bu değerlerden biri: markdown, plain, xml. Metin biçimi hakkında ayrıntılı bilgi için bkz . İleti oluşturma.
textHighlights TextHighlight[] Etkinlik bir replyToId değeri içerdiğinde vurgulamak için metin parçalarının koleksiyonu.
Zaman damgası String İletinin UTC saat diliminde gönderildiği tarih ve saat ISO-8601 biçiminde ifade edilir.
topicName String Etkinliğin ait olduğu konuşmanın konusu.
type String Etkinlik türü. Bu değerlerden biri: message, contactRelationUpdate, conversationUpdate, typing, endOfConversation, event, invoke, deleteUserData, messageUpdate, messageDelete, installationUpdate, messageReaction, suggestion, trace, handoff. Etkinlik türleri hakkında ayrıntılı bilgi için bkz . Etkinliklere genel bakış.
value Nesne Açık uçlu değer.
Valuetype String Etkinliğin değer nesnesinin türü.

Şema tablosuna geri dön

AnimationCard nesnesi

Animasyonlu GIF'leri veya kısa videoları oynatabilen bir kart tanımlar.

Özellik Tür Tanım
Yönü Boolean Küçük resim/medya yer tutucusunun en boy oranı. İzin verilen değerler "16:9" ve "4:3" değerleridir.
otomatik açılma Boolean Sonuncusu sona erdiğinde animasyonlu GIF listesinin yeniden oynatılıp oynatılmayacağını gösteren bayrak. Animasyonu otomatik olarak yeniden oynatmak için bu özelliği true olarak ayarlayın; aksi takdirde false. Varsayılan değer true değeridir.
Autostart Boolean Kart görüntülendiğinde animasyonu otomatik olarak oynatıp oynatmayacağını gösteren bayrak. Animasyonu otomatik olarak oynatmak için bu özelliği true , aksi takdirde false olarak ayarlayın. Varsayılan değer true değeridir.
Düğme CardAction[] Kullanıcının bir veya daha fazla eylem gerçekleştirmesini sağlayan CardAction nesneleri dizisi. Kanal, belirteceğiniz düğme sayısını belirler.
Süre String Iso 8601 süre biçimindeki medya içeriğinin uzunluğu.
Görüntü ThumbnailUrl Kartta görüntülenecek görüntüyü belirten ThumbnailUrl nesnesi.
Medya MediaUrl[] MediaUrl nesneleri dizisi. Bu alan birden fazla URL içerdiğinde, her URL aynı içeriğin alternatif biçimidir.
Paylaşılabilir Boolean Animasyonu başkalarıyla paylaşılıp paylaşılamayacağını gösteren bayrak. Animasyon paylaşılabilirse bu özelliği true , aksi takdirde false olarak ayarlayın. Varsayılan değer true değeridir.
Altyazı String Kartın başlığının altında görüntülenecek alt başlık.
text String Kartın başlığı veya alt başlığı altında görüntülenecek açıklama veya istem.
title String Kartın başlığı.
value Nesne Bu kart için ek parametre.

Şema tablosuna geri dön

Ek nesnesi

İletiye eklenecek ek bilgileri tanımlar. Ek bir dosya (resim, ses veya video gibi) veya zengin bir kart olabilir.

Özellik Tür Tanım
Içerik Nesne Ekin içeriği. Ek zengin bir kartsa, bu özelliği zengin kart nesnesi olarak ayarlayın. Bu özellik ve contentUrl özelliği birbirini dışlar.
Contenttype String Ekteki içeriğin medya türü. Medya dosyaları için bu özelliği image/png, audio/wav ve video/mp4 gibi bilinen medya türlerine ayarlayın. Zengin kartlar için bu özelliği satıcıya özgü türlerden birine ayarlayın:
  • application/vnd.microsoft.card.adaptive: Metin, konuşma, resim, düğme ve giriş alanlarının herhangi bir bileşimini içerebilen zengin bir kart. İçerik özelliğini AdaptiveCard nesnesi olarak ayarlayın.
  • application/vnd.microsoft.card.animation: Animasyonu oynatan zengin bir kart. İçerik özelliğini bir AnimationCard nesnesi olarak ayarlayın.
  • application/vnd.microsoft.card.audio: Ses dosyalarını çalan zengin bir kart. İçerik özelliğini bir AudioCard nesnesi olarak ayarlayın.
  • application/vnd.microsoft.card.hero: Hero kartı. İçerik özelliğini herocard nesnesi olarak ayarlayın.
  • application/vnd.microsoft.card.receipt: Makbuz kartı. content özelliğini ReceiptCard nesnesi olarak ayarlayın.
  • application/vnd.microsoft.card.signin: Kullanıcı Oturum Açma kartı. content özelliğini bir SignInCard nesnesi olarak ayarlayın.
  • application/vnd.microsoft.card.thumbnail: Küçük resim kartı. content özelliğini ThumbnailCard nesnesi olarak ayarlayın.
  • application/vnd.microsoft.card.video: Video oynatan zengin bir kart. İçerik özelliğini bir VideoCard nesnesi olarak ayarlayın.
contentUrl String Ekin içeriğinin URL'si. Örneğin, ek bir görüntüyse contentUrl'i görüntünün konumunu temsil eden URL'ye ayarlayabilirsiniz. Desteklenen protokoller şunlardır: HTTP, HTTPS, Dosya ve Veri.
Adı String Ekin adı.
thumbnailUrl String Kanalın alternatif, daha küçük bir içerik veya contentUrl biçimini kullanmayı destekliyorsa kullanabileceği küçük resim görüntüsünün URL'si. Örneğin, contentType değerini application/word olarak ve contentUrl değerini Word belgesinin konumuna ayarlarsanız, belgeyi temsil eden bir küçük resim görüntüsü ekleyebilirsiniz. Kanal, belge yerine küçük resim görüntüsünü görüntüleyebilir. Kullanıcı resme tıkladığında kanal belgeyi açar.

Şema tablosuna geri dön

AttachmentData nesnesi

Ekin verilerini açıklar.

Özellik Tür Tanım
Adı String Ekin adı.
originalBase64 String Ek içeriği.
thumbnailBase64 String Ek küçük resim içeriği.
type String Ekin içerik türü.

Şema tablosuna geri dön

AttachmentInfo nesnesi

Ek için meta veriler.

Özellik Tür Tanım
Adı String Ekin adı.
type String Ekin içerik türü.
Görünümler AttachmentView[] Ek için kullanılabilir görünümleri temsil eden AttachmentView nesneleri dizisi.

Şema tablosuna geri dön

AttachmentView nesnesi

Ek için kullanılabilir bir görünümü temsil eden bir nesne tanımlar.

Özellik Tür Tanım
Boyutu Numara Dosyanın boyutu.
viewId String Görünüm Kimliği.

Şema tablosuna geri dön

AudioCard nesnesi

Ses dosyasını yürütebilen bir kart tanımlar.

Özellik Tür Tanım
Yönü String Görüntü özelliğinde belirtilen küçük resmin en boy oranı. Geçerli değerler 16:9 ve 4:3'tir.
otomatik açılma Boolean Son dosya sona erdiğinde ses dosyalarının listesinin yeniden oynatılıp oynatılmayacağını gösteren bayrak. Ses dosyalarını otomatik olarak yeniden oynatmak için bu özelliği true olarak ayarlayın; aksi takdirde false. Varsayılan değer true değeridir.
Autostart Boolean Kart görüntülendiğinde sesin otomatik olarak oynatılıp oynatılmayacağını gösteren bayrak. Sesi otomatik olarak yürütmek için bu özelliği true olarak ayarlayın; aksi takdirde false. Varsayılan değer true değeridir.
Düğme CardAction[] Kullanıcının bir veya daha fazla eylem gerçekleştirmesini sağlayan CardAction nesneleri dizisi. Kanal, belirteceğiniz düğme sayısını belirler.
Süre String Iso 8601 süre biçimindeki medya içeriğinin uzunluğu.
Görüntü ThumbnailUrl Kartta görüntülenecek görüntüyü belirten ThumbnailUrl nesnesi.
Medya MediaUrl[] MediaUrl nesneleri dizisi. Bu alan birden fazla URL içerdiğinde, her URL aynı içeriğin alternatif biçimidir.
Paylaşılabilir Boolean Ses dosyalarının başkalarıyla paylaşılıp paylaşılamayacağını gösteren bayrak. Ses paylaşılabilirse bu özelliği true , aksi takdirde false olarak ayarlayın. Varsayılan değer true değeridir.
Altyazı String Kartın başlığının altında görüntülenecek alt başlık.
text String Kartın başlığı veya alt başlığı altında görüntülenecek açıklama veya istem.
title String Kartın başlığı.
value Nesne Bu kart için ek parametre.

Şema tablosuna geri dön

CardAction nesnesi

Bir düğmeyle tıklanabilir bir eylem tanımlar.

Özellik Tür Tanım
channelData String Bu eylemle ilişkili kanala özgü veriler.
displayText String Düğmeye tıklandığında sohbet akışında görüntülenecek metin.
Görüntü String Düğmede, metin etiketinin yanında görünecek resim URL'si.
text String Eylem metni.
title String Düğmede görüntülenen metin açıklaması.
type String Gerçekleştirilecek eylem türü. Geçerli değerlerin listesi için bkz . İletilere zengin kart ekleri ekleme.
value Nesne Eylem için ek parametre. Bu özelliğin davranışı eylem türüne göre değişir. Daha fazla bilgi için bkz . İletilere zengin kart ekleri ekleme.

Şema tablosuna geri dön

CardImage nesnesi

Kartta görüntülenecek görüntüyü tanımlar.

Özellik Tür Tanım
alt String Resmin açıklaması. Erişilebilirliği desteklemek için açıklamayı eklemelisiniz.
Dokunun CardAction Kullanıcı resme dokunduğunda veya tıkladıysa gerçekleştirilecek eylemi belirten bir CardAction nesnesi.
Url String Görüntünün kaynağının URL'si veya görüntünün base64 ikili dosyası (örneğin, data:image/png;base64,iVBORw0KGgo...).

Şema tablosuna geri dön

ChannelAccount nesnesi

Kanalda bir bot veya kullanıcı hesabı tanımlar.

Özellik Tür Tanım
aadObjectId String Bu hesabın Microsoft Entra Id içindeki nesne kimliği.
id String Bu kanaldaki kullanıcı veya bot için benzersiz kimlik.
Adı String Botun veya kullanıcının kolay görünen adı.
Rolü String Hesabın arkasındaki varlığın rolü. Kullanıcı veya bot.

Şema tablosuna geri dön

ConversationAccount nesnesi

Kanaldaki bir konuşmayı tanımlar.

Özellik Tür Tanım
aadObjectId String Bu hesabın Microsoft Entra Id içindeki nesne kimliği.
conversationType String Kanallarda konuşma türlerini (örneğin, grup veya kişisel) ayırt eden konuşma türünü gösterir.
id String Konuşmayı tanımlayan kimlik. Kimlik, kanal başına benzersizdir. Kanal konuşmayı başlatırsa bu kimliği ayarlar; aksi takdirde, bot bu özelliği konuşmayı başlattığında yanıta geri aldığı kimlik olarak ayarlar (bkz . Konuşma Oluşturma).
isGroup Boolean Etkinliğin oluşturulduğu sırada konuşmanın ikiden fazla katılımcı içerip içermediğini gösteren bayrak. Bu bir grup konuşmasıysa true, aksi takdirde false olarak ayarlayın. Varsayılan değer false'tur.
Adı String Konuşmayı tanımlamak için kullanılabilecek bir görünen ad.
Rolü String Hesabın arkasındaki varlığın rolü. Kullanıcı veya bot.
tenantId String Bu konuşmanın kiracı kimliği.

Şema tablosuna geri dön

ConversationMembers nesnesi

Konuşmanın üyelerini tanımlar.

Özellik Tür Açıklama
id String Konuşma kimliği.
Üyeler ChannelAccount[] Bu konuşmadaki üyelerin listesi.

Şema tablosuna geri dön

ConversationParameters nesnesi

Yeni konuşma oluşturmak için parametreleri tanımlar.

Özellik Tür Tanım
Etkinlik Etkinlik Oluşturulduğunda konuşmaya gönderilecek ilk ileti.
Bot ChannelAccount Bir iletiyi bota yönlendirmek için gereken kanal hesabı bilgileri.
channelData Nesne Konuşmayı oluşturmak için kanala özgü yük.
isGroup Boolean Bunun bir grup konuşması olup olmadığını gösterir.
Üyeler ChannelAccount[] Bir iletiyi her kullanıcıya yönlendirmek için gereken kanal hesabı bilgileri.
tenantId String Konuşmanın oluşturulması gereken kiracı kimliği.
topicName String Konuşmanın konusu. Bu özellik yalnızca bir kanal destekliyorsa kullanılır.

Şema tablosuna geri dön

ConversationReference nesnesi

Konuşmadaki belirli bir noktayı tanımlar.

Özellik Tür Veri Akışı Açıklaması
Activityıd String Bu nesnenin başvurduğunu etkinliği benzersiz olarak tanımlayan kimlik.
Bot ChannelAccount Bu nesnenin başvurduğunu konuşmada botu tanımlayan bir ChannelAccount nesnesi.
channelId String Bu nesnenin başvurduğunu konuşmada kanalı benzersiz olarak tanımlayan bir kimlik.
Konuşma ConversationAccount Bu nesnenin başvurduğunu konuşmayı tanımlayan bir ConversationAccount nesnesi.
serviceUrl String Bu nesnenin başvurduğunu konuşmada kanalın hizmet uç noktasını belirten URL.
kullanıcı ChannelAccount Bu nesnenin başvurduğunu konuşmada kullanıcıyı tanımlayan bir ChannelAccount nesnesi.

Şema tablosuna geri dön

ConversationResourceResponse nesnesi

Konuşma Oluştur'a bir yanıt tanımlar.

Özellik Tür Veri Akışı Açıklaması
Activityıd String Gönderildiyse etkinliğin kimliği.
id String Kaynağın kimliği.
serviceUrl String Konuşmayla ilgili işlemlerin gerçekleştirilebileceği hizmet uç noktası.

Şema tablosuna geri dön

ConversationsResult nesnesi

Get Conversations sonucunu tanımlar.

Özellik Tür Tanım
Konuşma ConversationMembers[] Konuşmaların her birindeki üyeler.
continuationToken String Konuşma Al'a sonraki çağrılarda kullanılabilecek devamlılık belirteci.

Şema tablosuna geri dön

Varlık nesnesi

Bir etkinlikle ilgili meta veri nesnesi.

Özellik Tür Tanım
type String Bu varlığın türü (RFC 3987 IRI).

Şema tablosuna geri dön

Hata nesnesi

Hata bilgilerini temsil eden nesne.

Özellik Tür Tanım
kod String Hata kodu.
innerHttpError İçHttpError İç HTTP hatasını temsil eden nesne.
ileti String Hatanın tanımı.

Şema tablosuna geri dön

ErrorResponse nesnesi

BIR HTTP API yanıtı tanımlar.

Özellik Tür Tanım
Hata Hata Hata hakkında bilgi içeren bir Error nesnesi.

Şema tablosuna geri dön

Olgu nesnesi

Olgu içeren bir anahtar-değer çifti tanımlar.

Özellik Tür Tanım
key String Gerçeğin adı. Örneğin, İade et. Anahtar, olgu değerini görüntülerken etiket olarak kullanılır.
value String Gerçeğin değeri. Örneğin, 10 Ekim 2016.

Şema tablosuna geri dön

GeoCoordinates nesnesi

Dünya Jeodetik Sistem (WSG84) koordinatlarını kullanarak bir coğrafi konum tanımlar.

Özellik Tür Tanım
Yükseklik Numara Konumun yükseltilmesi.
Enlem Numara Konumun enlemi.
Boylam Numara Konumun boylamı.
Adı String Konumun adı.
type String Bu nesnenin türü. Her zaman GeoCoordinates olarak ayarlanır.

Şema tablosuna geri dön

HeroCard nesnesi

Büyük resim, başlık, metin ve eylem düğmeleri olan bir kart tanımlar.

Özellik Tür Tanım
Düğme CardAction[] Kullanıcının bir veya daha fazla eylem gerçekleştirmesini sağlayan CardAction nesneleri dizisi. Kanal, belirteceğiniz düğme sayısını belirler.
Görüntü CardImage[] Kartta görüntülenecek görüntüyü belirten CardImage nesneleri dizisi. Hero kartı yalnızca bir resim içerir.
Altyazı String Kartın başlığının altında görüntülenecek alt başlık.
Dokunun CardAction Kullanıcı karta dokunduğunda veya tıkladıysa gerçekleştirilecek eylemi belirten bir CardAction nesnesi. Bu, düğmelerden biriyle veya farklı bir eylemle aynı eylem olabilir.
text String Kartın başlığı veya alt başlığı altında görüntülenecek açıklama veya istem.
title String Kartın başlığı.

Şema tablosuna geri dön

InnerHttpError nesnesi

İç HTTP hatasını temsil eden nesne.

Özellik Tür Tanım
Statuscode Numara Başarısız istekten HTTP durum kodu.
gövde Nesne Başarısız istekten gövde.

Şema tablosuna geri dön

MediaEventValue nesnesi

Medya olayları için ek parametre.

Özellik Tür Tanım
cardValue Nesne Bu olayı oluşturan medya kartının değer alanında belirtilen geri çağırma parametresi.

Şema tablosuna geri dön

MediaUrl nesnesi

Bir medya dosyasının kaynağının URL'sini tanımlar.

Özellik Tür Tanım
Profil String Medyanın içeriğini açıklayan ipucu.
Url String Medya dosyasının kaynağının URL'si.

Şema tablosuna geri dön

Bahsetme nesnesi

Konuşmada bahsedilen bir kullanıcı veya bot tanımlar.

Özellik Tür Tanım
Belirtilen ChannelAccount Bahsedilen kullanıcıyı veya botu belirten bir ChannelAccount nesnesi. Slack gibi bazı kanallar konuşma başına ad atar, bu nedenle botunuzun adı (iletinin alıcı özelliğinde) botunuzu kaydederken belirttiğiniz tanıtıcıdan farklı olabilir. Ancak, her ikisi için de hesap kimlikleri aynı olacaktır.
text String Konuşmada belirtildiği gibi kullanıcı veya bot. Örneğin, ileti "@ColorBot bana yeni bir renk seçin" ise, bu özellik @ColorBot olarak ayarlanır. Tüm kanallar bu özelliği ayarlamaz.
type String Bu nesnenin türü. Her zaman Bahsetme olarak ayarlayın.

Şema tablosuna geri dön

MessageReaction nesnesi

İletiye bir tepki tanımlar.

Özellik Tür Tanım
type String Tepki türü. Like veya plusOne.

Şema tablosuna geri dön

PagedMembersResult nesnesi

Konuşma Sayfalı Üyeleri Al tarafından döndürülen üyelerin sayfası.

Özellik Tür Tanım
continuationToken String Konuşma Sayfalı Üyeleri Al'a yapılan sonraki çağrılarda kullanılabilecek devamlılık belirteci.
Üyeler ChannelAccount[] Konuşma üyeleri dizisi.

Şema tablosuna geri dön

Nesne yerleştir

Konuşmada bahsedilen bir yeri tanımlar.

Özellik Tür Tanım
Adres Nesne Bir yerin adresi. Bu özellik, PostalAddress türünde bir dize veya karmaşık bir nesne olabilir.
coğrafi bölge Coğrafi Koordinatlar Yerin coğrafi koordinatlarını belirten GeoCoordinates nesnesi.
hasMap Nesne Yerle eşle. Bu özellik bir dize (URL) veya Map türünde karmaşık bir nesne olabilir.
Adı String Yerin adı.
type String Bu nesnenin türü. Her zaman Yer olarak ayarlayın.

Şema tablosuna geri dön

ReceiptCard nesnesi

Satın alma için makbuz içeren bir kart tanımlar.

Özellik Tür Tanım
Düğme CardAction[] Kullanıcının bir veya daha fazla eylem gerçekleştirmesini sağlayan CardAction nesneleri dizisi. Kanal, belirteceğiniz düğme sayısını belirler.
Gerçekler Olgu[] Satın alma hakkındaki bilgileri belirten Olgu nesneleri dizisi. Örneğin, bir otel konaklaması makbuzu için olgu listesi, giriş tarihini ve çıkış tarihini içerebilir. Kanal, belirtebileceğin olgu sayısını belirler.
Bileşen ReceiptItem[] Satın alınan öğeleri belirten ReceiptItem nesneleri dizisi
Dokunun CardAction Kullanıcı karta dokunduğunda veya tıkladıysa gerçekleştirilecek eylemi belirten bir CardAction nesnesi. Bu, düğmelerden biriyle veya farklı bir eylemle aynı eylem olabilir.
Vergi String Satın alma işlemine uygulanan vergi miktarını belirten para birimiyle biçimlendirilmiş bir dize.
title String Makbuzun üst kısmında görüntülenen başlık.
total String Tüm geçerli vergiler dahil olmak üzere toplam satın alma fiyatını belirten para birimi biçimli bir dize.
Kdv String Satın alma fiyatına uygulanan katma değer vergisi (KDV) miktarını belirten para birimiyle biçimlendirilmiş bir dize.

Şema tablosuna geri dön

ReceiptItem nesnesi

Alış irsaliyesi içindeki bir satır öğesini tanımlar.

Özellik Tür Açıklama
Görüntü CardImage Satır öğesinin yanında görüntülenecek küçük resim görüntüsünü belirten bir CardImage nesnesi.
Fiyat String Satın alınan tüm birimlerin toplam fiyatını belirten para birimiyle biçimlendirilmiş bir dize.
Miktar String Satın alınan birim sayısını belirten sayısal dize.
Altyazı String Satır öğesinin başlığının altında görüntülenecek alt başlık.
Dokunun CardAction Kullanıcı satır öğesine dokunduğunda veya tıklarsa gerçekleştirilecek eylemi belirten bir CardAction nesnesi.
text String Satır öğesinin açıklaması.
title String Satır öğesinin başlığı.

Şema tablosuna geri dön

ResourceResponse nesnesi

Kaynak kimliği içeren bir yanıt tanımlar.

Özellik Tür Açıklama
id String Kaynağı benzersiz olarak tanımlayan kimlik.

Şema tablosuna geri dön

SemanticAction nesnesi

Programlı bir eyleme başvuru tanımlar.

Özellik Tür Tanım
varlıklar Nesne Her özelliğin değerinin bir Entity nesnesi olduğu nesne.
id String Bu eylemin kimliği.
state String Bu eylemin durumu. İzin verilen değerler: başlangıç, devam, bitti.

Şema tablosuna geri dön

SignInCard nesnesi

Kullanıcının bir hizmette oturum açmasına olanak tanıyan bir kart tanımlar.

Özellik Tür Tanım
Düğme CardAction[] Kullanıcının bir hizmette oturum açmasını sağlayan CardAction nesneleri dizisi. Kanal, belirteceğiniz düğme sayısını belirler.
text String Oturum açma kartına açıklama veya ekleme istemi.

Şema tablosuna geri dön

SuggestedActions nesnesi

Bir kullanıcının seçebileceği seçenekleri tanımlar.

Özellik Tür Tanım
Eylem CardAction[] Önerilen eylemleri tanımlayan CardAction nesneleri dizisi.
to Dize[] Önerilen eylemlerin görüntülenmesi gereken alıcıların kimliklerini içeren dize dizisi.

Şema tablosuna geri dön

TextHighlight nesnesi

Başka bir alandaki içeriğin alt dizesini ifade eder.

Özellik Tür Tanım
Oluşumu Numara Birden çok metin varsa, başvuruda bulunılan metin içinde metin alanının oluşumu.
text String Vurgulamak için metin parçacığını tanımlar.

Şema tablosuna geri dön

ThumbnailCard nesnesi

Küçük resim resmi, başlık, metin ve eylem düğmeleri içeren bir kart tanımlar.

Özellik Tür Tanım
Düğme CardAction[] Kullanıcının bir veya daha fazla eylem gerçekleştirmesini sağlayan CardAction nesneleri dizisi. Kanal, belirteceğiniz düğme sayısını belirler.
Görüntü CardImage[] Kartta görüntülenecek küçük resim görüntülerini belirten CardImage nesneleri dizisi. Kanal, belirtebilecek küçük resim görüntülerinin sayısını belirler.
Altyazı String Kartın başlığının altında görüntülenecek alt başlık.
Dokunun CardAction Kullanıcı karta dokunduğunda veya tıkladıysa gerçekleştirilecek eylemi belirten bir CardAction nesnesi. Bu, düğmelerden biriyle veya farklı bir eylemle aynı eylem olabilir.
text String Kartın başlığı veya alt başlığı altında görüntülenecek açıklama veya istem.
title String Kartın başlığı.

Şema tablosuna geri dön

ThumbnailUrl nesnesi

Görüntünün kaynağının URL'sini tanımlar.

Özellik Tür Tanım
alt String Resmin açıklaması. Erişilebilirliği desteklemek için açıklamayı eklemelisiniz.
Url String Görüntünün kaynağının URL'si veya görüntünün base64 ikili dosyası (örneğin, data:image/png;base64,iVBORw0KGgo...).

Şema tablosuna geri dön

Transkript nesnesi

Konuşma Geçmişi Gönder kullanılarak karşıya yüklenecek etkinlikler koleksiyonu.

Özellik Tür Tanım
Faaliyetleri dizi Etkinlik nesneleri dizisi. Her birinin benzersiz bir kimliği ve zaman damgası olmalıdır.

Şema tablosuna geri dön

VideoCard nesnesi

Video oynatabilen bir kart tanımlar.

Özellik Tür Tanım
Yönü String Videonun en boy oranı. 16:9 veya 4:3.
otomatik açılma Boolean Son video sona erdiğinde video listesinin yeniden oynatılıp oynatılmayacağını gösteren bayrak. Videoları otomatik olarak yeniden oynatmak için bu özelliği true , aksi takdirde false olarak ayarlayın. Varsayılan değer true değeridir.
Autostart Boolean Kart görüntülendiğinde videoların otomatik olarak oynatılıp oynatılmayacağını gösteren bayrak. Videoları otomatik olarak oynatmak için bu özelliği true , aksi takdirde false olarak ayarlayın. Varsayılan değer true değeridir.
Düğme CardAction[] Kullanıcının bir veya daha fazla eylem gerçekleştirmesini sağlayan CardAction nesneleri dizisi. Kanal, belirteceğiniz düğme sayısını belirler.
Süre String Iso 8601 süre biçimindeki medya içeriğinin uzunluğu.
Görüntü ThumbnailUrl Kartta görüntülenecek görüntüyü belirten ThumbnailUrl nesnesi.
Medya MediaUrl[] MediaUrl dizisi. Bu alan birden fazla URL içerdiğinde, her URL aynı içeriğin alternatif biçimidir.
Paylaşılabilir Boolean Videoların başkalarıyla paylaşılıp paylaşılamayacağını gösteren bayrak. Videolar paylaşılabilirse bu özelliği true , aksi takdirde false olarak ayarlayın. Varsayılan değer true değeridir.
Altyazı String Kartın başlığının altında görüntülenecek alt başlık.
text String Kartın başlığı veya alt başlığı altında görüntülenecek açıklama veya istem.
title String Kartın başlığı.
value Nesne Bu kart için ek parametre

Şema tablosuna geri dön