Chat Thread - Add Chat Participants

Ссылка

Служба:: Communication

Версия API:: 2024-03-07

Добавляет участников потока в поток. Если участники уже существуют, изменения не происходят.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
chatThreadId	path	True	string	Идентификатор потока для добавления участников.
endpoint	path	True	string	Конечная точка ресурса связи Azure.
api-version	query	True	string	Версия API для вызова.

Заголовок запроса

Имя	Обязательно	Тип	Описание
Authorization	True	string	Маркер доступа пользователей ACS (Службы коммуникации Azure).

Текст запроса

Имя	Обязательно	Тип	Описание
participants	True	ChatParticipant[]	Участники, добавляя в поток чата.

Ответы

Имя	Тип	Описание
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

Образец запроса

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

Пример ответа

Код состояния:: 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."
  }
}

Определения

Имя	Описание
AddChatParticipantsRequest	Участники, добавляемые в поток.
AddChatParticipantsResult	Результат операции добавления участников чата.
ChatParticipant	Участник потока чата.

AddChatParticipantsRequest

Участники, добавляемые в поток.

Имя	Тип	Описание
participants	ChatParticipant[]	Участники, добавляя в поток чата.

AddChatParticipantsResult

Результат операции добавления участников чата.

Имя	Тип	Описание
invalidParticipants	CommunicationError[]	Участники, которые не удалось добавить в поток чата.

ChatParticipant

Участник потока чата.

Имя	Тип	Описание
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Отображаемое имя участника чата.
shareHistoryTime	string	Время, из которого журнал чата предоставляется участнику. Метка времени находится в формате RFC3339: `yyyy-MM-ddTHH:mm:ssZ`.

Поделиться через