CommunicationMessagesClient (preview:2025-04-01)

2025/04/11 • 13 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 ,
}
,
}
,
}
,
}
ConversationThreadOperations_ListConversations (new)
Description :  Retrieves list of conversations.
Reference :  Link ¶

⚼ Request

GET:  /messages/conversations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
maxPageSize:
{
Description: Number of objects to return per page. ,
Format: int32 ,
Required: False ,
}
integer ,
participantId:
{
Description: The participant user ID ,
Required: False ,
}
string ,
channelId:
{
Description: The id of channel ,
Format: uuid ,
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 ,
}

⚐ 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 Conversation items ,
}
{
value:
{
Description: The Conversation items on this page ,
Required: True ,
}
[
{
id:
{
Description: The conversation ID. ,
Required: True ,
}
string ,
topic:
{
Description: The conversation topic. ,
Required: False ,
}
string ,
deliveryChannelIds:
{
Description: List of delivery channel IDs. ,
Required: False ,
}
[
string ,
]
,
outboundDeliveryStrategy:
{
Description: Outbound delivery strategy for the conversation. ,
Enum:
{
internalOnly: Delivery strategy for internal only. ,
allParticipants: Delivery strategy for all participants. ,
}
,
Required: False ,
}
enum ,
participants:
{
Description: List of participants involved in the conversation. ,
Required: False ,
}
[
{
id:
{
Description: Participant Identifier. ,
Required: True ,
}
string ,
displayName:
{
Description: Participant display name. ,
Required: False ,
}
string ,
kind:
{
Description: The type discriminator describing a participant type. ,
Enum:
{
internal: A participant internal to Azure Communication Services. ,
external: A participant on other platforms ,
}
,
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 ,
}
,
}
,
}
,
}
ConversationAdministrationOperations_CreateConversation (new)
Description :  Creates a new conversation. This is only for create operation.
Reference :  Link ¶

⚼ Request

POST:  /messages/conversations
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
{
conversation:
{
Description: The conversation details. ,
Required: True ,
}
{
id:
{
Description: The conversation ID. ,
Required: True ,
}
string ,
topic:
{
Description: The conversation topic. ,
Required: False ,
}
string ,
deliveryChannelIds:
{
Description: List of delivery channel IDs. ,
Required: False ,
}
[
string ,
]
,
outboundDeliveryStrategy:
{
Description: Outbound delivery strategy for the conversation. ,
Enum:
{
internalOnly: Delivery strategy for internal only. ,
allParticipants: Delivery strategy for all participants. ,
}
,
Required: False ,
}
enum ,
participants:
{
Description: List of participants involved in the conversation. ,
Required: False ,
}
[
{
id:
{
Description: Participant Identifier. ,
Required: True ,
}
string ,
displayName:
{
Description: Participant display name. ,
Required: False ,
}
string ,
kind:
{
Description: The type discriminator describing a participant type. ,
Enum:
{
internal: A participant internal to Azure Communication Services. ,
external: A participant on other platforms ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
initialMessage:
{
Description: An initial message within the conversation. ,
Required: False ,
}
{
content:
{
Description: Content of the message. ,
Required: True ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
id:
{
Description: The conversation ID. ,
Required: True ,
}
string ,
topic:
{
Description: The conversation topic. ,
Required: False ,
}
string ,
deliveryChannelIds:
{
Description: List of delivery channel IDs. ,
Required: False ,
}
[
string ,
]
,
outboundDeliveryStrategy:
{
Description: Outbound delivery strategy for the conversation. ,
Enum:
{
internalOnly: Delivery strategy for internal only. ,
allParticipants: Delivery strategy for all participants. ,
}
,
Required: False ,
}
enum ,
participants:
{
Description: List of participants involved in the conversation. ,
Required: False ,
}
[
{
id:
{
Description: Participant Identifier. ,
Required: True ,
}
string ,
displayName:
{
Description: Participant display name. ,
Required: False ,
}
string ,
kind:
{
Description: The type discriminator describing a participant type. ,
Enum:
{
internal: A participant internal to Azure Communication Services. ,
external: A participant on other platforms ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}

⚐ 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 ,
}
,
}
,
}
,
}
ConversationAdministrationOperations_GetConversation (new)
Description :  Gets the details of a specific conversation.
Reference :  Link ¶

⚼ Request

GET:  /messages/conversations/{conversationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
conversationId:
{
Description: The conversation 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:
{
Description: A conversation. ,
}
{
id:
{
Description: The conversation ID. ,
Required: True ,
}
string ,
topic:
{
Description: The conversation topic. ,
Required: False ,
}
string ,
deliveryChannelIds:
{
Description: List of delivery channel IDs. ,
Required: False ,
}
[
string ,
]
,
outboundDeliveryStrategy:
{
Description: Outbound delivery strategy for the conversation. ,
Enum:
{
internalOnly: Delivery strategy for internal only. ,
allParticipants: Delivery strategy for all participants. ,
}
,
Required: False ,
}
enum ,
participants:
{
Description: List of participants involved in the conversation. ,
Required: False ,
}
[
{
id:
{
Description: Participant Identifier. ,
Required: True ,
}
string ,
displayName:
{
Description: Participant display name. ,
Required: False ,
}
string ,
kind:
{
Description: The type discriminator describing a participant type. ,
Enum:
{
internal: A participant internal to Azure Communication Services. ,
external: A participant on other platforms ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
ConversationAdministrationOperations_DeleteConversation (new)
Description :  Deletes a specific conversation.
Reference :  Link ¶

⚼ Request

DELETE:  /messages/conversations/{conversationId}
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
conversationId:
{
Description: The conversation ID. ,
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 ,
}

⚐ Response (204)

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

⚐ 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 ,
}
,
}
,
}
,
}
ConversationAdministrationOperations_TerminateConversation (new)
Description :  Terminates a specific conversation.
Reference :  Link ¶

⚼ Request

POST:  /messages/conversations/{conversationId}:terminate
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
conversationId:
{
Description: The conversation ID. ,
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 ,
}

⚐ Response (200)

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

⚐ 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 ,
}
,
}
,
}
,
}
ConversationThreadOperations_AnalyzeConversation (new)
Description :  Get AI Analysis of a conversation.
Reference :  Link ¶

⚼ Request

POST:  /messages/conversations/{conversationId}:analyze
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
conversationId:
{
Description: The conversation ID. ,
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 ,
}

⚐ Response (200)

{
$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 get conversation messages AI Analysis operation. ,
}
{
summary:
{
Description: The AI summary of the conversation messages. ,
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 ,
}
,
}
,
}
,
}
ConversationThreadOperations_ListMessages (new)
Description :  Retrieves list of conversation messages.
Reference :  Link ¶

⚼ Request

GET:  /messages/conversations/{conversationId}/messages
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
conversationId:
{
Description: The conversation ID. ,
Required: True ,
}
string ,
maxPageSize:
{
Description: Number of objects to return per page. ,
Format: int32 ,
Required: False ,
}
integer ,
participantId:
{
Description: The participant user ID ,
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 ,
}

⚐ 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 ConversationMessageItem items ,
}
{
value:
{
Description: The ConversationMessageItem items on this page ,
Required: True ,
}
[
{
id:
{
Description: Message ID. ,
Required: True ,
}
string ,
sequenceId:
{
Description: Message sequence ID. ,
Format: int64 ,
Required: False ,
}
integer ,
message:
{
Description: Payload of a threaded conversation message. ,
Required: True ,
}
{
kind:
{
Description: The type discriminator describing a message 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 ,
}
,
senderDisplayName:
{
Description: The display name of the message sender. ,
Required: False ,
}
string ,
senderCommunicationIdentifier:
{
Description: The communication identifier of the message sender. ,
Required: True ,
}
string ,
createdOn:
{
Description: Timestamp when the message is sent. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
]
,
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 ,
}
,
}
,
}
,
}
ConversationThreadOperations_SendMessage (new)
Description :  Sends a conversation message from Business to User.
Reference :  Link ¶

⚼ Request

POST:  /messages/conversations/{conversationId}/messages:send
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
conversationId:
{
Description: The conversation ID. ,
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 ,
options:
{
Description: Details of the conversation message to send. ,
Required: True ,
}
{
request:
{
Description: Details of a send conversation message request. ,
Required: True ,
}
{
kind:
{
Description: The type discriminator describing a message 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 ,
}
,
outboundDeliveryStrategy:
{
Description: The options of the outbound delivery strategy for messages sent by participants in a conversation. Supports internalOnly, allChannels. ,
Enum:
{
internalOnly: Delivery strategy for internal only. ,
allParticipants: Delivery strategy for all participants. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (200)

{
$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 conversation message operation. ,
}
{
messageId:
{
Description: A server-generated Advanced Messaging conversation message id. ,
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 ,
}
,
}
,
}
,
}
ConversationThreadOperations_AddParticipants (new)
Description :  Adds participants to a specific conversation.
Reference :  Link ¶

⚼ Request

POST:  /messages/conversations/{conversationId}/participants:add
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
conversationId:
{
Description: The conversation ID. ,
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 ,
options:
{
Description: Details of the payload for adding participants to a conversation. ,
Required: True ,
}
{
participants:
{
Description: List of participants to add. ,
Required: True ,
}
[
{
id:
{
Description: Participant Identifier. ,
Required: True ,
}
string ,
displayName:
{
Description: Participant display name. ,
Required: False ,
}
string ,
kind:
{
Description: The type discriminator describing a participant type. ,
Enum:
{
internal: A participant internal to Azure Communication Services. ,
external: A participant on other platforms ,
}
,
Required: True ,
}
enum ,
}
,
]
,
}
,
}

⚐ Response (207)

{
$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: Response for the add participants operation. ,
}
{
invalidParticipants:
{
Description: List of Ids with Errors if failed to be added ,
Required: True ,
}
[
{
id:
{
Description: Participant User Id. ,
Required: True ,
}
string ,
error:
{
Description: Error of the participant operation. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
}
,
}
,
}
ConversationThreadOperations_RemoveParticipants (new)
Description :  remove a participant from a conversation
Reference :  Link ¶

⚼ Request

POST:  /messages/conversations/{conversationId}/participants:remove
{
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
conversationId:
{
Description: The conversation ID. ,
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 ,
options:
{
Description: Details of the request body for removing participants from a conversation. ,
Required: True ,
}
{
participantIds:
{
Description: The participant IDs to remove. ,
Required: True ,
}
[
string ,
]
,
}
,
}

⚐ Response (207)

{
$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: Response for the remove participants operation. ,
}
{
invalidParticipants:
{
Description: List of Ids with Errors if failed to be added ,
Required: True ,
}
[
{
id:
{
Description: Participant User Id. ,
Required: True ,
}
string ,
error:
{
Description: Error of the participant operation. ,
Required: False ,
}
{
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 ,
}
,
}
,
}
,
]
,
}
,
}

⚐ 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 message 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 ,
}
,
}
,
}
,
}