Chat Thread - Send Chat Message

서비스:

Communication

API 버전:

2024-03-07

스레드에 메시지를 보냅니다.

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

URI 매개 변수

Name	In(다음 안에)	필수	형식	Description
chatThreadId	path	True	string	메시지를 보낼 스레드 ID입니다.
endpoint	path	True	string	Azure Communication 리소스의 엔드포인트입니다.
api-version	query	True	string	호출할 API의 버전입니다.

요청 헤더

Name	필수	형식	Description
Authorization	True	string	ACS(Azure Communication Services) 사용자 액세스 토큰입니다.

요청 본문

Name	필수	형식	Description
content	True	string	채팅 메시지 콘텐츠입니다.
metadata		object	메시지 메타데이터입니다.
senderDisplayName		string	채팅 메시지 보낸 사람의 표시 이름입니다. 이 속성은 푸시 알림의 보낸 사람 이름을 채우는 데 사용됩니다.
type		ChatMessageType	채팅 메시지 유형입니다.

응답

Name	형식	Description
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
In(다음 안에): 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."
  }
}

정의

Name	Description
ChatMessageType	채팅 메시지 유형입니다.
SendChatMessageRequest	보낼 메시지의 세부 정보입니다.
SendChatMessageResult	메시지 보내기 작업의 결과입니다.

ChatMessageType

채팅 메시지 유형입니다.

Name	형식	Description
html	string
participantAdded	string
participantRemoved	string
text	string
topicUpdated	string

SendChatMessageRequest

보낼 메시지의 세부 정보입니다.

Name	형식	Description
content	string	채팅 메시지 콘텐츠입니다.
metadata	object	메시지 메타데이터입니다.
senderDisplayName	string	채팅 메시지 보낸 사람의 표시 이름입니다. 이 속성은 푸시 알림의 보낸 사람 이름을 채우는 데 사용됩니다.
type	ChatMessageType	채팅 메시지 유형입니다.

SendChatMessageResult

메시지 보내기 작업의 결과입니다.

Name	형식	Description
id	string	서버에서 생성된 메시지 ID입니다.