MENU
      메시지

        메시지


        기사 요약

        메시지에 대한 생성/수정/삭제하기 위한 API를 안내합니다.

        채널내 메시지 조회 API

        채널내에 메시지를 검색할 수 있습니다.

        요청 URL

        GET https://dashboard-api.ncloudchat.naverncp.com/v1/api/messages/{channelId}
        HTTP

        요청 헤더

        HeaderDescription
        x-project-id- 대시보드 > 설정 > 일반 > 프로젝트 ID
        x-api-key- 대시보드 > 설정 > 일반 > API 키

        요청 Path 파라미터

        파라미터타입필수 여부설명
        channelIdStringO채널ID

        요청 Query 파라미터

        파라미터타입필수 여부설명
        filterStringO{} 로 입력하여 사용하시면 됩니다.
        sortStringX정렬 하고자 하는 필드의 필터를 정의 합니다. ex) 내림차순 {"created_at":"-1"} / 오름차순 {"created_at":"1"}
        optionStringX옵션이 존재할 경우 아래를 참고하세요. ex) {"offset":0,"per_page":20}

        요청 예시

        curl -X 'GET' \
          'https://dashboard-api.ncloudchat.naverncp.com/v1/api/messages/339c2b1c-d35b-47f2-828d-xxxxxxxxxxx?filter=%7B%7D&sort=%7B%22created_at%22%3A%22-1%22%7D&option=%7B%22offset%22%3A0%2C%22per_page%22%3A20%7D' \
          -H 'accept: application/json' \
          -H 'x-project-id: 339c2b1c-d35b-47f2-828d-xxxxxxxxx' \
          -H 'x-api-key: 4302925661f70ce7c1406c59543f2546xxxxxxxxxxxxxx'
        Plain text

        응답 예시 (정상)

        [
          {
            "id": "644219bf0210fafxxxxxxx",
            "message_id": "644219bf0210faf7fxxxxxxx",
            "channel_id": "d6b52237-aebe-4509-81d1-xxxxxxxxxxx",
            "sort_id": "1682053567257",
            "message_type": "text",
            "sender": {
              "id": "guest-5159",
              "name": "GUEST-5159",
              "profile": "https://loremflickr.com/640/360"
            },
            "admin": {
              "id": "",
              "name": "",
              "profile": ""
            },
            "attachment_filenames": {
              "name": "",
              "size": 0,
              "type": "text",
              "url": ""
            },
            "has": "",
            "embed_providers": "",
            "embed_type": "",
            "isExpress": false,
            "link_hostnames": "",
            "mentions": [],
            "mentions_everyone": "false",
            "content": "hippo",
            "sended_at": "2023-04-21T14:06:07+09:00",
            "created_at": "2023-04-21T14:06:07+09:00"
          },
          {
            "id": "6441f2150117ce7d4f93c5da",
            "message_id": "6441f2150117ce7d4fxxxxxxx",
            "channel_id": "d6b52237-aebe-4509-81d1-8937xxxxxxx",
            "sort_id": "1682043413705",
            "message_type": "text",
            "sender": {
              "id": "guest-1964",
              "name": "GUEST-1964",
              "profile": "https://loremflickr.com/640/360"
            },
            "admin": {
              "id": "",
              "name": "",
              "profile": ""
            },
            "attachment_filenames": {
              "name": "",
              "size": 0,
              "type": "text",
              "url": ""
            },
            "has": "",
            "embed_providers": "",
            "embed_type": "",
            "isExpress": false,
            "link_hostnames": "",
            "mentions": [],
            "mentions_everyone": "false",
            "content": "hello",
            "sended_at": "2023-04-21T11:16:53+09:00",
            "created_at": "2023-04-21T11:16:53+09:00"
          }]
        Plain text

        응답

        HTTP 상태 코드로 리턴되고, Body 정보로 전달합니다.

        HTTP 상태 코드응답 메시지설명
        200OK일반적인 요청 성공
        400Bad Request일반적인 요청 실패에 사용(대체로 서버가 이해할 수 없는 형식의 요청이 왔을 때 응답하기 위해 사용)
        500Internal Server Error- 일반적인 서버 오류에 대한 응답 코드
        - 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용
        - 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용

        채널내 개별 메시지 조회 API

        특정 채널내에 특정 메시지를 가져올 수 있습니다.

        요청 URL

        GET https://dashboard-api.ncloudchat.naverncp.com/v1/api/messages/{channelId}/{messageId}
        HTTP

        요청 헤더

        HeaderDescription
        x-project-id- 대시보드 > 설정 > 일반 > 프로젝트 ID
        x-api-key- 대시보드 > 설정 > 일반 > API 키

        요청 Path 파라미터

        파라미터타입필수 여부설명
        channelIdStringY채널 ID
        messageIdStringY메시지 ID

        요청 예시

        curl -X 'GET' \
          'https://dashboard-api.ncloudchat.naverncp.com/v1/api/messages/bb63b36f-4642-40c3-XXXX-XXXXXXXXXX/62b40c6deaadXXXXXXXX' \
          -H 'accept: application/json' \
          -H 'x-project-id: 339c2b1c-d35b-47f2-828d-xxxxxxxxx' \
          -H 'x-api-key: 4302925661f70ce7c14xxxxxxxxxxxxxxxxxxxx'
        Plain text

        응답 예시 (정상)

        {
          "id": "62b40c6deaadXXXXXXXX",
          "message_id": "62b40c6deaadXXXXXXXX",
          "channel_id": "bb63b36f-4642-40c3-XXXX-XXXXXXXXXX",
          "sort_id": "1655966829820",
          "message_type": "text",
          "sender": {
            "id": "XXXXXX",
            "name": "tester2",
            "profile": null
          },
          "admin": {
            "id": "XXXXXX",
            "name": "tester2",
            "profile": null
          },
          "attachment_filenames": {
            "name": "",
            "size": null,
            "type": "text",
            "url": null
          },
          "has": "",
          "embed_providers": "",
          "embed_type": "",
          "isExpress": null,
          "link_hostnames": "",
          "mentions": [],
          "mentions_everyone": "false",
          "content": "msg TEXT",
          "sended_at": null,
          "created_at": "2022-06-23T15:47:09+09:00"
        }
        Plain text

        응답

        HTTP 상태 코드로 리턴되고, Body 정보로 전달합니다.

        HTTP 상태 코드응답 메시지설명
        200OK일반적인 요청 성공
        400Bad Request일반적인 요청 실패에 사용(대체로 서버가 이해할 수 없는 형식의 요청이 왔을 때 응답하기 위해 사용)
        500Internal Server Error- 일반적인 서버 오류에 대한 응답 코드
        - 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용
        - 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용

        메시지 생성 API

        채널내에 메시지를 발송 할 수 있습니다.

        요청 URL

        POST https://dashboard-api.ncloudchat.naverncp.com/v1/api/messages/{channelId}
        HTTP

        요청 헤더

        HeaderDescription
        x-project-id- 대시보드 > 설정 > 일반 > 프로젝트 ID
        x-api-key- 대시보드 > 설정 > 일반 > API 키

        요청 Path 파라미터

        파라미터타입필수 여부설명
        channelIdStringY채널 ID

        요청 Body 파라미터

        파라미터타입필수 여부설명
        contentStringY메세지
        메시지 길이 제한

        메시지 텍스트 최대값은 프로젝트 설정에 메시지 길이 설정 값에 따라 결정됩니다.

        요청 예시

        curl -X 'POST' \
          'https://dashboard-api.ncloudchat.naverncp.com/v1/api/messages/d6b52237-aebe-4509-XXXX-XXXXXXX' \
          -H 'accept: application/json' \
          -H 'x-project-id: 339c2b1c-d35b-47f2-828d-xxxxxxxxxx' \
          -H 'x-api-key: 4302925661f70ce7c1406c59543f2546dxxxxxxxxxx' \
          -H 'Content-Type: application/json' \
          -d '{
          "content": "new Message"
        }'
        Plain text

        응답 예시 (정상)

        {
          "message": {
            "id": "64488985d0172afd5axxxxxxx",
            "message_id": "64488985d0172afd5axxxxxx",
            "channel_id": "d6b52237-aebe-4509-81d1-xxxxxxxx",
            "sort_id": "1682475397355",
            "message_type": "text",
            "sender": {
              "id": "f8002d46-3064-4d42-XXXX-XXXXXXX",
              "name": "TEST",
              "profile": null
            },
            "admin": {
              "id": "f8002d46-3064-4d42-XXXX-XXXXXXX",
              "name": "TEST",
              "profile": null
            },
            "attachment_filenames": {
              "name": "",
              "size": 0,
              "type": "text",
              "url": ""
            },
            "has": "",
            "embed_providers": "",
            "embed_type": "",
            "isExpress": false,
            "link_hostnames": "",
            "mentions": [],
            "mentions_everyone": "false",
            "content": "new Message",
            "sended_at": "2023-04-26T11:16:37+09:00",
            "created_at": "2023-04-26T11:16:37+09:00"
          },
          "status": 1
        }
        Plain text

        응답

        HTTP 상태 코드로 리턴되고, Body 정보로 전달합니다.

        HTTP 상태 코드응답 메시지설명
        200OK일반적인 요청 성공
        400Bad Request일반적인 요청 실패에 사용(대체로 서버가 이해할 수 없는 형식의 요청이 왔을 때 응답하기 위해 사용)
        500Internal Server Error- 일반적인 서버 오류에 대한 응답 코드
        - 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용
        - 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용

        메시지 삭제 API

        특정 메시지를 삭제 할 수 있습니다.

        요청 URL

        DELETE https://dashboard-api.ncloudchat.naverncp.com/v1/api/messages/:channelId/:messageId
        HTTP

        요청 헤더

        HeaderDescription
        x-project-id- 대시보드 > 설정 > 일반 > 프로젝트 ID
        x-api-key- 대시보드 > 설정 > 일반 > API 키

        요청 Path 파라미터

        파라미터타입필수 여부설명
        channelIdStringY채널ID
        messageIdStringY메시지ID

        요청 예시

        curl -X 'DELETE' \
          'https://dashboard-api.ncloudchat.naverncp.com/v1/api/messages/ac712308-95d7-4c9a-bba7-xxxxxxxxxx/63cad8c3faac16dxxxxxxxx' \
          -H 'accept: */*' \
          -H 'x-project-id: 339c2b1c-d35b-47f2-828d-5f02axxxxxxx' \
          -H 'x-api-key: 4302925661f70ce7c1406c59543f2546d261d2xxxxxxx'
        Plain text

        응답 예시 (정상)

        {
          "message": {
            "id": "63cad8c3faac16dxxxxxx",
            "message_id": "63cad8c3faac16dxxxxxxxx",
            "channel_id": "ac712308-95d7-4c9a-bba7-xxxxxxxxxx",
            "sort_id": "1674238147614",
            "message_type": "text",
            "sender": {
              "id": "0e596be1-2ef0-4a79-a105-09a47xxxxxx",
              "name": "User",
              "profile": "https://cloudchat.gcdn.ntruss.com/samples/2.jpeg"
            },
            "admin": {
              "id": "0e596be1-2ef0-4a79-a105-09a47xxxxxxx",
              "name": "User",
              "profile": "https://cloudchat.gcdn.ntruss.com/samples/2.jpeg"
            },
            "attachment_filenames": {
              "name": "",
              "size": 0,
              "type": "text",
              "url": ""
            },
            "has": "",
            "embed_providers": "",
            "embed_type": "",
            "isExpress": false,
            "link_hostnames": "",
            "mentions": [],
            "mentions_everyone": "false",
            "content": "헬로우우우우우",
            "sended_at": "2023-01-21T03:09:07+09:00",
            "created_at": "2023-01-21T03:09:07+09:00"
          },
          "status": 1
        }
        Plain text

        응답

        HTTP 상태 코드로 리턴되고, Body 정보로 전달합니다.

        HTTP 상태 코드응답 메시지설명
        200OK일반적인 요청 성공
        400Bad Request일반적인 요청 실패에 사용(대체로 서버가 이해할 수 없는 형식의 요청이 왔을 때 응답하기 위해 사용)
        500Internal Server Error- 일반적인 서버 오류에 대한 응답 코드
        - 4XX대의 오류 코드가 클라이언트 측 오류를 나타내기 위해 사용
        - 5XX대의 오류 코드는 서버 측 오류를 나타내기 위해 사용

        이 문서가 도움이 되었습니까?

        Changing your password will log you out immediately. Use the new password to log back in.
        First name must have atleast 2 characters. Numbers and special characters are not allowed.
        Last name must have atleast 1 characters. Numbers and special characters are not allowed.
        Enter a valid email
        Enter a valid password
        Your profile has been successfully updated.