受信拒否番号の照会

Prev Next

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

広告メッセージの受信を拒否した番号を照会します。

リクエスト

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

メソッド URI
GET /sms/v2/services/{serviceId}/unsubscribes

リクエストヘッダ

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

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

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

フィールド タイプ 必須の有無 説明
serviceId String Required SMSサービス ID

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

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

フィールド タイプ 必須の有無 説明
clientTelNo String Optional 受信拒否電話番号
  • 数字のみ入力可能
pageSize Integer Optional ページごとの項目数
  • 1~100
pageIndex Integer Optional ページインデックス
  • 0~N (デフォルト: 0)
startTime Integer Optional 照会開始日時(ミリ秒)
  • Unix Timestamp形式
  • 受信拒否登録日時基準
  • 未入力時、デフォルト値の全期間を適用
endTime Integer Optional 照会終了日時(ミリ秒)
  • Unix Timestamp形式
  • 受信拒否登録日時基準
  • 未入力時、デフォルト値の全期間を適用

リクエスト例

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

curl --location --request GET 'https://sens.apigw.ntruss.com/sms/v2/services/ncp:sms:kr:50*********1:sens/unsubscribes?startTime=1763721600000&endTime=1763808000000' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
clientTelNo String Required 受信拒否電話番号
registerTime String Required 受信拒否の登録日時
  • YYYY-MM-DDTHH:mm:ss.sss形式
registerType String Required 受信拒否の流入経路
  • C | M
    • C: ARS
    • M: 手動

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

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

レスポンス例

レスポンスのサンプルコードは次の通りです。
照会期間に登録された受信拒否番号がない場合、200 OKと表示され、空の値で呼び出されます。

[
    {
        "clientTelNo": "010********",
        "registerType": "M",
        "registerTime": "2025-11-21T16:10:47.884"
    }
]