Chat Thread - Send Typing Notification

  • Reference
Service:
Communication
API Version:
2024-03-07

Posts a typing event to a thread, on behalf of a user.

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

URI Parameters

Name In Required Type Description
chatThreadId
 path True

string

Id of the thread.
endpoint
 path True

string

The endpoint of the Azure Communication resource.
api-version
 query True

string

Version of API to invoke.

Request Header

Name Required Type Description
Authorization True

string

An ACS (Azure Communication Services) user access token.

Request Body

Name Type Description
senderDisplayName

string

The display name of the typing notification sender. This property is used to populate sender name for push notifications.

Responses

Name Type Description
200 OK

Request successful.
401 Unauthorized

CommunicationErrorResponse

Unauthorized.
403 Forbidden

CommunicationErrorResponse

Forbidden.
429 Too Many Requests

CommunicationErrorResponse

Too many requests.
Other Status Codes

CommunicationErrorResponse

Service unavailable.

Security

Authorization

An ACS (Azure Communication Services) user access token.

Type: apiKey
In: header

Examples

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-07

{
  "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."
  }
}

Definitions

SendTypingNotificationRequest

Request payload for typing notifications.

Name Type Description
senderDisplayName

string

The display name of the typing notification sender. This property is used to populate sender name for push notifications.