共用方式為

Chat Thread - Add Chat Participants

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

將線程參與者新增至線程。 如果參與者已經存在，則不會發生任何變更。

POST {endpoint}/chat/threads/{chatThreadId}/participants/:add?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
participants True

ChatParticipant[]

要新增至聊天對話的參與者。

回應

名稱 類型 Description
201 Created

AddChatParticipantsResult

已成功新增參與者。
401 Unauthorized

CommunicationErrorResponse

未經授權。
403 Forbidden

CommunicationErrorResponse

禁止。
429 Too Many Requests

CommunicationErrorResponse

要求太多。
Other Status Codes

CommunicationErrorResponse

服務無法使用。

安全性

Authorization

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

類型: apiKey
位於: header

範例

Add participants

範例要求

POST https://contoso.westus.communications.azure.com/chat/threads/19:f2167429acf6482880c6b7790a9086c1@thread.v2/participants/:add?api-version=2024-03-07

{
  "participants": [
    {
      "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"
        }
      },
      "displayName": "Alex",
      "shareHistoryTime": "2020-06-06T05:55:41Z"
    },
    {
      "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"
        }
      },
      "displayName": "Peter",
      "shareHistoryTime": "2020-06-06T05:55:41Z"
    },
    {
      "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"
        }
      },
      "displayName": "Rama",
      "shareHistoryTime": "2020-06-06T05:55:41Z"
    }
  ]
}

範例回覆

狀態碼:
201 
{
  "invalidParticipants": [
    {
      "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a",
      "code": "403",
      "message": "Permissions check failed"
    },
    {
      "target": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b",
      "code": "404",
      "message": "Not found"
    }
  ]
}
狀態碼:
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
AddChatParticipantsRequest

要新增至線程的參與者。
AddChatParticipantsResult

新增聊天參與者作業的結果。
ChatParticipant

聊天對話的參與者。

AddChatParticipantsRequest

要新增至線程的參與者。

名稱 類型 Description
participants

ChatParticipant[]

要新增至聊天對話的參與者。

AddChatParticipantsResult

新增聊天參與者作業的結果。

名稱 類型 Description
invalidParticipants

CommunicationError[]

無法新增至聊天對話的參與者。

ChatParticipant

聊天對話的參與者。

名稱 類型 Description
communicationIdentifier

CommunicationIdentifierModel

displayName

string

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

string

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