Chat Thread - Add Chat Participants
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-07
URI-parametrar
Name | I | Obligatorisk | Typ | Description |
---|---|---|---|---|
chat
|
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 |
Deltagare att lägga till i en chatttråd. |
Svar
Name | Typ | Description |
---|---|---|
201 Created |
Deltagarna har lagts till. |
|
401 Unauthorized |
Communication |
Obehörig. |
403 Forbidden |
Communication |
Förbjuden. |
429 Too Many Requests |
Communication |
För många begäranden. |
Other Status Codes |
Communication |
Tjänsten är inte tillgänglig. |
Säkerhet
Authorization
En ACS-användaråtkomsttoken (Azure Communication Services).
Typ:
apiKey
I:
header
Exempel
Add participants
Exempelbegäran
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"
}
]
}
Exempelsvar
{
"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"
}
]
}
{
"error": {
"code": "Unauthorized",
"message": "Request is not authorized."
}
}
{
"error": {
"code": "Forbidden",
"message": "User is not allowed to perform specified action."
}
}
{
"error": {
"code": "TooManyRequests",
"message": "Rate limit exceeded."
}
}
{
"error": {
"code": "ServiceUnavailable",
"message": "The server is currently unable to handle the request."
}
}
Definitioner
Name | Description |
---|---|
Add |
Deltagare som ska läggas till i tråden. |
Add |
Resultatet av åtgärden lägg till chattdeltagare. |
Chat |
En deltagare i chatttråden. |
AddChatParticipantsRequest
Deltagare som ska läggas till i tråden.
Name | Typ | Description |
---|---|---|
participants |
Deltagare att lägga till i en chatttråd. |
AddChatParticipantsResult
Resultatet av åtgärden lägg till chattdeltagare.
Name | Typ | Description |
---|---|---|
invalidParticipants |
Communication |
De deltagare som inte kunde läggas till i chatttråden. |
ChatParticipant
En deltagare i chatttråden.
Name | Typ | Description |
---|---|---|
communicationIdentifier |
Communication |
|
displayName |
string |
Visningsnamn för chattdeltagaren. |
shareHistoryTime |
string |
Tid från vilken chatthistoriken delas med deltagaren. Tidsstämpeln är i RFC3339 format: |