Поделиться через

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

Идентификатор потока для отправки сообщения.
endpoint
 path True

string

Конечная точка ресурса связи Azure.
api-version
 query True

string

Версия API для вызова.

Заголовок запроса

Имя Обязательно Тип Описание
Authorization True

string

Маркер доступа пользователей ACS (Службы коммуникации Azure).

Текст запроса

Имя Обязательно Тип Описание
content True

string

Содержимое сообщения чата.
metadata

object

Метаданные сообщения.
senderDisplayName

string

Отображаемое имя отправителя сообщения чата. Это свойство используется для заполнения имени отправителя для push-уведомлений.
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

Образец запроса

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
participantAdded
participantRemoved
text
topicUpdated

SendChatMessageRequest

Object

Сведения о сообщении для отправки.

Имя Тип Описание
content

string

Содержимое сообщения чата.
metadata

object

Метаданные сообщения.
senderDisplayName

string

Отображаемое имя отправителя сообщения чата. Это свойство используется для заполнения имени отправителя для push-уведомлений.
type

ChatMessageType

Тип сообщения чата.

SendChatMessageResult

Object

Результат операции отправки сообщения.

Имя Тип Описание
id

string

Идентификатор сообщения, созданного сервером.