Chat Thread - Add Chat Participants

Reference

Služba:: Communication

Verze rozhraní API:: 2024-03-07

Přidá účastníky vlákna do vlákna. Pokud už účastníci existují, nedojde k žádné změně.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
chatThreadId	path	True	string	ID vlákna pro přidání účastníků.
endpoint	path	True	string	Koncový bod prostředku komunikace Azure.
api-version	query	True	string	Verze rozhraní API k vyvolání

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Přístupový token uživatele ACS (Azure Communication Services).

Text požadavku

Name	Vyžadováno	Typ	Description
participants	True	ChatParticipant[]	Účastníci, kteří se mají přidat do vlákna chatu

Odpovědi

Name	Typ	Description
201 Created	AddChatParticipantsResult	Účastníci byli úspěšně přidáni.
401 Unauthorized	CommunicationErrorResponse	Neautorizovaný.
403 Forbidden	CommunicationErrorResponse	Zakázaný.
429 Too Many Requests	CommunicationErrorResponse	Příliš mnoho požadavků.
Other Status Codes	CommunicationErrorResponse	Služba není k dispozici.

Zabezpečení

Authorization

Přístupový token uživatele ACS (Azure Communication Services).

Typ: apiKey
V: header

Příklady

Add participants

Ukázkový požadavek

HTTP

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"
    }
  ]
}

Ukázková odpověď

Stavový kód:: 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"
    }
  ]
}

Stavový kód:: 401

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

Stavový kód:: 403

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

Stavový kód:: 429

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

Stavový kód:: 503

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

Definice

Name	Description
AddChatParticipantsRequest	Účastníci, kteří se mají přidat do vlákna.
AddChatParticipantsResult	Výsledek operace přidání účastníků chatu
ChatParticipant	Účastník vlákna chatu.

AddChatParticipantsRequest

Účastníci, kteří se mají přidat do vlákna.

Name	Typ	Description
participants	ChatParticipant[]	Účastníci, kteří se mají přidat do vlákna chatu

AddChatParticipantsResult

Výsledek operace přidání účastníků chatu

Name	Typ	Description
invalidParticipants	CommunicationError[]	Účastníci, kteří se nepodařilo přidat do vlákna chatu.

ChatParticipant

Účastník vlákna chatu.

Name	Typ	Description
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Zobrazované jméno účastníka chatu
shareHistoryTime	string	Čas, ze kterého se historie chatu sdílí s účastníkem Časové razítko je ve formátu RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.

Sdílet prostřednictvím