Chat Thread - Add Chat Participants

Referens

Service:: Communication

API Version:: 2024-03-15-preview

Lägger till tråddeltagare i en tråd. Om deltagarna redan finns sker ingen ändring.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
chatThreadId	path	True	string	ID för tråden som deltagarna ska läggas till i.
endpoint	path	True	string	Slutpunkten för Azure Communication-resursen.
api-version	query	True	string	Version av API som ska anropas.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Authorization	True	string	En ACS-användaråtkomsttoken (Azure Communication Services).

Begärandetext

Name	Obligatorisk	Typ	Description
participants	True	ChatParticipant[]	Deltagare att lägga till i en chatttråd.

Svar

Name	Typ	Description
201 Created	AddChatParticipantsResult	Deltagarna har lagts till.
401 Unauthorized	CommunicationErrorResponse	Behörighet saknas.
403 Forbidden	CommunicationErrorResponse	Förbjudet.
429 Too Many Requests	CommunicationErrorResponse	För många begäranden.
Other Status Codes	CommunicationErrorResponse	Tjänsten är inte tillgänglig.

Säkerhet

Authorization

En ACS-användaråtkomsttoken (Azure Communication Services).

Type: apiKey
In: header

Exempel

Add participants

Sample Request

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

Sample Response

Status code:: 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"
    }
  ]
}

Status code:: 401

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

Status code:: 403

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

Status code:: 429

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

Status code:: 503

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

Definitioner

Name	Description
AddChatParticipantsRequest	Deltagare som ska läggas till i tråden.
AddChatParticipantsResult	Resultatet av åtgärden Lägg till chattdeltagare.
ChatParticipant	En deltagare i chatttråden.

AddChatParticipantsRequest

Deltagare som ska läggas till i tråden.

Name	Typ	Description
participants	ChatParticipant[]	Deltagare att lägga till i en chatttråd.

AddChatParticipantsResult

Resultatet av åtgärden Lägg till chattdeltagare.

Name	Typ	Description
invalidParticipants	CommunicationError[]	De deltagare som inte kunde läggas till i chatttråden.

ChatParticipant

En deltagare i chatttråden.

Name	Typ	Description
communicationIdentifier	CommunicationIdentifierModel
displayName	string	Visningsnamn för chattdeltagaren.
metadata	object	Kontextuella metadata för chattdeltagaren. Metadata består av namn/värde-par. Den totala storleken på alla metadatapar kan vara upp till 1 KB i storlek.
shareHistoryTime	string	Tid från vilken chatthistoriken delas med deltagaren. Tidsstämpeln är i RFC3339 format: `yyyy-MM-ddTHH:mm:ssZ`.

Dela via