메시지 조회

Prev Next

Classic/VPC 환경에서 이용 가능합니다.

메시지의 상세 정보를 조회합니다.

요청

요청 형식을 설명합니다. 요청 형식은 다음과 같습니다.

메서드 URI
GET /v1/api/messages/{channelId}/{messageId}

요청 헤더

Ncloud Chat API에서 공통으로 사용하는 헤더에 대한 정보는 Ncloud Chat 요청 헤더를 참조해 주십시오.

요청 경로 파라미터

요청 경로 파라미터에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
channelId String Required 채널 아이디
messageId String Required 메시지 아이디

요청 예시

요청 예시는 다음과 같습니다.

curl --location --request GET 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/messages/8ed73d56-****-****-****-2bd6eb8b4a14/672036b**********125bc79"' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}'

응답

응답 형식을 설명합니다.

응답 바디

응답 바디에 대한 설명은 다음과 같습니다.

필드 타입 필수 여부 설명
id String - 메시지 아이디
message_id String - 메시지 아이디
channel_id String - 채널 아이디
sort_id String - 발신 일시
  • Unix Timestamp 형식
message_type String - 메시지 유형
  • text | file
sender Object - 발신자 정보
sender.id String - 발신자 아이디
sender.name String - 발신자 이름
sender.profile String - 발신자 프로필 이미지
admin Object - 관리자 정보
admin.id String - 관리자 아이디
admin.name String - 관리자 이름
admin.profile String - 관리자 프로필 이미지
attachment_filenames Object - 첨부 파일 정보
attachment_filenames.name String - 첨부 파일 이름
attachment_filenames.size Number - 첨부 파일 크기(Bytes)
attachment_filenames.type String - 첨부 파일 유형
attachment_filenames.url String - 첨부 파일 URL
has String - 첨부 특수 항목 구분 (기본값: "")
  • <예시> link, image, video, file
embed_providers String - 첨부 임베드 특수 항목의 제공자
embed_type String - 임베드 특수 항목의 유형 (기본값: "")
isExpress Boolean - 빠른 메시지 여부
  • true | false (기본값)
    • true: 빠른 메시지
    • false: 일반 메시지
link_hostnames String - 링크 호스트 이름
  • has가 link인 경우
mentions Array - 멘션 정보 (기본값: [])
mentions_everyone Boolean - 전체 멘션 여부
  • true | false (기본값)
    • true: 전체
    • false: 전체 아님
content String - 메시지 내용
sended_at String - 메시지 전송 일시
  • ISO 8601 형식
created_at String - 메시지 생성 일시
  • ISO 8601 형식

응답 상태 코드

Ncloud Chat API에서 공통으로 사용하는 응답 상태 코드에 대한 정보는 Ncloud Chat 응답 상태 코드를 참조해 주십시오.

응답 예시

응답 예시는 다음과 같습니다.

{
    "id": "672036b**********125bc79",
    "message_id": "672036b**********125bc79",
    "channel_id": "8ed73d56-****-****-****-2bd6eb8b4a14",
    "sort_id": "1730164402698",
    "message_type": "file",
    "sender": {
        "id": "radevjs3",
        "name": "radevjs3",
        "profile": ""
    },
    "admin": {
        "id": "",
        "name": "",
        "profile": ""
    },
    "attachment_filenames": {
        "name": "죠르디벚꽃.jpg",
        "size": 70439,
        "type": "file",
        "url": "/archive/8ecf3fce-****-****-****-88e8225cdc32"
    },
    "has": "",
    "embed_providers": "",
    "embed_type": "",
    "isExpress": false,
    "link_hostnames": "",
    "mentions": [],
    "mentions_everyone": "false",
    "content": null,
    "sended_at": "2024-10-29T10:13:22+09:00",
    "created_at": "2024-10-29T10:13:22+09:00"
}