Conversation Thread Operations - List Conversations

Referência

Serviço:: Communication

Versão da API:: 2025-04-01-preview

Recupera a lista de conversas.

GET {endpoint}/messages/conversations?api-version=2025-04-01-preview

Com parâmetros opcionais:

GET {endpoint}/messages/conversations?api-version=2025-04-01-preview&maxPageSize={maxPageSize}&participantId={participantId}&channelId={channelId}

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string (uri)	O recurso de comunicação, por exemplo, https://my-resource.communication.azure.com
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.
channelId	query		string (uuid)	A ID do canal
maxPageSize	query		integer (int32)	Número de objetos a serem retornados por página.
participantId	query		string	A ID do usuário participante

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
x-ms-client-request-id		string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Respostas

Nome	Tipo	Description
200 OK	PagedConversation	A solicitação foi bem-sucedida. Cabeçalhos x-ms-client-request-id: string
Other Status Codes	Azure.Core.Foundations.ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

200 OK

PagedConversation

A solicitação foi bem-sucedida.

Cabeçalhos

x-ms-client-request-id: string

Other Status Codes

Azure.Core.Foundations.ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

AadOauth2Auth

O fluxo OAuth2 do Azure Active Directory

Tipo: oauth2
Flow: accessCode
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize
URL do Token: https://login.microsoftonline.com/common/oauth2/token

Escopos

Nome	Description
https://communication.azure.com/.default

Authorization

Tipo: apiKey
Em: header

Exemplos

Retrieves list of conversations

Solicitação de exemplo

HTTP

GET https://my-resource.communication.azure.com/messages/conversations?api-version=2025-04-01-preview&maxPageSize=25&channelId=0f0eb78e-a576-1dfc-b414-0f0756de3338

Resposta de exemplo

Código de status:: 200

{
  "value": [
    {
      "id": "19:34adfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2",
      "topic": "Test",
      "deliveryChannelIds": [
        "0f0eb78e-a576-1dfc-b414-0f0756de3338"
      ],
      "outboundDeliveryStrategy": "allParticipants",
      "participants": [
        {
          "id": "8:acs:uuid2",
          "displayName": "Customer",
          "kind": "external",
          "contacts": [
            {
              "id": "12345678901",
              "kind": "whatsApp"
            },
            {
              "id": "8:acs:uuid2",
              "kind": "communication"
            }
          ]
        },
        {
          "id": "8:acs:uuid1",
          "displayName": "Support",
          "kind": "internal",
          "contact": {
            "id": "8:acs:uuid1",
            "kind": "communication"
          }
        }
      ]
    },
    {
      "id": "19:111dfa4f-cedf-4dc0-ba29-b6d1a69ab345@thread.v2",
      "topic": "Test",
      "deliveryChannelIds": [
        "0f0eb78e-a576-1dfc-b414-0f0756de3338"
      ],
      "outboundDeliveryStrategy": "allParticipants",
      "participants": [
        {
          "id": "8:acs:uuid3",
          "displayName": "Customer",
          "kind": "external",
          "contacts": [
            {
              "id": "12331112222",
              "kind": "whatsApp"
            },
            {
              "id": "8:acs:uuid3",
              "kind": "communication"
            }
          ]
        },
        {
          "id": "8:acs:uuid3",
          "displayName": "Support",
          "kind": "internal",
          "contact": {
            "id": "8:acs:uuid3",
            "kind": "communication"
          }
        }
      ]
    }
  ]
}

Definições

Nome	Description
Azure.Core.Foundations.Error	O objeto de erro.
Azure.Core.Foundations.ErrorResponse	Uma resposta que contém detalhes do erro.
Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.
BotContact	Contato do Bot.
CommunicationContact	Contato de comunicação.
CommunicationConversation	Uma conversa.
ExternalConversationParticipant	Participante da conversa externa.
InternalConversationParticipant	Participante da conversa interna.
MessagePlatformKind	Define o tipo de plataforma de mensagem.
OutboundDeliveryStrategyKind	As opções da estratégia de entrega de saída para mensagens enviadas por participantes em uma conversa.
PagedConversation	Coleção de páginas de itens de conversa
ParticipantKind	O tipo de um participante em uma conversa encadeada.
WhatsAppContact	Contato do WhatsApp.

Azure.Core.Foundations.Error

