Send Chat Message - Send Chat Message

Dienst:

Communication

API-Version:

2020-09-21-preview2

Sendet eine Nachricht an einen Thread.

POST {endpoint}/chat/threads/{chatThreadId}/messages?api-version=2020-09-21-preview2

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.
priority		ChatMessagePriority	Die Priorität der Chatnachricht.
senderDisplayName		string	Der Anzeigename des Absenders der Chatnachricht. Diese Eigenschaft wird verwendet, um den Namen des Absenders für Pushbenachrichtigungen aufzufüllen.

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	Error	Unbefugt
403 Forbidden	Error	Verboten
429 Too Many Requests	Error	Zu viele Anforderungen
Other Status Codes	Error	Dienst 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=2020-09-21-preview2

{
  "priority": "Normal",
  "content": "Let's head out for lunch in 15 minutes.",
  "senderDisplayName": "Jane"
}

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

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

Statuscode:

403

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

Statuscode:

429

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

Statuscode:

503

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

Definitionen

Name	Beschreibung
ChatMessagePriority	Die Priorität der Chatnachricht.
Error
SendChatMessageRequest	Details der zu sendenden Nachricht.
SendChatMessageResult	Ergebnis des Sendenachrichtenvorgangs.

ChatMessagePriority

Enumeration

Die Priorität der Chatnachricht.

Wert	Beschreibung
High
Normal

Error

Objekt

Name	Typ	Beschreibung
code	string
innerErrors	Error[]
message	string
target	string

SendChatMessageRequest

Objekt

Details der zu sendenden Nachricht.

Name	Typ	Beschreibung
content	string	Chatnachrichteninhalt.
priority	ChatMessagePriority	Die Priorität der Chatnachricht.
senderDisplayName	string	Der Anzeigename des Absenders der Chatnachricht. Diese Eigenschaft wird verwendet, um den Namen des Absenders für Pushbenachrichtigungen aufzufüllen.

SendChatMessageResult

Objekt

Ergebnis des Sendenachrichtenvorgangs.

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