受信拒否番号の登録

Prev Next

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

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

リクエスト

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

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

リクエストヘッダ

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

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

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

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

リクエストボディ

リクエストボディの説明は次の通りです。

フィールド タイプ 必須の有無 説明
clientTelNo String Required 受信拒否電話番号
  • 最大1,000個まで入力可能

リクエスト例

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

curl --location --request POST 'https://sens.apigw.ntruss.com/sms/v2/services/ncp:sms:kr:50*********1:sens/unsubscribes' \
--header 'x-ncp-apigw-timestamp: {Timestamp}' \
--header 'x-ncp-iam-access-key: {Access Key}' \
--header 'x-ncp-apigw-signature-v2: {API Gateway Signature}' \
--header 'Content-Type: application/json' \
--data '[
  {
    "clientTelNo": "010********"
  },
  {
    "clientTelNo": "010********"
  }
]'

レスポンス

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

レスポンスボディ

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

フィールド タイプ 必須の有無 説明
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のレスポンスステータスコードをご参照ください。

レスポンス例

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

[
    {
        "clientTelNo": "010********",
        "registerType": "M",
        "registerTime": "2025-11-26T10:11:59.271"
    },
    {
        "clientTelNo": "010********",
        "registerType": "M",
        "registerTime": "2025-11-18T10:51:36.957"
    }
]