Chat Thread - Send Chat Message

Referenz

Dienst:: Communication

API-Version:: 2024-03-07

Sendet eine Nachricht an einen Thread.

POST {endpoint}/chat/threads/{chatThreadId}/messages?api-version=2024-03-07

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
chatThreadId	path	True	string	Die Thread-ID, an die die Nachricht gesendet werden soll.
endpoint	path	True	string	Der Endpunkt der Azure Communication-Ressource.
api-version	query	True	string	Version der API, die aufgerufen werden soll.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
Authorization	True	string	Ein ACS(Azure Communication Services)-Benutzerzugriffstoken.

Anforderungstext

Name	Erforderlich	Typ	Beschreibung
content	True	string	Chatnachrichteninhalt.
metadata		object	Nachrichtenmetadaten.
senderDisplayName		string	Der Anzeigename des Absenders der Chatnachricht. Diese Eigenschaft wird verwendet, um den Namen des Absenders für Pushbenachrichtigungen aufzufüllen.
type		ChatMessageType	Der Chatnachrichtentyp.

Antworten

Name	Typ	Beschreibung
201 Created	SendChatMessageResult	Die gesendete Nachricht enthält die `Location` Kopfzeile die URL für die neu gesendete Nachricht.
401 Unauthorized	CommunicationErrorResponse	Unbefugt.
403 Forbidden	CommunicationErrorResponse	Verboten.
429 Too Many Requests	CommunicationErrorResponse	Zu viele Anforderungen.
Other Status Codes	CommunicationErrorResponse	Der Dienst ist nicht verfügbar.

Sicherheit

Authorization

Ein ACS(Azure Communication Services)-Benutzerzugriffstoken.

Typ: apiKey
In: header

Beispiele

Send Message

Beispielanforderung

HTTP

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

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

Beispiel für eine Antwort

Statuscode:: 201

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

{
  "id": "1593072104708"
}

Statuscode:: 401

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

Statuscode:: 403

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

Statuscode:: 429

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

Statuscode:: 503

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

Definitionen

Name	Beschreibung
ChatMessageType	Der Chatnachrichtentyp.
SendChatMessageRequest	Details der zu sendenden Nachricht.
SendChatMessageResult	Ergebnis des Sendenachrichtenvorgangs.

ChatMessageType

Der Chatnachrichtentyp.

Name	Typ	Beschreibung
html	string
participantAdded	string
participantRemoved	string
text	string
topicUpdated	string

SendChatMessageRequest

Details der zu sendenden Nachricht.

Name	Typ	Beschreibung
content	string	Chatnachrichteninhalt.
metadata	object	Nachrichtenmetadaten.
senderDisplayName	string	Der Anzeigename des Absenders der Chatnachricht. Diese Eigenschaft wird verwendet, um den Namen des Absenders für Pushbenachrichtigungen aufzufüllen.
type	ChatMessageType	Der Chatnachrichtentyp.

SendChatMessageResult

Ergebnis des Sendenachrichtenvorgangs.

Name	Typ	Beschreibung
id	string	Eine vom Server generierte Nachrichten-ID.

Freigeben über