Python SDK で電話番号の状態をクエリする API の呼び出し - CPNS

このトピックでは、OpenAPI を使用して操作を呼び出して電話番号の状態をクエリし、GetPhoneNumberIdentificationUrl 操作を呼び出してご利用の電話番号の本人確認用 URL を取得する方法について説明します。

API ドキュメントの参照

API 操作を呼び出す前に、GetPhoneNumberIdentificationUrl 操作に関するドキュメントを参照し、必要なパラメーターおよび権限を確認することを推奨します。詳細については、「」「機能別操作一覧」をご参照ください。

認証設定

ステップ 1：RAM ユーザーの作成と権限付与

重要

Alibaba Cloud アカウント (root ユーザー) は最高レベルの管理権限を持ちます。セキュリティ上の理由から、API 呼び出しおよび日常的な運用には Resource Access Management (RAM) ユーザーを使用することを推奨します。RAM ユーザーの詳細については、「RAM ユーザーの概要」をご参照ください。

RAM ユーザーの作成：「ユーザーの作成」にアクセスします。Access Configuration を Permanent AccessKey に設定し、ユーザー名を構成します。はいをクリックします。作成直後に AccessKey ペアを保存してください。
RAM ユーザーへの権限付与：「ユーザー」にアクセスします。作成した RAM ユーザーを見つけ、Actions をクリックし、「Attach Policy」をクリックします。Policy の検索ボックスに AliyunDysmsFullAccess を入力し、該当ポリシーを選択して Grant permissions をクリックします。

説明

AliyunDytnsReadOnlyAccess：携帯電話番号サービスに対する読み取り専用権限を付与します。
AliyunDytnsFullAccess：携帯電話番号サービスに対する完全管理権限を付与します。
カスタムポリシーを作成する場合は、「」「RAM 権限付与」をご参照ください。

ステップ 2：アクセス認証情報の取得

AccessKey ペアを環境変数に設定します。詳細については、「Linux、macOS、Windows における環境変数の設定」をご参照ください。

説明

AccessKey ペアが漏洩しないよう、アプリケーション内にハードコードしないでください。代わりに環境変数を使用してください。
本例では、環境変数名として ALIBABA_CLOUD_ACCESS_KEY_ID および ALIBABA_CLOUD_ACCESS_KEY_SECRET を使用します。

API 操作の呼び出し

本例では、Cell Phone Number Service SDK for Python を使用してこの API 操作を呼び出します。他のプログラミング言語向け SDK も同様の手順で使用できます。詳細については、「」「Cell Phone Number Service」をご参照ください。必要に応じて、その他の呼び出し方法も利用可能です。詳細については、「呼び出し方法」をご参照ください。

Python 環境の準備

Python 3 をダウンロードしてインストールします。すでに Python がインストール済みの場合は、python --version コマンドを実行してバージョンを確認できます。

説明

操作を呼び出す前に、環境変数を設定する必要があります。これにより、アクセス認証情報が環境変数から読み込まれます。AccessKey ID および AccessKey Secret の環境変数名はそれぞれ VMS_AK_ENV および VMS_SK_ENV です。詳細については、「Linux、macOS、Windows における環境変数の設定」をご参照ください。

依存関係のインストール

デバイス上で以下のコマンドを順次実行して、依存関係をインストールします：

pip3 install alibabacloud_credentials
pip install alibabacloud_dytnsapi20230101
pip3 install alibabacloud_tea_console

サンプルコードのダウンロード

「」「GetPhoneNumberIdentificationUrl」にアクセスします。
パラメーター タブで、必要なパラメーターを設定します。本例では、リージョン を 中国 (杭州) に設定します。
SDK サンプルコード タブで Python を選択し、プロジェクトのダウンロード をクリックします。
デバイス上でパッケージを展開し、alibabacloud_sample ディレクトリに移動します。

コードの実行

以下のコマンドを実行します：

python sample.py

以下のようなサンプル結果が返されます：

  { 
    "headers":{
         "access-control-allow-origin":"*",
         "date":"Wed, 24 Apr 2024 09:27:47 GMT",
         "content-length":"128",
         "keep-alive":"timeout=25",
         "x-acs-request-id":"7250E964-DFF7-5343-9CB6-4BA94AAD320F",
         "connection":"keep-alive",
         "content-type":"application/json;charset=utf-8",
         "etag":"1Yd7WQjEOnVh24d2GHVjkIQ8",
         "access-control-expose-headers":"*",
         "x-acs-trace-id":"d553c17e7b941c8f9086ebe9cea4b5db"
         },

         "statusCode":200,
         "body":{
             "code":"OK",
             "data":{
                 "carrierCode":"CTCC",
                 "verifyResult":1
                     },
                 "message":"OK",
                 "requestId":"7250E964-DFF7-5343-9CB6-4BA94AAD320F"
                 }
        }