Method: spaces.messages.create

Google Chat 스페이스에 메시지를 만듭니다. 예를 참고하세요. 메시지 보내기

다음 인증 유형을 지원합니다.

  • 앱 인증 승인 범위:
    • https://www.googleapis.com/auth/chat.bot
  • 사용자 인증 다음 승인 범위 중 하나를 사용하는:
    • https://www.googleapis.com/auth/chat.messages.create
    • https://www.googleapis.com/auth/chat.messages
    • https://www.googleapis.com/auth/chat.import (가져오기 모드 스페이스만 해당)

Chat은 요청에 사용하는 인증 유형에 따라 메시지 발신자를 다르게 속성 지정합니다.

다음 이미지는 앱 인증을 사용할 때 Chat에서 메시지를 속성 지정하는 방법을 보여줍니다. Chat은 Chat 앱을 메시지 발신자로 표시합니다. 메시지 콘텐츠에는 텍스트 (text), 카드 (cardsV2), 보조 위젯 (accessoryWidgets)이 포함될 수 있습니다.

앱 인증을 통해 전송된 메일

다음 이미지는 사용자 인증을 사용할 때 Chat에서 메시지를 속성 지정하는 방법을 보여줍니다. Chat은 사용자를 메시지 발신자로 표시하고 이름을 표시하여 Chat 앱을 메시지에 속성 지정합니다. 메시지 콘텐츠에는 텍스트 (text)만 포함될 수 있습니다.

사용자 인증으로 전송된 메일

메시지 콘텐츠를 포함한 최대 메시지 크기는 32,000바이트입니다.

웹훅 요청의 경우 응답에 전체 메시지가 포함되지 않습니다. 응답은 요청에 포함된 정보 외에 name 및 thread.name 필드만 채웁니다.

HTTP 요청

POST https://chat.googleapis.com/v1/{parent=spaces/*}/messages

URL은 gRPC 트랜스코딩 구문을 사용합니다.

경로 매개변수

매개변수
parent

string

필수 항목입니다. 메시지를 만들 스페이스의 리소스 이름입니다.

형식: spaces/{space}

쿼리 파라미터

파라미터
threadKey
(deprecated)

string

선택사항입니다. 지원 중단됨: 대신 thread.thread_key를 사용하세요. 대화목록의 ID입니다. 최대 4,000자를 지원합니다. 대화목록을 시작하거나 대화목록에 추가하려면 메시지를 만들고 threadKey 또는 thread.name을 지정합니다. 사용 예는 메시지 대화목록 시작 또는 답장을 참고하세요.
requestId

string

선택사항입니다. 이 요청의 고유 ID입니다. 임의의 UUID를 사용하는 것이 좋습니다. 요청 ID를 지정하면 요청이 멱등해지므로 동일한 요청 ID가 있는 여러 동일한 요청으로 인해 메시지가 하나만 생성됩니다. 동일한 요청 ID가 있는 후속 요청은 요청된 세부정보가 현재 상태와 다르더라도 기존 메시지를 반환하고 메시지를 업데이트하지 않습니다.

이 필드를 효과적으로 사용하려면 다음 단계를 따르세요.

  • 후속 요청이 동일하고 원래 요청과 동일한 인증 사용자 인증 정보를 사용하는지 확인합니다.
  • 제공된 요청 ID로 메시지가 이미 생성된 경우 요청은 해당 메시지를 반환합니다. 반환된 메시지가 완전히 채워지지 않을 수 있습니다. API는 시스템 할당 리소스 이름이 채워진 요청의 메시지를 에코합니다. 메시지의 최신 메타데이터를 검색하려면 messages.get을 호출합니다.
  • 인증된 사용자가 다른 기존 요청 ID를 재사용하면 오류가 발생합니다.
messageReplyOption

enum (MessageReplyOption)

선택사항입니다. 메시지가 대화목록을 시작하는지 아니면 대화목록에 답장하는지 지정합니다. 이름이 지정된 스페이스에서만 지원됩니다.

