API overview-Cell Phone Number Service(CPNS)-阿里云帮助中心

API standard and pre-built SDKs in multi-language

The OpenAPI specification of this product (Dytnsapi/2020-02-17) follows the RPC standard. Alibaba Cloud provides pre-built SDKs for popular programming languages to abstract low-level complexities such as request signing. This enables developers to call APIs using language-specific syntax without dealing with HTTP details directly.

Custom signature

If your specific needs, such as a customized signature, are not supported by the SDK, manually sign requests using the signature mechanism. Note that manual signing requires significant effort (usually about 5 business days). For support, join our DingTalk group (ID: 147535001692).

Before you begin

An Alibaba Cloud account has full administrative privileges. A compromised AccessKey pair exposes all associated resources to unauthorized access, posing a significant security risk. To call APIs securely, create a Resource Access Management (RAM) user with API access only, configure its AccessKey pairs, and implement the principle of least privilege (PoLP) through RAM policies. Use the Alibaba Cloud account only when its permissions are explicitly required for specific scenarios.

ID card two-factor/three-factor verification

API	Title	Description
CertNoTwoElementVerification	Two-element ID Verification	Verify two elements (name and ID number). This API compares whether the name and ID number provided by the user belong to the same individual.
CertNoThreeElementVerification	ID Three-Element Verification	Three-element verification (name, ID number, and ID photo). This service verifies whether the name, ID number, and uploaded portrait photo provided by the user belong to the same individual.

UAID query

API	Title	Description
GetUAIDApplyTokenSign	Obtain the signature value for the UAID authorization token	This API only provides the signing functionality for acquiring an authorization token during UAID retrieval from the three-network operators.
UAIDVerification	Obtain UAID Based on Carrier Authorization Token	Obtain the UAID based on the carrier authorization token. For information about how to obtain the authorization token and its signature value, see the GetUAIDApplyTokenSign API documentation. The UAID is 64 characters long. The first 32 characters describe device information, and the last 32 characters describe phone number information.

Number Attribution Inquiry

API	Title	Description
DescribePhoneNumberOperatorAttribute	Phone Number Belonging Query (Encrypted Version)	Query the ownership information of a phone number, including the province, city, underlying carrier (China Mobile, China Unicom, China Telecom, China Broadcasting Network), mobile virtual network operator (MVNO) such as Ali Telecom, whether mobile number portability is enabled, and the number segment.

Number Analysis Query

API	Title	Description
DescribePhoneNumberAnalysisAI	Phone AI Analysis Service	Obtain the return result of phone number analysis.
DescribePhoneNumberAnalysis	Query Phone Number Analysis Result	Obtain the return result of phone number analysis.

Number Encryption

API	Title	Description
PhoneNumberEncrypt	Encrypt Number	Encrypts the original phone number into a virtual number starting with 140. By integrating Alibaba Cloud's communication service, you can use the encrypted 140 number to initiate a voice call, achieving the effect of a virtual number call.

Label

API	Title	Description
QueryTagInfoBySelection	Query tag information	Query tag information.

Others

API	Title	Description
CompanyFourElementsVerification	CompanyFourElementsVerification	Verifies whether the enterprise name, the business license number, and the name and ID card of the legal representative belong to the same enterprise. The verification is successful only when the preceding four elements belong to the same enterprise and the business status of the enterprise is Active.
CompanyThreeElementsVerification	CompanyThreeElementsVerification	Verifies whether the enterprise name, the business license number, and the name of the legal representative belong to the same enterprise. The verification is successful only when the three elements belong to the same enterprise and the business status of the enterprise is Active.
CompanyTwoElementsVerification	CompanyTwoElementsVerification	Verifies whether the enterprise name and the business license number belong to the same enterprise. The verification is successful only when the two elements belong to the same enterprise and the business status of the enterprise is Active.
DeleteContacts	Delete a contact	Deletes a contact.
DescribeEmptyNumber	DescribeEmptyNumber	Predicts whether a phone number is a nonexistent number by using AI algorithms.
DescribePhoneNumberOnlineTime	DescribePhoneNumberOnlineTime	Queries the usage period of a phone number of a user.
DescribePhoneTwiceTelVerify	DescribePhoneTwiceTelVerify	Quickly verify in a single request if a mobile phone number is a carrier's secondary number assignment.
InvalidPhoneNumberFilter	InvalidPhoneNumberFilter	Filters invalid phone numbers.
ListContacts	List alert contacts for the Cell Phone Number Service	Lists the alert contacts for Number Encyclopedia.
PhoneNumberStatusForAccount	PhoneNumberStatusForAccount	Retrieves the real-time network status of a mobile phone number, such as active, shutdown, or non-existent. You can query numbers that are in plaintext or hashed using MD5 or SHA256.
PhoneNumberStatusForPublic	PhoneNumberStatusForPublic	Queries the real-time status of a mobile phone number to determine whether it is in service, suspended, or non-existent. This operation supports queries for plaintext numbers or numbers encrypted with MD5 or SHA256.
PhoneNumberStatusForReal	PhoneNumberStatusForReal	Queries the real-time status of a mobile phone number, such as normal, suspended, or not in service. This operation supports queries for phone numbers that are in plaintext or encrypted by using MD5, SHA256, or SM3.
PhoneNumberStatusForSms	PhoneNumberStatusForSms	Retrieves the real-time network status of a phone number, such as active, shutdown, or non-existent. This operation supports queries for numbers in plaintext or numbers encrypted by using MD5, SHA256, or SM3.
PhoneNumberStatusForVoice	PhoneNumberStatusForVoice	Queries the real-time network status of a mobile phone number, such as normal, shutdown, or non-existent. This operation supports queries for numbers in plaintext and numbers encrypted by using MD5, SHA256, or SM3.
QueryAvailableAuthCode	QueryAvailableAuthCode	Queries available authorization codes.
QueryPackageTypeInfo	QueryPackageTypeInfo	Queries package type information.
QueryTagApplyRule	QueryTagApplyRule	Queries tag application rules.
QueryTagListPage	QueryTagListPage	Queries a list of tags by page.
QueryTaskList	Query Encyclopedia Offline Task List	Queries a list of offline tasks.
QueryUsageStatisticsByTagId	QueryUsageStatisticsByTagId	Queries the usage statistics based on tag IDs.
SaveContacts	Save Contact	Saves an alert contact.
ThreeElementsVerification	ThreeElementsVerification	Verifies whether the name, phone number, and ID card number entered by a user belong to the same user.
TwoElementsVerification	TwoElementsVerification	Verifies whether the name and phone number entered by a user belong to the same user.
UpdateContacts	Update Contact	Updates an alert contact.