Partilhar via

Chat - Create Chat Thread

Serviço:
Communication
Versão da API:
2025-03-15

Cria um thread de chat.

POST {endpoint}/chat/threads?api-version=2025-03-15

Parâmetros do URI

Name Em Necessário Tipo Description
endpoint
 path True

string

O ponto de extremidade do recurso de Comunicação do Azure.
api-version
 query True

string

Versão da API a invocar.

Cabeçalho do Pedido

Name Necessário Tipo Description
Authorization True

string

Um token de acesso de usuário ACS (Serviços de Comunicação do Azure).
repeatability-request-id

string

Se especificado, o cliente direciona que a solicitação é repetível; ou seja, que o cliente pode fazer a solicitação várias vezes com o mesmoRequest-Id de repetibilidade e obter de volta uma resposta apropriada sem que o servidor execute a solicitação várias vezes. O valor daRequest-Id de repetibilidade é uma cadeia de caracteres opaca que representa um identificador gerado pelo cliente, globalmente exclusivo para todos os tempos, para a solicitação. Recomenda-se o uso da versão 4 (aleatória) UUIDs.

Corpo do Pedido

Name Necessário Tipo Description
topic True

string

O tópico do tópico do chat.
metadata

object

Metadados contextuais para o thread. Os metadados consistem em pares nome/valor. O tamanho total de todos os pares de metadados pode ser de até 1 KB.
participants

ChatParticipant[]

Participantes a serem adicionados ao tópico de chat.
retentionPolicy ChatRetentionPolicy:

Política de retenção de dados para exclusão automática.

Respostas

Name Tipo Description
201 Created

CreateChatThreadResult

Thread criado, o cabeçalho Location conteria a URL para o thread recém-criado.
401 Unauthorized

CommunicationErrorResponse

Não autorizado.
403 Forbidden

CommunicationErrorResponse

Proibido.
429 Too Many Requests

CommunicationErrorResponse

Demasiados pedidos.
Other Status Codes

CommunicationErrorResponse

Serviço indisponível.

Segurança

Authorization

Um token de acesso de usuário ACS (Serviços de Comunicação do Azure).

Tipo: apiKey
Em: header

Exemplos

Create chat thread
Create chat thread with repeatability request id header

Create chat thread

Pedido de amostra

POST https://contoso.westus.communications.azure.com/chat/threads?api-version=2025-03-15

{
  "topic": "Lunch",
  "retentionPolicy": {
    "kind": "threadCreationDate",
    "deleteThreadAfterDays": 30
  },
  "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": "Jane"
    },
    {
      "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": "Alex"
    },
    {
      "communicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a"
        }
      },
      "displayName": "Bob"
    },
    {
      "communicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b"
        }
      },
      "displayName": "Peter"
    }
  ]
}

Resposta da amostra

Código de estado:
201 
Location: https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2
{
  "chatThread": {
    "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2",
    "topic": "Lunch",
    "createdOn": "2020-06-06T05:55:41.6460000Z",
    "createdByCommunicationIdentifier": {
      "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"
      }
    },
    "retentionPolicy": {
      "kind": "threadCreationDate",
      "deleteThreadAfterDays": 30
    }
  },
  "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"
    }
  ]
}
Código de estado:
401 
{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}
Código de estado:
403 
{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}
Código de estado:
429 
{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}
Código de estado:
503 
{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

Create chat thread with repeatability request id header

Pedido de amostra

POST https://contoso.westus.communications.azure.com/chat/threads?api-version=2025-03-15

{
  "topic": "Lunch",
  "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": "Jane"
    },
    {
      "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": "Alex"
    },
    {
      "communicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_a34d2d65-d72f-4c48-a12c-2d5c9ac75a1a"
        }
      },
      "displayName": "Bob"
    },
    {
      "communicationIdentifier": {
        "rawId": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b",
        "communicationUser": {
          "id": "8:acs:8540c0de-899f-5cce-acb5-3ec493af3800_f6762773-e33a-4727-985f-50bd1d197c7b"
        }
      },
      "displayName": "Peter"
    }
  ]
}

