Template Operations - List Templates

Dienst:

Communication

API-Version:

2024-02-01

Auflisten aller Vorlagen für den angegebenen Azure Communication Services Kanal

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
channelId	path	True	string uuid	Die Registrierungs-ID des Kanals.
endpoint	path	True	string uri	Die Kommunikationsressource, z. B. https://my-resource.communication.azure.com
api-version	query	True	string	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.
maxpagesize	query		integer int32	Anzahl der zurückzugebenden Objekte pro Seite.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string uuid	Ein undurchsichtiger, global eindeutiger, vom Client generierter Zeichenfolgenbezeichner für die Anforderung.

Antworten

Name	Typ	Beschreibung
200 OK	PagedMessageTemplateItem	Die Anforderung wurde erfolgreich durchgeführt. Header x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Eine unerwartete Fehlerantwort. Header x-ms-error-code: string

Sicherheit

AadOauth2Auth

Der Azure Active Directory OAuth2-Flow

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize
Token-URL: https://login.microsoftonline.com/common/oauth2/token

Bereiche

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

Authorization

Typ: apiKey
In: header

Beispiele

Gets a list of templates

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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
}

Definitionen

Name	Beschreibung
Azure.Core.Foundations.Error	Das Fehlerobjekt.
Azure.Core.Foundations.ErrorResponse	Eine Antwort, die Fehlerdetails enthält.
Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
CommunicationMessagesChannel	Der Typ des Kommunikationsnachrichtenkanals.
MessageTemplateStatus	Die aggregierte Vorlage status.
PagedMessageTemplateItem	Ausgelagerte Auflistung von MessageTemplateItem-Elementen
WhatsAppMessageTemplateItem	Der Antwortvertrag für WhatsApp-spezifische Vorlagen

Azure.Core.Foundations.Error

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten Fehlercodes.
details	Azure.Core.Foundations.Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	Azure.Core.Foundations.InnerError	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine für Menschen lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

Azure.Core.Foundations.ErrorResponse

Eine Antwort, die Fehlerdetails enthält.

Name	Typ	Beschreibung
error	Azure.Core.Foundations.Error	Das Fehlerobjekt.

Azure.Core.Foundations.InnerError

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	string	Einer der vom Server definierten Fehlercodes.
innererror	Azure.Core.Foundations.InnerError	Innerer Fehler.

CommunicationMessagesChannel

Der Typ des Kommunikationsnachrichtenkanals.

Name	Typ	Beschreibung
whatsApp	string	Der Kanaltyp "WhatsApp-Kommunikationsnachrichten".

MessageTemplateStatus

Die aggregierte Vorlage status.

Name	Typ	Beschreibung
approved	string	Die Nachrichtenvorlage wird genehmigt.
paused	string	Die Nachrichtenvorlage wird angehalten.
pending	string	Die Nachrichtenvorlage steht aus.
rejected	string	Die Nachrichtenvorlage wird abgelehnt.

PagedMessageTemplateItem

Ausgelagerte Auflistung von MessageTemplateItem-Elementen

Name	Typ	Beschreibung
nextLink	string	Der Link zur nächsten Seite von Elementen
value	MessageTemplateItem[]: WhatsAppMessageTemplateItem[]	Die MessageTemplateItem-Elemente auf dieser Seite

WhatsAppMessageTemplateItem

Der Antwortvertrag für WhatsApp-spezifische Vorlagen

Name	Typ	Beschreibung
content		Vorlageninhalte der WhatsApp-Plattform. Dies ist die Nutzlast, die von der WhatsApp-API zurückgegeben wird.
kind	string: whatsApp	Der Typdiskriminator, der einen Vorlagentyp beschreibt.
language	string	Die Sprache der Vorlage im ISO-639-Format besteht aus einem Zweibuchstaben-Sprachcode gefolgt von einem optionalen Zweibuchstaben-Ländercode, z. B. "en" oder "en_US".
name	string	Der Name der Vorlage.
status	MessageTemplateStatus	Die aggregierte Vorlage status.