Chat Thread - Get Chat Message

Reference

Služba:: Communication

Verze rozhraní API:: 2024-03-07

Získá zprávu podle ID.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
chatMessageId	path	True	string	ID zprávy.
chatThreadId	path	True	string	ID vlákna, do kterého byla zpráva odeslána.
endpoint	path	True	string	Koncový bod prostředku komunikace Azure.
api-version	query	True	string	Verze rozhraní API k vyvolání

Hlavička požadavku

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

Odpovědi

Name	Typ	Description
200 OK	ChatMessage	Žádost byla úspěšná. Akce vrátí `Message` prostředek.
401 Unauthorized	CommunicationErrorResponse	Neautorizovaný.
403 Forbidden	CommunicationErrorResponse	Zakázaný.
429 Too Many Requests	CommunicationErrorResponse	Příliš mnoho požadavků.
Other Status Codes	CommunicationErrorResponse	Služba není k dispozici.

Zabezpečení

Authorization

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

Typ: apiKey
V: header

Příklady

Get Message

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

{
  "id": "1591768249318",
  "sequenceId": "1",
  "type": "text",
  "version": "1599016601134",
  "content": {
    "message": "Let's head out for lunch in 15 minutes."
  },
  "senderDisplayName": "Jane",
  "createdOn": "2020-06-10T05:50:49.3180000Z",
  "senderCommunicationIdentifier": {
    "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
    "communicationUser": {
      "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
    }
  },
  "metadata": {
    "someKey1": "someValue1",
    "someKey2": "someValue2"
  }
}

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
ChatAttachmentType	Typ přílohy.
ChatMessage	Zpráva chatu.
ChatMessageContent	Obsah chatové zprávy
ChatMessageType	Typ zprávy chatu.
ChatParticipant	Účastník vlákna chatu.

ChatAttachment

Příloha ve zprávě chatu

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

ChatAttachmentType

Typ přílohy.

Name	Typ	Description
file	string
image	string

ChatMessage

Zpráva chatu.

Name	Typ	Description
content	ChatMessageContent	Obsah chatové zprávy
createdOn	string	Časové razítko, kdy zpráva chatu přišla na server. Časové razítko je ve formátu RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
deletedOn	string	Časové razítko (pokud je k dispozici) při odstranění zprávy. Časové razítko je ve formátu RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
editedOn	string	Poslední časové razítko (pokud je k dispozici) při úpravě zprávy. Časové razítko je ve formátu RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.
id	string	ID zprávy chatu. Toto ID je vygenerováno serverem.
metadata	object	Metadata zpráv
senderCommunicationIdentifier	CommunicationIdentifierModel
senderDisplayName	string	Zobrazované jméno odesílatele zprávy chatu. Tato vlastnost slouží k naplnění názvu odesílatele pro nabízená oznámení.
sequenceId	string	Posloupnost chatové zprávy v konverzaci
type	ChatMessageType	Typ zprávy chatu.
version	string	Verze zprávy chatu

ChatMessageContent

Obsah chatové zprávy

Name	Typ	Description
attachments	ChatAttachment[]	Seznam příloh pro tuto zprávu
initiatorCommunicationIdentifier	CommunicationIdentifierModel
message	string	Obsah zprávy chatu pro zprávy typu text nebo html
participants	ChatParticipant[]	Obsah zprávy chatu pro zprávy typu participantAdded nebo participantRemoved.
topic	string	Obsah zprávy chatu pro zprávy typu topicUpdated

ChatMessageType

Typ zprávy chatu.

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

ChatParticipant

Účastník vlákna chatu.

Name	Typ	Description
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Zobrazované jméno účastníka chatu
shareHistoryTime	string	Čas, ze kterého se historie chatu sdílí s účastníkem Časové razítko je ve formátu RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.

Sdílet prostřednictvím