チャンネル購読リストの照会

Classic/VPC環境で利用できます。

ユーザーのチャンネル購読情報を照会します。

リクエスト

リクエスト形式を説明します。リクエスト形式は次の通りです。

メソッド	URI
GET	/v1/api/subscriptions

リクエストヘッダ

Ncloud Chat APIで共通して使用されるヘッダの詳細は、Ncloud Chatのリクエストヘッダをご参照ください。

リクエストクエリパラメータ

リクエストクエリパラメータの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`filter`	String	Required	絞り込み条件レスポンスボディの一部のフィールドに基づいて絞り込み完全一致する値のみ絞り込み条件がない場合、空の値`{}`を入力 <例> `{"channel_id":"{チャンネル ID}"}`、`{"user_id":"{ユーザー ID}"}`、`{"online":true}`
`sort`	String	Optional	ソートの基準 `{基準:方式}`形式で入力基準: レスポンスボディの Stringタイプフィールド方式: `-1` \| `1` `-1`: 降順 `1`: 昇順 <例> `{"created_at":"-1"}`: 作成日時基準の降順
`option`	String	Optional	追加オプション: Option <例> `{"offset":0,"per_page":20}`: 最初の項目から20個表示

Option

Optionの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`offset`	Number	Optional	照会開始オフセット 0~N
`per_page`	Number	Optional	ページごとの項目数 1~100
`count`	Boolean	Optional	リストの代わりにレスポンス結果数を表示するか `true` \| `false` `true`: レスポンス結果数を表示 `false`: リストを表示

リクエスト例

リクエストのサンプルコードは次の通りです。

curl --location --request GET 'https://dashboard-api.ncloudchat.naverncp.com/v1/api/subscriptions
?filter=%7B%22user_id%22%3A%22NCP001%22%7D
&sort=%7B%22created_at%22%3A%22-1%22%7D
&option=%7B%22offset%22%3A0%2C%22per_page%22%3A20%7D' \
--header 'x-api-key: {API Key}' \
--header 'x-project-id: {Project ID}'

レスポンス

レスポンス形式を説明します。

レスポンスボディ

レスポンスボディの説明は次の通りです。

フィールド	タイプ	必須の有無	説明
`id`	String	-	購読固有 ID
`project_id`	String	-	プロジェクト ID
`channel_id`	String	-	チャンネル ID
`user_id`	String	-	ユーザー ID
`online`	Boolean	-	オンラインかどうか `true` \| `false` `true`: オンライン `false`: オフライン
`language`	String	-	アクセス言語
`push`	Boolean	-	プッシュ通知を許可するか `true` \| `false` `true`: 許可 `false`: ブロック
`mute`	Boolean	-	チャンネルをミュートするか `true` \| `false` `true`: ミュート `false`: ミュートしない
`user`	Object	-	ユーザー情報
`user.name`	String	-	ユーザーの名前
`user.profile`	String	-	ユーザープロファイル画像
`mark`	Object	-	最後のメッセージ情報
`mark.user_id`	String	-	送信者 ID
`mark.message_id`	String	-	メッセージ ID
`mark.sort_id`	String	-	送信日時 Unix Timestamp形式
`mark.unread`	String	-	以降の未読メッセージ数

レスポンスステータスコード

Ncloud Chat APIで共通して使用されるレスポンスステータスコードの詳細は、Ncloud Chatのレスポンスステータスコードをご参照ください。

レスポンス例

レスポンスのサンプルコードは次の通りです。

[
    {
        "id": "78e6d8ca-****-****-****-6ebe51af5906",
        "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
        "channel_id": "17563b23-****-****-****-de11ce1ff34a",
        "user_id": "NCP001",
        "online": false,
        "language": "",
        "push": true,
        "mute": false,
        "user": {
            "name": "ベビー木",
            "profile": ""
        },
        "mark": {
            "user_id": "NCP001",
            "message_id": "66a04**********b5b4d9e10",
            "sort_id": "1721780063170",
            "unread": 117
        }
    },
    {
        "id": "4fed04e9-****-****-****-dcd4c180079c",
        "project_id": "8be54b8b-****-****-****-84c0d5df2e9c",
        "channel_id": "a7adab41-****-****-****-961f661dcefd",
        "user_id": "NCP001",
        "online": false,
        "language": "",
        "push": true,
        "mute": false,
        "user": {
            "name": "ベビー木",
            "profile": ""
        },
        "mark": {
            "user_id": "NCP001",
            "message_id": "",
            "sort_id": "",
            "unread": 24
        }
    }
]