Share via

Chat Thread - Send Typing Notification

  • Referência
Service:
Communication
API Version:
2024-03-15-preview

Publica um evento de escrita num tópico, em nome de um utilizador.

POST {endpoint}/chat/threads/{chatThreadId}/typing?api-version=2024-03-15-preview

Parâmetros do URI

Name Em Necessário Tipo Description
chatThreadId
 path True

string

ID do thread.
endpoint
 path True

string

O ponto final 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 utilizador ACS (Azure Communication Services).

Corpo do Pedido

Name Tipo Description
senderDisplayName

string

O nome a apresentar do remetente de notificação de escrita. Esta propriedade é utilizada para preencher o nome do remetente para notificações push.

Respostas

Name Tipo Description
200 OK

Pedido com êxito.
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 utilizador ACS (Azure Communication Services).

Type: apiKey
In: header

Exemplos

Post typing event to a thread

Sample Request

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

{
  "senderDisplayName": "Jane"
}

Sample Response

Status code:
200
Status code:
401 
{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}
Status code:
403 
{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}
Status code:
429 
{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}
Status code:
503 
{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

Definições

SendTypingNotificationRequest

Pedir payload para escrever notificações.

Name Tipo Description
senderDisplayName

string

O nome a apresentar do remetente de notificação de escrita. Esta propriedade é utilizada para preencher o nome do remetente para notificações push.