Objeto

O objeto de erro.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
details	Azure.Core.Foundations.Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	Azure.Core.Foundations.InnerError	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

Azure.Core.Foundations.ErrorResponse

Objeto

Uma resposta que contém detalhes do erro.

Nome	Tipo	Description
error	Azure.Core.Foundations.Error	O objeto de erro.

Azure.Core.Foundations.InnerError

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/microsoft/api-guidelines/blob/vNext/azure/Guidelines.md#handling-errors.

Nome	Tipo	Description
code	string	Um de um conjunto definido pelo servidor de códigos de erro.
innererror	Azure.Core.Foundations.InnerError	Erro interno.

BotContact

Objeto

Contato do Bot.

Nome	Tipo	Description
botAppId	string	ID do aplicativo bot do Contato do Bot.
id	string	Identificador de plataforma externa.
kind	string: bot	Tipo de plataforma de mensagens (por exemplo, WhatsApp).

CommunicationContact

Objeto

Contato de comunicação.

Nome	Tipo	Description
id	string	Identificador de plataforma externa.
kind	string: communication	Tipo de plataforma de mensagens (por exemplo, WhatsApp).

CommunicationConversation

Objeto

Uma conversa.

Nome	Tipo	Description
deliveryChannelIds	string[]	Lista de IDs do canal de entrega.
id	string	A ID da conversa.
outboundDeliveryStrategy	OutboundDeliveryStrategyKind	Estratégia de entrega de saída para a conversa.
participants	ConversationParticipant[]: ExternalConversationParticipant[] InternalConversationParticipant[]	Lista de participantes envolvidos na conversa.
topic	string	O tópico da conversa.

ExternalConversationParticipant

Objeto

Participante da conversa externa.

Nome	Tipo	Description
contacts	Contact[]: BotContact[] CommunicationContact[] WhatsAppContact[]	Lista de identificadores de plataforma externa para o participante.
displayName	string	Nome de exibição do participante.
id	string	Identificador do participante.
kind	string: external	O tipo discriminatório que descreve um tipo de participante.

InternalConversationParticipant

Objeto

Participante da conversa interna.

Nome	Tipo	Description
contact	Contact: BotContact CommunicationContact WhatsAppContact	Os identificadores internos da plataforma para o participante.
displayName	string	Nome de exibição do participante.
id	string	Identificador do participante.
kind	string: internal	O tipo discriminatório que descreve um tipo de participante.

MessagePlatformKind

Enumeração

Define o tipo de plataforma de mensagem.

Valor	Description
bot	Plataforma de bot.
communication	Plataforma de Comunicação do Azure.
whatsApp	Plataforma WhatsApp.

OutboundDeliveryStrategyKind

Enumeração

As opções da estratégia de entrega de saída para mensagens enviadas por participantes em uma conversa.

Valor	Description
allParticipants	Estratégia de entrega para todos os participantes.
internalOnly	Estratégia de entrega somente interna.

PagedConversation

Objeto

Coleção de páginas de itens de conversa

Nome	Tipo	Description
nextLink	string (uri)	O link para a próxima página de itens
value	CommunicationConversation[]	Os itens de conversa nesta página

ParticipantKind

Enumeração

O tipo de um participante em uma conversa encadeada.

Valor	Description
external	Um participante em outras plataformas
internal	Um participante interno dos Serviços de Comunicação do Azure.

WhatsAppContact

Objeto

Contato do WhatsApp.

Nome	Tipo	Description
id	string	Identificador de plataforma externa.
kind	string: whatsApp	Tipo de plataforma de mensagens (por exemplo, WhatsApp).

Compartilhar via

Conversation Thread Operations - List Conversations

Parâmetros de URI

Cabeçalho da solicitação

Respostas

Segurança

AadOauth2Auth

Escopos

Authorization

Exemplos

Retrieves list of conversations

Solicitação de exemplo

Resposta de exemplo

Definições

Azure.Core.Foundations.Error

Azure.Core.Foundations.ErrorResponse

Azure.Core.Foundations.InnerError

BotContact

CommunicationContact

CommunicationConversation

ExternalConversationParticipant

InternalConversationParticipant

MessagePlatformKind

OutboundDeliveryStrategyKind

PagedConversation

ParticipantKind

WhatsAppContact