你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

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 通信资源的终结点。
api-version	query	True	string	要调用的 API 版本。

请求头

名称	必需	类型	说明
Authorization	True	string	ACS（Azure 通信服务）用户访问令牌。

请求正文

名称	必需	类型	说明
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 通信服务）用户访问令牌。

类型: apiKey
在: header

示例

Send Message

示例请求

HTTP

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。