Chat Thread - Get Chat Message

Referens

Tjänst:: Communication

API-version:: 2024-03-07

Hämtar ett meddelande via ID.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
chatMessageId	path	True	string	Meddelande-ID:t.
chatThreadId	path	True	string	Det tråd-ID som meddelandet skickades till.
endpoint	path	True	string	Slutpunkten för Azure Communication-resursen.
api-version	query	True	string	Version av API som ska anropas.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	En ACS-användaråtkomsttoken (Azure Communication Services).

Svar

Name	Typ	Description
200 OK	ChatMessage	Begäran lyckades. Åtgärden returnerar en `Message` resurs.
401 Unauthorized	CommunicationErrorResponse	Obehörig.
403 Forbidden	CommunicationErrorResponse	Förbjuden.
429 Too Many Requests	CommunicationErrorResponse	För många begäranden.
Other Status Codes	CommunicationErrorResponse	Tjänsten är inte tillgänglig.

Säkerhet

Authorization

En ACS-användaråtkomsttoken (Azure Communication Services).

Typ: apiKey
I: header

Exempel

Get Message

Exempelbegäran

HTTP

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

Exempelsvar

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

Statuskod:: 401

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

Statuskod:: 403

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

Statuskod:: 429

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

Statuskod:: 503

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

Definitioner

Name	Description
ChatAttachment	En bifogad fil i ett chattmeddelande.
ChatAttachmentType	Typ av bifogad fil.
ChatMessage	Chattmeddelande.
ChatMessageContent	Innehåll i ett chattmeddelande.
ChatMessageType	Typ av chattmeddelande.
ChatParticipant	En deltagare i chatttråden.

ChatAttachment

En bifogad fil i ett chattmeddelande.

Name	Typ	Description
attachmentType	ChatAttachmentType	Typ av bifogad fil.
id	string	ID för den bifogade filen
name	string	Namnet på det bifogade innehållet.
previewUrl	string	Url:en där förhandsgranskningen av den bifogade filen kan laddas ned
url	string	Url:en där den bifogade filen kan laddas ned

ChatAttachmentType

Typ av bifogad fil.

Name	Typ	Description
file	string
image	string

ChatMessage

Chattmeddelande.

Name	Typ	Description
content	ChatMessageContent	Innehåll i ett chattmeddelande.
createdOn	string	Tidsstämpeln när chattmeddelandet kom till servern. Tidsstämpeln är i RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.
deletedOn	string	Tidsstämpeln (om tillämpligt) när meddelandet togs bort. Tidsstämpeln är i RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.
editedOn	string	Den senaste tidsstämpeln (om tillämpligt) när meddelandet redigerades. Tidsstämpeln är i RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.
id	string	ID för chattmeddelandet. Det här ID:t genereras av servern.
metadata	object	Meddelandemetadata.
senderCommunicationIdentifier	CommunicationIdentifierModel
senderDisplayName	string	Visningsnamnet för chattmeddelandets avsändare. Den här egenskapen används för att fylla i avsändarens namn för push-meddelanden.
sequenceId	string	Sekvens av chattmeddelandet i konversationen.
type	ChatMessageType	Typ av chattmeddelande.
version	string	Version av chattmeddelandet.

ChatMessageContent

Innehåll i ett chattmeddelande.

Name	Typ	Description
attachments	ChatAttachment[]	Lista över bifogade filer för det här meddelandet
initiatorCommunicationIdentifier	CommunicationIdentifierModel
message	string	Chattmeddelandeinnehåll för meddelanden av typen text eller html.
participants	ChatParticipant[]	Chattmeddelandeinnehåll för meddelanden av typen deltagareLägg till eller deltagareRemoved.
topic	string	Chattmeddelandeinnehåll för meddelanden av typen topicUpdated.

ChatMessageType

Typ av chattmeddelande.

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

ChatParticipant

En deltagare i chatttråden.

Name	Typ	Description
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Visningsnamn för chattdeltagaren.
shareHistoryTime	string	Tid från vilken chatthistoriken delas med deltagaren. Tidsstämpeln är i RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.

Dela via