Chat Thread - Send Chat Message

Referência

Serviço:: Communication

Versão da API:: 2024-03-07

Envia uma mensagem para um thread.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
chatThreadId	path	True	string	A ID do thread para a qual enviar a mensagem.
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 ser invocada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Um token de acesso de usuário do ACS (Serviços de Comunicação do Azure).

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
content	True	string	Conteúdo da mensagem de chat.
metadata		object	Metadados de mensagem.
senderDisplayName		string	O nome de exibição do remetente da mensagem de chat. Essa propriedade é usada para preencher o nome do remetente para notificações por push.
type		ChatMessageType	O tipo de mensagem de chat.

Respostas

Nome	Tipo	Description
201 Created	SendChatMessageResult	Mensagem enviada, o cabeçalho `Location` contém a URL da mensagem enviada recentemente.
401 Unauthorized	CommunicationErrorResponse	Desautorizado.
403 Forbidden	CommunicationErrorResponse	Proibido.
429 Too Many Requests	CommunicationErrorResponse	Muitas solicitações.
Other Status Codes	CommunicationErrorResponse	Serviço indisponível.

Segurança

Authorization

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

Tipo: apiKey
Em: header

Exemplos

Send Message

Solicitação de exemplo

HTTP

POST https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/messages?api-version=2024-03-07

{
  "content": "Let's head out for lunch in 15 minutes.",
  "senderDisplayName": "Jane",
  "metadata": {
    "someKey1": "someValue1",
    "someKey2": "someValue2"
  }
}

Resposta de exemplo

Código de status:: 201

Location: https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/messages/1593072104708

{
  "id": "1593072104708"
}

Código de status:: 401

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

Código de status:: 403

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

Código de status:: 429

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

Código de status:: 503

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

Definições

Nome	Description
ChatMessageType	O tipo de mensagem de chat.
SendChatMessageRequest	Detalhes da mensagem a ser enviada.
SendChatMessageResult	Resultado da operação de envio de mensagem.

ChatMessageType

O tipo de mensagem de chat.

Nome	Tipo	Description
html	string
participantAdded	string
participantRemoved	string
text	string
topicUpdated	string

SendChatMessageRequest

Detalhes da mensagem a ser enviada.

Nome	Tipo	Description
content	string	Conteúdo da mensagem de chat.
metadata	object	Metadados de mensagem.
senderDisplayName	string	O nome de exibição do remetente da mensagem de chat. Essa propriedade é usada para preencher o nome do remetente para notificações por push.
type	ChatMessageType	O tipo de mensagem de chat.

SendChatMessageResult

Resultado da operação de envio de mensagem.

Nome	Tipo	Description
id	string	Uma ID de mensagem gerada pelo servidor.

Compartilhar via