MessageTemplateClient Class

A client to interact with the AzureCommunicationService Messaging service.

This client provides Advanced Messaging.

Constructor

MessageTemplateClient(endpoint: str, credential: TokenCredential | AzureKeyCredential, **kwargs: Any)

Parameters

Name	Description
endpoint Required	str The endpoint of the Azure Communication resource.
credential Required	Union[<xref:TokenCredential>, <xref:AsyncTokenCredential>] The credentials with which to authenticate

Keyword-Only Parameters

Name	Description
api_version	str Azure Communication Messages API version. Default value is "2024-02-01". Note that overriding this default value may result in unsupported behavior.

Methods

close
from_connection_string	Create MessageTemplateClient from a Connection String.
list_templates	List all templates for given Azure Communication Services channel.
send_request	Runs the network request through the client's chained policies. >>> from azure.core.rest import HttpRequest >>> request = HttpRequest("GET", "https://www.example.org/") <HttpRequest [GET], url: 'https://www.example.org/'> >>> response = client.send_request(request) <HttpResponse: 200 OK> For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request

close

close() -> None

from_connection_string

Create MessageTemplateClient from a Connection String.

from_connection_string(conn_str: str, **kwargs: Any) -> MessageTemplateClient

Parameters

Name	Description
conn_str Required	str Azure communication service connection string. Required.

Returns

Type	Description
MessageTemplateClient	instance of MessageTemplateClient

list_templates

List all templates for given Azure Communication Services channel.

list_templates(channel_id: str, **kwargs: Any) -> Iterable[MessageTemplateItem]

Parameters

Name	Description
channel_id Required	str The registration ID of the channel. Required.

Returns

Type	Description
ItemPaged[MessageTemplateItem]	An iterator like instance of MessageTemplateItem

Exceptions

Type	Description
HttpResponseError

send_request

Runs the network request through the client's chained policies.

>>> from azure.core.rest import HttpRequest
>>> request = HttpRequest("GET", "https://www.example.org/")
<HttpRequest [GET], url: 'https://www.example.org/'>
>>> response = client.send_request(request)
<HttpResponse: 200 OK>

For more information on this code flow, see https://aka.ms/azsdk/dpcodegen/python/send_request

send_request(request: HttpRequest, *, stream: bool = False, **kwargs: Any) -> HttpResponse

Parameters

Name	Description
request Required	HttpRequest The network request you want to make. Required.

Keyword-Only Parameters

Name	Description
stream	bool Whether the response payload will be streamed. Defaults to False.

Returns

Type	Description
HttpResponse	The response of your network call. Does not do error handling on your response.