Share via

Chat Thread - Send Typing Notification

  • Reference
Service:
Communication
API Version:
2024-03-15-preview

Publikuje událost psaní do vlákna jménem uživatele.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
chatThreadId
 path True

string

ID vlákna.
endpoint
 path True

string

Koncový bod prostředku Azure Communication.
api-version
 query True

string

Verze rozhraní API, která se má vyvolat.

Hlavička požadavku

Name Vyžadováno Typ Description
Authorization True

string

Přístupový token uživatele služby ACS (Azure Communication Services).

Text požadavku

Name Typ Description
senderDisplayName

string

Zobrazovaný název odesílatele oznámení o psaní. Tato vlastnost se používá k vyplnění jména odesílatele pro nabízená oznámení.

Odpovědi

Name Typ Description
200 OK

Žádost byla úspěšná.
401 Unauthorized

CommunicationErrorResponse

Neautorizováno
403 Forbidden

CommunicationErrorResponse

Zakázáno.
429 Too Many Requests

CommunicationErrorResponse

Příliš mnoho požadavků.
Other Status Codes

CommunicationErrorResponse

Nedostupná služba.

Zabezpečení

Authorization

Přístupový token uživatele služby ACS (Azure Communication Services).

Type: apiKey
In: header

Příklady

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

Definice

SendTypingNotificationRequest

Vyžádejte si datovou část pro zadání oznámení.

Name Typ Description
senderDisplayName

string

Zobrazovaný název odesílatele oznámení o psaní. Tato vlastnost se používá k vyplnění jména odesílatele pro nabízená oznámení.