Chat Thread - Send Chat Message

Referentie

Service:: Communication

API-versie:: 2024-03-07

Hiermee wordt een bericht verzonden naar een thread.

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

URI-parameters

Name	In	Vereist	Type	Description
chatThreadId	path	True	string	De thread-id waar het bericht naartoe moet worden verzonden.
endpoint	path	True	string	Het eindpunt van de Azure Communication-resource.
api-version	query	True	string	De versie van de API die moet worden aangeroepen.

Aanvraagkoptekst

Name	Vereist	Type	Description
Authorization	True	string	Een ACS-gebruikerstoegangstoken (Azure Communication Services).

Aanvraagbody

Name	Vereist	Type	Description
content	True	string	Inhoud van chatberichten.
metadata		object	Berichtmetagegevens.
senderDisplayName		string	De weergavenaam van de afzender van het chatbericht. Deze eigenschap wordt gebruikt om de naam van de afzender in te vullen voor pushmeldingen.
type		ChatMessageType	Het type chatbericht.

Antwoorden

Name	Type	Description
201 Created	SendChatMessageResult	Bericht verzonden, de `Location` header bevat de URL voor het zojuist verzonden bericht.
401 Unauthorized	CommunicationErrorResponse	Ongeoorloofd.
403 Forbidden	CommunicationErrorResponse	Verboden.
429 Too Many Requests	CommunicationErrorResponse	Te veel aanvragen.
Other Status Codes	CommunicationErrorResponse	De service is niet beschikbaar.

Beveiliging

Authorization

Een ACS-gebruikerstoegangstoken (Azure Communication Services).

Type: apiKey
In: header

Voorbeelden

Send Message

Voorbeeldaanvraag

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

Voorbeeldrespons

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

Definities

Name	Description
ChatMessageType	Het type chatbericht.
SendChatMessageRequest	Details van het te verzenden bericht.
SendChatMessageResult	Resultaat van de verzendberichtbewerking.

ChatMessageType

Inventarisatie

Het type chatbericht.

Waarde	Description
html
participantAdded
participantRemoved
text
topicUpdated

SendChatMessageRequest

Object

Details van het te verzenden bericht.

Name	Type	Description
content	string	Inhoud van chatberichten.
metadata	object	Berichtmetagegevens.
senderDisplayName	string	De weergavenaam van de afzender van het chatbericht. Deze eigenschap wordt gebruikt om de naam van de afzender in te vullen voor pushmeldingen.
type	ChatMessageType	Het type chatbericht.

SendChatMessageResult