Chat Thread - Send Chat Message

Service:

Communication

Version d'API:

2025-03-15

Envoie un message à un thread.

POST {endpoint}/chat/threads/{chatThreadId}/messages?api-version=2025-03-15

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
chatThreadId	path	True	string	ID de thread à laquelle envoyer le message.
endpoint	path	True	string	Point de terminaison de la ressource Azure Communication.
api-version	query	True	string	Version de l’API à appeler.

En-tête de la demande

Nom	Obligatoire	Type	Description
Authorization	True	string	Jeton d’accès utilisateur ACS (Azure Communication Services).

Corps de la demande

Nom	Obligatoire	Type	Description
content	True	string	Contenu du message de conversation.
metadata		object	Métadonnées de message.
senderDisplayName		string	Nom complet de l’expéditeur du message de conversation. Cette propriété est utilisée pour remplir le nom de l’expéditeur pour les notifications Push.
type		ChatMessageType	Type de message de conversation.

Réponses

Nom	Type	Description
201 Created	SendChatMessageResult	Message envoyé, l’en-tête Location contient l’URL du message qui vient d’être envoyé.
401 Unauthorized	CommunicationErrorResponse	Non autorisée.
403 Forbidden	CommunicationErrorResponse	Interdit.
429 Too Many Requests	CommunicationErrorResponse	Trop de demandes.
Other Status Codes	CommunicationErrorResponse	Service non disponible.

Sécurité

Authorization

Jeton d’accès utilisateur ACS (Azure Communication Services).

Type: apiKey
Dans: header

Exemples

Send Message

Exemple de requête

HTTP

POST https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/messages?api-version=2025-03-15

{
  "content": "Let's head out for lunch in 15 minutes.",
  "senderDisplayName": "Jane",
  "metadata": {
    "someKey1": "someValue1",
    "someKey2": "someValue2"
  }
}

Exemple de réponse

Code d’état:

201

Location: https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/messages/1593072104708

{
  "id": "1593072104708"
}

Code d’état:

401

{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}

Code d’état:

403

{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}

Code d’état:

429

{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}

Code d’état:

503

{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

Définitions

Nom	Description
ChatMessageType	Type de message de conversation.
SendChatMessageRequest	Détails du message à envoyer.
SendChatMessageResult	Résultat de l’opération d’envoi de message.

ChatMessageType

Énumération

Type de message de conversation.

Valeur	Description
html
participantAdded
participantRemoved
text
topicUpdated

SendChatMessageRequest

Object

Détails du message à envoyer.

Nom	Type	Description
content	string	Contenu du message de conversation.
metadata	object	Métadonnées de message.
senderDisplayName	string	Nom complet de l’expéditeur du message de conversation. Cette propriété est utilisée pour remplir le nom de l’expéditeur pour les notifications Push.
type	ChatMessageType	Type de message de conversation.

SendChatMessageResult

Object

Résultat de l’opération d’envoi de message.

Nom	Type	Description
id	string	ID de message généré par le serveur.