Chat Thread - Send Chat Message

Odwołanie

Usługa:: Communication

Wersja interfejsu API:: 2024-03-07

Wysyła wiadomość do wątku.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
chatThreadId	path	True	string	Identyfikator wątku do wysłania wiadomości.
endpoint	path	True	string	Punkt końcowy zasobu usługi Azure Communication.
api-version	query	True	string	Wersja interfejsu API do wywołania.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token dostępu użytkownika usług ACS (Azure Communication Services).

Treść żądania

Nazwa	Wymagane	Typ	Opis
content	True	string	Zawartość wiadomości czatu.
metadata		object	Metadane wiadomości.
senderDisplayName		string	Nazwa wyświetlana nadawcy wiadomości czatu. Ta właściwość służy do wypełniania nazwy nadawcy dla powiadomień wypychanych.
type		ChatMessageType	Typ wiadomości czatu.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	SendChatMessageResult	Wysłany komunikat, nagłówek `Location` zawiera adres URL nowo wysłanej wiadomości.
401 Unauthorized	CommunicationErrorResponse	Nieautoryzowanych.
403 Forbidden	CommunicationErrorResponse	Zakazany.
429 Too Many Requests	CommunicationErrorResponse	Zbyt wiele żądań.
Other Status Codes	CommunicationErrorResponse	Usługa jest niedostępna.

Zabezpieczenia

Authorization

Token dostępu użytkownika usług ACS (Azure Communication Services).

Typ: apiKey
W: header

Przykłady

Send Message

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 201

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

{
  "id": "1593072104708"
}

Kod stanu:: 401

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

Kod stanu:: 403

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

Kod stanu:: 429

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

Kod stanu:: 503

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

Definicje

Nazwa	Opis
ChatMessageType	Typ wiadomości czatu.
SendChatMessageRequest	Szczegóły wiadomości do wysłania.
SendChatMessageResult	Wynik operacji wysyłania komunikatu.

ChatMessageType

Typ wiadomości czatu.

Nazwa	Typ	Opis
html	string
participantAdded	string
participantRemoved	string
text	string
topicUpdated	string

SendChatMessageRequest

Szczegóły wiadomości do wysłania.

Nazwa	Typ	Opis
content	string	Zawartość wiadomości czatu.
metadata	object	Metadane wiadomości.
senderDisplayName	string	Nazwa wyświetlana nadawcy wiadomości czatu. Ta właściwość służy do wypełniania nazwy nadawcy dla powiadomień wypychanych.
type	ChatMessageType	Typ wiadomości czatu.

SendChatMessageResult

Wynik operacji wysyłania komunikatu.

Nazwa	Typ	Opis
id	string	Identyfikator komunikatu wygenerowanego przez serwer.

Udostępnij za pośrednictwem