共用方式為

Chat Thread - Send Chat Message

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

將訊息傳送至線程。

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

URI 參數

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

string

要傳送訊息的線程標識碼。
endpoint
 path True

string

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

string

要叫用的 API 版本。

要求標頭

名稱 必要 類型 Description
Authorization True

string

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

要求本文

名稱 必要 類型 Description
content True

string

聊天訊息內容。
metadata

object

訊息元數據。
senderDisplayName

string

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

ChatMessageType

聊天訊息類型。

回應

名稱 類型 Description
201 Created

SendChatMessageResult

傳送的訊息，Location 標頭包含新傳送訊息的 URL。
401 Unauthorized

CommunicationErrorResponse

未經授權。
403 Forbidden

CommunicationErrorResponse

禁止。
429 Too Many Requests

CommunicationErrorResponse

要求太多。
Other Status Codes

CommunicationErrorResponse

服務無法使用。

安全性

Authorization

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

類型: apiKey
位於: header

範例

Send Message

範例要求

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

{
  "content": "Let's head out for lunch in 15 minutes.",
  "senderDisplayName": "Jane",
  "metadata": {
    "someKey1": "someValue1",
    "someKey2": "someValue2"
  }
}

範例回覆

狀態碼:
201 
Location: https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/messages/1593072104708
{
  "id": "1593072104708"
}
狀態碼:
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
ChatMessageType

聊天訊息類型。
SendChatMessageRequest

要傳送之訊息的詳細數據。
SendChatMessageResult

傳送訊息作業的結果。

ChatMessageType

聊天訊息類型。

名稱 類型 Description
html

string

participantAdded

string

participantRemoved

string

text

string

topicUpdated

string

SendChatMessageRequest

要傳送之訊息的詳細數據。

名稱 類型 Description
content

string

聊天訊息內容。
metadata

object

訊息元數據。
senderDisplayName

string

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

ChatMessageType

聊天訊息類型。

SendChatMessageResult

傳送訊息作業的結果。

名稱 類型 Description
id

string

伺服器產生的訊息識別碼。