Chat Thread - Add Chat Participants

Odwołanie

Usługa:: Communication

Wersja interfejsu API:: 2024-03-15-preview

Dodaje uczestników wątku do wątku. Jeśli uczestnicy już istnieją, nie nastąpi żadna zmiana.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
chatThreadId	path	True	string	Identyfikator wątku do dodania uczestników.
endpoint	path	True	string	Punkt końcowy zasobu usługi Azure Communication.
api-version	query	True	string	Wersja interfejsu API do wywołania.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Authorization	True	string	Token dostępu użytkownika usługi ACS (Azure Communication Services).

Treść żądania

Nazwa	Wymagane	Typ	Opis
participants	True	ChatParticipant[]	Uczestnicy dodawania do wątku czatu.

Odpowiedzi

Nazwa	Typ	Opis
201 Created	AddChatParticipantsResult	Uczestnicy zostali pomyślnie dodani.
401 Unauthorized	CommunicationErrorResponse	Brak autoryzacji.
403 Forbidden	CommunicationErrorResponse	Zakazane.
429 Too Many Requests	CommunicationErrorResponse	Zbyt wiele żądań.
Other Status Codes	CommunicationErrorResponse	Usługa niedostępna.

Zabezpieczenia

Authorization

Token dostępu użytkownika usługi ACS (Azure Communication Services).

Typ: apiKey
W: header

Przykłady

Add participants

Przykładowe żądanie

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

Przykładowa odpowiedź

Kod stanu:: 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"
    }
  ]
}

Kod stanu:: 401

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

Kod stanu:: 403

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

Kod stanu:: 429

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

Kod stanu:: 503

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

Definicje

Nazwa	Opis
AddChatParticipantsRequest	Uczestnicy do dodania do wątku.
AddChatParticipantsResult	Wynik operacji dodawania uczestników czatu.
ChatParticipant	Uczestnik wątku czatu.

AddChatParticipantsRequest

Uczestnicy do dodania do wątku.

Nazwa	Typ	Opis
participants	ChatParticipant[]	Uczestnicy dodawania do wątku czatu.

AddChatParticipantsResult

Wynik operacji dodawania uczestników czatu.

Nazwa	Typ	Opis
invalidParticipants	CommunicationError[]	Uczestnicy, którzy nie zostali dodani do wątku czatu.

ChatParticipant

Uczestnik wątku czatu.

Nazwa	Typ	Opis
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Nazwa wyświetlana uczestnika czatu.
metadata	object	Kontekstowe metadane uczestnika czatu. Metadane składają się z par nazwa/wartość. Całkowity rozmiar wszystkich par metadanych może wynosić do 1 KB.
shareHistoryTime	string	Czas, z którego historia czatu jest udostępniana uczestnikowi. Znacznik czasu ma format RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.

Udostępnij za pośrednictwem