Template Operations - List Templates

Hizmet:

Communication

API Sürümü:

2024-02-01

Verilen Azure İletişim Hizmetleri kanalı için tüm şablonları listeleme

GET {endpoint}/messages/channels/{channelId}/templates?api-version=2024-02-01

İsteğe bağlı parametrelerle:

GET {endpoint}/messages/channels/{channelId}/templates?api-version=2024-02-01&maxpagesize={maxpagesize}

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
channelId	path	True	string uuid	Kanalın kayıt kimliği.
endpoint	path	True	string uri	İletişim kaynağı, örneğin https://my-resource.communication.azure.com
api-version	query	True	string	Bu işlem için kullanılacak API sürümü.
maxpagesize	query		integer int32	Sayfa başına döndürülecek nesne sayısı.

İstek Başlığı

Name	Gerekli	Tür	Description
x-ms-client-request-id		string uuid	İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

Yanıtlar

Name	Tür	Description
200 OK	PagedMessageTemplateItem	İstek başarılı oldu. Üst Bilgiler x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Beklenmeyen bir hata yanıtı. Üst Bilgiler x-ms-error-code: string

Güvenlik

AadOauth2Auth

Azure Active Directory OAuth2 Akışı

Tür: oauth2
Akış: accessCode
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize
Belirteç URL'si: https://login.microsoftonline.com/common/oauth2/token

Kapsamlar

Name	Description
https://communication.azure.com/.default

Authorization

Tür: apiKey
İçinde: header

Örnekler

Gets a list of templates

Örnek isteği

HTTP

GET https://my-resource.communication.azure.com/messages/channels/0f0eb78e-a576-1dfc-b414-0f0756de3338/templates?api-version=2024-02-01

Örnek yanıt

Durum kodu:

200

{
  "value": [
    {
      "name": "sample_shipping_confirmation",
      "language": "en_US",
      "status": "approved",
      "kind": "whatsApp",
      "content": [
        {
          "type": "BODY",
          "text": "Your package has been shipped. It will be delivered in {{1}} business days."
        },
        {
          "type": "FOOTER",
          "text": "This message is from an unverified business."
        }
      ]
    }
  ],
  "nextLink": null
}

Tanımlar

Name	Description
Azure.Core.Foundations.Error	Hata nesnesi.
Azure.Core.Foundations.ErrorResponse	Hata ayrıntılarını içeren bir yanıt.
Azure.Core.Foundations.InnerError	Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CommunicationMessagesChannel	İletişim iletileri kanalının türü.
MessageTemplateStatus	Toplanan şablon durumu.
PagedMessageTemplateItem	MessageTemplateItem öğelerinin disk belleğine alınmış koleksiyonu
WhatsAppMessageTemplateItem	WhatsApp'a özgü şablon yanıt sözleşmesi

Azure.Core.Foundations.Error

Hata nesnesi.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
details	Azure.Core.Foundations.Error[]	Bu bildirilen hataya yol açan belirli hatalarla ilgili bir dizi ayrıntı.
innererror	Azure.Core.Foundations.InnerError	Hatayla ilgili geçerli nesneden daha belirli bilgiler içeren bir nesne.
message	string	Hatanın insanlar tarafından okunabilir bir gösterimi.
target	string	Hatanın hedefi.

Azure.Core.Foundations.ErrorResponse

Hata ayrıntılarını içeren bir yanıt.

Name	Tür	Description
error	Azure.Core.Foundations.Error	Hata nesnesi.

Azure.Core.Foundations.InnerError

Hata hakkında daha ayrıntılı bilgi içeren bir nesne. Microsoft One API yönergelerine göre - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
innererror	Azure.Core.Foundations.InnerError	İç hata.

CommunicationMessagesChannel

İletişim iletileri kanalının türü.

Name	Tür	Description
whatsApp	string	WhatsApp iletişim iletileri kanal türü.

MessageTemplateStatus

Toplanan şablon durumu.

Name	Tür	Description
approved	string	İleti şablonu onaylandı.
paused	string	İleti şablonu duraklatıldı.
pending	string	İleti şablonu beklemede.
rejected	string	İleti şablonu reddedildi.

PagedMessageTemplateItem

MessageTemplateItem öğelerinin disk belleğine alınmış koleksiyonu

Name	Tür	Description
nextLink	string	Öğelerin sonraki sayfasına bağlantı
value	MessageTemplateItem[]: WhatsAppMessageTemplateItem[]	Bu sayfadaki MessageTemplateItem öğeleri

WhatsAppMessageTemplateItem

WhatsApp'a özgü şablon yanıt sözleşmesi

Name	Tür	Description
content		WhatsApp platformlarının şablon içeriği. Bu, WhatsApp API'sinden döndürülen yükdür.
kind	string: whatsApp	Bir şablon türünü açıklayan tür ayrıştırıcısı.
language	string	Şablonun ISO 639 biçimindeki dili, iki harfli bir dil kodundan ve ardından isteğe bağlı iki harfli ülke kodundan (örneğin, 'en' veya 'en_US') oluşur.
name	string	Şablonun adı.
status	MessageTemplateStatus	Toplanan şablon durumu.