Resposta da amostra

Código de estado:
201 
Location: https://contoso.westus.communications.azure.com/chat/threads/19%3Auni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2
{
  "chatThread": {
    "id": "19:uni01_zbnh3nt2dfuffezc3sox7dog7wfhk6y5qe2rwlnfhlhdzirihdpq@thread.v2",
    "topic": "Lunch",
    "createdOn": "2020-06-06T05:55:41.6460000Z",
    "createdByCommunicationIdentifier": {
      "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"
      }
    }
  },
  "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"
    }
  ]
}
Código de estado:
401 
{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}
Código de estado:
403 
{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}
Código de estado:
429 
{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}
Código de estado:
503 
{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

Definições

Name Description
ChatParticipant

Um participante do tópico de bate-papo.
ChatThreadProperties

Tópico de bate-papo.
CreateChatThreadRequest

Solicite carga útil para criar um thread de chat.
CreateChatThreadResult

Resultado da operação de criação de thread de chat.
NoneRetentionPolicy

Nenhuma política de retenção de threads.
ThreadCreationDateRetentionPolicy

Política de retenção de threads com base na data de criação do thread.

ChatParticipant

Object

Um participante do tópico de bate-papo.

Name Tipo Description
communicationIdentifier

CommunicationIdentifierModel

displayName

string

Nome de exibição para o participante do bate-papo.
metadata

object

Metadados contextuais para o participante do chat. Os metadados consistem em pares nome/valor. O tamanho total de todos os pares de metadados pode ser de até 1 KB.
shareHistoryTime

string (date-time)

Hora a partir da qual o histórico do chat é partilhado com o participante. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.

ChatThreadProperties

Object

Tópico de bate-papo.

Name Tipo Description
createdByCommunicationIdentifier

CommunicationIdentifierModel

createdOn

string (date-time)

O carimbo de data/hora quando o thread de bate-papo foi criado. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
deletedOn

string (date-time)

O carimbo de data/hora quando o thread de bate-papo foi excluído. O carimbo de data/hora está no formato RFC3339: yyyy-MM-ddTHH:mm:ssZ.
id

string

ID do tópico de chat.
metadata

object

Metadados contextuais para o thread. Os metadados consistem em pares nome/valor. O tamanho total de todos os pares de metadados pode ser de até 1 KB.
retentionPolicy ChatRetentionPolicy:

Política de retenção de dados para exclusão automática.
topic

string

Tópico do tópico do bate-papo.

CreateChatThreadRequest

Object

Solicite carga útil para criar um thread de chat.

Name Tipo Description
metadata

object

Metadados contextuais para o thread. Os metadados consistem em pares nome/valor. O tamanho total de todos os pares de metadados pode ser de até 1 KB.
participants

ChatParticipant[]

Participantes a serem adicionados ao tópico de chat.
retentionPolicy ChatRetentionPolicy:

Política de retenção de dados para exclusão automática.
topic

string

O tópico do tópico do chat.

CreateChatThreadResult

Object

Resultado da operação de criação de thread de chat.

Name Tipo Description
chatThread

ChatThreadProperties

Tópico de bate-papo.
invalidParticipants

CommunicationError[]

Os participantes que não puderam ser adicionados ao tópico de chat.

NoneRetentionPolicy

Object

Nenhuma política de retenção de threads.

Name Tipo Description
kind string:

none

Tipo de política de retenção

ThreadCreationDateRetentionPolicy

Object

Política de retenção de threads com base na data de criação do thread.

Name Tipo Description
deleteThreadAfterDays

integer (int32)

Indica quantos dias após a criação do thread o thread será excluído.
kind string:

threadCreationDate

Tipo de política de retenção