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 do URI

Name	Em	Necessário	Tipo	Description
chatThreadId	path	True	string	O ID do thread para o 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 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).

Corpo do Pedido

Name	Necessário	Tipo	Description
content	True	string	Conteúdo da mensagem de chat.
metadata		object	Metadados da mensagem.
senderDisplayName		string	O nome para 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

Name	Tipo	Description
201 Created	SendChatMessageResult	Mensagem enviada, o cabeçalho `Location` contém o URL da mensagem recém-enviada.
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

Send Message

Pedido de amostra

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 da amostra

Código de estado:: 201

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

{
  "id": "1593072104708"
}

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
ChatMessageType	O tipo de mensagem de chat.
SendChatMessageRequest	Detalhes da mensagem a enviar.
SendChatMessageResult	Resultado da operação de envio de mensagem.

ChatMessageType

O tipo de mensagem de chat.

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

SendChatMessageRequest

Detalhes da mensagem a enviar.

Name	Tipo	Description
content	string	Conteúdo da mensagem de chat.
metadata	object	Metadados da mensagem.
senderDisplayName	string	O nome para 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.

Name	Tipo	Description
id	string	Um ID de mensagem gerado pelo servidor.

Partilhar via