Chat Thread - Add Chat Participants

Reference

Služba:: Communication

Verze rozhraní API:: 2024-03-15-preview

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

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
chatThreadId	path	True	string	ID vlákna, do které chcete přidat účastníky.
endpoint	path	True	string	Koncový bod prostředku Azure Communication.
api-version	query	True	string	Verze rozhraní API, která se má vyvolat.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Authorization	True	string	Přístupový token uživatele služby 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	Neautorizováno
403 Forbidden	CommunicationErrorResponse	Zakázáno.
429 Too Many Requests	CommunicationErrorResponse	Příliš mnoho požadavků.
Other Status Codes	CommunicationErrorResponse	Nedostupná služba.

Zabezpečení

Authorization

Přístupový token uživatele služby 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-15-preview

{
  "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ří mají být přidáni do vlákna.
AddChatParticipantsResult	Výsledek operace přidání účastníků chatu
ChatParticipant	Účastník vlákna chatu.

AddChatParticipantsRequest

Účastníci, kteří mají být přidáni 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, které 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
metadata	object	Kontextová metadata účastníka chatu. Metadata se skládají z párů název/hodnota. Celková velikost všech dvojic metadat může být až 1 kB.
shareHistoryTime	string	Čas, od 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