次の方法で共有

Chat Thread - Send Chat Message

  • リファレンス
サービス:
Communication
API バージョン:
2024-03-07

スレッドにメッセージを送信します。

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

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) ユーザー アクセス トークン。

要求本文

名前 必須 型 説明
content True

string

チャット メッセージの内容。
metadata

object

メッセージ メタデータ。
senderDisplayName

string

チャット メッセージ送信者の表示名。 このプロパティは、プッシュ通知の送信者名を設定するために使用されます。
type

ChatMessageType

チャット メッセージの種類。

応答

名前 型 説明
201 Created

SendChatMessageResult

メッセージが送信されました。Location ヘッダーには、新しく送信されたメッセージの URL が含まれています。
401 Unauthorized

CommunicationErrorResponse

不正。
403 Forbidden

CommunicationErrorResponse

禁じられた。
429 Too Many Requests

CommunicationErrorResponse

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

CommunicationErrorResponse

サービスは使用できません。

セキュリティ

Authorization

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

型: apiKey
/: header

例

Send Message

要求のサンプル

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

{
  "content": "Let's head out for lunch in 15 minutes.",
  "senderDisplayName": "Jane",
  "metadata": {
    "someKey1": "someValue1",
    "someKey2": "someValue2"
  }
}

応答のサンプル

状態コード:
201 
Location: https://contoso.westus.communications.azure.com/chat/threads/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/messages/1593072104708
{
  "id": "1593072104708"
}
状態コード:
401 
{
  "error": {
    "code": "Unauthorized",
    "message": "Request is not authorized."
  }
}
状態コード:
403 
{
  "error": {
    "code": "Forbidden",
    "message": "User is not allowed to perform specified action."
  }
}
状態コード:
429 
{
  "error": {
    "code": "TooManyRequests",
    "message": "Rate limit exceeded."
  }
}
状態コード:
503 
{
  "error": {
    "code": "ServiceUnavailable",
    "message": "The server is currently unable to handle the request."
  }
}

定義

名前 説明
ChatMessageType

チャット メッセージの種類。
SendChatMessageRequest

送信するメッセージの詳細。
SendChatMessageResult

メッセージ送信操作の結果。

ChatMessageType

チャット メッセージの種類。

名前 型 説明
html

string

participantAdded

string

participantRemoved

string

text

string

topicUpdated

string

SendChatMessageRequest

送信するメッセージの詳細。

名前 型 説明
content

string

チャット メッセージの内容。
metadata

object

メッセージ メタデータ。
senderDisplayName

string

チャット メッセージ送信者の表示名。 このプロパティは、プッシュ通知の送信者名を設定するために使用されます。
type

ChatMessageType

チャット メッセージの種類。

SendChatMessageResult

メッセージ送信操作の結果。

名前 型 説明
id

string

サーバーによって生成されたメッセージ ID。