CommunicationMessagesClient (preview:2025-01-15)

2025/02/10 • 3 new methods

TemplateOperations_ListTemplates (new)
Description :  List all templates for given Azure Communication Services channel
Reference :  Link ¶

⚼ Request

GET:  /messages/channels/{channelId}/templates
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
channelId:
{
Description: The registration ID of the channel. ,
Format: uuid ,
Required: True ,
}
string ,
maxpagesize:
{
Description: Number of objects to return per page. ,
Format: int32 ,
Required: False ,
}
integer ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Paged collection of MessageTemplateItem items ,
}
{
value:
{
Description: The MessageTemplateItem items on this page ,
Required: True ,
}
[
{
name:
{
Description: The template's name. ,
Required: True ,
}
string ,
language:
{
Description: The template's language, in the ISO 639 format, consist of a two-letter language code followed by an optional two-letter country code, e.g., 'en' or 'en_US'. ,
Required: True ,
}
string ,
status:
{
Description: The aggregated template status. ,
Enum:
{
approved: Message template is approved. ,
rejected: Message template is rejected. ,
pending: Message template is pending. ,
paused: Message template is paused. ,
}
,
Required: True ,
}
enum ,
kind:
{
Description: The type discriminator describing a template type. ,
Enum:
{
whatsApp: The WhatsApp communication messages channel type. ,
}
,
Required: True ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The link to the next page of items ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
NotificationMessagesOperations_Send (new)
Description :  Sends a notification message from Business to User.
Reference :  Link ¶

⚼ Request

POST:  /messages/notifications:send
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
Repeatability-Request-ID:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Required: False ,
}
string ,
Repeatability-First-Sent:
{
Description: Specifies the date and time at which the request was first created. ,
Format: date-time ,
Required: False ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
body:
{
Description: Details of the message to send. ,
Required: True ,
}
{
channelRegistrationId:
{
Description: The Channel Registration ID for the Business Identifier. ,
Format: uuid ,
Required: True ,
}
string ,
to:
{
Description: The native external platform user identifiers of the recipient. ,
Required: True ,
}
[
string ,
]
,
kind:
{
Description: The type discriminator describing a notification type. ,
Enum:
{
text: Text message type. ,
image: Image message type. ,
image_v0: Image message type. Legacy image type for `MediaNotificationContent` which is being deprecated ,
document: Document message type. ,
video: Video message type. ,
audio: Audio message type. ,
template: Template message type. ,
sticker: Sticker message type. ,
reaction: Reaction message type. ,
interactive: Interactive Actionable message type. ,
}
,
Required: True ,
}
enum ,
}
,
}

⚐ Response (202)

{
$headers:
{
repeatability-result:
{
Description: Indicates whether the repeatable request was accepted or rejected. ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema:
{
Description: Result of the send message operation. ,
}
{
receipts:
{
Description: Receipts of the send message operation. ,
Required: True ,
}
[
{
messageId:
{
Description: The message id. ,
Required: True ,
}
string ,
to:
{
Description: The native external platform user identifier of the recipient. ,
Required: True ,
}
string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}
StreamOperations_GetMedia (new)
Description :  Download the Media payload from a User to Business message.
Reference :  Link ¶

⚼ Request

GET:  /messages/streams/{id}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
id:
{
Description: The stream ID. ,
Required: True ,
}
string ,
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
Format: uuid ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
x-ms-client-request-id:
{
Description: An opaque, globally-unique, client-generated string identifier for the request. ,
}
string ,
}
,
$schema: file ,
}

⚐ Response (default)

{
$headers:
{
x-ms-error-code:
{
Description: String error code indicating what went wrong. ,
}
string ,
}
,
$schema:
{
Description: A response containing error details. ,
}
{
error:
{
Description: The error object. ,
Required: True ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: True ,
}
string ,
message:
{
Description: A human-readable representation of the error. ,
Required: True ,
}
string ,
target:
{
Description: The target of the error. ,
Required: False ,
}
string ,
details:
{
Description: An array of details about specific errors that led to this reported error. ,
Required: False ,
}
[
string ,
]
,
innererror:
{
Description: An object containing more specific information than the current object about the error. ,
Required: False ,
}
{
code:
{
Description: One of a server-defined set of error codes. ,
Required: False ,
}
string ,
innererror:
{
Required: False ,
}
string ,
}
,
}
,
}
,
}