사용자 상호작용에 응답할 때는 이 필드가 무시됩니다. 대화목록 내의 상호작용의 경우 답장이 동일한 대화목록에서 생성됩니다. 그렇지 않으면 답장이 새 대화목록으로 생성됩니다.
messageId

string

선택사항입니다. 메시지의 커스텀 ID입니다. Chat 앱에서 메시지의 리소스 이름 (메시지 name 필드에 표시됨)에 시스템 할당 ID를 저장하지 않고도 메시지를 가져오거나 업데이트하거나 삭제할 수 있습니다.

이 필드의 값은 다음 요구사항을 충족해야 합니다.

  • client-로 시작합니다. 예를 들어 client-custom-name은 유효한 커스텀 ID이지만 custom-name은 유효하지 않습니다.
  • 최대 63자로 구성되며 소문자, 숫자, 하이픈만 포함합니다.
  • 스페이스 내에서 고유합니다. Chat 앱은 서로 다른 메시지에 동일한 커스텀 ID를 사용할 수 없습니다.

자세한 내용은 메시지 이름 지정을 참고하세요.
createMessageNotificationOptions

object (CreateMessageNotificationOptions)

선택사항입니다. 메시지가 게시될 때 알림 동작을 제어합니다. 자세한 내용은 알림 강제 적용 또는 자동 메시지 전송을 참고하세요.

요청 본문

요청 본문에 Message의 인스턴스가 포함됩니다.

응답 본문

성공한 경우 응답 본문에 새로 생성된 Message의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

  • https://www.googleapis.com/auth/chat.bot
  • https://www.googleapis.com/auth/chat.import
  • https://www.googleapis.com/auth/chat.messages
  • https://www.googleapis.com/auth/chat.messages.create

자세한 내용은 승인 가이드를 참고하세요.

MessageReplyOption

메시지에 답장하는 방법을 지정합니다. 향후 더 많은 상태가 추가될 수 있습니다.

열거형
MESSAGE_REPLY_OPTION_UNSPECIFIED 기본값입니다. 새 대화목록을 시작합니다. 이 옵션을 사용하면 포함된 thread ID 또는 threadKey가 무시됩니다.
REPLY_MESSAGE_FALLBACK_TO_NEW_THREAD thread ID 또는 threadKey로 지정된 대화목록에 대한 답장으로 메시지를 만듭니다. 실패하면 메시지가 대신 새 대화목록을 시작합니다.
REPLY_MESSAGE_OR_FAIL thread ID 또는 threadKey로 지정된 대화목록에 대한 답장으로 메시지를 만듭니다. 새 threadKey를 사용하면 새 대화목록이 생성됩니다. 메시지 생성이 실패하면 대신 NOT_FOUND 오류가 반환됩니다.

CreateMessageNotificationOptions

메시지가 게시될 때 알림 동작의 옵션입니다.

JSON 표현 
{
  "notificationType": enum (NotificationType)
}
필드
notificationType

enum (NotificationType)

메시지의 알림 유형입니다.

NotificationType

메시지의 알림 유형 옵션입니다.

열거형
NOTIFICATION_TYPE_NONE 기본 동작입니다. 알림 동작은 실제 사용자가 Chat UI를 사용하여 메시지를 보낼 때와 유사합니다. 실제 발신자에게 알림이 전송되지 않습니다.
NOTIFICATION_TYPE_FORCE_NOTIFY

수신자에게 알림을 강제 적용합니다. 이렇게 하면 사용자의 스페이스 알림 설정 및 Chat 방해 금지 모드 설정이 무시됩니다. 이 옵션은 기기 수준의 방해 금지 설정을 무시하지 않습니다.

앱 인증이 필요합니다.
NOTIFICATION_TYPE_SILENT

수신자에게 알림을 보내지 않고 메시지를 읽지 않음으로 표시하지 않습니다. 이는 사용자가 대화를 음소거하거나 Chat 방해 금지를 사용 설정하는 것과 유사하게 작동합니다.

앱 인증이 필요합니다.