共用方式為

Chat Thread - Get Chat Message

  • 參考
服務:
Communication
API 版本:
2024-03-07

依標識碼取得訊息。

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

URI 參數

名稱 位於 必要 類型 Description
chatMessageId
 path True

string

訊息標識碼。
chatThreadId
 path True

string

訊息傳送至其中的線程標識碼。
endpoint
 path True

string

Azure 通訊資源的端點。
api-version
 query True

string

要叫用的 API 版本。

要求標頭

名稱 必要 類型 Description
Authorization True

string

ACS （Azure 通訊服務） 使用者存取令牌。

回應

名稱 類型 Description
200 OK

ChatMessage

要求成功。 動作會傳回 Message 資源。
401 Unauthorized

CommunicationErrorResponse

未經授權。
403 Forbidden

CommunicationErrorResponse

禁止。
429 Too Many Requests

CommunicationErrorResponse

要求太多。
Other Status Codes

CommunicationErrorResponse

服務無法使用。

安全性

Authorization

ACS （Azure 通訊服務） 使用者存取令牌。

類型: apiKey
位於: header

範例

Get Message

範例要求

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

範例回覆

狀態碼:
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"
  }
}
狀態碼:
401 
{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}
狀態碼:
403 
{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}
狀態碼:
429 
{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}
狀態碼:
503 
{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

定義

名稱 Description
ChatAttachment

聊天訊息中的附件。
ChatAttachmentType

附件的類型。
ChatMessage

聊天訊息。
ChatMessageContent

聊天訊息的內容。
ChatMessageType

聊天訊息類型。
ChatParticipant

聊天對話的參與者。

ChatAttachment

聊天訊息中的附件。

名稱 類型 Description
attachmentType

ChatAttachmentType

附件的類型。
id

string

附件的標識碼
name

string

附件內容的名稱。
previewUrl

string

可以下載附件預覽的 URL
url

string

可以下載附件的 URL

ChatAttachmentType

附件的類型。

名稱 類型 Description
file

string

image

string

ChatMessage

聊天訊息。

名稱 類型 Description
content

ChatMessageContent

聊天訊息的內容。
createdOn

string

聊天訊息抵達伺服器時的時間戳。 時間戳的格式為RFC3339：yyyy-MM-ddTHH:mm:ssZ。
deletedOn

string

刪除訊息時的時間戳（如果適用的話）。 時間戳的格式為RFC3339：yyyy-MM-ddTHH:mm:ssZ。
editedOn

string

編輯訊息時的最後一個時間戳（如果適用）。 時間戳的格式為RFC3339：yyyy-MM-ddTHH:mm:ssZ。
id

string

聊天訊息的標識碼。 此標識碼是伺服器產生的。
metadata

object

訊息元數據。
senderCommunicationIdentifier

CommunicationIdentifierModel

senderDisplayName

string

聊天訊息寄件人的顯示名稱。 這個屬性可用來填入推播通知的寄件人名稱。
sequenceId

string

交談中的聊天訊息序列。
type

ChatMessageType

聊天訊息類型。
version

string

聊天訊息的版本。

ChatMessageContent

聊天訊息的內容。

名稱 類型 Description
attachments

ChatAttachment[]

此郵件的附件清單
initiatorCommunicationIdentifier

CommunicationIdentifierModel

message

string

文字或 html 類型的訊息聊天訊息內容。
participants

ChatParticipant[]

參與者或參與者Removed類型的訊息聊天訊息內容。
topic

string

主題更新類型的訊息聊天訊息內容。

ChatMessageType

聊天訊息類型。

名稱 類型 Description
html

string

participantAdded

string

participantRemoved

string

text

string

topicUpdated

string

ChatParticipant

聊天對話的參與者。

名稱 類型 Description
communicationIdentifier

CommunicationIdentifierModel

displayName

string

聊天參與者的顯示名稱。
shareHistoryTime

string

與參與者共用聊天記錄的時間。 時間戳的格式為RFC3339：yyyy-MM-ddTHH:mm:ssZ。