チャンネルの照会

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

通知トークチャンネルの情報を照会します。

リクエスト

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

メソッド	URI
GET	/alimtalk/v2/services/{serviceId}/channels

リクエストヘッダ

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

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

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

フィールド	タイプ	必須の有無	説明
`serviceId`	String	Required	Biz Messageサービス ID プロジェクトリストの照会を参照

リクエスト例

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

curl --location --request GET 'https://sens.apigw.ntruss.com/alimtalk/v2/services/ncp:kkobizmsg:kr:27*********6:sens/channels' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド	タイプ	必須の有無	説明
`createTime`	String	Required	チャンネルの作成日時 YYYY-MM-DDTHH:mm:ss.sss形式
`updateTime`	String	Optional	チャンネルの更新日時 YYYY-MM-DDTHH:mm:ss.sss形式
`serviceId`	String	Required	Biz Messageサービス ID
`channelId`	String	Required	チャンネル ID
`channelName`	String	Required	チャネル名
`channelStatus`	String	Required	チャンネルの状態 `ACTIVE` \| `DELETED` \| `DELETING_PERMANETLY` \| `PERMANENTLY_DELETED` \| `BLOCKED` \| `PENDING_DELETE` `ACTIVE`: 正常 `DELETED`: 削除 `DELETING_PERMANETLY`: 完全削除中 `PERMANENTLY_DELETED`: 完全削除 `BLOCKED`: ブロック `PENDING_DELETE`: 削除遅延中
`useSmsFailover`	Boolean	Required	SMS代替送信を設定するか `true` \| `false` `true`: 設定 `false`: 設定しない
`failoverServiceId`	String	Optional	代替送信に使用された SMSサービス ID
`failoverTelNo`	String	Optional	送信番号
`isBlock`	Boolean	Required	チャンネルをブロックするか
`isDormant`	Boolean	Required	チャンネルは休眠中か

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

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

レスポンス例

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

[
    {
        "createTime": "2025-11-25T09:53:21.365",
        "updateTime": "2025-11-25T09:58:23.200",
        "serviceId": "ncp:kkobizmsg:kr:27*********6:sens",
        "channelId": "@******",
        "channelName": "******",
        "channelStatus": "ACTIVE",
        "useSmsFailover": true,
        "failoverServiceId": "ncp:sms:kr:27*********6:sens",
        "failoverTelNo": "010********",
        "isBlock": false,
        "isDormant": false
    }
]