Chat Thread - Send Chat Message

Referens

Tjänst:: Communication

API-version:: 2024-03-07

Skickar ett meddelande till en tråd.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
chatThreadId	path	True	string	Tråd-ID:t som meddelandet ska skickas till.
endpoint	path	True	string	Slutpunkten för Azure Communication-resursen.
api-version	query	True	string	Version av API som ska anropas.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	En ACS-användaråtkomsttoken (Azure Communication Services).

Begärandetext

Name	Obligatorisk	Typ	Description
content	True	string	Chattmeddelandeinnehåll.
metadata		object	Meddelandemetadata.
senderDisplayName		string	Visningsnamnet för chattmeddelandets avsändare. Den här egenskapen används för att fylla i avsändarens namn för push-meddelanden.
type		ChatMessageType	Typ av chattmeddelande.

Svar

Name	Typ	Description
201 Created	SendChatMessageResult	Meddelandet skickas, `Location`-huvudet innehåller URL:en för det nyligen skickade meddelandet.
401 Unauthorized	CommunicationErrorResponse	Obehörig.
403 Forbidden	CommunicationErrorResponse	Förbjuden.
429 Too Many Requests	CommunicationErrorResponse	För många begäranden.
Other Status Codes	CommunicationErrorResponse	Tjänsten är inte tillgänglig.

Säkerhet

Authorization

En ACS-användaråtkomsttoken (Azure Communication Services).

Typ: apiKey
I: header

Exempel

Send Message

Exempelbegäran

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"
  }
}

Exempelsvar

Statuskod:: 201

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

{
  "id": "1593072104708"
}

Statuskod:: 401

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

Statuskod:: 403

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

Statuskod:: 429

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

Statuskod:: 503

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

Definitioner

Name	Description
ChatMessageType	Typ av chattmeddelande.
SendChatMessageRequest	Information om meddelandet som ska skickas.
SendChatMessageResult	Resultatet av åtgärden skicka meddelande.

ChatMessageType

Typ av chattmeddelande.

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

SendChatMessageRequest

Information om meddelandet som ska skickas.

Name	Typ	Description
content	string	Chattmeddelandeinnehåll.
metadata	object	Meddelandemetadata.
senderDisplayName	string	Visningsnamnet för chattmeddelandets avsändare. Den här egenskapen används för att fylla i avsändarens namn för push-meddelanden.
type	ChatMessageType	Typ av chattmeddelande.

SendChatMessageResult

Resultatet av åtgärden skicka meddelande.

Name	Typ	Description
id	string	Ett servergenererat meddelande-ID.

Dela via