Chat Thread - Send Chat Message

Reference

Služba:: Communication

Verze rozhraní API:: 2024-03-15-preview

Odešle zprávu do vlákna.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
chatThreadId	path	True	string	ID vlákna, do které se má zpráva odeslat.
endpoint	path	True	string	Koncový bod prostředku Azure Communication.
api-version	query	True	string	Verze rozhraní API, která se má vyvolat.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Přístupový token uživatele služby ACS (Azure Communication Services).

Text požadavku

Name	Vyžadováno	Typ	Description
content	True	string	Obsah zpráv chatu.
attachments		ChatAttachment[]	Pole příloh
metadata		object	Metadata zpráv.
senderDisplayName		string	Zobrazované jméno odesílatele chatové zprávy. Tato vlastnost se používá k naplnění jména odesílatele pro nabízená oznámení.
type		ChatMessageType	Typ zprávy chatu

Odpovědi

Name	Typ	Description
201 Created	SendChatMessageResult	Zpráva byla odeslána, `Location` záhlaví obsahuje adresu URL nově odeslané zprávy.
401 Unauthorized	CommunicationErrorResponse	Neautorizováno
403 Forbidden	CommunicationErrorResponse	Zakázáno.
429 Too Many Requests	CommunicationErrorResponse	Příliš mnoho požadavků.
Other Status Codes	CommunicationErrorResponse	Nedostupná služba.

Zabezpečení

Authorization

Přístupový token uživatele služby ACS (Azure Communication Services).

Typ: apiKey
V: header

Příklady

Send Message

Ukázkový požadavek

HTTP

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

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

Ukázková odpověď

Stavový kód:: 201

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

{
  "id": "1593072104708"
}

Stavový kód:: 401

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

Stavový kód:: 403

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

Stavový kód:: 429

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

Stavový kód:: 503

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

Definice

Name	Description
ChatAttachment	Příloha ve zprávě chatu V současné době se podporuje pouze ve scénářích spolupráce Teams.
ChatAttachmentType	Typ přílohy.
ChatMessageType	Typ zprávy chatu
SendChatMessageRequest	Podrobnosti o zprávě, která se má odeslat.
SendChatMessageResult	Výsledek operace odeslání zprávy.

ChatAttachment

Příloha ve zprávě chatu V současné době se podporuje pouze ve scénářích spolupráce Teams.

Name	Typ	Description
attachmentType	ChatAttachmentType	Typ přílohy.
id	string	ID přílohy
name	string	Název obsahu přílohy.
previewUrl	string	Adresa URL, na které je možné stáhnout náhled přílohy
url	string	Adresa URL, na které lze přílohu stáhnout

ChatAttachmentType

Typ přílohy.

Name	Typ	Description
file	string
image	string

ChatMessageType

Typ zprávy chatu

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

SendChatMessageRequest

Podrobnosti o zprávě, která se má odeslat.

Name	Typ	Description
attachments	ChatAttachment[]	Pole příloh
content	string	Obsah zpráv chatu.
metadata	object	Metadata zpráv.
senderDisplayName	string	Zobrazované jméno odesílatele chatové zprávy. Tato vlastnost se používá k naplnění jména odesílatele pro nabízená oznámení.
type	ChatMessageType	Typ zprávy chatu

SendChatMessageResult

Výsledek operace odeslání zprávy.

Name	Typ	Description
id	string	ID zprávy vygenerované serverem.

Sdílet prostřednictvím