携帯電話番号サービス (CPNS) は、ビジネス要件に基づいて電話番号の状態を照会するために呼び出すことができる API 操作を提供します。 これにより、ビジネスオペレーションの簡素化とコストの管理に役立ちます。 プログラミング手法を使用して、CPNS をビジネスシステムと統合できます。 このトピックでは、CPNS でデバッグを実行するための API 操作を呼び出す際の基本情報と注意事項について説明します。
OpenAPI Explorer の紹介
Alibaba Cloud は、さまざまな Alibaba Cloud サービスの API 操作を効率的に理解し、使用するための OpenAPI Explorer を提供しています。 OpenAPI Explorer は、API 操作のために以下の機能を統合しています。インテリジェント検索、ドキュメント、オンラインデバッグ、SDK の取得、CodeSample、呼び出しエラー診断、および呼び出し統計。 OpenAPI Explorer では、Alibaba Cloud サービスの API 操作を呼び出し、API リクエストとレスポンスを表示できます。 さらに、OpenAPI Explorer は、Alibaba Cloud サービスの使用を容易にするために、対応する SDK サンプルコードを自動的に生成します。 詳細については、「API とは」をご参照ください。
バージョンの説明
CPNS は、電話番号の状態の照会、移植された電話番号の照会、電話番号の登録場所の照会、およびユーザー情報の検証のために呼び出すことができる API 操作を提供します。 これにより、CPNS をビジネスシステムと統合できます。
Alibaba Cloud API は、バージョン番号を使用して、クラウドサービス API のメジャーバージョンの操作リストを管理します。
たとえば、CPNS は現在、バージョン 2023-01-01 の操作リストをサポートしています。 2023-01-01 は日付ではなく API バージョン番号です。 ユーザーには、API に関する最新の公開情報が表示されます。 2023-01-01 は、API の最終更新日ではありません。
API バージョン | 説明 |
このバージョンの API 操作を使用することをお勧めします。 |
オンラインデバッグ
CPNS は、OpenAPI Explorer で API デバッグなどの機能を提供します。 API 操作を呼び出す前に、CPNS によって提供される以下の情報を理解する必要があります。バージョン、エンドポイント、API スタイル、および呼び出し方法。
デバッグ
https://api.alibabacloud.com/api/Dytnsapi/2023-01-01/ で API デバッグを実行できます。
エンドポイントの説明
レイテンシを削減するために、リソースが存在するリージョンに基づいてエンドポイントを選択します。
グローバルエンドポイントは dytnsapi.aliyuncs.com です。 詳細については、「エンドポイント」をご参照ください。
ID
Alibaba Cloud アカウントで OpenAPI Explorer にログオンすると、OpenAPI Explorer はデフォルトで Alibaba Cloud アカウントを使用して API 操作をオンラインでデバッグします。
ID | サポートされている |
はい | |
いいえ | |
いいえ |
統合方法
CPNS では、ビジネス要件に基づいて、SDK などのさまざまな統合方法を使用して、CPNS をビジネスシステムと統合できます。
Alibaba Cloud SDK
Alibaba Cloud は、Java、C#、Go、Python、TypeScript + Node.js、PHP、C++ など、複数のプログラミング言語で SDK を提供しています。 アプリケーションに統合された SDK を介して API 操作を直接呼び出すことができます。 SDK は、署名ロジック、タイムアウトメカニズム、再試行メカニズムなどの情報をカプセル化し、仕様に基づいて構造化されたレスポンスオブジェクトを返します。これにより、開発者にとって便利です。 詳細については、「Alibaba Cloud SDK」をご参照ください。
さまざまなプログラミング言語でサポートされている SDK と依存関係のインストールの詳細については、「SDK リファレンス」をご参照ください。
Alibaba Cloud CLI
Alibaba Cloud コマンドラインインターフェース (Alibaba Cloud CLI) を使用すると、
aliyunコマンドを使用して他の Alibaba Cloud サービスと対話し、Alibaba Cloud リソースを管理できます。 詳細については、「Alibaba Cloud CLI とは」をご参照ください。Alibaba Cloud CLI は、CPNS の呼び出しには使用できません。
ROS
Resource Orchestration Service (ROS) は、クラウドコンピューティングリソースの管理を簡素化できる Alibaba Cloud サービスです。 テンプレートを作成して、必要な Elastic Compute Service (ECS) や ApsaraDB RDS インスタンスなどのクラウドコンピューティングリソースと、リソース間の関係を記述できます。 ROS は、テンプレートに基づいてすべてのリソースを自動的に作成および構成し、自動化されたデプロイと O&M を実装します。 詳細については、「ROS とは」をご参照ください。
ROS は、CPNS の呼び出しには使用できません。
API 操作のリクエストのカプセル化
上記のいずれの方法もビジネス要件を満たしていない場合は、API 操作のリクエストをカプセル化して、対応する操作を呼び出すことができます。 この方法は推奨されません。 詳細については、「リクエスト構文と署名方式 V3」をご参照ください。
使用上の注意
携帯電話番号サービスの API 操作を呼び出した後にエラーが返された場合は、返されたエラーコードに基づいて、リクエストパラメーターと値が有効かどうかを確認する必要があります。 詳細については、「携帯電話番号サービス - エラーコード」をご参照ください。
OpenAPI 問題診断 にアクセスして、返されたリクエスト ID または SDK エラー情報に基づいてセルフサービス診断を実行することもできます。