Use OpenAPI to debug Phone Number Privacy Protection-Phone Number Protection(PNP)-阿里云帮助中心

Integrate Phone Number Privacy Protection into your business systems programmatically to automate privacy-enhanced calls. This simplifies operations and reduces management costs. This topic describes the OpenAPI operations provided by Phone Number Privacy Protection and the supported integration methods.

OpenAPI

Alibaba Cloud provides OpenAPI Explorer to help you quickly and efficiently learn and use the OpenAPI of each cloud product. OpenAPI Explorer is an all-in-one platform that provides intelligent OpenAPI search, documentation, online debugging, obtaining SDKs, code samples, error diagnosis, and call statistics. You can use OpenAPI Explorer to call the OpenAPI operations of various Alibaba Cloud products and view the requests and responses. OpenAPI Explorer also automatically generates SDK code samples to accelerate your development with Alibaba Cloud products. For more information, see What is OpenAPI Explorer?.

Versions

Phone Number Privacy Protection provides OpenAPI operations for binding private numbers, retrieving recording files, and querying private numbers.

Note

Alibaba Cloud uses version numbers to manage the API lists for major versions of its cloud products.

The string 2017-05-25 is an API version identifier, not a date. It represents the latest public API data, not a static list from 2017-05-25.

API version	Description
2017-05-25	Recommended

Online debugging

Before you make a call, familiarize yourself with the service's version, endpoints, API style, and calling methods. Log on to OpenAPI Explorer. In the left-side navigation pane for Phone Number Privacy Protection, select the BindAxb API. On the parameter configuration tab, select China (Shanghai) as the region. Then, specify request parameters such as PoolKey, PhoneNoA, PhoneNoB, PhoneNoX, Expiration, ExpectCity, and IsRecordingEnabled. Click Initiate Call to complete the online debugging. The panel on the right displays the API description and details about the request parameters. The QPS limit is 5,000 calls per second.

Debugging entry point

The entry point for API debugging is: OpenAPI Explorer debugging page for Phone Number Privacy Protection

Endpoints

Select an endpoint based on the region where your resources are located for the lowest latency.

The global endpoint is dyplsapi.aliyuncs.com. For more information, see Endpoints.

Supported identities

After you log on to OpenAPI Explorer with your Alibaba Cloud account, OpenAPI Explorer uses your account to debug OpenAPI operations by default. An Alibaba Cloud account has permissions to access all APIs, which poses a high security risk. We recommend using a RAM user for API access or daily O&M. Before calling APIs, grant the RAM user only the required permissions. For more information, see Control access with RAM.

User identity	Support status
Alibaba Cloud account	Supported
RAM user (Recommended)	Supported
RAM role (Recommended)	Supported

Integration methods

Phone Number Privacy Protection provides multiple integration methods, such as SDKs.

Alibaba Cloud SDK

Alibaba Cloud provides SDKs for multiple programming languages, such as Java, C#, Go, Python, Node.js/TypeScript, PHP, and C++. You can call OpenAPI operations by integrating the corresponding SDK. The SDKs encapsulate signing logic, timeout mechanisms, and retry mechanisms. They also return structured response objects based on the documentation, which simplifies development. For more information about Alibaba Cloud SDKs, see Alibaba Cloud SDK.
See SDK Reference for the languages and dependencies supported by the Phone Number Privacy Protection SDK.

Alibaba Cloud CLI

Alibaba Cloud Command Line Interface (CLI) lets you interact with Alibaba Cloud services and manage your cloud resources from a command-line terminal by using the aliyun command. For more information about Alibaba Cloud CLI, see What is Alibaba Cloud CLI?.
Not supported: You cannot use Alibaba Cloud CLI to call Phone Number Privacy Protection operations.

Resource Orchestration Service (ROS)

Resource Orchestration Service (ROS) is an Alibaba Cloud service that simplifies the management of cloud resources. You can create templates to define the required Alibaba Cloud resources, such as an ECS instance or an RDS database instance, and their dependencies. The ROS orchestration engine automatically creates and configures all resources based on the templates for automated deployment and O&M. For more information, see What is ROS?.
Not supported: You cannot use ROS to call Phone Number Privacy Protection operations.

Custom API call encapsulation

If none of the preceding methods meet your business needs, you can encapsulate API requests yourself (not recommended). For more information, see Request body and signature mechanism of the V3.0 protocol.

Usage notes

If a Phone Number Privacy Protection API call returns an error, use the error code to verify your request parameters and their values. For more information, see API error codes.
You can also record the RequestID from the response or the error message from the SDK and use the Alibaba Cloud OpenAPI Diagnostic Platform for self-service troubleshooting.