You can integrate Phone Number Verification Service with your business systems to implement features such as quick verification for multiple channels based on your business requirements. This helps you simplify business operations and manage costs. This topic describes the basic information about and usage notes on how to call the API operations of Phone Number Verification Service.
Server-side integration
Phone Number Verification Service provides multiple features such as short message service (SMS) verification. You can use Alibaba Cloud SDKs to integrate Phone Number Verification Service and use these features by calling API operations.
OpenAPI Explorer
Alibaba Cloud provides OpenAPI Explorer for you to easily manage cloud resources, data, and services by calling API operations. For more information, see What is an API?
API versions
API version | Description |
We recommend that you use this API version. |
2017-07-25 is an API version number rather than a date. 2017-07-25 is the up-to-date version of the Phone Number Verification Service API, which provides the latest public information about the API.
Endpoints
Select an endpoint based on the region in which your resources reside to reduce latency.
The global endpoint is dypnsapi-intl.ap-southeast-1.aliyuncs.com.
For more information, see Endpoints.
Identities
Phone Number Verification Service allows you to call API operations by using the following identities. We recommend that you call the API operations of Phone Number Verification Service as a Resource Access Management (RAM) user or RAM role that is granted the permissions required by your applications.
Identity | Supported |
Yes | |
(Recommended) RAM user | Yes |
(Recommended) RAM role | Yes |
After you log on to OpenAPI Explorer with your Alibaba Cloud account, OpenAPI Explorer uses your Alibaba Cloud account to debug API operations online by default. An Alibaba Cloud account has permissions on all API operations. Security risks may arise if you use an Alibaba Cloud account to call API operations. We recommend that you call API operations or perform routine O&M as a RAM user. Before you call API operations as a RAM user, grant the required permissions to the RAM user based on your business requirements. The RAM user must have the operation permissions. For more information, see Use RAM for access control.
Online debugging
Alibaba Cloud provides OpenAPI Explorer for you to efficiently understand and use the API operations of various Alibaba Cloud services. OpenAPI Explorer integrates the following features related to API operations: intelligent search, documentation, online debugging, SDK download, sample code, call error diagnostics, and call statistics. In OpenAPI Explorer, you can call the API operations of Alibaba Cloud services and view API requests and responses. In addition, OpenAPI Explorer automatically generates the corresponding SDK sample code to facilitate the use of Alibaba Cloud services.
You can perform API debugging at https://api.alibabacloud.com/api/Dypnsapi-intl/2017-07-25/.
Integration methods
You can integrate Phone Number Verification Service with your business systems by using different integration methods such as Alibaba Cloud SDKs based on your business requirements.
Alibaba Cloud SDKs
Alibaba Cloud provides SDKs in multiple programming languages. You can integrate the SDKs with your applications to directly call API operations. The SDKs encapsulate information such as the signature logic, timeout mechanism, and retry mechanism, and return structured response objects based on specifications. This facilitates development. For more information, see Alibaba Cloud SDKs.
For more information about the supported Phone Number Verification Service SDKs in different programming languages and the installation of dependencies, see SDK reference.
Encapsulation of requests for API operations
If the preceding method does not meet your business requirements, you can encapsulate requests for API operations and call the corresponding operations. This method is not recommended. For more information, see Request syntax and signature method V3.
Usage notes
If an error is returned after you call an API operation of Phone Number Verification Service, you must check whether the request parameters and values are valid based on the returned error code. For more information, see Verify - Error Codes.
You can also visit OpenAPI problem diagnosis to perform self-service diagnostics based on the returned request ID or SDK error information.