@alicloud/dytnsapi20200217 3.3.0 → 3.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/client.d.ts +543 -228
- package/dist/client.js +605 -229
- package/dist/client.js.map +1 -1
- package/dist/models/CertNoThreeElementVerificationRequest.d.ts +15 -2
- package/dist/models/CertNoThreeElementVerificationRequest.js.map +1 -1
- package/dist/models/CertNoThreeElementVerificationResponseBody.d.ts +33 -0
- package/dist/models/CertNoThreeElementVerificationResponseBody.js.map +1 -1
- package/dist/models/CertNoTwoElementVerificationRequest.d.ts +10 -2
- package/dist/models/CertNoTwoElementVerificationRequest.js.map +1 -1
- package/dist/models/CertNoTwoElementVerificationResponseBody.d.ts +25 -0
- package/dist/models/CertNoTwoElementVerificationResponseBody.js.map +1 -1
- package/dist/models/CompanyFourElementsVerificationRequest.d.ts +10 -13
- package/dist/models/CompanyFourElementsVerificationRequest.js.map +1 -1
- package/dist/models/CompanyFourElementsVerificationResponseBody.d.ts +21 -18
- package/dist/models/CompanyFourElementsVerificationResponseBody.js.map +1 -1
- package/dist/models/CompanyThreeElementsVerificationRequest.d.ts +7 -8
- package/dist/models/CompanyThreeElementsVerificationRequest.js.map +1 -1
- package/dist/models/CompanyThreeElementsVerificationResponseBody.d.ts +26 -20
- package/dist/models/CompanyThreeElementsVerificationResponseBody.js.map +1 -1
- package/dist/models/CompanyTwoElementsVerificationRequest.d.ts +5 -5
- package/dist/models/CompanyTwoElementsVerificationResponseBody.d.ts +26 -16
- package/dist/models/CompanyTwoElementsVerificationResponseBody.js.map +1 -1
- package/dist/models/DeleteContactsRequest.d.ts +2 -0
- package/dist/models/DeleteContactsRequest.js.map +1 -1
- package/dist/models/DeleteContactsResponseBody.d.ts +17 -0
- package/dist/models/DeleteContactsResponseBody.js.map +1 -1
- package/dist/models/DescribeEmptyNumberRequest.d.ts +10 -7
- package/dist/models/DescribeEmptyNumberRequest.js.map +1 -1
- package/dist/models/DescribeEmptyNumberResponseBody.d.ts +16 -12
- package/dist/models/DescribeEmptyNumberResponseBody.js.map +1 -1
- package/dist/models/DescribePhoneNumberAnalysisAirequest.d.ts +5 -5
- package/dist/models/DescribePhoneNumberAnalysisAiresponseBody.d.ts +16 -10
- package/dist/models/DescribePhoneNumberAnalysisAiresponseBody.js.map +1 -1
- package/dist/models/DescribePhoneNumberAnalysisRequest.d.ts +29 -2
- package/dist/models/DescribePhoneNumberAnalysisRequest.js.map +1 -1
- package/dist/models/DescribePhoneNumberAnalysisResponseBody.d.ts +36 -1
- package/dist/models/DescribePhoneNumberAnalysisResponseBody.js.map +1 -1
- package/dist/models/DescribePhoneNumberAnalysisTransparentResponseBody.d.ts +0 -16
- package/dist/models/DescribePhoneNumberAnalysisTransparentResponseBody.js.map +1 -1
- package/dist/models/DescribePhoneNumberAttributeRequest.d.ts +0 -5
- package/dist/models/DescribePhoneNumberAttributeRequest.js.map +1 -1
- package/dist/models/DescribePhoneNumberAttributeResponseBody.d.ts +0 -67
- package/dist/models/DescribePhoneNumberAttributeResponseBody.js.map +1 -1
- package/dist/models/DescribePhoneNumberOnlineTimeRequest.d.ts +13 -14
- package/dist/models/DescribePhoneNumberOnlineTimeRequest.js.map +1 -1
- package/dist/models/DescribePhoneNumberOnlineTimeResponseBody.d.ts +21 -21
- package/dist/models/DescribePhoneNumberOnlineTimeResponseBody.js.map +1 -1
- package/dist/models/DescribePhoneNumberOperatorAttributeRequest.d.ts +20 -12
- package/dist/models/DescribePhoneNumberOperatorAttributeRequest.js.map +1 -1
- package/dist/models/DescribePhoneNumberOperatorAttributeResponseBody.d.ts +30 -22
- package/dist/models/DescribePhoneNumberOperatorAttributeResponseBody.js.map +1 -1
- package/dist/models/DescribePhoneTwiceTelVerifyRequest.d.ts +18 -14
- package/dist/models/DescribePhoneTwiceTelVerifyRequest.js.map +1 -1
- package/dist/models/DescribePhoneTwiceTelVerifyResponseBody.d.ts +29 -19
- package/dist/models/DescribePhoneTwiceTelVerifyResponseBody.js.map +1 -1
- package/dist/models/GetUaidapplyTokenSignRequest.d.ts +35 -0
- package/dist/models/GetUaidapplyTokenSignRequest.js.map +1 -1
- package/dist/models/GetUaidapplyTokenSignResponseBody.d.ts +33 -0
- package/dist/models/GetUaidapplyTokenSignResponseBody.js.map +1 -1
- package/dist/models/HistoryThreeElementsVerificationRequest.d.ts +43 -6
- package/dist/models/HistoryThreeElementsVerificationRequest.js.map +1 -1
- package/dist/models/HistoryThreeElementsVerificationResponseBody.d.ts +38 -0
- package/dist/models/HistoryThreeElementsVerificationResponseBody.js.map +1 -1
- package/dist/models/InvalidPhoneNumberFilterRequest.d.ts +2 -2
- package/dist/models/InvalidPhoneNumberFilterResponseBody.d.ts +29 -19
- package/dist/models/InvalidPhoneNumberFilterResponseBody.js.map +1 -1
- package/dist/models/ListContactsRequest.d.ts +6 -0
- package/dist/models/ListContactsRequest.js.map +1 -1
- package/dist/models/ListContactsResponseBody.d.ts +60 -0
- package/dist/models/ListContactsResponseBody.js.map +1 -1
- package/dist/models/PhoneNumberEncryptRequest.d.ts +12 -4
- package/dist/models/PhoneNumberEncryptRequest.js.map +1 -1
- package/dist/models/PhoneNumberEncryptResponseBody.d.ts +16 -6
- package/dist/models/PhoneNumberEncryptResponseBody.js.map +1 -1
- package/dist/models/PhoneNumberStatusForAccountRequest.d.ts +20 -10
- package/dist/models/PhoneNumberStatusForAccountRequest.js.map +1 -1
- package/dist/models/PhoneNumberStatusForAccountResponseBody.d.ts +28 -19
- package/dist/models/PhoneNumberStatusForAccountResponseBody.js.map +1 -1
- package/dist/models/PhoneNumberStatusForPublicRequest.d.ts +17 -9
- package/dist/models/PhoneNumberStatusForPublicRequest.js.map +1 -1
- package/dist/models/PhoneNumberStatusForPublicResponseBody.d.ts +32 -22
- package/dist/models/PhoneNumberStatusForPublicResponseBody.js.map +1 -1
- package/dist/models/PhoneNumberStatusForRealRequest.d.ts +19 -9
- package/dist/models/PhoneNumberStatusForRealRequest.js.map +1 -1
- package/dist/models/PhoneNumberStatusForRealResponseBody.d.ts +33 -22
- package/dist/models/PhoneNumberStatusForRealResponseBody.js.map +1 -1
- package/dist/models/PhoneNumberStatusForSmsRequest.d.ts +20 -10
- package/dist/models/PhoneNumberStatusForSmsRequest.js.map +1 -1
- package/dist/models/PhoneNumberStatusForSmsResponseBody.d.ts +29 -20
- package/dist/models/PhoneNumberStatusForSmsResponseBody.js.map +1 -1
- package/dist/models/PhoneNumberStatusForVoiceRequest.d.ts +19 -9
- package/dist/models/PhoneNumberStatusForVoiceRequest.js.map +1 -1
- package/dist/models/PhoneNumberStatusForVoiceResponseBody.d.ts +31 -21
- package/dist/models/PhoneNumberStatusForVoiceResponseBody.js.map +1 -1
- package/dist/models/QueryAvailableAuthCodeRequest.d.ts +1 -1
- package/dist/models/QueryAvailableAuthCodeResponseBody.d.ts +8 -7
- package/dist/models/QueryAvailableAuthCodeResponseBody.js.map +1 -1
- package/dist/models/QueryPackageTypeInfoRequest.d.ts +1 -1
- package/dist/models/QueryPackageTypeInfoResponseBody.d.ts +31 -4
- package/dist/models/QueryPackageTypeInfoResponseBody.js.map +1 -1
- package/dist/models/QueryTagApplyRuleResponseBody.d.ts +28 -15
- package/dist/models/QueryTagApplyRuleResponseBody.js.map +1 -1
- package/dist/models/QueryTagInfoBySelectionResponseBody.d.ts +33 -18
- package/dist/models/QueryTagInfoBySelectionResponseBody.js.map +1 -1
- package/dist/models/QueryTagListPageResponseBody.d.ts +23 -21
- package/dist/models/QueryTagListPageResponseBody.js.map +1 -1
- package/dist/models/QueryTaskListRequest.d.ts +24 -1
- package/dist/models/QueryTaskListRequest.js.map +1 -1
- package/dist/models/QueryTaskListResponseBody.d.ts +31 -0
- package/dist/models/QueryTaskListResponseBody.js.map +1 -1
- package/dist/models/QueryTaskListShrinkRequest.d.ts +24 -1
- package/dist/models/QueryTaskListShrinkRequest.js.map +1 -1
- package/dist/models/QueryUsageStatisticsByTagIdRequest.d.ts +5 -5
- package/dist/models/QueryUsageStatisticsByTagIdResponseBody.d.ts +23 -24
- package/dist/models/QueryUsageStatisticsByTagIdResponseBody.js.map +1 -1
- package/dist/models/SaveContactsRequest.d.ts +26 -0
- package/dist/models/SaveContactsRequest.js.map +1 -1
- package/dist/models/SaveContactsResponseBody.d.ts +12 -0
- package/dist/models/SaveContactsResponseBody.js.map +1 -1
- package/dist/models/ThreeElementsVerificationRequest.d.ts +19 -17
- package/dist/models/ThreeElementsVerificationRequest.js.map +1 -1
- package/dist/models/ThreeElementsVerificationResponseBody.d.ts +23 -21
- package/dist/models/ThreeElementsVerificationResponseBody.js.map +1 -1
- package/dist/models/TwoElementsVerificationRequest.d.ts +15 -13
- package/dist/models/TwoElementsVerificationRequest.js.map +1 -1
- package/dist/models/TwoElementsVerificationResponseBody.d.ts +26 -22
- package/dist/models/TwoElementsVerificationResponseBody.js.map +1 -1
- package/dist/models/UaidverificationRequest.d.ts +28 -2
- package/dist/models/UaidverificationRequest.js.map +1 -1
- package/dist/models/UaidverificationResponseBody.d.ts +21 -0
- package/dist/models/UaidverificationResponseBody.js.map +1 -1
- package/dist/models/UpdateContactsRequest.d.ts +36 -0
- package/dist/models/UpdateContactsRequest.js.map +1 -1
- package/dist/models/UpdateContactsResponseBody.d.ts +12 -0
- package/dist/models/UpdateContactsResponseBody.js.map +1 -1
- package/dist/models/VirtualThreeElementsVerificationRequest.d.ts +53 -0
- package/dist/models/VirtualThreeElementsVerificationRequest.js +66 -0
- package/dist/models/VirtualThreeElementsVerificationRequest.js.map +1 -0
- package/dist/models/VirtualThreeElementsVerificationResponse.d.ts +19 -0
- package/dist/models/VirtualThreeElementsVerificationResponse.js +69 -0
- package/dist/models/VirtualThreeElementsVerificationResponse.js.map +1 -0
- package/dist/models/VirtualThreeElementsVerificationResponseBody.d.ts +35 -0
- package/dist/models/VirtualThreeElementsVerificationResponseBody.js +88 -0
- package/dist/models/VirtualThreeElementsVerificationResponseBody.js.map +1 -0
- package/dist/models/model.d.ts +4 -0
- package/dist/models/model.js +12 -4
- package/dist/models/model.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +612 -229
- package/src/models/CertNoThreeElementVerificationRequest.ts +15 -2
- package/src/models/CertNoThreeElementVerificationResponseBody.ts +33 -0
- package/src/models/CertNoTwoElementVerificationRequest.ts +10 -2
- package/src/models/CertNoTwoElementVerificationResponseBody.ts +25 -0
- package/src/models/CompanyFourElementsVerificationRequest.ts +10 -13
- package/src/models/CompanyFourElementsVerificationResponseBody.ts +21 -18
- package/src/models/CompanyThreeElementsVerificationRequest.ts +7 -8
- package/src/models/CompanyThreeElementsVerificationResponseBody.ts +26 -20
- package/src/models/CompanyTwoElementsVerificationRequest.ts +5 -5
- package/src/models/CompanyTwoElementsVerificationResponseBody.ts +26 -16
- package/src/models/DeleteContactsRequest.ts +2 -0
- package/src/models/DeleteContactsResponseBody.ts +17 -0
- package/src/models/DescribeEmptyNumberRequest.ts +10 -7
- package/src/models/DescribeEmptyNumberResponseBody.ts +16 -12
- package/src/models/DescribePhoneNumberAnalysisAirequest.ts +5 -5
- package/src/models/DescribePhoneNumberAnalysisAiresponseBody.ts +16 -10
- package/src/models/DescribePhoneNumberAnalysisRequest.ts +29 -2
- package/src/models/DescribePhoneNumberAnalysisResponseBody.ts +36 -1
- package/src/models/DescribePhoneNumberAnalysisTransparentResponseBody.ts +0 -16
- package/src/models/DescribePhoneNumberAttributeRequest.ts +0 -5
- package/src/models/DescribePhoneNumberAttributeResponseBody.ts +0 -67
- package/src/models/DescribePhoneNumberOnlineTimeRequest.ts +13 -14
- package/src/models/DescribePhoneNumberOnlineTimeResponseBody.ts +21 -21
- package/src/models/DescribePhoneNumberOperatorAttributeRequest.ts +20 -12
- package/src/models/DescribePhoneNumberOperatorAttributeResponseBody.ts +30 -22
- package/src/models/DescribePhoneTwiceTelVerifyRequest.ts +19 -15
- package/src/models/DescribePhoneTwiceTelVerifyResponseBody.ts +29 -19
- package/src/models/GetUaidapplyTokenSignRequest.ts +35 -0
- package/src/models/GetUaidapplyTokenSignResponseBody.ts +33 -0
- package/src/models/HistoryThreeElementsVerificationRequest.ts +43 -6
- package/src/models/HistoryThreeElementsVerificationResponseBody.ts +38 -0
- package/src/models/InvalidPhoneNumberFilterRequest.ts +2 -2
- package/src/models/InvalidPhoneNumberFilterResponseBody.ts +29 -19
- package/src/models/ListContactsRequest.ts +6 -0
- package/src/models/ListContactsResponseBody.ts +60 -0
- package/src/models/PhoneNumberEncryptRequest.ts +12 -4
- package/src/models/PhoneNumberEncryptResponseBody.ts +16 -6
- package/src/models/PhoneNumberStatusForAccountRequest.ts +20 -10
- package/src/models/PhoneNumberStatusForAccountResponseBody.ts +28 -19
- package/src/models/PhoneNumberStatusForPublicRequest.ts +17 -9
- package/src/models/PhoneNumberStatusForPublicResponseBody.ts +32 -22
- package/src/models/PhoneNumberStatusForRealRequest.ts +19 -9
- package/src/models/PhoneNumberStatusForRealResponseBody.ts +33 -22
- package/src/models/PhoneNumberStatusForSmsRequest.ts +20 -10
- package/src/models/PhoneNumberStatusForSmsResponseBody.ts +29 -20
- package/src/models/PhoneNumberStatusForVoiceRequest.ts +19 -9
- package/src/models/PhoneNumberStatusForVoiceResponseBody.ts +31 -21
- package/src/models/QueryAvailableAuthCodeRequest.ts +1 -1
- package/src/models/QueryAvailableAuthCodeResponseBody.ts +8 -7
- package/src/models/QueryPackageTypeInfoRequest.ts +1 -1
- package/src/models/QueryPackageTypeInfoResponseBody.ts +31 -4
- package/src/models/QueryTagApplyRuleResponseBody.ts +28 -15
- package/src/models/QueryTagInfoBySelectionResponseBody.ts +33 -18
- package/src/models/QueryTagListPageResponseBody.ts +23 -21
- package/src/models/QueryTaskListRequest.ts +24 -1
- package/src/models/QueryTaskListResponseBody.ts +31 -0
- package/src/models/QueryTaskListShrinkRequest.ts +24 -1
- package/src/models/QueryUsageStatisticsByTagIdRequest.ts +5 -5
- package/src/models/QueryUsageStatisticsByTagIdResponseBody.ts +23 -24
- package/src/models/SaveContactsRequest.ts +26 -0
- package/src/models/SaveContactsResponseBody.ts +12 -0
- package/src/models/ThreeElementsVerificationRequest.ts +19 -17
- package/src/models/ThreeElementsVerificationResponseBody.ts +23 -21
- package/src/models/TwoElementsVerificationRequest.ts +15 -13
- package/src/models/TwoElementsVerificationResponseBody.ts +26 -22
- package/src/models/UaidverificationRequest.ts +28 -2
- package/src/models/UaidverificationResponseBody.ts +21 -0
- package/src/models/UpdateContactsRequest.ts +36 -0
- package/src/models/UpdateContactsResponseBody.ts +12 -0
- package/src/models/VirtualThreeElementsVerificationRequest.ts +74 -0
- package/src/models/VirtualThreeElementsVerificationResponse.ts +40 -0
- package/src/models/VirtualThreeElementsVerificationResponseBody.ts +69 -0
- package/src/models/model.ts +4 -0
package/dist/client.d.ts
CHANGED
|
@@ -9,7 +9,15 @@ export default class Client extends OpenApi {
|
|
|
9
9
|
[key: string]: string;
|
|
10
10
|
}, endpoint: string): string;
|
|
11
11
|
/**
|
|
12
|
-
*
|
|
12
|
+
* Three-element (name, ID card number, and ID card photo) verification. Used to compare whether the three pieces of information (the name and ID card number filled in by the user and the uploaded portrait photo) belong to the same user.
|
|
13
|
+
*
|
|
14
|
+
* @remarks
|
|
15
|
+
* - Before using this API, log on to the Cell Phone Number Service console, go to the Tag Square page, find the corresponding tag, click Apply to Activate, fill in the application materials, and use the tag after the application is approved.
|
|
16
|
+
* - Before using this API, make sure that you have fully understood the [Cell Phone Number Service pricing](https://help.aliyun.com/document_detail/154751.html).
|
|
17
|
+
* - Billing applies only when the API return value is Code="OK". Other return results are not billed.
|
|
18
|
+
* - For the verifiable scope, see [ID Card Three Elements Verification](https://help.aliyun.com/document_detail/2844379.html).
|
|
19
|
+
* ### QPS limit
|
|
20
|
+
* - The per-user QPS limit for this API is 200 calls per second. If you exceed the limit, API calls are throttled, which may affect your business. Call the API reasonably.
|
|
13
21
|
*
|
|
14
22
|
* @param request - CertNoThreeElementVerificationRequest
|
|
15
23
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -17,14 +25,29 @@ export default class Client extends OpenApi {
|
|
|
17
25
|
*/
|
|
18
26
|
certNoThreeElementVerificationWithOptions(request: $_model.CertNoThreeElementVerificationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CertNoThreeElementVerificationResponse>;
|
|
19
27
|
/**
|
|
20
|
-
*
|
|
28
|
+
* Three-element (name, ID card number, and ID card photo) verification. Used to compare whether the three pieces of information (the name and ID card number filled in by the user and the uploaded portrait photo) belong to the same user.
|
|
29
|
+
*
|
|
30
|
+
* @remarks
|
|
31
|
+
* - Before using this API, log on to the Cell Phone Number Service console, go to the Tag Square page, find the corresponding tag, click Apply to Activate, fill in the application materials, and use the tag after the application is approved.
|
|
32
|
+
* - Before using this API, make sure that you have fully understood the [Cell Phone Number Service pricing](https://help.aliyun.com/document_detail/154751.html).
|
|
33
|
+
* - Billing applies only when the API return value is Code="OK". Other return results are not billed.
|
|
34
|
+
* - For the verifiable scope, see [ID Card Three Elements Verification](https://help.aliyun.com/document_detail/2844379.html).
|
|
35
|
+
* ### QPS limit
|
|
36
|
+
* - The per-user QPS limit for this API is 200 calls per second. If you exceed the limit, API calls are throttled, which may affect your business. Call the API reasonably.
|
|
21
37
|
*
|
|
22
38
|
* @param request - CertNoThreeElementVerificationRequest
|
|
23
39
|
* @returns CertNoThreeElementVerificationResponse
|
|
24
40
|
*/
|
|
25
41
|
certNoThreeElementVerification(request: $_model.CertNoThreeElementVerificationRequest): Promise<$_model.CertNoThreeElementVerificationResponse>;
|
|
26
42
|
/**
|
|
27
|
-
*
|
|
43
|
+
* Two-element (name and ID card number) verification. Used to verify whether the name and ID card number entered by a user belong to the same person.
|
|
44
|
+
*
|
|
45
|
+
* @remarks
|
|
46
|
+
* - Before using this operation, make sure that you have fully understood the pricing of Cell Phone Number Service.
|
|
47
|
+
* - Before using this operation, log on to the Cell Phone Number Service console. On the Tag Marketplace page, find the desired tag, click Apply to Activate, and fill in the application information. You can use the operation only after your application is approved.
|
|
48
|
+
* - The operation is charged when the response contains Code="OK" and IsConsistent != 2. Other response results are not charged.
|
|
49
|
+
* ## QPS Limit
|
|
50
|
+
* The per-user QPS limit of this operation is 200 calls per second. If the limit is exceeded, the API calls are throttled, which may affect your business. Call the operation properly.
|
|
28
51
|
*
|
|
29
52
|
* @param request - CertNoTwoElementVerificationRequest
|
|
30
53
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -32,19 +55,28 @@ export default class Client extends OpenApi {
|
|
|
32
55
|
*/
|
|
33
56
|
certNoTwoElementVerificationWithOptions(request: $_model.CertNoTwoElementVerificationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CertNoTwoElementVerificationResponse>;
|
|
34
57
|
/**
|
|
35
|
-
*
|
|
58
|
+
* Two-element (name and ID card number) verification. Used to verify whether the name and ID card number entered by a user belong to the same person.
|
|
59
|
+
*
|
|
60
|
+
* @remarks
|
|
61
|
+
* - Before using this operation, make sure that you have fully understood the pricing of Cell Phone Number Service.
|
|
62
|
+
* - Before using this operation, log on to the Cell Phone Number Service console. On the Tag Marketplace page, find the desired tag, click Apply to Activate, and fill in the application information. You can use the operation only after your application is approved.
|
|
63
|
+
* - The operation is charged when the response contains Code="OK" and IsConsistent != 2. Other response results are not charged.
|
|
64
|
+
* ## QPS Limit
|
|
65
|
+
* The per-user QPS limit of this operation is 200 calls per second. If the limit is exceeded, the API calls are throttled, which may affect your business. Call the operation properly.
|
|
36
66
|
*
|
|
37
67
|
* @param request - CertNoTwoElementVerificationRequest
|
|
38
68
|
* @returns CertNoTwoElementVerificationResponse
|
|
39
69
|
*/
|
|
40
70
|
certNoTwoElementVerification(request: $_model.CertNoTwoElementVerificationRequest): Promise<$_model.CertNoTwoElementVerificationResponse>;
|
|
41
71
|
/**
|
|
42
|
-
* Verifies
|
|
72
|
+
* Verifies the enterprise name, enterprise certificate number, enterprise legal person name, and enterprise legal person ID card number. All four items must be consistent and the enterprise\\"s operating status must be active for verification to pass.
|
|
43
73
|
*
|
|
44
74
|
* @remarks
|
|
45
|
-
*
|
|
46
|
-
*
|
|
47
|
-
*
|
|
75
|
+
* - Before you use this API, make sure that you fully understand the billing method and prices of the Enterprise Four-Element Verification product. For billing details, see [Product Billing](https://help.aliyun.com/document_detail/154751.html?spm=a2c4g.154007.0.0.3edd7eb6E90YT4).
|
|
76
|
+
* - Billing applies when VerifyResult returns true/false and ReasonCode is 0, 1, or 2 in the response. Billing does not apply in other cases.
|
|
77
|
+
* - Before you use this API, log on to the [Cell Phone Number Service console](https://account.aliyun.com/login/login.htm?oauth_callback=https%3A%2F%2Fdytns.console.aliyun.com%2Foverview%3Fspm%3Da2c4g.608385.0.0.79847f8b3awqUC&lang=zh), go to the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply to Activate**, and submit your application. You can use the API after the application is approved.
|
|
78
|
+
* ### QPS limit
|
|
79
|
+
* The per-user QPS limit for this API is 200 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call the API appropriately.
|
|
48
80
|
*
|
|
49
81
|
* @param request - CompanyFourElementsVerificationRequest
|
|
50
82
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -52,24 +84,28 @@ export default class Client extends OpenApi {
|
|
|
52
84
|
*/
|
|
53
85
|
companyFourElementsVerificationWithOptions(request: $_model.CompanyFourElementsVerificationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CompanyFourElementsVerificationResponse>;
|
|
54
86
|
/**
|
|
55
|
-
* Verifies
|
|
87
|
+
* Verifies the enterprise name, enterprise certificate number, enterprise legal person name, and enterprise legal person ID card number. All four items must be consistent and the enterprise\\"s operating status must be active for verification to pass.
|
|
56
88
|
*
|
|
57
89
|
* @remarks
|
|
58
|
-
*
|
|
59
|
-
*
|
|
60
|
-
*
|
|
90
|
+
* - Before you use this API, make sure that you fully understand the billing method and prices of the Enterprise Four-Element Verification product. For billing details, see [Product Billing](https://help.aliyun.com/document_detail/154751.html?spm=a2c4g.154007.0.0.3edd7eb6E90YT4).
|
|
91
|
+
* - Billing applies when VerifyResult returns true/false and ReasonCode is 0, 1, or 2 in the response. Billing does not apply in other cases.
|
|
92
|
+
* - Before you use this API, log on to the [Cell Phone Number Service console](https://account.aliyun.com/login/login.htm?oauth_callback=https%3A%2F%2Fdytns.console.aliyun.com%2Foverview%3Fspm%3Da2c4g.608385.0.0.79847f8b3awqUC&lang=zh), go to the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply to Activate**, and submit your application. You can use the API after the application is approved.
|
|
93
|
+
* ### QPS limit
|
|
94
|
+
* The per-user QPS limit for this API is 200 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call the API appropriately.
|
|
61
95
|
*
|
|
62
96
|
* @param request - CompanyFourElementsVerificationRequest
|
|
63
97
|
* @returns CompanyFourElementsVerificationResponse
|
|
64
98
|
*/
|
|
65
99
|
companyFourElementsVerification(request: $_model.CompanyFourElementsVerificationRequest): Promise<$_model.CompanyFourElementsVerificationResponse>;
|
|
66
100
|
/**
|
|
67
|
-
*
|
|
101
|
+
* Used to verify a company name, company certificate number, and the name of the company\\"s legal representative. Verification passes only when all three are consistent and the company\\"s operating status is in business.
|
|
68
102
|
*
|
|
69
103
|
* @remarks
|
|
70
|
-
*
|
|
71
|
-
*
|
|
72
|
-
*
|
|
104
|
+
* - Before you use this API, make sure that you have fully understood the billing method and pricing of the Three-Element Company Verification product. For billing details, see [Billing](https://help.aliyun.com/document_detail/154751.html?spm=a2c4g.154007.0.0.3edd7eb6E90YT4).
|
|
105
|
+
* - In the returned result, charges apply when VerifyResult is true/false and ReasonCode is 0/1/2. No charges apply in other cases.
|
|
106
|
+
* - Before you use this API, log on to the [Cell Phone Number Service console](https://account.aliyun.com/login/login.htm?oauth_callback=https%3A%2F%2Fdytns.console.aliyun.com%2Foverview%3Fspm%3Da2c4g.608385.0.0.79847f8b3awqUC&lang=zh), go to the [Tag Plaza](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply for Activation**, and submit the application materials. You can use the API after the application is approved.
|
|
107
|
+
* ### QPS limit
|
|
108
|
+
* The per-user QPS limit for this API is 200 calls per second. Requests that exceed this limit are throttled, which may affect your business. Call this API at a reasonable rate.
|
|
73
109
|
*
|
|
74
110
|
* @param request - CompanyThreeElementsVerificationRequest
|
|
75
111
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -77,24 +113,28 @@ export default class Client extends OpenApi {
|
|
|
77
113
|
*/
|
|
78
114
|
companyThreeElementsVerificationWithOptions(request: $_model.CompanyThreeElementsVerificationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CompanyThreeElementsVerificationResponse>;
|
|
79
115
|
/**
|
|
80
|
-
*
|
|
116
|
+
* Used to verify a company name, company certificate number, and the name of the company\\"s legal representative. Verification passes only when all three are consistent and the company\\"s operating status is in business.
|
|
81
117
|
*
|
|
82
118
|
* @remarks
|
|
83
|
-
*
|
|
84
|
-
*
|
|
85
|
-
*
|
|
119
|
+
* - Before you use this API, make sure that you have fully understood the billing method and pricing of the Three-Element Company Verification product. For billing details, see [Billing](https://help.aliyun.com/document_detail/154751.html?spm=a2c4g.154007.0.0.3edd7eb6E90YT4).
|
|
120
|
+
* - In the returned result, charges apply when VerifyResult is true/false and ReasonCode is 0/1/2. No charges apply in other cases.
|
|
121
|
+
* - Before you use this API, log on to the [Cell Phone Number Service console](https://account.aliyun.com/login/login.htm?oauth_callback=https%3A%2F%2Fdytns.console.aliyun.com%2Foverview%3Fspm%3Da2c4g.608385.0.0.79847f8b3awqUC&lang=zh), go to the [Tag Plaza](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply for Activation**, and submit the application materials. You can use the API after the application is approved.
|
|
122
|
+
* ### QPS limit
|
|
123
|
+
* The per-user QPS limit for this API is 200 calls per second. Requests that exceed this limit are throttled, which may affect your business. Call this API at a reasonable rate.
|
|
86
124
|
*
|
|
87
125
|
* @param request - CompanyThreeElementsVerificationRequest
|
|
88
126
|
* @returns CompanyThreeElementsVerificationResponse
|
|
89
127
|
*/
|
|
90
128
|
companyThreeElementsVerification(request: $_model.CompanyThreeElementsVerificationRequest): Promise<$_model.CompanyThreeElementsVerificationResponse>;
|
|
91
129
|
/**
|
|
92
|
-
*
|
|
130
|
+
* Used to verify the enterprise name and enterprise certificate number. The name and certificate must be fully consistent, and the enterprise must be in operating status for the verification to pass.
|
|
93
131
|
*
|
|
94
132
|
* @remarks
|
|
95
|
-
*
|
|
96
|
-
*
|
|
97
|
-
*
|
|
133
|
+
* - Before you use this API, make sure that you fully understand the billing methods and pricing of the Enterprise Two-Element Verification product. For billing details, see [Product billing](https://help.aliyun.com/document_detail/154751.html?spm=a2c4g.154007.0.0.3edd7eb6E90YT4).
|
|
134
|
+
* - Billing applies when Code=OK and ReasonCode=0/1/3 in the returned result. Other cases are not billed.
|
|
135
|
+
* - Before you use this API, log on to the [Cell Phone Number Service console](https://account.aliyun.com/login/login.htm?oauth_callback=https%3A%2F%2Fdytns.console.aliyun.com%2Foverview%3Fspm%3Da2c4g.608385.0.0.79847f8b3awqUC&lang=zh), find the corresponding tag on the [Tag Plaza](https://dytns.console.aliyun.com/analysis/square) page, click **Apply to Activate**, and fill in the application materials. After the application is approved, you can use the API.
|
|
136
|
+
* ### QPS limit
|
|
137
|
+
* The single-user QPS limit for this API is 200 times/second. If the limit is exceeded, API calls will be throttled, which may affect your business. Please call the API reasonably.
|
|
98
138
|
*
|
|
99
139
|
* @param request - CompanyTwoElementsVerificationRequest
|
|
100
140
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -102,19 +142,24 @@ export default class Client extends OpenApi {
|
|
|
102
142
|
*/
|
|
103
143
|
companyTwoElementsVerificationWithOptions(request: $_model.CompanyTwoElementsVerificationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.CompanyTwoElementsVerificationResponse>;
|
|
104
144
|
/**
|
|
105
|
-
*
|
|
145
|
+
* Used to verify the enterprise name and enterprise certificate number. The name and certificate must be fully consistent, and the enterprise must be in operating status for the verification to pass.
|
|
106
146
|
*
|
|
107
147
|
* @remarks
|
|
108
|
-
*
|
|
109
|
-
*
|
|
110
|
-
*
|
|
148
|
+
* - Before you use this API, make sure that you fully understand the billing methods and pricing of the Enterprise Two-Element Verification product. For billing details, see [Product billing](https://help.aliyun.com/document_detail/154751.html?spm=a2c4g.154007.0.0.3edd7eb6E90YT4).
|
|
149
|
+
* - Billing applies when Code=OK and ReasonCode=0/1/3 in the returned result. Other cases are not billed.
|
|
150
|
+
* - Before you use this API, log on to the [Cell Phone Number Service console](https://account.aliyun.com/login/login.htm?oauth_callback=https%3A%2F%2Fdytns.console.aliyun.com%2Foverview%3Fspm%3Da2c4g.608385.0.0.79847f8b3awqUC&lang=zh), find the corresponding tag on the [Tag Plaza](https://dytns.console.aliyun.com/analysis/square) page, click **Apply to Activate**, and fill in the application materials. After the application is approved, you can use the API.
|
|
151
|
+
* ### QPS limit
|
|
152
|
+
* The single-user QPS limit for this API is 200 times/second. If the limit is exceeded, API calls will be throttled, which may affect your business. Please call the API reasonably.
|
|
111
153
|
*
|
|
112
154
|
* @param request - CompanyTwoElementsVerificationRequest
|
|
113
155
|
* @returns CompanyTwoElementsVerificationResponse
|
|
114
156
|
*/
|
|
115
157
|
companyTwoElementsVerification(request: $_model.CompanyTwoElementsVerificationRequest): Promise<$_model.CompanyTwoElementsVerificationResponse>;
|
|
116
158
|
/**
|
|
117
|
-
*
|
|
159
|
+
* Deletes a contact.
|
|
160
|
+
*
|
|
161
|
+
* @remarks
|
|
162
|
+
* - Make sure you have activated Phone Number Identity Service before calling this operation.
|
|
118
163
|
*
|
|
119
164
|
* @param request - DeleteContactsRequest
|
|
120
165
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -122,24 +167,27 @@ export default class Client extends OpenApi {
|
|
|
122
167
|
*/
|
|
123
168
|
deleteContactsWithOptions(request: $_model.DeleteContactsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DeleteContactsResponse>;
|
|
124
169
|
/**
|
|
125
|
-
*
|
|
170
|
+
* Deletes a contact.
|
|
171
|
+
*
|
|
172
|
+
* @remarks
|
|
173
|
+
* - Make sure you have activated Phone Number Identity Service before calling this operation.
|
|
126
174
|
*
|
|
127
175
|
* @param request - DeleteContactsRequest
|
|
128
176
|
* @returns DeleteContactsResponse
|
|
129
177
|
*/
|
|
130
178
|
deleteContacts(request: $_model.DeleteContactsRequest): Promise<$_model.DeleteContactsResponse>;
|
|
131
179
|
/**
|
|
132
|
-
* Predicts whether a phone number is
|
|
180
|
+
* Predicts whether a phone number is invalid by using AI algorithms.
|
|
133
181
|
*
|
|
134
182
|
* @remarks
|
|
135
|
-
*
|
|
136
|
-
*
|
|
137
|
-
*
|
|
138
|
-
*
|
|
139
|
-
* ###
|
|
140
|
-
*
|
|
141
|
-
* ###
|
|
142
|
-
*
|
|
183
|
+
* - 本接口用于验证号码是否为空号。发起调用该接口验证号码请求时,系统会根据验证次数计费,标准价为0.01元/次。**请确保在使用该接口前,已充分了解本产品的收费方式和价格。**
|
|
184
|
+
* - 当返回结果中:Code="OK" 且 Status != UNKNOWN 时计费,其他情况不计费。
|
|
185
|
+
* - 由于本产品通过AI算法预测手机号的空号概率,所以无法做到100%准确。当前评估的准确率和召回率约为95%左右。**调用时请注意差别**。
|
|
186
|
+
* - 使用本接口前,请登录号码百科控制台,在[标签广场](https://dytns.console.aliyun.com/analysis/square)页面,找到对应的标签,单击**申请开通**,填写申请资料,审批通过后即可使用。
|
|
187
|
+
* ### QPS限制
|
|
188
|
+
* 本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
|
|
189
|
+
* ### 授权信息
|
|
190
|
+
* 默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。具体请参见[为RAM用户授权](https://help.aliyun.com/document_detail/154006.html)。
|
|
143
191
|
*
|
|
144
192
|
* @param request - DescribeEmptyNumberRequest
|
|
145
193
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -147,17 +195,17 @@ export default class Client extends OpenApi {
|
|
|
147
195
|
*/
|
|
148
196
|
describeEmptyNumberWithOptions(request: $_model.DescribeEmptyNumberRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribeEmptyNumberResponse>;
|
|
149
197
|
/**
|
|
150
|
-
* Predicts whether a phone number is
|
|
198
|
+
* Predicts whether a phone number is invalid by using AI algorithms.
|
|
151
199
|
*
|
|
152
200
|
* @remarks
|
|
153
|
-
*
|
|
154
|
-
*
|
|
155
|
-
*
|
|
156
|
-
*
|
|
157
|
-
* ###
|
|
158
|
-
*
|
|
159
|
-
* ###
|
|
160
|
-
*
|
|
201
|
+
* - 本接口用于验证号码是否为空号。发起调用该接口验证号码请求时,系统会根据验证次数计费,标准价为0.01元/次。**请确保在使用该接口前,已充分了解本产品的收费方式和价格。**
|
|
202
|
+
* - 当返回结果中:Code="OK" 且 Status != UNKNOWN 时计费,其他情况不计费。
|
|
203
|
+
* - 由于本产品通过AI算法预测手机号的空号概率,所以无法做到100%准确。当前评估的准确率和召回率约为95%左右。**调用时请注意差别**。
|
|
204
|
+
* - 使用本接口前,请登录号码百科控制台,在[标签广场](https://dytns.console.aliyun.com/analysis/square)页面,找到对应的标签,单击**申请开通**,填写申请资料,审批通过后即可使用。
|
|
205
|
+
* ### QPS限制
|
|
206
|
+
* 本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
|
|
207
|
+
* ### 授权信息
|
|
208
|
+
* 默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。具体请参见[为RAM用户授权](https://help.aliyun.com/document_detail/154006.html)。
|
|
161
209
|
*
|
|
162
210
|
* @param request - DescribeEmptyNumberRequest
|
|
163
211
|
* @returns DescribeEmptyNumberResponse
|
|
@@ -179,7 +227,15 @@ export default class Client extends OpenApi {
|
|
|
179
227
|
*/
|
|
180
228
|
describeMobileOperatorAttribute(request: $_model.DescribeMobileOperatorAttributeRequest): Promise<$_model.DescribeMobileOperatorAttributeResponse>;
|
|
181
229
|
/**
|
|
182
|
-
* Obtains the
|
|
230
|
+
* Obtains the result returned by phone number analysis.
|
|
231
|
+
*
|
|
232
|
+
* @remarks
|
|
233
|
+
* - Before you use this API, log on to the Phone Number Service console, go to the [Tag Plaza](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply to Activate**, fill in the application materials, and then use the API after the application is approved.
|
|
234
|
+
* - Before you use this API, make sure that you fully understand the [billing](https://help.aliyun.com/document_detail/154008.html) of Phone Number Service.
|
|
235
|
+
* ### QPS limit
|
|
236
|
+
* The QPS limit of this API is 1,000 calls per second per user. If the limit is exceeded, API calls are throttled, which may affect your business. Make calls properly.
|
|
237
|
+
* ### Authorization information
|
|
238
|
+
* By default, only Alibaba Cloud accounts can use this API. RAM users can use this API only after they are granted the related API operation permissions. For more information, see [Authorize a RAM user](https://help.aliyun.com/document_detail/154006.html).
|
|
183
239
|
*
|
|
184
240
|
* @param request - DescribePhoneNumberAnalysisRequest
|
|
185
241
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -187,17 +243,26 @@ export default class Client extends OpenApi {
|
|
|
187
243
|
*/
|
|
188
244
|
describePhoneNumberAnalysisWithOptions(request: $_model.DescribePhoneNumberAnalysisRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribePhoneNumberAnalysisResponse>;
|
|
189
245
|
/**
|
|
190
|
-
* Obtains the
|
|
246
|
+
* Obtains the result returned by phone number analysis.
|
|
247
|
+
*
|
|
248
|
+
* @remarks
|
|
249
|
+
* - Before you use this API, log on to the Phone Number Service console, go to the [Tag Plaza](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply to Activate**, fill in the application materials, and then use the API after the application is approved.
|
|
250
|
+
* - Before you use this API, make sure that you fully understand the [billing](https://help.aliyun.com/document_detail/154008.html) of Phone Number Service.
|
|
251
|
+
* ### QPS limit
|
|
252
|
+
* The QPS limit of this API is 1,000 calls per second per user. If the limit is exceeded, API calls are throttled, which may affect your business. Make calls properly.
|
|
253
|
+
* ### Authorization information
|
|
254
|
+
* By default, only Alibaba Cloud accounts can use this API. RAM users can use this API only after they are granted the related API operation permissions. For more information, see [Authorize a RAM user](https://help.aliyun.com/document_detail/154006.html).
|
|
191
255
|
*
|
|
192
256
|
* @param request - DescribePhoneNumberAnalysisRequest
|
|
193
257
|
* @returns DescribePhoneNumberAnalysisResponse
|
|
194
258
|
*/
|
|
195
259
|
describePhoneNumberAnalysis(request: $_model.DescribePhoneNumberAnalysisRequest): Promise<$_model.DescribePhoneNumberAnalysisResponse>;
|
|
196
260
|
/**
|
|
197
|
-
*
|
|
261
|
+
* Get the phone number analysis result.
|
|
198
262
|
*
|
|
199
263
|
* @remarks
|
|
200
|
-
* Before
|
|
264
|
+
* Before using this operation, log on to the Cell Phone Number Service console, go to the Tag Square page, find the corresponding tag, click Apply to activate, and fill in the application materials. You can use the operation after the application is approved.
|
|
265
|
+
* Make sure that you fully understand the billing of the Cell Phone Number Service before you use this operation.
|
|
201
266
|
*
|
|
202
267
|
* @param request - DescribePhoneNumberAnalysisAIRequest
|
|
203
268
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -205,10 +270,11 @@ export default class Client extends OpenApi {
|
|
|
205
270
|
*/
|
|
206
271
|
describePhoneNumberAnalysisAIWithOptions(request: $_model.DescribePhoneNumberAnalysisAIRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribePhoneNumberAnalysisAIResponse>;
|
|
207
272
|
/**
|
|
208
|
-
*
|
|
273
|
+
* Get the phone number analysis result.
|
|
209
274
|
*
|
|
210
275
|
* @remarks
|
|
211
|
-
* Before
|
|
276
|
+
* Before using this operation, log on to the Cell Phone Number Service console, go to the Tag Square page, find the corresponding tag, click Apply to activate, and fill in the application materials. You can use the operation after the application is approved.
|
|
277
|
+
* Make sure that you fully understand the billing of the Cell Phone Number Service before you use this operation.
|
|
212
278
|
*
|
|
213
279
|
* @param request - DescribePhoneNumberAnalysisAIRequest
|
|
214
280
|
* @returns DescribePhoneNumberAnalysisAIResponse
|
|
@@ -245,14 +311,6 @@ export default class Client extends OpenApi {
|
|
|
245
311
|
*/
|
|
246
312
|
describePhoneNumberAnalysisTransparent(request: $_model.DescribePhoneNumberAnalysisTransparentRequest): Promise<$_model.DescribePhoneNumberAnalysisTransparentResponse>;
|
|
247
313
|
/**
|
|
248
|
-
* Queries the carrier, registration location, and mobile number portability information of a phone number.
|
|
249
|
-
*
|
|
250
|
-
* @remarks
|
|
251
|
-
* Before you call this operation, make sure that you are familiar with the [billing](https://help.aliyun.com/document_detail/154751.html) of Cell Phone Number Service.
|
|
252
|
-
* * By default, only Alibaba Cloud accounts can call this operation. RAM users can call this operation only after the RAM users are granted the related permissions. For more information, see [Grant permissions to RAM users](https://help.aliyun.com/document_detail/154006.html).
|
|
253
|
-
* ### [](#qps)QPS limits
|
|
254
|
-
* You can call this operation up to 2,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
|
|
255
|
-
*
|
|
256
314
|
* @deprecated OpenAPI DescribePhoneNumberAttribute is deprecated, please use Dytnsapi::2020-02-17::DescribePhoneNumberOperatorAttribute instead.
|
|
257
315
|
*
|
|
258
316
|
* @param request - DescribePhoneNumberAttributeRequest
|
|
@@ -261,14 +319,6 @@ export default class Client extends OpenApi {
|
|
|
261
319
|
*/
|
|
262
320
|
describePhoneNumberAttributeWithOptions(request: $_model.DescribePhoneNumberAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribePhoneNumberAttributeResponse>;
|
|
263
321
|
/**
|
|
264
|
-
* Queries the carrier, registration location, and mobile number portability information of a phone number.
|
|
265
|
-
*
|
|
266
|
-
* @remarks
|
|
267
|
-
* Before you call this operation, make sure that you are familiar with the [billing](https://help.aliyun.com/document_detail/154751.html) of Cell Phone Number Service.
|
|
268
|
-
* * By default, only Alibaba Cloud accounts can call this operation. RAM users can call this operation only after the RAM users are granted the related permissions. For more information, see [Grant permissions to RAM users](https://help.aliyun.com/document_detail/154006.html).
|
|
269
|
-
* ### [](#qps)QPS limits
|
|
270
|
-
* You can call this operation up to 2,000 times per second per account. If the number of calls per second exceeds the limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limit when you call this operation.
|
|
271
|
-
*
|
|
272
322
|
* @deprecated OpenAPI DescribePhoneNumberAttribute is deprecated, please use Dytnsapi::2020-02-17::DescribePhoneNumberOperatorAttribute instead.
|
|
273
323
|
*
|
|
274
324
|
* @param request - DescribePhoneNumberAttributeRequest
|
|
@@ -276,13 +326,13 @@ export default class Client extends OpenApi {
|
|
|
276
326
|
*/
|
|
277
327
|
describePhoneNumberAttribute(request: $_model.DescribePhoneNumberAttributeRequest): Promise<$_model.DescribePhoneNumberAttributeResponse>;
|
|
278
328
|
/**
|
|
279
|
-
* Queries the
|
|
329
|
+
* Queries the duration for which a mobile user has been registered on the carrier\\"s network.
|
|
280
330
|
*
|
|
281
331
|
* @remarks
|
|
282
|
-
*
|
|
283
|
-
*
|
|
284
|
-
* ###
|
|
285
|
-
*
|
|
332
|
+
* - Before using this API, log on to the Cell Phone Number Service console, go to the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply for Activation**, fill in the application materials, and use the API after the application is approved.
|
|
333
|
+
* - Make sure that you fully understand the [product pricing](https://help.aliyun.com/document_detail/154751.html) of Cell Phone Number Service before using this API.
|
|
334
|
+
* ### QPS limit
|
|
335
|
+
* The per-user QPS limit for this API is 200 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this API at a reasonable rate.
|
|
286
336
|
*
|
|
287
337
|
* @param request - DescribePhoneNumberOnlineTimeRequest
|
|
288
338
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -290,26 +340,28 @@ export default class Client extends OpenApi {
|
|
|
290
340
|
*/
|
|
291
341
|
describePhoneNumberOnlineTimeWithOptions(request: $_model.DescribePhoneNumberOnlineTimeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribePhoneNumberOnlineTimeResponse>;
|
|
292
342
|
/**
|
|
293
|
-
* Queries the
|
|
343
|
+
* Queries the duration for which a mobile user has been registered on the carrier\\"s network.
|
|
294
344
|
*
|
|
295
345
|
* @remarks
|
|
296
|
-
*
|
|
297
|
-
*
|
|
298
|
-
* ###
|
|
299
|
-
*
|
|
346
|
+
* - Before using this API, log on to the Cell Phone Number Service console, go to the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply for Activation**, fill in the application materials, and use the API after the application is approved.
|
|
347
|
+
* - Make sure that you fully understand the [product pricing](https://help.aliyun.com/document_detail/154751.html) of Cell Phone Number Service before using this API.
|
|
348
|
+
* ### QPS limit
|
|
349
|
+
* The per-user QPS limit for this API is 200 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call this API at a reasonable rate.
|
|
300
350
|
*
|
|
301
351
|
* @param request - DescribePhoneNumberOnlineTimeRequest
|
|
302
352
|
* @returns DescribePhoneNumberOnlineTimeResponse
|
|
303
353
|
*/
|
|
304
354
|
describePhoneNumberOnlineTime(request: $_model.DescribePhoneNumberOnlineTimeRequest): Promise<$_model.DescribePhoneNumberOnlineTimeResponse>;
|
|
305
355
|
/**
|
|
306
|
-
* Queries the
|
|
356
|
+
* Queries the carrier information of a phone number, including the province, city, basic carrier (China Mobile, China Unicom, China Telecom, or China Broadnet), mobile virtual network operator (such as Alibaba Cloud Communication), whether the number has been ported, and the number segment.
|
|
307
357
|
*
|
|
308
358
|
* @remarks
|
|
309
|
-
*
|
|
310
|
-
*
|
|
311
|
-
*
|
|
312
|
-
*
|
|
359
|
+
* - Before you use this API, make sure that you are familiar with the [billing](https://help.aliyun.com/document_detail/154008.html) of Cell Phone Number Service.
|
|
360
|
+
* - By default, only Alibaba Cloud accounts can use this API. RAM users can use this API only after they are granted the required permissions. For more information, see [Grant permissions to a RAM user](https://help.aliyun.com/document_detail/154006.html).
|
|
361
|
+
* - This API is used to obtain the current carrier, location, and number portability information of a phone number. The API supports queries for **plaintext**, **MD5**, and **SHA256** encrypted phone numbers.
|
|
362
|
+
* - Before you use this API, log on to the Cell Phone Number Service console, go to the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply for Activation**, and submit the application materials. You can use the API after your application is approved.
|
|
363
|
+
* ### QPS limit
|
|
364
|
+
* The QPS limit per user for this API is 2,000 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Make calls reasonably.
|
|
313
365
|
*
|
|
314
366
|
* @param request - DescribePhoneNumberOperatorAttributeRequest
|
|
315
367
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -317,13 +369,15 @@ export default class Client extends OpenApi {
|
|
|
317
369
|
*/
|
|
318
370
|
describePhoneNumberOperatorAttributeWithOptions(request: $_model.DescribePhoneNumberOperatorAttributeRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribePhoneNumberOperatorAttributeResponse>;
|
|
319
371
|
/**
|
|
320
|
-
* Queries the
|
|
372
|
+
* Queries the carrier information of a phone number, including the province, city, basic carrier (China Mobile, China Unicom, China Telecom, or China Broadnet), mobile virtual network operator (such as Alibaba Cloud Communication), whether the number has been ported, and the number segment.
|
|
321
373
|
*
|
|
322
374
|
* @remarks
|
|
323
|
-
*
|
|
324
|
-
*
|
|
325
|
-
*
|
|
326
|
-
*
|
|
375
|
+
* - Before you use this API, make sure that you are familiar with the [billing](https://help.aliyun.com/document_detail/154008.html) of Cell Phone Number Service.
|
|
376
|
+
* - By default, only Alibaba Cloud accounts can use this API. RAM users can use this API only after they are granted the required permissions. For more information, see [Grant permissions to a RAM user](https://help.aliyun.com/document_detail/154006.html).
|
|
377
|
+
* - This API is used to obtain the current carrier, location, and number portability information of a phone number. The API supports queries for **plaintext**, **MD5**, and **SHA256** encrypted phone numbers.
|
|
378
|
+
* - Before you use this API, log on to the Cell Phone Number Service console, go to the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply for Activation**, and submit the application materials. You can use the API after your application is approved.
|
|
379
|
+
* ### QPS limit
|
|
380
|
+
* The QPS limit per user for this API is 2,000 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Make calls reasonably.
|
|
327
381
|
*
|
|
328
382
|
* @param request - DescribePhoneNumberOperatorAttributeRequest
|
|
329
383
|
* @returns DescribePhoneNumberOperatorAttributeResponse
|
|
@@ -375,16 +429,16 @@ export default class Client extends OpenApi {
|
|
|
375
429
|
*/
|
|
376
430
|
describePhoneNumberRisk(request: $_model.DescribePhoneNumberRiskRequest): Promise<$_model.DescribePhoneNumberRiskResponse>;
|
|
377
431
|
/**
|
|
378
|
-
*
|
|
432
|
+
* Quickly verify in a single request if a mobile phone number is a carrier\\"s secondary number assignment.
|
|
379
433
|
*
|
|
380
434
|
* @remarks
|
|
381
|
-
*
|
|
382
|
-
*
|
|
383
|
-
*
|
|
384
|
-
* ##
|
|
385
|
-
*
|
|
386
|
-
* ##
|
|
387
|
-
* By default, only Alibaba Cloud
|
|
435
|
+
* - Before you use this API, make sure you understand the [pricing](https://help.aliyun.com/document_detail/154751.html) for Phone Number Verification Service.
|
|
436
|
+
* - You are charged only when the API response returns `Code="OK"` and `VerifyResult` is not `0`. No charge is incurred in any other case.
|
|
437
|
+
* - Before you use this API, log in to the Phone Number Verification Service console. On the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the tag you need, click **Request Activation**, and complete the application form. You can use the API once your application is approved.
|
|
438
|
+
* ## QPS limits
|
|
439
|
+
* The QPS limit is 100 per user. If you exceed this limit, the system throttles your API calls, which may affect your business. Plan your API calls accordingly.
|
|
440
|
+
* ## Authorization
|
|
441
|
+
* By default, only an Alibaba Cloud account can call this API. A RAM user must be granted the required permissions to call the API. For more information, see [Grant permissions to a RAM user](https://help.aliyun.com/document_detail/154006.html).
|
|
388
442
|
*
|
|
389
443
|
* @param request - DescribePhoneTwiceTelVerifyRequest
|
|
390
444
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -392,23 +446,113 @@ export default class Client extends OpenApi {
|
|
|
392
446
|
*/
|
|
393
447
|
describePhoneTwiceTelVerifyWithOptions(request: $_model.DescribePhoneTwiceTelVerifyRequest, runtime: $dara.RuntimeOptions): Promise<$_model.DescribePhoneTwiceTelVerifyResponse>;
|
|
394
448
|
/**
|
|
395
|
-
*
|
|
449
|
+
* Quickly verify in a single request if a mobile phone number is a carrier\\"s secondary number assignment.
|
|
396
450
|
*
|
|
397
451
|
* @remarks
|
|
398
|
-
*
|
|
399
|
-
*
|
|
400
|
-
*
|
|
401
|
-
* ##
|
|
402
|
-
*
|
|
403
|
-
* ##
|
|
404
|
-
* By default, only Alibaba Cloud
|
|
452
|
+
* - Before you use this API, make sure you understand the [pricing](https://help.aliyun.com/document_detail/154751.html) for Phone Number Verification Service.
|
|
453
|
+
* - You are charged only when the API response returns `Code="OK"` and `VerifyResult` is not `0`. No charge is incurred in any other case.
|
|
454
|
+
* - Before you use this API, log in to the Phone Number Verification Service console. On the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the tag you need, click **Request Activation**, and complete the application form. You can use the API once your application is approved.
|
|
455
|
+
* ## QPS limits
|
|
456
|
+
* The QPS limit is 100 per user. If you exceed this limit, the system throttles your API calls, which may affect your business. Plan your API calls accordingly.
|
|
457
|
+
* ## Authorization
|
|
458
|
+
* By default, only an Alibaba Cloud account can call this API. A RAM user must be granted the required permissions to call the API. For more information, see [Grant permissions to a RAM user](https://help.aliyun.com/document_detail/154006.html).
|
|
405
459
|
*
|
|
406
460
|
* @param request - DescribePhoneTwiceTelVerifyRequest
|
|
407
461
|
* @returns DescribePhoneTwiceTelVerifyResponse
|
|
408
462
|
*/
|
|
409
463
|
describePhoneTwiceTelVerify(request: $_model.DescribePhoneTwiceTelVerifyRequest): Promise<$_model.DescribePhoneTwiceTelVerifyResponse>;
|
|
410
464
|
/**
|
|
411
|
-
*
|
|
465
|
+
* This API only provides the signing functionality for acquiring an authorization token during UAID retrieval from the three-network operators.
|
|
466
|
+
*
|
|
467
|
+
* @remarks
|
|
468
|
+
* This API provides only the **signing function for obtaining an authorization token** as part of the UAID retrieval process for China\\"s three major operators.
|
|
469
|
+
* - To generate the other parameters required to obtain the authorization token, refer to the respective operator\\"s documentation.
|
|
470
|
+
* - To request the authorization token, refer to the respective operator\\"s documentation. Note that the request must be sent from the user\\"s mobile device over a cellular network.
|
|
471
|
+
* - After obtaining the authorization token, call the [UAIDVerification](~~UAIDVerification~~) API to complete the UAID retrieval.
|
|
472
|
+
* ### How to request an authorization token
|
|
473
|
+
* >Notice:
|
|
474
|
+
* When you request an authorization token, the client or H5 page must be connected to a cellular network.
|
|
475
|
+
* #### China Mobile (CM)
|
|
476
|
+
* Protocol: HTTPS + application/json
|
|
477
|
+
* Method: POST
|
|
478
|
+
* URL: https\\://msg.cmpassport.com/h5/getMobile
|
|
479
|
+
* ##### Request parameters
|
|
480
|
+
* Request example:
|
|
481
|
+
* `{ "traceId": "mfawsxtcmyplwzpayzzvdvbsowxmkynr", "appId": "300011580392", "sign": "2c61b3c58ffbeed97461e31be4fd931a", "msgId": "redbyxsdetddwaaffajcwwapspykftzx", "expandParams": "", "businessType": "3", "version": "1.0", "timestamp": "20201125101540980" }`
|
|
482
|
+
* Parameter description:
|
|
483
|
+
* - `version`: Use `1.0`.
|
|
484
|
+
* - `timestamp`: The request timestamp, with millisecond precision. This value and its format must match the `Time` input parameter for this API.
|
|
485
|
+
* - `appId`: Use `300011580392`.
|
|
486
|
+
* - `businessType`: Use `3`.
|
|
487
|
+
* - `traceId`: The trace ID. This value must match this API\\"s `OutId` input parameter.
|
|
488
|
+
* - `sign`: Obtained by calling this API.
|
|
489
|
+
* - `msgId`: A unique message identifier.
|
|
490
|
+
* ##### Response parameters
|
|
491
|
+
* Response example:
|
|
492
|
+
* `{ "header": { "appId": "300011580392", "msgId": "redbyxsdetddwaaffajcwwapspykftzx", "timestamp": "20201125101607932" }, "body": { "resultCode": "103000", "expandParams": "", "resultDesc": "成功", "token": "H5HTTPS4187AE9743AFCB14F8D99B9D65ED9E01" } }`
|
|
493
|
+
* Retrieve the `token` from the response `body`.
|
|
494
|
+
* #### China Unicom (CU)
|
|
495
|
+
* Obtain the token in two steps.
|
|
496
|
+
* ##### Step 1: Obtain the authurl
|
|
497
|
+
* Send a request to the portal server to get the authentication server address (`authurl`).
|
|
498
|
+
* Protocol: HTTPS + application/json
|
|
499
|
+
* Method: GET
|
|
500
|
+
* URL: https\\://nisportal.10010.com:9001/api
|
|
501
|
+
* ###### Request parameters
|
|
502
|
+
* Request examples:
|
|
503
|
+
* JSON request: `?appid=1554778161153`
|
|
504
|
+
* JSONP request: `?appid=1554778161153&callback=callbackFunction`
|
|
505
|
+
* Parameter description:
|
|
506
|
+
* - `appid`: Use 1554778161153.
|
|
507
|
+
* - `callback`: The name of the JSONP callback function. This parameter is required only for JSONP requests.
|
|
508
|
+
* ###### Response parameters
|
|
509
|
+
* Response examples:
|
|
510
|
+
* JSON response:
|
|
511
|
+
* `{"authurl": "https://enrichgw.10010.com/d93222629f52ec79"}`
|
|
512
|
+
* JSONP response:
|
|
513
|
+
* `callbackFunction({"authurl":"https://enrichgw.10010.com/d93222629f52ec79"})`
|
|
514
|
+
* Retrieve the `authurl` from the response.
|
|
515
|
+
* ##### Step 2: Obtain the token
|
|
516
|
+
* Protocol: HTTPS + application/json
|
|
517
|
+
* Method: GET
|
|
518
|
+
* URL: The authurl from Step 1, with /api appended.
|
|
519
|
+
* Request URL example: `https://enrichgw.10010.com/d93222629f52ec79/api`
|
|
520
|
+
* ###### Request parameters
|
|
521
|
+
* Request examples:
|
|
522
|
+
* JSON request: `?appid=1554778161153`
|
|
523
|
+
* JSONP request: `?appid=1554778161153&callback=callbackFunction`
|
|
524
|
+
* Parameter description:
|
|
525
|
+
* - `appid`: Use 1554778161153.
|
|
526
|
+
* - `callback`: The name of the JSONP callback function. This parameter is required only for JSONP requests.
|
|
527
|
+
* ###### Response parameters
|
|
528
|
+
* Response examples:
|
|
529
|
+
* JSON response:
|
|
530
|
+
* `{ "province": "1", "code": "7nHS1nggx2WP613750206700RN6oiRN1" }`
|
|
531
|
+
* JSONP response:
|
|
532
|
+
* `callbackFunction({"province":"1","code":"7nHS3Dnkd1BS701851092400RN6oiRN1"})`
|
|
533
|
+
* Retrieve the `code` from the response.
|
|
534
|
+
* #### China Telecom (CT)
|
|
535
|
+
* Protocol: HTTPS + application/x-www-form-urlencoded;charset=UTF-8
|
|
536
|
+
* Method: GET
|
|
537
|
+
* URL: https\\://id6.me/gw/preuniq.do
|
|
538
|
+
* ##### Request parameters
|
|
539
|
+
* Request example:
|
|
540
|
+
* `?clientType=30100&appId=9390188202&format=json&sign=D63C166FA19E1996EF********09C6A5397C10B4¶mKey=1D7C25EB8B0B8B4CB3CF8DC60628F6549********786B0AF1FEF93FA1335057A35BF5F0B39A3867EAA9BE14B3898********8B01DE34965060445B6E1F66401D714650E4AB161CD6DCF4A72********3B856F22A192B8B0C39D7A55B961062E68C89C928894F119B25********7C548355FE9DB82852EB93C939F2200B48CD17¶mStr=140********95AF8E138B94754CB4CF83BA6FB********52B258BFDFD38BF233&version=1.1`
|
|
541
|
+
* Parameter description:
|
|
542
|
+
* - `appId`: Use `9390188202`.
|
|
543
|
+
* - `clientType`: The client type. This value must match the `ClientType` input parameter for this API.
|
|
544
|
+
* - `format`: Use `json` or `jsonp`.
|
|
545
|
+
* - `version`: Use `1.1`.
|
|
546
|
+
* - `sign`: Obtained by calling this API.
|
|
547
|
+
* - `paramKey`: The ciphertext of key A. Key A is a 16-character random string generated by the client. To generate paramKey, encrypt key A using the RSA algorithm and the China Telecom public key. The padding mode is `RSA/ECB/PKCS1Padding`. Download the [China Telecom RSA public key](https://id.189.cn/source/files/API.pem).
|
|
548
|
+
* - `paramStr`: The ciphertext of a parameter string. This string contains `timeStamp` (a Unix timestamp with millisecond precision, for example `1697791988302`, that corresponds to the value of the `Time` parameter of this API) and `callback` (the name of the JSONP callback function, required only when `format` is set to `jsonp`). To generate `paramStr`, encrypt the string using AES with key A. The padding mode is `AES/CBC/PKCS5Padding`, and the initialization vector is `0000000000000000`.
|
|
549
|
+
* ##### Response parameters
|
|
550
|
+
* Response example:
|
|
551
|
+
* `callback?result=10000&msg=success&data=a35336711c70456cb883f4f224e9a259`
|
|
552
|
+
* The `data` parameter contains the ciphertext of the business result. To get the result, decrypt the data value using key A, the `AES/CBC/PKCS5Padding` mode, and an initialization vector of `0000000000000000`.
|
|
553
|
+
* Decrypted business result example:
|
|
554
|
+
* `{"accessCode": "H5HTTPS4187AE9743AFCB14F8D99B9D65ED9E01"}`
|
|
555
|
+
* Retrieve the `accessCode` from the decrypted result.
|
|
412
556
|
*
|
|
413
557
|
* @param request - GetUAIDApplyTokenSignRequest
|
|
414
558
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -416,7 +560,97 @@ export default class Client extends OpenApi {
|
|
|
416
560
|
*/
|
|
417
561
|
getUAIDApplyTokenSignWithOptions(request: $_model.GetUAIDApplyTokenSignRequest, runtime: $dara.RuntimeOptions): Promise<$_model.GetUAIDApplyTokenSignResponse>;
|
|
418
562
|
/**
|
|
419
|
-
*
|
|
563
|
+
* This API only provides the signing functionality for acquiring an authorization token during UAID retrieval from the three-network operators.
|
|
564
|
+
*
|
|
565
|
+
* @remarks
|
|
566
|
+
* This API provides only the **signing function for obtaining an authorization token** as part of the UAID retrieval process for China\\"s three major operators.
|
|
567
|
+
* - To generate the other parameters required to obtain the authorization token, refer to the respective operator\\"s documentation.
|
|
568
|
+
* - To request the authorization token, refer to the respective operator\\"s documentation. Note that the request must be sent from the user\\"s mobile device over a cellular network.
|
|
569
|
+
* - After obtaining the authorization token, call the [UAIDVerification](~~UAIDVerification~~) API to complete the UAID retrieval.
|
|
570
|
+
* ### How to request an authorization token
|
|
571
|
+
* >Notice:
|
|
572
|
+
* When you request an authorization token, the client or H5 page must be connected to a cellular network.
|
|
573
|
+
* #### China Mobile (CM)
|
|
574
|
+
* Protocol: HTTPS + application/json
|
|
575
|
+
* Method: POST
|
|
576
|
+
* URL: https\\://msg.cmpassport.com/h5/getMobile
|
|
577
|
+
* ##### Request parameters
|
|
578
|
+
* Request example:
|
|
579
|
+
* `{ "traceId": "mfawsxtcmyplwzpayzzvdvbsowxmkynr", "appId": "300011580392", "sign": "2c61b3c58ffbeed97461e31be4fd931a", "msgId": "redbyxsdetddwaaffajcwwapspykftzx", "expandParams": "", "businessType": "3", "version": "1.0", "timestamp": "20201125101540980" }`
|
|
580
|
+
* Parameter description:
|
|
581
|
+
* - `version`: Use `1.0`.
|
|
582
|
+
* - `timestamp`: The request timestamp, with millisecond precision. This value and its format must match the `Time` input parameter for this API.
|
|
583
|
+
* - `appId`: Use `300011580392`.
|
|
584
|
+
* - `businessType`: Use `3`.
|
|
585
|
+
* - `traceId`: The trace ID. This value must match this API\\"s `OutId` input parameter.
|
|
586
|
+
* - `sign`: Obtained by calling this API.
|
|
587
|
+
* - `msgId`: A unique message identifier.
|
|
588
|
+
* ##### Response parameters
|
|
589
|
+
* Response example:
|
|
590
|
+
* `{ "header": { "appId": "300011580392", "msgId": "redbyxsdetddwaaffajcwwapspykftzx", "timestamp": "20201125101607932" }, "body": { "resultCode": "103000", "expandParams": "", "resultDesc": "成功", "token": "H5HTTPS4187AE9743AFCB14F8D99B9D65ED9E01" } }`
|
|
591
|
+
* Retrieve the `token` from the response `body`.
|
|
592
|
+
* #### China Unicom (CU)
|
|
593
|
+
* Obtain the token in two steps.
|
|
594
|
+
* ##### Step 1: Obtain the authurl
|
|
595
|
+
* Send a request to the portal server to get the authentication server address (`authurl`).
|
|
596
|
+
* Protocol: HTTPS + application/json
|
|
597
|
+
* Method: GET
|
|
598
|
+
* URL: https\\://nisportal.10010.com:9001/api
|
|
599
|
+
* ###### Request parameters
|
|
600
|
+
* Request examples:
|
|
601
|
+
* JSON request: `?appid=1554778161153`
|
|
602
|
+
* JSONP request: `?appid=1554778161153&callback=callbackFunction`
|
|
603
|
+
* Parameter description:
|
|
604
|
+
* - `appid`: Use 1554778161153.
|
|
605
|
+
* - `callback`: The name of the JSONP callback function. This parameter is required only for JSONP requests.
|
|
606
|
+
* ###### Response parameters
|
|
607
|
+
* Response examples:
|
|
608
|
+
* JSON response:
|
|
609
|
+
* `{"authurl": "https://enrichgw.10010.com/d93222629f52ec79"}`
|
|
610
|
+
* JSONP response:
|
|
611
|
+
* `callbackFunction({"authurl":"https://enrichgw.10010.com/d93222629f52ec79"})`
|
|
612
|
+
* Retrieve the `authurl` from the response.
|
|
613
|
+
* ##### Step 2: Obtain the token
|
|
614
|
+
* Protocol: HTTPS + application/json
|
|
615
|
+
* Method: GET
|
|
616
|
+
* URL: The authurl from Step 1, with /api appended.
|
|
617
|
+
* Request URL example: `https://enrichgw.10010.com/d93222629f52ec79/api`
|
|
618
|
+
* ###### Request parameters
|
|
619
|
+
* Request examples:
|
|
620
|
+
* JSON request: `?appid=1554778161153`
|
|
621
|
+
* JSONP request: `?appid=1554778161153&callback=callbackFunction`
|
|
622
|
+
* Parameter description:
|
|
623
|
+
* - `appid`: Use 1554778161153.
|
|
624
|
+
* - `callback`: The name of the JSONP callback function. This parameter is required only for JSONP requests.
|
|
625
|
+
* ###### Response parameters
|
|
626
|
+
* Response examples:
|
|
627
|
+
* JSON response:
|
|
628
|
+
* `{ "province": "1", "code": "7nHS1nggx2WP613750206700RN6oiRN1" }`
|
|
629
|
+
* JSONP response:
|
|
630
|
+
* `callbackFunction({"province":"1","code":"7nHS3Dnkd1BS701851092400RN6oiRN1"})`
|
|
631
|
+
* Retrieve the `code` from the response.
|
|
632
|
+
* #### China Telecom (CT)
|
|
633
|
+
* Protocol: HTTPS + application/x-www-form-urlencoded;charset=UTF-8
|
|
634
|
+
* Method: GET
|
|
635
|
+
* URL: https\\://id6.me/gw/preuniq.do
|
|
636
|
+
* ##### Request parameters
|
|
637
|
+
* Request example:
|
|
638
|
+
* `?clientType=30100&appId=9390188202&format=json&sign=D63C166FA19E1996EF********09C6A5397C10B4¶mKey=1D7C25EB8B0B8B4CB3CF8DC60628F6549********786B0AF1FEF93FA1335057A35BF5F0B39A3867EAA9BE14B3898********8B01DE34965060445B6E1F66401D714650E4AB161CD6DCF4A72********3B856F22A192B8B0C39D7A55B961062E68C89C928894F119B25********7C548355FE9DB82852EB93C939F2200B48CD17¶mStr=140********95AF8E138B94754CB4CF83BA6FB********52B258BFDFD38BF233&version=1.1`
|
|
639
|
+
* Parameter description:
|
|
640
|
+
* - `appId`: Use `9390188202`.
|
|
641
|
+
* - `clientType`: The client type. This value must match the `ClientType` input parameter for this API.
|
|
642
|
+
* - `format`: Use `json` or `jsonp`.
|
|
643
|
+
* - `version`: Use `1.1`.
|
|
644
|
+
* - `sign`: Obtained by calling this API.
|
|
645
|
+
* - `paramKey`: The ciphertext of key A. Key A is a 16-character random string generated by the client. To generate paramKey, encrypt key A using the RSA algorithm and the China Telecom public key. The padding mode is `RSA/ECB/PKCS1Padding`. Download the [China Telecom RSA public key](https://id.189.cn/source/files/API.pem).
|
|
646
|
+
* - `paramStr`: The ciphertext of a parameter string. This string contains `timeStamp` (a Unix timestamp with millisecond precision, for example `1697791988302`, that corresponds to the value of the `Time` parameter of this API) and `callback` (the name of the JSONP callback function, required only when `format` is set to `jsonp`). To generate `paramStr`, encrypt the string using AES with key A. The padding mode is `AES/CBC/PKCS5Padding`, and the initialization vector is `0000000000000000`.
|
|
647
|
+
* ##### Response parameters
|
|
648
|
+
* Response example:
|
|
649
|
+
* `callback?result=10000&msg=success&data=a35336711c70456cb883f4f224e9a259`
|
|
650
|
+
* The `data` parameter contains the ciphertext of the business result. To get the result, decrypt the data value using key A, the `AES/CBC/PKCS5Padding` mode, and an initialization vector of `0000000000000000`.
|
|
651
|
+
* Decrypted business result example:
|
|
652
|
+
* `{"accessCode": "H5HTTPS4187AE9743AFCB14F8D99B9D65ED9E01"}`
|
|
653
|
+
* Retrieve the `accessCode` from the decrypted result.
|
|
420
654
|
*
|
|
421
655
|
* @param request - GetUAIDApplyTokenSignRequest
|
|
422
656
|
* @returns GetUAIDApplyTokenSignResponse
|
|
@@ -438,7 +672,17 @@ export default class Client extends OpenApi {
|
|
|
438
672
|
*/
|
|
439
673
|
getUAIDConversionSign(request: $_model.GetUAIDConversionSignRequest): Promise<$_model.GetUAIDConversionSignResponse>;
|
|
440
674
|
/**
|
|
441
|
-
*
|
|
675
|
+
* Verifies whether a name, phone number, and ID number belonged to the same user at a specific point in time.
|
|
676
|
+
*
|
|
677
|
+
* @remarks
|
|
678
|
+
* ## Usage notes
|
|
679
|
+
* - Before you use this API, ensure you understand its [pricing](https://help.aliyun.com/zh/cpns/product-overview/pricing-of-cpns).
|
|
680
|
+
* - Before you use this API, log on to the Phone Number Intelligence console and apply for the required tag on the [Tag Plaza](https://dytns.console.aliyun.com/analysis/square) page.
|
|
681
|
+
* - You are charged for a call only when the response returns `Code=\\"OK\\"` and `IsConsistent != 0`. No charges are incurred for any other results.
|
|
682
|
+
* - Verification of China Broadcasting Network numbers (numbers with the 192 prefix) is not supported. If you provide a number with the 192 prefix, an HTTP 400 error is returned.
|
|
683
|
+
* - Due to number portability, the actual carrier may differ from the current carrier of record. You can use the `Carrier` parameter to route the query to a specific carrier.
|
|
684
|
+
* - The queries per second (QPS) limit per user is 200. Requests that exceed this limit are throttled.
|
|
685
|
+
* - In the authorization information, the action is `dytns:HistoryThreeElementsVerification`, the access level is Read, and the resource type is All Resources.
|
|
442
686
|
*
|
|
443
687
|
* @param request - HistoryThreeElementsVerificationRequest
|
|
444
688
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -446,19 +690,29 @@ export default class Client extends OpenApi {
|
|
|
446
690
|
*/
|
|
447
691
|
historyThreeElementsVerificationWithOptions(request: $_model.HistoryThreeElementsVerificationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.HistoryThreeElementsVerificationResponse>;
|
|
448
692
|
/**
|
|
449
|
-
*
|
|
693
|
+
* Verifies whether a name, phone number, and ID number belonged to the same user at a specific point in time.
|
|
694
|
+
*
|
|
695
|
+
* @remarks
|
|
696
|
+
* ## Usage notes
|
|
697
|
+
* - Before you use this API, ensure you understand its [pricing](https://help.aliyun.com/zh/cpns/product-overview/pricing-of-cpns).
|
|
698
|
+
* - Before you use this API, log on to the Phone Number Intelligence console and apply for the required tag on the [Tag Plaza](https://dytns.console.aliyun.com/analysis/square) page.
|
|
699
|
+
* - You are charged for a call only when the response returns `Code=\\"OK\\"` and `IsConsistent != 0`. No charges are incurred for any other results.
|
|
700
|
+
* - Verification of China Broadcasting Network numbers (numbers with the 192 prefix) is not supported. If you provide a number with the 192 prefix, an HTTP 400 error is returned.
|
|
701
|
+
* - Due to number portability, the actual carrier may differ from the current carrier of record. You can use the `Carrier` parameter to route the query to a specific carrier.
|
|
702
|
+
* - The queries per second (QPS) limit per user is 200. Requests that exceed this limit are throttled.
|
|
703
|
+
* - In the authorization information, the action is `dytns:HistoryThreeElementsVerification`, the access level is Read, and the resource type is All Resources.
|
|
450
704
|
*
|
|
451
705
|
* @param request - HistoryThreeElementsVerificationRequest
|
|
452
706
|
* @returns HistoryThreeElementsVerificationResponse
|
|
453
707
|
*/
|
|
454
708
|
historyThreeElementsVerification(request: $_model.HistoryThreeElementsVerificationRequest): Promise<$_model.HistoryThreeElementsVerificationResponse>;
|
|
455
709
|
/**
|
|
456
|
-
*
|
|
710
|
+
* Performs invalid phone number filtering operations.
|
|
457
711
|
*
|
|
458
712
|
* @remarks
|
|
459
|
-
* Before you call this operation,
|
|
460
|
-
* ###
|
|
461
|
-
*
|
|
713
|
+
* Before you call this operation, log on to the Cell Phone Number Service console. On the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply for Activation**, and submit the application materials. You can use this operation after the application is approved.
|
|
714
|
+
* ### QPS limit
|
|
715
|
+
* The QPS limit per user for this operation is 1,000 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call the operation at a reasonable frequency.
|
|
462
716
|
*
|
|
463
717
|
* @param request - InvalidPhoneNumberFilterRequest
|
|
464
718
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -466,19 +720,22 @@ export default class Client extends OpenApi {
|
|
|
466
720
|
*/
|
|
467
721
|
invalidPhoneNumberFilterWithOptions(request: $_model.InvalidPhoneNumberFilterRequest, runtime: $dara.RuntimeOptions): Promise<$_model.InvalidPhoneNumberFilterResponse>;
|
|
468
722
|
/**
|
|
469
|
-
*
|
|
723
|
+
* Performs invalid phone number filtering operations.
|
|
470
724
|
*
|
|
471
725
|
* @remarks
|
|
472
|
-
* Before you call this operation,
|
|
473
|
-
* ###
|
|
474
|
-
*
|
|
726
|
+
* Before you call this operation, log on to the Cell Phone Number Service console. On the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply for Activation**, and submit the application materials. You can use this operation after the application is approved.
|
|
727
|
+
* ### QPS limit
|
|
728
|
+
* The QPS limit per user for this operation is 1,000 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call the operation at a reasonable frequency.
|
|
475
729
|
*
|
|
476
730
|
* @param request - InvalidPhoneNumberFilterRequest
|
|
477
731
|
* @returns InvalidPhoneNumberFilterResponse
|
|
478
732
|
*/
|
|
479
733
|
invalidPhoneNumberFilter(request: $_model.InvalidPhoneNumberFilterRequest): Promise<$_model.InvalidPhoneNumberFilterResponse>;
|
|
480
734
|
/**
|
|
481
|
-
*
|
|
735
|
+
* Lists the alert contacts for Number Encyclopedia.
|
|
736
|
+
*
|
|
737
|
+
* @remarks
|
|
738
|
+
* - Before using this API, ensure that you have activated Number Encyclopedia.
|
|
482
739
|
*
|
|
483
740
|
* @param request - ListContactsRequest
|
|
484
741
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -486,7 +743,10 @@ export default class Client extends OpenApi {
|
|
|
486
743
|
*/
|
|
487
744
|
listContactsWithOptions(request: $_model.ListContactsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ListContactsResponse>;
|
|
488
745
|
/**
|
|
489
|
-
*
|
|
746
|
+
* Lists the alert contacts for Number Encyclopedia.
|
|
747
|
+
*
|
|
748
|
+
* @remarks
|
|
749
|
+
* - Before using this API, ensure that you have activated Number Encyclopedia.
|
|
490
750
|
*
|
|
491
751
|
* @param request - ListContactsRequest
|
|
492
752
|
* @returns ListContactsResponse
|
|
@@ -504,12 +764,12 @@ export default class Client extends OpenApi {
|
|
|
504
764
|
*/
|
|
505
765
|
phoneNumberConvertService(request: $_model.PhoneNumberConvertServiceRequest): Promise<$_model.PhoneNumberConvertServiceResponse>;
|
|
506
766
|
/**
|
|
507
|
-
* Encrypts
|
|
767
|
+
* Encrypts an original phone number into a virtual phone number that starts with 140. By integrating with Alibaba Cloud communication services, you can use the encrypted 140 phone number to initiate voice calls, achieving the effect of a virtual phone number call.
|
|
508
768
|
*
|
|
509
769
|
* @remarks
|
|
510
|
-
* Before you
|
|
511
|
-
* ###
|
|
512
|
-
*
|
|
770
|
+
* Before you use this API, log on to the Cell Phone Number Service console, go to the [Tag Plaza](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply for Activation**, and fill in the application materials. You can use this API after the application is approved.
|
|
771
|
+
* ### QPS limit
|
|
772
|
+
* The per-user QPS limit of this API is 1,000 calls per second. If the number of API calls exceeds the limit, the calls will be throttled, which may affect your business. Call the API properly.
|
|
513
773
|
*
|
|
514
774
|
* @param request - PhoneNumberEncryptRequest
|
|
515
775
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -517,26 +777,27 @@ export default class Client extends OpenApi {
|
|
|
517
777
|
*/
|
|
518
778
|
phoneNumberEncryptWithOptions(request: $_model.PhoneNumberEncryptRequest, runtime: $dara.RuntimeOptions): Promise<$_model.PhoneNumberEncryptResponse>;
|
|
519
779
|
/**
|
|
520
|
-
* Encrypts
|
|
780
|
+
* Encrypts an original phone number into a virtual phone number that starts with 140. By integrating with Alibaba Cloud communication services, you can use the encrypted 140 phone number to initiate voice calls, achieving the effect of a virtual phone number call.
|
|
521
781
|
*
|
|
522
782
|
* @remarks
|
|
523
|
-
* Before you
|
|
524
|
-
* ###
|
|
525
|
-
*
|
|
783
|
+
* Before you use this API, log on to the Cell Phone Number Service console, go to the [Tag Plaza](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply for Activation**, and fill in the application materials. You can use this API after the application is approved.
|
|
784
|
+
* ### QPS limit
|
|
785
|
+
* The per-user QPS limit of this API is 1,000 calls per second. If the number of API calls exceeds the limit, the calls will be throttled, which may affect your business. Call the API properly.
|
|
526
786
|
*
|
|
527
787
|
* @param request - PhoneNumberEncryptRequest
|
|
528
788
|
* @returns PhoneNumberEncryptResponse
|
|
529
789
|
*/
|
|
530
790
|
phoneNumberEncrypt(request: $_model.PhoneNumberEncryptRequest): Promise<$_model.PhoneNumberEncryptResponse>;
|
|
531
791
|
/**
|
|
532
|
-
*
|
|
792
|
+
* 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.
|
|
533
793
|
*
|
|
534
794
|
* @remarks
|
|
535
|
-
*
|
|
536
|
-
*
|
|
537
|
-
*
|
|
538
|
-
*
|
|
539
|
-
*
|
|
795
|
+
* - **Before you use this operation, make sure that you fully understand the [pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Intelligence.**
|
|
796
|
+
* - By default, only an Alibaba Cloud account can call this operation. A RAM user can call this operation only after receiving the required permissions. For more information, see [Grant permissions to RAM users](https://help.aliyun.com/document_detail/154006.html).
|
|
797
|
+
* - Before you use this operation, log on to the Phone Number Intelligence console. On the [Tag Plaza](https://dytns.console.aliyun.com/analysis/square) page, find the required tag, click **Apply**, and then submit the required information. You can use this operation once your application is approved.
|
|
798
|
+
* - The phone number status query feature supports numbers from China Telecom, China Unicom, and China Mobile. This feature does not support numbers from China Broadnet. If you call this operation to query a China Broadnet number, the API returns the error code `OperatorLimit`, which indicates that the query is prohibited by the carrier.
|
|
799
|
+
* ### QPS limit
|
|
800
|
+
* This operation has a queries per second (QPS) limit of 300 per user. If you exceed this limit, your API calls are throttled, which may affect your services. We recommend that you call this operation at a reasonable frequency.
|
|
540
801
|
*
|
|
541
802
|
* @param request - PhoneNumberStatusForAccountRequest
|
|
542
803
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -544,28 +805,30 @@ export default class Client extends OpenApi {
|
|
|
544
805
|
*/
|
|
545
806
|
phoneNumberStatusForAccountWithOptions(request: $_model.PhoneNumberStatusForAccountRequest, runtime: $dara.RuntimeOptions): Promise<$_model.PhoneNumberStatusForAccountResponse>;
|
|
546
807
|
/**
|
|
547
|
-
*
|
|
808
|
+
* 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.
|
|
548
809
|
*
|
|
549
810
|
* @remarks
|
|
550
|
-
*
|
|
551
|
-
*
|
|
552
|
-
*
|
|
553
|
-
*
|
|
554
|
-
*
|
|
811
|
+
* - **Before you use this operation, make sure that you fully understand the [pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Intelligence.**
|
|
812
|
+
* - By default, only an Alibaba Cloud account can call this operation. A RAM user can call this operation only after receiving the required permissions. For more information, see [Grant permissions to RAM users](https://help.aliyun.com/document_detail/154006.html).
|
|
813
|
+
* - Before you use this operation, log on to the Phone Number Intelligence console. On the [Tag Plaza](https://dytns.console.aliyun.com/analysis/square) page, find the required tag, click **Apply**, and then submit the required information. You can use this operation once your application is approved.
|
|
814
|
+
* - The phone number status query feature supports numbers from China Telecom, China Unicom, and China Mobile. This feature does not support numbers from China Broadnet. If you call this operation to query a China Broadnet number, the API returns the error code `OperatorLimit`, which indicates that the query is prohibited by the carrier.
|
|
815
|
+
* ### QPS limit
|
|
816
|
+
* This operation has a queries per second (QPS) limit of 300 per user. If you exceed this limit, your API calls are throttled, which may affect your services. We recommend that you call this operation at a reasonable frequency.
|
|
555
817
|
*
|
|
556
818
|
* @param request - PhoneNumberStatusForAccountRequest
|
|
557
819
|
* @returns PhoneNumberStatusForAccountResponse
|
|
558
820
|
*/
|
|
559
821
|
phoneNumberStatusForAccount(request: $_model.PhoneNumberStatusForAccountRequest): Promise<$_model.PhoneNumberStatusForAccountResponse>;
|
|
560
822
|
/**
|
|
561
|
-
* Queries the real-time
|
|
823
|
+
* 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.
|
|
562
824
|
*
|
|
563
825
|
* @remarks
|
|
564
|
-
*
|
|
565
|
-
*
|
|
566
|
-
*
|
|
567
|
-
*
|
|
568
|
-
*
|
|
826
|
+
* - **Before you call this operation, make sure that you fully understand the [pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Intelligence.**
|
|
827
|
+
* - By default, only an Alibaba Cloud account can call this operation. A RAM user must be granted the required permissions before calling this operation. For more information, see [Grant permissions to RAM users](https://help.aliyun.com/document_detail/154006.html).
|
|
828
|
+
* - Before calling this operation, log on to the Phone Number Intelligence console. On the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the required tag, click **Apply**, and submit your application. You can use the operation after your application is approved.
|
|
829
|
+
* - The number status query feature supports numbers from China Telecom, China Unicom, and China Mobile, but does not support numbers from China Broadnet. If you call this operation to query the status of a China Broadnet number, the `OperatorLimit` error code is returned, which indicates that the query is prohibited by the carrier.
|
|
830
|
+
* ### QPS limit
|
|
831
|
+
* The queries per second (QPS) limit for each user is 300. API calls that exceed this limit are throttled. To avoid business disruptions, plan your calls accordingly.
|
|
569
832
|
*
|
|
570
833
|
* @param request - PhoneNumberStatusForPublicRequest
|
|
571
834
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -573,28 +836,30 @@ export default class Client extends OpenApi {
|
|
|
573
836
|
*/
|
|
574
837
|
phoneNumberStatusForPublicWithOptions(request: $_model.PhoneNumberStatusForPublicRequest, runtime: $dara.RuntimeOptions): Promise<$_model.PhoneNumberStatusForPublicResponse>;
|
|
575
838
|
/**
|
|
576
|
-
* Queries the real-time
|
|
839
|
+
* 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.
|
|
577
840
|
*
|
|
578
841
|
* @remarks
|
|
579
|
-
*
|
|
580
|
-
*
|
|
581
|
-
*
|
|
582
|
-
*
|
|
583
|
-
*
|
|
842
|
+
* - **Before you call this operation, make sure that you fully understand the [pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Intelligence.**
|
|
843
|
+
* - By default, only an Alibaba Cloud account can call this operation. A RAM user must be granted the required permissions before calling this operation. For more information, see [Grant permissions to RAM users](https://help.aliyun.com/document_detail/154006.html).
|
|
844
|
+
* - Before calling this operation, log on to the Phone Number Intelligence console. On the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the required tag, click **Apply**, and submit your application. You can use the operation after your application is approved.
|
|
845
|
+
* - The number status query feature supports numbers from China Telecom, China Unicom, and China Mobile, but does not support numbers from China Broadnet. If you call this operation to query the status of a China Broadnet number, the `OperatorLimit` error code is returned, which indicates that the query is prohibited by the carrier.
|
|
846
|
+
* ### QPS limit
|
|
847
|
+
* The queries per second (QPS) limit for each user is 300. API calls that exceed this limit are throttled. To avoid business disruptions, plan your calls accordingly.
|
|
584
848
|
*
|
|
585
849
|
* @param request - PhoneNumberStatusForPublicRequest
|
|
586
850
|
* @returns PhoneNumberStatusForPublicResponse
|
|
587
851
|
*/
|
|
588
852
|
phoneNumberStatusForPublic(request: $_model.PhoneNumberStatusForPublicRequest): Promise<$_model.PhoneNumberStatusForPublicResponse>;
|
|
589
853
|
/**
|
|
590
|
-
* Queries the real-time
|
|
854
|
+
* 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.
|
|
591
855
|
*
|
|
592
856
|
* @remarks
|
|
593
|
-
*
|
|
594
|
-
*
|
|
595
|
-
*
|
|
596
|
-
*
|
|
597
|
-
*
|
|
857
|
+
* - **Before calling this operation, ensure you fully understand the [pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Intelligence.**
|
|
858
|
+
* - By default, only an Alibaba Cloud account can call this operation. To allow a RAM user to call this operation, you must first grant the required permissions. For more information, see [Grant permissions to RAM users](https://help.aliyun.com/document_detail/154006.html).
|
|
859
|
+
* - Before you call this operation, log on to the Phone Number Intelligence console. On the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the required tag, click **Request Activation**, and then submit your application. You can call this operation only after your application is approved.
|
|
860
|
+
* - This operation supports phone numbers from China Telecom, China Unicom, and China Mobile. Numbers from China Broadnet are not supported. If you call this operation to query a China Broadnet number, the API returns the error code `OperatorLimit` and an error message indicating that the query is restricted by the carrier.
|
|
861
|
+
* ### QPS limit
|
|
862
|
+
* The QPS limit for this operation is 300 queries per second (QPS) per user. The system throttles calls that exceed this limit, which may affect your business. Plan your calls accordingly.
|
|
598
863
|
*
|
|
599
864
|
* @param request - PhoneNumberStatusForRealRequest
|
|
600
865
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -602,28 +867,30 @@ export default class Client extends OpenApi {
|
|
|
602
867
|
*/
|
|
603
868
|
phoneNumberStatusForRealWithOptions(request: $_model.PhoneNumberStatusForRealRequest, runtime: $dara.RuntimeOptions): Promise<$_model.PhoneNumberStatusForRealResponse>;
|
|
604
869
|
/**
|
|
605
|
-
* Queries the real-time
|
|
870
|
+
* 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.
|
|
606
871
|
*
|
|
607
872
|
* @remarks
|
|
608
|
-
*
|
|
609
|
-
*
|
|
610
|
-
*
|
|
611
|
-
*
|
|
612
|
-
*
|
|
873
|
+
* - **Before calling this operation, ensure you fully understand the [pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Intelligence.**
|
|
874
|
+
* - By default, only an Alibaba Cloud account can call this operation. To allow a RAM user to call this operation, you must first grant the required permissions. For more information, see [Grant permissions to RAM users](https://help.aliyun.com/document_detail/154006.html).
|
|
875
|
+
* - Before you call this operation, log on to the Phone Number Intelligence console. On the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the required tag, click **Request Activation**, and then submit your application. You can call this operation only after your application is approved.
|
|
876
|
+
* - This operation supports phone numbers from China Telecom, China Unicom, and China Mobile. Numbers from China Broadnet are not supported. If you call this operation to query a China Broadnet number, the API returns the error code `OperatorLimit` and an error message indicating that the query is restricted by the carrier.
|
|
877
|
+
* ### QPS limit
|
|
878
|
+
* The QPS limit for this operation is 300 queries per second (QPS) per user. The system throttles calls that exceed this limit, which may affect your business. Plan your calls accordingly.
|
|
613
879
|
*
|
|
614
880
|
* @param request - PhoneNumberStatusForRealRequest
|
|
615
881
|
* @returns PhoneNumberStatusForRealResponse
|
|
616
882
|
*/
|
|
617
883
|
phoneNumberStatusForReal(request: $_model.PhoneNumberStatusForRealRequest): Promise<$_model.PhoneNumberStatusForRealResponse>;
|
|
618
884
|
/**
|
|
619
|
-
*
|
|
885
|
+
* 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.
|
|
620
886
|
*
|
|
621
887
|
* @remarks
|
|
622
|
-
*
|
|
623
|
-
*
|
|
624
|
-
*
|
|
625
|
-
*
|
|
626
|
-
*
|
|
888
|
+
* - **Before you call this operation, make sure you understand the [Product Pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Pedia**.
|
|
889
|
+
* - By default, only an Alibaba Cloud account can call this operation. A RAM user can call this operation only after being granted the required permissions. For more information, see [Grant permissions to a RAM user](https://help.aliyun.com/document_detail/154006.html).
|
|
890
|
+
* - Before calling this operation, log on to the Phone Number Pedia console. On the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the required tag, click **Request Activation**, and then complete the application form. You can use this operation only after your application is approved.
|
|
891
|
+
* - This feature supports phone numbers from China Telecom, China Unicom, and China Mobile, but does not support phone numbers from China Broadnet. If you call this operation to query the status of a China Broadnet number, the `OperatorLimit` error code and the "The number is limited by the operator." message are returned.
|
|
892
|
+
* ### QPS limit
|
|
893
|
+
* This operation is limited to 300 queries per second (QPS) for each user. Calls that exceed this limit are throttled, which may affect your business. Plan your calls accordingly.
|
|
627
894
|
*
|
|
628
895
|
* @param request - PhoneNumberStatusForSmsRequest
|
|
629
896
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -631,28 +898,30 @@ export default class Client extends OpenApi {
|
|
|
631
898
|
*/
|
|
632
899
|
phoneNumberStatusForSmsWithOptions(request: $_model.PhoneNumberStatusForSmsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.PhoneNumberStatusForSmsResponse>;
|
|
633
900
|
/**
|
|
634
|
-
*
|
|
901
|
+
* 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.
|
|
635
902
|
*
|
|
636
903
|
* @remarks
|
|
637
|
-
*
|
|
638
|
-
*
|
|
639
|
-
*
|
|
640
|
-
*
|
|
641
|
-
*
|
|
904
|
+
* - **Before you call this operation, make sure you understand the [Product Pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Pedia**.
|
|
905
|
+
* - By default, only an Alibaba Cloud account can call this operation. A RAM user can call this operation only after being granted the required permissions. For more information, see [Grant permissions to a RAM user](https://help.aliyun.com/document_detail/154006.html).
|
|
906
|
+
* - Before calling this operation, log on to the Phone Number Pedia console. On the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the required tag, click **Request Activation**, and then complete the application form. You can use this operation only after your application is approved.
|
|
907
|
+
* - This feature supports phone numbers from China Telecom, China Unicom, and China Mobile, but does not support phone numbers from China Broadnet. If you call this operation to query the status of a China Broadnet number, the `OperatorLimit` error code and the "The number is limited by the operator." message are returned.
|
|
908
|
+
* ### QPS limit
|
|
909
|
+
* This operation is limited to 300 queries per second (QPS) for each user. Calls that exceed this limit are throttled, which may affect your business. Plan your calls accordingly.
|
|
642
910
|
*
|
|
643
911
|
* @param request - PhoneNumberStatusForSmsRequest
|
|
644
912
|
* @returns PhoneNumberStatusForSmsResponse
|
|
645
913
|
*/
|
|
646
914
|
phoneNumberStatusForSms(request: $_model.PhoneNumberStatusForSmsRequest): Promise<$_model.PhoneNumberStatusForSmsResponse>;
|
|
647
915
|
/**
|
|
648
|
-
* Queries the real-time
|
|
916
|
+
* 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.
|
|
649
917
|
*
|
|
650
918
|
* @remarks
|
|
651
|
-
*
|
|
652
|
-
*
|
|
653
|
-
*
|
|
654
|
-
*
|
|
655
|
-
*
|
|
919
|
+
* - **Before you use this API, make sure that you understand the [pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Encyclopedia**.
|
|
920
|
+
* - By default, only Alibaba Cloud accounts can call this API. To allow a RAM user to do so, you must grant them the required permissions. For more information, see [Grant permissions to RAM users](https://help.aliyun.com/document_detail/154006.html).
|
|
921
|
+
* - Before you use this API, log in to the Phone Number Encyclopedia console. On the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the required tag, click **Apply for Access**, and then complete the application form. You can call this API after your application is approved.
|
|
922
|
+
* - This feature supports phone numbers from China Telecom, China Unicom, and China Mobile, but not from China Broadnet. If you query a China Broadnet number, the `OperatorLimit` error code and an error message are returned: The number is limited by the operator.
|
|
923
|
+
* ### QPS limit
|
|
924
|
+
* The QPS limit for a single user is 300 queries per second. If you exceed this limit, the system throttles your API calls, which may impact your business. To avoid interruptions, call this API at a reasonable rate.
|
|
656
925
|
*
|
|
657
926
|
* @param request - PhoneNumberStatusForVoiceRequest
|
|
658
927
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -660,14 +929,15 @@ export default class Client extends OpenApi {
|
|
|
660
929
|
*/
|
|
661
930
|
phoneNumberStatusForVoiceWithOptions(request: $_model.PhoneNumberStatusForVoiceRequest, runtime: $dara.RuntimeOptions): Promise<$_model.PhoneNumberStatusForVoiceResponse>;
|
|
662
931
|
/**
|
|
663
|
-
* Queries the real-time
|
|
932
|
+
* 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.
|
|
664
933
|
*
|
|
665
934
|
* @remarks
|
|
666
|
-
*
|
|
667
|
-
*
|
|
668
|
-
*
|
|
669
|
-
*
|
|
670
|
-
*
|
|
935
|
+
* - **Before you use this API, make sure that you understand the [pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Encyclopedia**.
|
|
936
|
+
* - By default, only Alibaba Cloud accounts can call this API. To allow a RAM user to do so, you must grant them the required permissions. For more information, see [Grant permissions to RAM users](https://help.aliyun.com/document_detail/154006.html).
|
|
937
|
+
* - Before you use this API, log in to the Phone Number Encyclopedia console. On the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the required tag, click **Apply for Access**, and then complete the application form. You can call this API after your application is approved.
|
|
938
|
+
* - This feature supports phone numbers from China Telecom, China Unicom, and China Mobile, but not from China Broadnet. If you query a China Broadnet number, the `OperatorLimit` error code and an error message are returned: The number is limited by the operator.
|
|
939
|
+
* ### QPS limit
|
|
940
|
+
* The QPS limit for a single user is 300 queries per second. If you exceed this limit, the system throttles your API calls, which may impact your business. To avoid interruptions, call this API at a reasonable rate.
|
|
671
941
|
*
|
|
672
942
|
* @param request - PhoneNumberStatusForVoiceRequest
|
|
673
943
|
* @returns PhoneNumberStatusForVoiceResponse
|
|
@@ -689,7 +959,7 @@ export default class Client extends OpenApi {
|
|
|
689
959
|
*/
|
|
690
960
|
queryAvailableAuthCode(request: $_model.QueryAvailableAuthCodeRequest): Promise<$_model.QueryAvailableAuthCodeResponse>;
|
|
691
961
|
/**
|
|
692
|
-
*
|
|
962
|
+
* Queries package type information.
|
|
693
963
|
*
|
|
694
964
|
* @param request - QueryPackageTypeInfoRequest
|
|
695
965
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -697,7 +967,7 @@ export default class Client extends OpenApi {
|
|
|
697
967
|
*/
|
|
698
968
|
queryPackageTypeInfoWithOptions(request: $_model.QueryPackageTypeInfoRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryPackageTypeInfoResponse>;
|
|
699
969
|
/**
|
|
700
|
-
*
|
|
970
|
+
* Queries package type information.
|
|
701
971
|
*
|
|
702
972
|
* @param request - QueryPackageTypeInfoRequest
|
|
703
973
|
* @returns QueryPackageTypeInfoResponse
|
|
@@ -749,7 +1019,7 @@ export default class Client extends OpenApi {
|
|
|
749
1019
|
*/
|
|
750
1020
|
queryTagApplyRule(request: $_model.QueryTagApplyRuleRequest): Promise<$_model.QueryTagApplyRuleResponse>;
|
|
751
1021
|
/**
|
|
752
|
-
* Queries information
|
|
1022
|
+
* Queries tag information.
|
|
753
1023
|
*
|
|
754
1024
|
* @param request - QueryTagInfoBySelectionRequest
|
|
755
1025
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -757,14 +1027,14 @@ export default class Client extends OpenApi {
|
|
|
757
1027
|
*/
|
|
758
1028
|
queryTagInfoBySelectionWithOptions(request: $_model.QueryTagInfoBySelectionRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryTagInfoBySelectionResponse>;
|
|
759
1029
|
/**
|
|
760
|
-
* Queries information
|
|
1030
|
+
* Queries tag information.
|
|
761
1031
|
*
|
|
762
1032
|
* @param request - QueryTagInfoBySelectionRequest
|
|
763
1033
|
* @returns QueryTagInfoBySelectionResponse
|
|
764
1034
|
*/
|
|
765
1035
|
queryTagInfoBySelection(request: $_model.QueryTagInfoBySelectionRequest): Promise<$_model.QueryTagInfoBySelectionResponse>;
|
|
766
1036
|
/**
|
|
767
|
-
* Queries
|
|
1037
|
+
* Queries the tag list by page.
|
|
768
1038
|
*
|
|
769
1039
|
* @param request - QueryTagListPageRequest
|
|
770
1040
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -772,14 +1042,14 @@ export default class Client extends OpenApi {
|
|
|
772
1042
|
*/
|
|
773
1043
|
queryTagListPageWithOptions(request: $_model.QueryTagListPageRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryTagListPageResponse>;
|
|
774
1044
|
/**
|
|
775
|
-
* Queries
|
|
1045
|
+
* Queries the tag list by page.
|
|
776
1046
|
*
|
|
777
1047
|
* @param request - QueryTagListPageRequest
|
|
778
1048
|
* @returns QueryTagListPageResponse
|
|
779
1049
|
*/
|
|
780
1050
|
queryTagListPage(request: $_model.QueryTagListPageRequest): Promise<$_model.QueryTagListPageResponse>;
|
|
781
1051
|
/**
|
|
782
|
-
*
|
|
1052
|
+
* Queries a list of offline tasks.
|
|
783
1053
|
*
|
|
784
1054
|
* @param tmpReq - QueryTaskListRequest
|
|
785
1055
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -787,14 +1057,14 @@ export default class Client extends OpenApi {
|
|
|
787
1057
|
*/
|
|
788
1058
|
queryTaskListWithOptions(tmpReq: $_model.QueryTaskListRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryTaskListResponse>;
|
|
789
1059
|
/**
|
|
790
|
-
*
|
|
1060
|
+
* Queries a list of offline tasks.
|
|
791
1061
|
*
|
|
792
1062
|
* @param request - QueryTaskListRequest
|
|
793
1063
|
* @returns QueryTaskListResponse
|
|
794
1064
|
*/
|
|
795
1065
|
queryTaskList(request: $_model.QueryTaskListRequest): Promise<$_model.QueryTaskListResponse>;
|
|
796
1066
|
/**
|
|
797
|
-
* Queries
|
|
1067
|
+
* Queries usage statistics by tag ID.
|
|
798
1068
|
*
|
|
799
1069
|
* @param request - QueryUsageStatisticsByTagIdRequest
|
|
800
1070
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -802,14 +1072,17 @@ export default class Client extends OpenApi {
|
|
|
802
1072
|
*/
|
|
803
1073
|
queryUsageStatisticsByTagIdWithOptions(request: $_model.QueryUsageStatisticsByTagIdRequest, runtime: $dara.RuntimeOptions): Promise<$_model.QueryUsageStatisticsByTagIdResponse>;
|
|
804
1074
|
/**
|
|
805
|
-
* Queries
|
|
1075
|
+
* Queries usage statistics by tag ID.
|
|
806
1076
|
*
|
|
807
1077
|
* @param request - QueryUsageStatisticsByTagIdRequest
|
|
808
1078
|
* @returns QueryUsageStatisticsByTagIdResponse
|
|
809
1079
|
*/
|
|
810
1080
|
queryUsageStatisticsByTagId(request: $_model.QueryUsageStatisticsByTagIdRequest): Promise<$_model.QueryUsageStatisticsByTagIdResponse>;
|
|
811
1081
|
/**
|
|
812
|
-
*
|
|
1082
|
+
* Saves an alert contact.
|
|
1083
|
+
*
|
|
1084
|
+
* @remarks
|
|
1085
|
+
* - Before you call this operation, ensure you have activated Phone Number Intelligence.
|
|
813
1086
|
*
|
|
814
1087
|
* @param request - SaveContactsRequest
|
|
815
1088
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -817,21 +1090,25 @@ export default class Client extends OpenApi {
|
|
|
817
1090
|
*/
|
|
818
1091
|
saveContactsWithOptions(request: $_model.SaveContactsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.SaveContactsResponse>;
|
|
819
1092
|
/**
|
|
820
|
-
*
|
|
1093
|
+
* Saves an alert contact.
|
|
1094
|
+
*
|
|
1095
|
+
* @remarks
|
|
1096
|
+
* - Before you call this operation, ensure you have activated Phone Number Intelligence.
|
|
821
1097
|
*
|
|
822
1098
|
* @param request - SaveContactsRequest
|
|
823
1099
|
* @returns SaveContactsResponse
|
|
824
1100
|
*/
|
|
825
1101
|
saveContacts(request: $_model.SaveContactsRequest): Promise<$_model.SaveContactsResponse>;
|
|
826
1102
|
/**
|
|
827
|
-
*
|
|
1103
|
+
* Verification of three elements (name, mobile phone number, and ID card number). Used to verify whether the name, mobile phone number, and ID card number entered by a user belong to the same user.
|
|
828
1104
|
*
|
|
829
1105
|
* @remarks
|
|
830
|
-
*
|
|
831
|
-
*
|
|
832
|
-
*
|
|
833
|
-
*
|
|
834
|
-
*
|
|
1106
|
+
* - Before you call this API, make sure that you have fully understood the [pricing](https://help.aliyun.com/document_detail/154751.html) of Cell Phone Number Service.
|
|
1107
|
+
* - Before you call this API, log on to the Cell Phone Number Service console, go to the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply for Activation**, fill in the application materials, and call the API after the application is approved.
|
|
1108
|
+
* - Billing applies when the API returns Code=\\"OK\\" and IsConsistent != 2. Other return results are not billed.
|
|
1109
|
+
* - The verification of virtual carrier numbers is not supported. Virtual carrier numbers refer to numbers that start with 170, 171, 162, or 165.
|
|
1110
|
+
* ### QPS limit
|
|
1111
|
+
* The QPS limit per user for this API is 200 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call the API in a reasonable manner.
|
|
835
1112
|
*
|
|
836
1113
|
* @param request - ThreeElementsVerificationRequest
|
|
837
1114
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -839,28 +1116,30 @@ export default class Client extends OpenApi {
|
|
|
839
1116
|
*/
|
|
840
1117
|
threeElementsVerificationWithOptions(request: $_model.ThreeElementsVerificationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.ThreeElementsVerificationResponse>;
|
|
841
1118
|
/**
|
|
842
|
-
*
|
|
1119
|
+
* Verification of three elements (name, mobile phone number, and ID card number). Used to verify whether the name, mobile phone number, and ID card number entered by a user belong to the same user.
|
|
843
1120
|
*
|
|
844
1121
|
* @remarks
|
|
845
|
-
*
|
|
846
|
-
*
|
|
847
|
-
*
|
|
848
|
-
*
|
|
849
|
-
*
|
|
1122
|
+
* - Before you call this API, make sure that you have fully understood the [pricing](https://help.aliyun.com/document_detail/154751.html) of Cell Phone Number Service.
|
|
1123
|
+
* - Before you call this API, log on to the Cell Phone Number Service console, go to the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply for Activation**, fill in the application materials, and call the API after the application is approved.
|
|
1124
|
+
* - Billing applies when the API returns Code=\\"OK\\" and IsConsistent != 2. Other return results are not billed.
|
|
1125
|
+
* - The verification of virtual carrier numbers is not supported. Virtual carrier numbers refer to numbers that start with 170, 171, 162, or 165.
|
|
1126
|
+
* ### QPS limit
|
|
1127
|
+
* The QPS limit per user for this API is 200 calls per second. If the limit is exceeded, API calls are throttled, which may affect your business. Call the API in a reasonable manner.
|
|
850
1128
|
*
|
|
851
1129
|
* @param request - ThreeElementsVerificationRequest
|
|
852
1130
|
* @returns ThreeElementsVerificationResponse
|
|
853
1131
|
*/
|
|
854
1132
|
threeElementsVerification(request: $_model.ThreeElementsVerificationRequest): Promise<$_model.ThreeElementsVerificationResponse>;
|
|
855
1133
|
/**
|
|
856
|
-
*
|
|
1134
|
+
* Two-element (name and phone number) verification. Used to compare whether the name and phone number entered by the user belong to the same user.
|
|
857
1135
|
*
|
|
858
1136
|
* @remarks
|
|
859
|
-
*
|
|
860
|
-
*
|
|
861
|
-
*
|
|
862
|
-
*
|
|
863
|
-
*
|
|
1137
|
+
* - Before using this API, ensure that you fully understand the [product pricing](https://help.aliyun.com/document_detail/154751.html) of Cell Phone Number Service.
|
|
1138
|
+
* - Before using this API, log on to the Cell Phone Number Service console, go to the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply to Enable**, fill in the application materials, and use it after the approval.
|
|
1139
|
+
* - Billing is applied when the API returns Code="OK" and IsConsistent != 2. Other return results are not billed.
|
|
1140
|
+
* - MVNO number verification is not supported. MVNO numbers refer to numbers starting with 170, 171, 162, and 165.
|
|
1141
|
+
* ### QPS limit
|
|
1142
|
+
* The per-user QPS limit of this API is 200 times/second. If the limit is exceeded, API calls will be throttled, which may affect your business. Please call the API reasonably.
|
|
864
1143
|
*
|
|
865
1144
|
* @param request - TwoElementsVerificationRequest
|
|
866
1145
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -868,14 +1147,15 @@ export default class Client extends OpenApi {
|
|
|
868
1147
|
*/
|
|
869
1148
|
twoElementsVerificationWithOptions(request: $_model.TwoElementsVerificationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.TwoElementsVerificationResponse>;
|
|
870
1149
|
/**
|
|
871
|
-
*
|
|
1150
|
+
* Two-element (name and phone number) verification. Used to compare whether the name and phone number entered by the user belong to the same user.
|
|
872
1151
|
*
|
|
873
1152
|
* @remarks
|
|
874
|
-
*
|
|
875
|
-
*
|
|
876
|
-
*
|
|
877
|
-
*
|
|
878
|
-
*
|
|
1153
|
+
* - Before using this API, ensure that you fully understand the [product pricing](https://help.aliyun.com/document_detail/154751.html) of Cell Phone Number Service.
|
|
1154
|
+
* - Before using this API, log on to the Cell Phone Number Service console, go to the [Tag Square](https://dytns.console.aliyun.com/analysis/square) page, find the corresponding tag, click **Apply to Enable**, fill in the application materials, and use it after the approval.
|
|
1155
|
+
* - Billing is applied when the API returns Code="OK" and IsConsistent != 2. Other return results are not billed.
|
|
1156
|
+
* - MVNO number verification is not supported. MVNO numbers refer to numbers starting with 170, 171, 162, and 165.
|
|
1157
|
+
* ### QPS limit
|
|
1158
|
+
* The per-user QPS limit of this API is 200 times/second. If the limit is exceeded, API calls will be throttled, which may affect your business. Please call the API reasonably.
|
|
879
1159
|
*
|
|
880
1160
|
* @param request - TwoElementsVerificationRequest
|
|
881
1161
|
* @returns TwoElementsVerificationResponse
|
|
@@ -912,7 +1192,14 @@ export default class Client extends OpenApi {
|
|
|
912
1192
|
*/
|
|
913
1193
|
uAIDConversion(request: $_model.UAIDConversionRequest): Promise<$_model.UAIDConversionResponse>;
|
|
914
1194
|
/**
|
|
915
|
-
* Obtains a
|
|
1195
|
+
* Obtains a UAID based on the carrier authorization token.
|
|
1196
|
+
* For information about how to obtain the authorization token and its signature, see the GetUAIDApplyTokenSign API documentation.
|
|
1197
|
+
* A UAID is 64 characters in length. The first 32 characters describe the device information, and the last 32 characters describe the phone number information.
|
|
1198
|
+
*
|
|
1199
|
+
* @remarks
|
|
1200
|
+
* Before you call this API, make sure that you have fully understood the billing method and [pricing](https://www.aliyun.com/price/product#/dytns/detail/dytns_penqbag_public_cn) of Cell Phone Number Service.
|
|
1201
|
+
* Obtains a UAID based on the carrier authorization token.
|
|
1202
|
+
* For information about how to obtain the authorization token and its signature, see the GetUAIDApplyTokenSign API documentation.
|
|
916
1203
|
*
|
|
917
1204
|
* @param request - UAIDVerificationRequest
|
|
918
1205
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -920,14 +1207,24 @@ export default class Client extends OpenApi {
|
|
|
920
1207
|
*/
|
|
921
1208
|
uAIDVerificationWithOptions(request: $_model.UAIDVerificationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UAIDVerificationResponse>;
|
|
922
1209
|
/**
|
|
923
|
-
* Obtains a
|
|
1210
|
+
* Obtains a UAID based on the carrier authorization token.
|
|
1211
|
+
* For information about how to obtain the authorization token and its signature, see the GetUAIDApplyTokenSign API documentation.
|
|
1212
|
+
* A UAID is 64 characters in length. The first 32 characters describe the device information, and the last 32 characters describe the phone number information.
|
|
1213
|
+
*
|
|
1214
|
+
* @remarks
|
|
1215
|
+
* Before you call this API, make sure that you have fully understood the billing method and [pricing](https://www.aliyun.com/price/product#/dytns/detail/dytns_penqbag_public_cn) of Cell Phone Number Service.
|
|
1216
|
+
* Obtains a UAID based on the carrier authorization token.
|
|
1217
|
+
* For information about how to obtain the authorization token and its signature, see the GetUAIDApplyTokenSign API documentation.
|
|
924
1218
|
*
|
|
925
1219
|
* @param request - UAIDVerificationRequest
|
|
926
1220
|
* @returns UAIDVerificationResponse
|
|
927
1221
|
*/
|
|
928
1222
|
uAIDVerification(request: $_model.UAIDVerificationRequest): Promise<$_model.UAIDVerificationResponse>;
|
|
929
1223
|
/**
|
|
930
|
-
*
|
|
1224
|
+
* Updates an alert contact.
|
|
1225
|
+
*
|
|
1226
|
+
* @remarks
|
|
1227
|
+
* - Ensure that you have activated the Phone Number Information Service before calling this operation.
|
|
931
1228
|
*
|
|
932
1229
|
* @param request - UpdateContactsRequest
|
|
933
1230
|
* @param runtime - runtime options for this request RuntimeOptions
|
|
@@ -935,10 +1232,28 @@ export default class Client extends OpenApi {
|
|
|
935
1232
|
*/
|
|
936
1233
|
updateContactsWithOptions(request: $_model.UpdateContactsRequest, runtime: $dara.RuntimeOptions): Promise<$_model.UpdateContactsResponse>;
|
|
937
1234
|
/**
|
|
938
|
-
*
|
|
1235
|
+
* Updates an alert contact.
|
|
1236
|
+
*
|
|
1237
|
+
* @remarks
|
|
1238
|
+
* - Ensure that you have activated the Phone Number Information Service before calling this operation.
|
|
939
1239
|
*
|
|
940
1240
|
* @param request - UpdateContactsRequest
|
|
941
1241
|
* @returns UpdateContactsResponse
|
|
942
1242
|
*/
|
|
943
1243
|
updateContacts(request: $_model.UpdateContactsRequest): Promise<$_model.UpdateContactsResponse>;
|
|
1244
|
+
/**
|
|
1245
|
+
* 虚商三要素
|
|
1246
|
+
*
|
|
1247
|
+
* @param request - VirtualThreeElementsVerificationRequest
|
|
1248
|
+
* @param runtime - runtime options for this request RuntimeOptions
|
|
1249
|
+
* @returns VirtualThreeElementsVerificationResponse
|
|
1250
|
+
*/
|
|
1251
|
+
virtualThreeElementsVerificationWithOptions(request: $_model.VirtualThreeElementsVerificationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.VirtualThreeElementsVerificationResponse>;
|
|
1252
|
+
/**
|
|
1253
|
+
* 虚商三要素
|
|
1254
|
+
*
|
|
1255
|
+
* @param request - VirtualThreeElementsVerificationRequest
|
|
1256
|
+
* @returns VirtualThreeElementsVerificationResponse
|
|
1257
|
+
*/
|
|
1258
|
+
virtualThreeElementsVerification(request: $_model.VirtualThreeElementsVerificationRequest): Promise<$_model.VirtualThreeElementsVerificationResponse>;
|
|
944
1259
|
}
|