Login
      目次 x
      メッセージ
        • 印刷する
        • PDF
        目次

        メッセージ

          • 印刷する
          • PDF
          記事の要約

          メッセージを作成/変更/削除するための APIをご案内します。

          チャンネル内のメッセージ照会 API

          チャンネル内でメッセージを検索できます。

          リクエスト URL

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

          リクエストヘッダ

          HeaderDescription
          x-project-id- ダッシュボード > 設定 > プロジェクトの設定 > プロジェクト ID
          x-api-key- ダッシュボード > 設定 > プロジェクトの設定 > API Key

          リクエスト 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'

          レスポンス例(正常)

          
[
  {
    "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"
  }]

          レスポンス

          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}

          リクエストヘッダ

          HeaderDescription
          x-project-id- ダッシュボード > 設定 > プロジェクトの設定 > プロジェクト ID
          x-api-key- ダッシュボード > 設定 > プロジェクトの設定 > API Key

          リクエスト 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'

          レスポンス例(正常)

            {
  "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"
}

          レスポンス

          HTTP状態コードでリターンされ、Body情報として転送します。

          HTTP状態コードレスポンスメッセージ説明
          200OK一般的なリクエスト成功
          400Bad Request一般的なリクエスト失敗に使用(多くの場合、サーバが理解できない形式のリクエストがあった時のレスポンスとして使用)
          500Internal Server Error- 一般的なサーバエラーに対するレスポンスコード
          - 4XX台のエラーコードは、クライアント側のエラーを表示するために使用
          - 5XX台のエラーコードはサーバ側のエラーを表示するために使用

          メッセージ作成 API

          チャンネル内にメッセージを送信できます。

          リクエスト URL

          POST https://dashboard-api.ncloudchat.naverncp.com/v1/api/messages

          リクエストヘッダ

          HeaderDescription
          x-project-id- ダッシュボード > 設定 > プロジェクトの設定 > プロジェクト ID
          x-api-key- ダッシュボード > 設定 > プロジェクトの設定 > API Key

          リクエスト 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"
}'

          レスポンス例(正常)

           {
  "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
}

          レスポンス

          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

          リクエストヘッダ

          HeaderDescription
          x-project-id- ダッシュボード > 設定 > プロジェクトの設定 > プロジェクト ID
          x-api-key- ダッシュボード > 設定 > プロジェクトの設定 > API Key

          リクエスト 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'

          レスポンス例(正常)

           {
  "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
}

          レスポンス

          HTTP状態コードでリターンされ、Body情報として転送します。

          HTTP状態コードレスポンスメッセージ説明
          200OK一般的なリクエスト成功
          400Bad Request一般的なリクエスト失敗に使用(多くの場合、サーバが理解できない形式のリクエストがあった時のレスポンスとして使用)
          500Internal Server Error- 一般的なサーバエラーに対するレスポンスコード
          - 4XX台のエラーコードは、クライアント側のエラーを表示するために使用
          - 5XX台のエラーコードはサーバ側のエラーを表示するために使用
          この記事は役に立ちましたか?
          What's Next
          Change password!
          Changing your password will log you out immediately. Use the new password to log back in.
          Change profile
          Success!
          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.
          Logout