Chat Thread - Send Typing Notification

Référence

Service:: Communication

Version d'API:: 2024-03-15-preview

Publie un événement de frappe sur un fil, pour le compte d’un utilisateur.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
chatThreadId	path	True	string	ID du thread.
endpoint	path	True	string	Point de terminaison de la ressource Azure Communication.
api-version	query	True	string	Version de l’API à appeler.

En-tête de la demande

Nom	Obligatoire	Type	Description
Authorization	True	string	Jeton d’accès utilisateur ACS (Azure Communication Services).

Corps de la demande

Nom	Type	Description
senderDisplayName	string	Nom d’affichage de l’expéditeur de la notification de saisie. Cette propriété est utilisée pour renseigner le nom de l’expéditeur pour les notifications Push.

Réponses

Nom	Type	Description
200 OK		La demande a réussi.
401 Unauthorized	CommunicationErrorResponse	Non autorisé.
403 Forbidden	CommunicationErrorResponse	Interdit.
429 Too Many Requests	CommunicationErrorResponse	Trop grand nombre de requêtes.
Other Status Codes	CommunicationErrorResponse	Service indisponible.

Sécurité

Authorization

Jeton d’accès utilisateur ACS (Azure Communication Services).

Type: apiKey
Dans: header

Exemples

Post typing event to a thread

Exemple de requête

HTTP

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

{
  "senderDisplayName": "Jane"
}

Exemple de réponse

Code d’état:: 200

Code d’état:: 401

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

Code d’état:: 403

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

Code d’état:: 429

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

Code d’état:: 503

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

Définitions

SendTypingNotificationRequest

Charge utile de requête pour les notifications de saisie.

Nom	Type	Description
senderDisplayName	string	Nom d’affichage de l’expéditeur de la notification de saisie. Cette propriété est utilisée pour renseigner le nom de l’expéditeur pour les notifications Push.

Partager via