Share via

Chat Thread - Send Typing Notification

  • リファレンス
Service:
Communication
API Version:
2024-03-15-preview

ユーザーに代わって入力イベントをスレッドにポストします。

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

URI パラメーター

名前 / 必須 型 説明
chatThreadId
 path True

string

スレッドの ID。
endpoint
 path True

string

Azure Communication リソースのエンドポイント。
api-version
 query True

string

呼び出す API のバージョン。

要求ヘッダー

名前 必須 型 説明
Authorization True

string

ACS (Azure Communication Services) ユーザー アクセス トークン。

要求本文

名前 型 説明
senderDisplayName

string

入力通知送信者の表示名。 このプロパティは、プッシュ通知の送信者名を設定するために使用されます。

応答

名前 型 説明
200 OK

要求が成功しました。
401 Unauthorized

CommunicationErrorResponse

権限がありません。
403 Forbidden

CommunicationErrorResponse

Forbidden.
429 Too Many Requests

CommunicationErrorResponse

要求が多すぎます。
Other Status Codes

CommunicationErrorResponse

Service unavailable. (サービス利用不可。)

セキュリティ

Authorization

ACS (Azure Communication Services) ユーザー アクセス トークン。

Type: apiKey
In: header

例

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

定義

SendTypingNotificationRequest

通知を入力するための要求ペイロード。

名前 型 説明
senderDisplayName

string

入力通知送信者の表示名。 このプロパティは、プッシュ通知の送信者名を設定するために使用されます。