Chat Thread - Get Chat Message

Referentie

Service:: Communication

API-versie:: 2024-03-07

Hiermee haalt u een bericht op id op.

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

URI-parameters

Name	In	Vereist	Type	Description
chatMessageId	path	True	string	De bericht-id.
chatThreadId	path	True	string	De thread-id waarnaar het bericht is 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).

Antwoorden

Name	Type	Description
200 OK	ChatMessage	Aanvraag is voltooid. De actie retourneert een `Message` resource.
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

Get Message

Voorbeeldaanvraag

HTTP

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

Voorbeeldrespons

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

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
ChatAttachment	Een bijlage in een chatbericht.
ChatAttachmentType	Het type bijlage.
ChatMessage	Chatbericht.
ChatMessageContent	Inhoud van een chatbericht.
ChatMessageType	Het type chatbericht.
ChatParticipant	Een deelnemer aan de chat-thread.

ChatAttachment

Een bijlage in een chatbericht.

Name	Type	Description
attachmentType	ChatAttachmentType	Het type bijlage.
id	string	Id van de bijlage
name	string	De naam van de inhoud van de bijlage.
previewUrl	string	De URL waar het voorbeeld van de bijlage kan worden gedownload
url	string	De URL waar de bijlage kan worden gedownload

ChatAttachmentType

Het type bijlage.

Name	Type	Description
file	string
image	string

ChatMessage

Chatbericht.

Name	Type	Description
content	ChatMessageContent	Inhoud van een chatbericht.
createdOn	string	De tijdstempel toen het chatbericht op de server aankwam. De tijdstempel heeft RFC3339 indeling: `yyyy-MM-ddTHH:mm:ssZ`.
deletedOn	string	De tijdstempel (indien van toepassing) toen het bericht werd verwijderd. De tijdstempel heeft RFC3339 indeling: `yyyy-MM-ddTHH:mm:ssZ`.
editedOn	string	De laatste tijdstempel (indien van toepassing) toen het bericht werd bewerkt. De tijdstempel heeft RFC3339 indeling: `yyyy-MM-ddTHH:mm:ssZ`.
id	string	De id van het chatbericht. Deze id wordt gegenereerd door de server.
metadata	object	Berichtmetagegevens.
senderCommunicationIdentifier	CommunicationIdentifierModel
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.
sequenceId	string	Volgorde van het chatbericht in het gesprek.
type	ChatMessageType	Het type chatbericht.
version	string	Versie van het chatbericht.

ChatMessageContent

Inhoud van een chatbericht.

Name	Type	Description
attachments	ChatAttachment[]	Lijst met bijlagen voor dit bericht
initiatorCommunicationIdentifier	CommunicationIdentifierModel
message	string	Chatberichtinhoud voor berichten van typen tekst of HTML.
participants	ChatParticipant[]	Chatberichtinhoud voor berichten van het type participantAdded of participantRemoved.
topic	string	Chatberichtinhoud voor berichten van het type topicUpdated.

ChatMessageType

Het type chatbericht.

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

ChatParticipant

Een deelnemer aan de chat-thread.

Name	Type	Description
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Weergavenaam voor de chatdeelnemer.
shareHistoryTime	string	Tijd van waaruit de chatgeschiedenis wordt gedeeld met de deelnemer. De tijdstempel heeft RFC3339 indeling: `yyyy-MM-ddTHH:mm:ssZ`.

Delen via