Chat Thread - List Chat Messages

Reference

Služba:: Communication

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

Získá seznam zpráv z vlákna.

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

S volitelnými parametry:

GET {endpoint}/chat/threads/{chatThreadId}/messages?maxPageSize={maxPageSize}&startTime={startTime}&api-version=2024-03-15-preview

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
chatThreadId	path	True	string	ID vlákna zprávy.
endpoint	path	True	string	Koncový bod prostředku Azure Communication.
api-version	query	True	string	Verze rozhraní API, která se má vyvolat.
maxPageSize	query		integer int32	Maximální počet zpráv, které se mají vrátit na stránku.
startTime	query		string date-time	Nejstarší bod v čase, po který se mají dostat zprávy. Časové razítko by mělo být ve formátu RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.

Hlavička požadavku

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

Odpovědi

Name	Typ	Description
200 OK	ChatMessagesCollection	Success
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

Get messages with pagination (max page size)

Ukázkový požadavek

HTTP

GET https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/messages?maxPageSize=5&api-version=2024-03-15-preview

Ukázková odpověď

Stavový kód:: 200

{
  "value": [
    {
      "id": "1593107077690",
      "type": "html",
      "version": "1593107077683",
      "sequenceId": "5",
      "content": {
        "message": "<p>This place for lunch?&nbsp;</p>\r\n<p><img itemscope=\"png\" src=\"\" width=\"1425\" height=\"539\" alt=\"image\" id=\"0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73\"></p>",
        "attachments": [
          {
            "id": "0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73",
            "attachmentType": "image",
            "name": "image",
            "url": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/images/0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73/views/original?api-version=2023-07-01-preview",
            "previewUrl": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/messages/1700844519132/teamsInterop/images/0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73/views/small?api-version=2023-07-01-preview"
          }
        ]
      },
      "senderDisplayName": "Jane",
      "createdOn": "2020-06-25T17:44:37.6830000Z",
      "metadata": {
        "amsreferences": "[\"0-canaryeus-d1-907ca0083e8f3bef6793e5a46c0ded73\"]"
      },
      "senderCommunicationIdentifier": {
        "rawId": "8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b",
        "communicationUser": {
          "id": "8540c0de-899f-5cce-acb5-3ec493af3800_0e59221d-0c1d-46ae-9544-c963ce56c10b"
        }
      }
    },
    {
      "id": "1593107077683",
      "type": "text",
      "sequenceId": "4",
      "version": "1593107077683",
      "content": {
        "message": "Let's use this chat to decide what to get for lunch today."
      },
      "senderDisplayName": "Jane",
      "createdOn": "2020-06-25T17:44:37.6830000Z",
      "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"
        }
      }
    },
    {
      "id": "1593107046498",
      "type": "text",
      "sequenceId": "3",
      "version": "1593107046498",
      "content": {
        "message": "Good morning everyone!"
      },
      "senderDisplayName": "Jane",
      "createdOn": "2020-06-25T17:44:06.4980000Z",
      "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"
        }
      }
    },
    {
      "id": "1593106976785",
      "type": "topicUpdated",
      "sequenceId": "2",
      "version": "1593106976785",
      "content": {
        "initiatorCommunicationIdentifier": {
          "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"
          }
        },
        "topic": "Lunch"
      },
      "createdOn": "2020-06-25T17:42:56.7850000Z"
    },
    {
      "id": "1593106976753",
      "type": "participantAdded",
      "version": "1593106976753",
      "sequenceId": "1",
      "content": {
        "initiatorCommunicationIdentifier": {
          "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"
          }
        },
        "participants": [
          {
            "communicationIdentifier": {
              "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"
              }
            }
          },
          {
            "communicationIdentifier": {
              "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715",
              "communicationUser": {
                "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_c94ff260-162d-46d6-94fd-e79f4d213715"
              }
            }
          },
          {
            "communicationIdentifier": {
              "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce",
              "communicationUser": {
                "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f13a9208-0bb8-45c0-916c-f3ed922728ce"
              }
            }
          }
        ]
      },
      "createdOn": "2020-06-25T17:42:56.7530000Z"
    }
  ],
  "nextLink": "https://contoso.westus.communications.azure.com/chat/threads/19:meeting_453dafb77b26481ea2e73bcada0324af@thread.v2/messages?syncState=3e4700000031393a756e6930315f7a626e68336e74326466756666657a6333736f7837646f67377766686b36793571653272776c6e66686c68647a69726968647071407468726561642e763201451fe6e77201000004357fea72010000&startTime=0&maxPageSize=5&api-version=2024-03-15-preview"
}

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 Aktuálně se podporuje pouze ve scénářích zprostředkovatele komunikace Teams.
ChatAttachmentType	Typ přílohy.
ChatMessage	Zpráva chatu.
ChatMessageContent	Obsah zprávy chatu
ChatMessagesCollection	Kolekce zpráv chatu pro konkrétní vlákno chatu.
ChatMessageType	Typ zprávy chatu
ChatParticipant	Účastník vlákna chatu.

ChatAttachment

Příloha ve zprávě chatu Aktuálně se podporuje pouze ve scénářích zprostředkovatele komunikace 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, 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 zprávy chatu
createdOn	string	Časové razítko, kdy zpráva chatu dorazila 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 vygenerované serverem.
metadata	object	Metadata zpráv.
senderCommunicationIdentifier	CommunicationIdentifierModel
senderDisplayName	string	Zobrazované jméno odesílatele zprávy chatu. Tato vlastnost se používá k vyplnění jména odesílatele pro nabízená oznámení.
sequenceId	string	Posloupnost zprávy chatu v konverzaci
type	ChatMessageType	Typ zprávy chatu
version	string	Verze zprávy chatu

ChatMessageContent

Obsah zprávy chatu

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

ChatMessagesCollection

Kolekce zpráv chatu pro konkrétní vlákno chatu.

Name	Typ	Description
nextLink	string	Pokud je možné načíst další chatové zprávy, vyplní se další odkaz.
value	ChatMessage[]	Kolekce zpráv chatu.

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
metadata	object	Kontextová metadata účastníka chatu Metadata se skládají z párů název/hodnota. Celková velikost všech párů metadat může být až 1 kB.
shareHistoryTime	string	Čas, od 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