@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.
Files changed (222) hide show
  1. package/dist/client.d.ts +543 -228
  2. package/dist/client.js +605 -229
  3. package/dist/client.js.map +1 -1
  4. package/dist/models/CertNoThreeElementVerificationRequest.d.ts +15 -2
  5. package/dist/models/CertNoThreeElementVerificationRequest.js.map +1 -1
  6. package/dist/models/CertNoThreeElementVerificationResponseBody.d.ts +33 -0
  7. package/dist/models/CertNoThreeElementVerificationResponseBody.js.map +1 -1
  8. package/dist/models/CertNoTwoElementVerificationRequest.d.ts +10 -2
  9. package/dist/models/CertNoTwoElementVerificationRequest.js.map +1 -1
  10. package/dist/models/CertNoTwoElementVerificationResponseBody.d.ts +25 -0
  11. package/dist/models/CertNoTwoElementVerificationResponseBody.js.map +1 -1
  12. package/dist/models/CompanyFourElementsVerificationRequest.d.ts +10 -13
  13. package/dist/models/CompanyFourElementsVerificationRequest.js.map +1 -1
  14. package/dist/models/CompanyFourElementsVerificationResponseBody.d.ts +21 -18
  15. package/dist/models/CompanyFourElementsVerificationResponseBody.js.map +1 -1
  16. package/dist/models/CompanyThreeElementsVerificationRequest.d.ts +7 -8
  17. package/dist/models/CompanyThreeElementsVerificationRequest.js.map +1 -1
  18. package/dist/models/CompanyThreeElementsVerificationResponseBody.d.ts +26 -20
  19. package/dist/models/CompanyThreeElementsVerificationResponseBody.js.map +1 -1
  20. package/dist/models/CompanyTwoElementsVerificationRequest.d.ts +5 -5
  21. package/dist/models/CompanyTwoElementsVerificationResponseBody.d.ts +26 -16
  22. package/dist/models/CompanyTwoElementsVerificationResponseBody.js.map +1 -1
  23. package/dist/models/DeleteContactsRequest.d.ts +2 -0
  24. package/dist/models/DeleteContactsRequest.js.map +1 -1
  25. package/dist/models/DeleteContactsResponseBody.d.ts +17 -0
  26. package/dist/models/DeleteContactsResponseBody.js.map +1 -1
  27. package/dist/models/DescribeEmptyNumberRequest.d.ts +10 -7
  28. package/dist/models/DescribeEmptyNumberRequest.js.map +1 -1
  29. package/dist/models/DescribeEmptyNumberResponseBody.d.ts +16 -12
  30. package/dist/models/DescribeEmptyNumberResponseBody.js.map +1 -1
  31. package/dist/models/DescribePhoneNumberAnalysisAirequest.d.ts +5 -5
  32. package/dist/models/DescribePhoneNumberAnalysisAiresponseBody.d.ts +16 -10
  33. package/dist/models/DescribePhoneNumberAnalysisAiresponseBody.js.map +1 -1
  34. package/dist/models/DescribePhoneNumberAnalysisRequest.d.ts +29 -2
  35. package/dist/models/DescribePhoneNumberAnalysisRequest.js.map +1 -1
  36. package/dist/models/DescribePhoneNumberAnalysisResponseBody.d.ts +36 -1
  37. package/dist/models/DescribePhoneNumberAnalysisResponseBody.js.map +1 -1
  38. package/dist/models/DescribePhoneNumberAnalysisTransparentResponseBody.d.ts +0 -16
  39. package/dist/models/DescribePhoneNumberAnalysisTransparentResponseBody.js.map +1 -1
  40. package/dist/models/DescribePhoneNumberAttributeRequest.d.ts +0 -5
  41. package/dist/models/DescribePhoneNumberAttributeRequest.js.map +1 -1
  42. package/dist/models/DescribePhoneNumberAttributeResponseBody.d.ts +0 -67
  43. package/dist/models/DescribePhoneNumberAttributeResponseBody.js.map +1 -1
  44. package/dist/models/DescribePhoneNumberOnlineTimeRequest.d.ts +13 -14
  45. package/dist/models/DescribePhoneNumberOnlineTimeRequest.js.map +1 -1
  46. package/dist/models/DescribePhoneNumberOnlineTimeResponseBody.d.ts +21 -21
  47. package/dist/models/DescribePhoneNumberOnlineTimeResponseBody.js.map +1 -1
  48. package/dist/models/DescribePhoneNumberOperatorAttributeRequest.d.ts +20 -12
  49. package/dist/models/DescribePhoneNumberOperatorAttributeRequest.js.map +1 -1
  50. package/dist/models/DescribePhoneNumberOperatorAttributeResponseBody.d.ts +30 -22
  51. package/dist/models/DescribePhoneNumberOperatorAttributeResponseBody.js.map +1 -1
  52. package/dist/models/DescribePhoneTwiceTelVerifyRequest.d.ts +18 -14
  53. package/dist/models/DescribePhoneTwiceTelVerifyRequest.js.map +1 -1
  54. package/dist/models/DescribePhoneTwiceTelVerifyResponseBody.d.ts +29 -19
  55. package/dist/models/DescribePhoneTwiceTelVerifyResponseBody.js.map +1 -1
  56. package/dist/models/GetUaidapplyTokenSignRequest.d.ts +35 -0
  57. package/dist/models/GetUaidapplyTokenSignRequest.js.map +1 -1
  58. package/dist/models/GetUaidapplyTokenSignResponseBody.d.ts +33 -0
  59. package/dist/models/GetUaidapplyTokenSignResponseBody.js.map +1 -1
  60. package/dist/models/HistoryThreeElementsVerificationRequest.d.ts +43 -6
  61. package/dist/models/HistoryThreeElementsVerificationRequest.js.map +1 -1
  62. package/dist/models/HistoryThreeElementsVerificationResponseBody.d.ts +38 -0
  63. package/dist/models/HistoryThreeElementsVerificationResponseBody.js.map +1 -1
  64. package/dist/models/InvalidPhoneNumberFilterRequest.d.ts +2 -2
  65. package/dist/models/InvalidPhoneNumberFilterResponseBody.d.ts +29 -19
  66. package/dist/models/InvalidPhoneNumberFilterResponseBody.js.map +1 -1
  67. package/dist/models/ListContactsRequest.d.ts +6 -0
  68. package/dist/models/ListContactsRequest.js.map +1 -1
  69. package/dist/models/ListContactsResponseBody.d.ts +60 -0
  70. package/dist/models/ListContactsResponseBody.js.map +1 -1
  71. package/dist/models/PhoneNumberEncryptRequest.d.ts +12 -4
  72. package/dist/models/PhoneNumberEncryptRequest.js.map +1 -1
  73. package/dist/models/PhoneNumberEncryptResponseBody.d.ts +16 -6
  74. package/dist/models/PhoneNumberEncryptResponseBody.js.map +1 -1
  75. package/dist/models/PhoneNumberStatusForAccountRequest.d.ts +20 -10
  76. package/dist/models/PhoneNumberStatusForAccountRequest.js.map +1 -1
  77. package/dist/models/PhoneNumberStatusForAccountResponseBody.d.ts +28 -19
  78. package/dist/models/PhoneNumberStatusForAccountResponseBody.js.map +1 -1
  79. package/dist/models/PhoneNumberStatusForPublicRequest.d.ts +17 -9
  80. package/dist/models/PhoneNumberStatusForPublicRequest.js.map +1 -1
  81. package/dist/models/PhoneNumberStatusForPublicResponseBody.d.ts +32 -22
  82. package/dist/models/PhoneNumberStatusForPublicResponseBody.js.map +1 -1
  83. package/dist/models/PhoneNumberStatusForRealRequest.d.ts +19 -9
  84. package/dist/models/PhoneNumberStatusForRealRequest.js.map +1 -1
  85. package/dist/models/PhoneNumberStatusForRealResponseBody.d.ts +33 -22
  86. package/dist/models/PhoneNumberStatusForRealResponseBody.js.map +1 -1
  87. package/dist/models/PhoneNumberStatusForSmsRequest.d.ts +20 -10
  88. package/dist/models/PhoneNumberStatusForSmsRequest.js.map +1 -1
  89. package/dist/models/PhoneNumberStatusForSmsResponseBody.d.ts +29 -20
  90. package/dist/models/PhoneNumberStatusForSmsResponseBody.js.map +1 -1
  91. package/dist/models/PhoneNumberStatusForVoiceRequest.d.ts +19 -9
  92. package/dist/models/PhoneNumberStatusForVoiceRequest.js.map +1 -1
  93. package/dist/models/PhoneNumberStatusForVoiceResponseBody.d.ts +31 -21
  94. package/dist/models/PhoneNumberStatusForVoiceResponseBody.js.map +1 -1
  95. package/dist/models/QueryAvailableAuthCodeRequest.d.ts +1 -1
  96. package/dist/models/QueryAvailableAuthCodeResponseBody.d.ts +8 -7
  97. package/dist/models/QueryAvailableAuthCodeResponseBody.js.map +1 -1
  98. package/dist/models/QueryPackageTypeInfoRequest.d.ts +1 -1
  99. package/dist/models/QueryPackageTypeInfoResponseBody.d.ts +31 -4
  100. package/dist/models/QueryPackageTypeInfoResponseBody.js.map +1 -1
  101. package/dist/models/QueryTagApplyRuleResponseBody.d.ts +28 -15
  102. package/dist/models/QueryTagApplyRuleResponseBody.js.map +1 -1
  103. package/dist/models/QueryTagInfoBySelectionResponseBody.d.ts +33 -18
  104. package/dist/models/QueryTagInfoBySelectionResponseBody.js.map +1 -1
  105. package/dist/models/QueryTagListPageResponseBody.d.ts +23 -21
  106. package/dist/models/QueryTagListPageResponseBody.js.map +1 -1
  107. package/dist/models/QueryTaskListRequest.d.ts +24 -1
  108. package/dist/models/QueryTaskListRequest.js.map +1 -1
  109. package/dist/models/QueryTaskListResponseBody.d.ts +31 -0
  110. package/dist/models/QueryTaskListResponseBody.js.map +1 -1
  111. package/dist/models/QueryTaskListShrinkRequest.d.ts +24 -1
  112. package/dist/models/QueryTaskListShrinkRequest.js.map +1 -1
  113. package/dist/models/QueryUsageStatisticsByTagIdRequest.d.ts +5 -5
  114. package/dist/models/QueryUsageStatisticsByTagIdResponseBody.d.ts +23 -24
  115. package/dist/models/QueryUsageStatisticsByTagIdResponseBody.js.map +1 -1
  116. package/dist/models/SaveContactsRequest.d.ts +26 -0
  117. package/dist/models/SaveContactsRequest.js.map +1 -1
  118. package/dist/models/SaveContactsResponseBody.d.ts +12 -0
  119. package/dist/models/SaveContactsResponseBody.js.map +1 -1
  120. package/dist/models/ThreeElementsVerificationRequest.d.ts +19 -17
  121. package/dist/models/ThreeElementsVerificationRequest.js.map +1 -1
  122. package/dist/models/ThreeElementsVerificationResponseBody.d.ts +23 -21
  123. package/dist/models/ThreeElementsVerificationResponseBody.js.map +1 -1
  124. package/dist/models/TwoElementsVerificationRequest.d.ts +15 -13
  125. package/dist/models/TwoElementsVerificationRequest.js.map +1 -1
  126. package/dist/models/TwoElementsVerificationResponseBody.d.ts +26 -22
  127. package/dist/models/TwoElementsVerificationResponseBody.js.map +1 -1
  128. package/dist/models/UaidverificationRequest.d.ts +28 -2
  129. package/dist/models/UaidverificationRequest.js.map +1 -1
  130. package/dist/models/UaidverificationResponseBody.d.ts +21 -0
  131. package/dist/models/UaidverificationResponseBody.js.map +1 -1
  132. package/dist/models/UpdateContactsRequest.d.ts +36 -0
  133. package/dist/models/UpdateContactsRequest.js.map +1 -1
  134. package/dist/models/UpdateContactsResponseBody.d.ts +12 -0
  135. package/dist/models/UpdateContactsResponseBody.js.map +1 -1
  136. package/dist/models/VirtualThreeElementsVerificationRequest.d.ts +53 -0
  137. package/dist/models/VirtualThreeElementsVerificationRequest.js +66 -0
  138. package/dist/models/VirtualThreeElementsVerificationRequest.js.map +1 -0
  139. package/dist/models/VirtualThreeElementsVerificationResponse.d.ts +19 -0
  140. package/dist/models/VirtualThreeElementsVerificationResponse.js +69 -0
  141. package/dist/models/VirtualThreeElementsVerificationResponse.js.map +1 -0
  142. package/dist/models/VirtualThreeElementsVerificationResponseBody.d.ts +35 -0
  143. package/dist/models/VirtualThreeElementsVerificationResponseBody.js +88 -0
  144. package/dist/models/VirtualThreeElementsVerificationResponseBody.js.map +1 -0
  145. package/dist/models/model.d.ts +4 -0
  146. package/dist/models/model.js +12 -4
  147. package/dist/models/model.js.map +1 -1
  148. package/package.json +1 -1
  149. package/src/client.ts +612 -229
  150. package/src/models/CertNoThreeElementVerificationRequest.ts +15 -2
  151. package/src/models/CertNoThreeElementVerificationResponseBody.ts +33 -0
  152. package/src/models/CertNoTwoElementVerificationRequest.ts +10 -2
  153. package/src/models/CertNoTwoElementVerificationResponseBody.ts +25 -0
  154. package/src/models/CompanyFourElementsVerificationRequest.ts +10 -13
  155. package/src/models/CompanyFourElementsVerificationResponseBody.ts +21 -18
  156. package/src/models/CompanyThreeElementsVerificationRequest.ts +7 -8
  157. package/src/models/CompanyThreeElementsVerificationResponseBody.ts +26 -20
  158. package/src/models/CompanyTwoElementsVerificationRequest.ts +5 -5
  159. package/src/models/CompanyTwoElementsVerificationResponseBody.ts +26 -16
  160. package/src/models/DeleteContactsRequest.ts +2 -0
  161. package/src/models/DeleteContactsResponseBody.ts +17 -0
  162. package/src/models/DescribeEmptyNumberRequest.ts +10 -7
  163. package/src/models/DescribeEmptyNumberResponseBody.ts +16 -12
  164. package/src/models/DescribePhoneNumberAnalysisAirequest.ts +5 -5
  165. package/src/models/DescribePhoneNumberAnalysisAiresponseBody.ts +16 -10
  166. package/src/models/DescribePhoneNumberAnalysisRequest.ts +29 -2
  167. package/src/models/DescribePhoneNumberAnalysisResponseBody.ts +36 -1
  168. package/src/models/DescribePhoneNumberAnalysisTransparentResponseBody.ts +0 -16
  169. package/src/models/DescribePhoneNumberAttributeRequest.ts +0 -5
  170. package/src/models/DescribePhoneNumberAttributeResponseBody.ts +0 -67
  171. package/src/models/DescribePhoneNumberOnlineTimeRequest.ts +13 -14
  172. package/src/models/DescribePhoneNumberOnlineTimeResponseBody.ts +21 -21
  173. package/src/models/DescribePhoneNumberOperatorAttributeRequest.ts +20 -12
  174. package/src/models/DescribePhoneNumberOperatorAttributeResponseBody.ts +30 -22
  175. package/src/models/DescribePhoneTwiceTelVerifyRequest.ts +19 -15
  176. package/src/models/DescribePhoneTwiceTelVerifyResponseBody.ts +29 -19
  177. package/src/models/GetUaidapplyTokenSignRequest.ts +35 -0
  178. package/src/models/GetUaidapplyTokenSignResponseBody.ts +33 -0
  179. package/src/models/HistoryThreeElementsVerificationRequest.ts +43 -6
  180. package/src/models/HistoryThreeElementsVerificationResponseBody.ts +38 -0
  181. package/src/models/InvalidPhoneNumberFilterRequest.ts +2 -2
  182. package/src/models/InvalidPhoneNumberFilterResponseBody.ts +29 -19
  183. package/src/models/ListContactsRequest.ts +6 -0
  184. package/src/models/ListContactsResponseBody.ts +60 -0
  185. package/src/models/PhoneNumberEncryptRequest.ts +12 -4
  186. package/src/models/PhoneNumberEncryptResponseBody.ts +16 -6
  187. package/src/models/PhoneNumberStatusForAccountRequest.ts +20 -10
  188. package/src/models/PhoneNumberStatusForAccountResponseBody.ts +28 -19
  189. package/src/models/PhoneNumberStatusForPublicRequest.ts +17 -9
  190. package/src/models/PhoneNumberStatusForPublicResponseBody.ts +32 -22
  191. package/src/models/PhoneNumberStatusForRealRequest.ts +19 -9
  192. package/src/models/PhoneNumberStatusForRealResponseBody.ts +33 -22
  193. package/src/models/PhoneNumberStatusForSmsRequest.ts +20 -10
  194. package/src/models/PhoneNumberStatusForSmsResponseBody.ts +29 -20
  195. package/src/models/PhoneNumberStatusForVoiceRequest.ts +19 -9
  196. package/src/models/PhoneNumberStatusForVoiceResponseBody.ts +31 -21
  197. package/src/models/QueryAvailableAuthCodeRequest.ts +1 -1
  198. package/src/models/QueryAvailableAuthCodeResponseBody.ts +8 -7
  199. package/src/models/QueryPackageTypeInfoRequest.ts +1 -1
  200. package/src/models/QueryPackageTypeInfoResponseBody.ts +31 -4
  201. package/src/models/QueryTagApplyRuleResponseBody.ts +28 -15
  202. package/src/models/QueryTagInfoBySelectionResponseBody.ts +33 -18
  203. package/src/models/QueryTagListPageResponseBody.ts +23 -21
  204. package/src/models/QueryTaskListRequest.ts +24 -1
  205. package/src/models/QueryTaskListResponseBody.ts +31 -0
  206. package/src/models/QueryTaskListShrinkRequest.ts +24 -1
  207. package/src/models/QueryUsageStatisticsByTagIdRequest.ts +5 -5
  208. package/src/models/QueryUsageStatisticsByTagIdResponseBody.ts +23 -24
  209. package/src/models/SaveContactsRequest.ts +26 -0
  210. package/src/models/SaveContactsResponseBody.ts +12 -0
  211. package/src/models/ThreeElementsVerificationRequest.ts +19 -17
  212. package/src/models/ThreeElementsVerificationResponseBody.ts +23 -21
  213. package/src/models/TwoElementsVerificationRequest.ts +15 -13
  214. package/src/models/TwoElementsVerificationResponseBody.ts +26 -22
  215. package/src/models/UaidverificationRequest.ts +28 -2
  216. package/src/models/UaidverificationResponseBody.ts +21 -0
  217. package/src/models/UpdateContactsRequest.ts +36 -0
  218. package/src/models/UpdateContactsResponseBody.ts +12 -0
  219. package/src/models/VirtualThreeElementsVerificationRequest.ts +74 -0
  220. package/src/models/VirtualThreeElementsVerificationResponse.ts +40 -0
  221. package/src/models/VirtualThreeElementsVerificationResponseBody.ts +69 -0
  222. package/src/models/model.ts +4 -0
package/src/client.ts CHANGED
@@ -11,7 +11,32 @@ export default class Client extends OpenApi {
11
11
 
12
12
  constructor(config: $OpenApiUtil.Config) {
13
13
  super(config);
14
- this._endpointRule = "central";
14
+ this._endpointRule = "regional";
15
+ this._endpointMap = {
16
+ 'us-west-1': "dytnsapi.aliyuncs.com",
17
+ 'us-east-1': "dytnsapi.aliyuncs.com",
18
+ 'me-east-1': "dytnsapi.aliyuncs.com",
19
+ 'eu-west-1': "dytnsapi.aliyuncs.com",
20
+ 'eu-central-1': "dytnsapi.aliyuncs.com",
21
+ 'cn-zhangjiakou': "dytnsapi.aliyuncs.com",
22
+ 'cn-wulanchabu': "dytnsapi.aliyuncs.com",
23
+ 'cn-shenzhen-finance-1': "dytnsapi.aliyuncs.com",
24
+ 'cn-shenzhen': "dytnsapi.aliyuncs.com",
25
+ 'cn-shanghai-finance-1': "dytnsapi.aliyuncs.com",
26
+ 'cn-shanghai': "dytnsapi.aliyuncs.com",
27
+ 'cn-qingdao': "dytnsapi.aliyuncs.com",
28
+ 'cn-huhehaote': "dytnsapi.aliyuncs.com",
29
+ 'cn-hongkong': "dytnsapi.aliyuncs.com",
30
+ 'cn-hangzhou-finance': "dytnsapi.aliyuncs.com",
31
+ 'cn-hangzhou': "dytnsapi.aliyuncs.com",
32
+ 'cn-chengdu': "dytnsapi.aliyuncs.com",
33
+ 'cn-beijing-finance-1': "dytnsapi.aliyuncs.com",
34
+ 'cn-beijing': "dytnsapi.aliyuncs.com",
35
+ 'ap-southeast-5': "dytnsapi.aliyuncs.com",
36
+ 'ap-southeast-3': "dytnsapi.aliyuncs.com",
37
+ 'ap-southeast-1': "dytnsapi.aliyuncs.com",
38
+ 'ap-northeast-1': "dytnsapi.aliyuncs.com",
39
+ };
15
40
  this.checkConfig(config);
16
41
  this._endpoint = this.getEndpoint("dytnsapi", this._regionId, this._endpointRule, this._network, this._suffix, this._endpointMap, this._endpoint);
17
42
  }
@@ -30,7 +55,15 @@ export default class Client extends OpenApi {
30
55
  }
31
56
 
32
57
  /**
33
- * 身份证三要素
58
+ * 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.
59
+ *
60
+ * @remarks
61
+ * - 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.
62
+ * - 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).
63
+ * - Billing applies only when the API return value is Code="OK". Other return results are not billed.
64
+ * - For the verifiable scope, see [ID Card Three Elements Verification](https://help.aliyun.com/document_detail/2844379.html).
65
+ * ### QPS limit
66
+ * - 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.
34
67
  *
35
68
  * @param request - CertNoThreeElementVerificationRequest
36
69
  * @param runtime - runtime options for this request RuntimeOptions
@@ -89,7 +122,15 @@ export default class Client extends OpenApi {
89
122
  }
90
123
 
91
124
  /**
92
- * 身份证三要素
125
+ * 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.
126
+ *
127
+ * @remarks
128
+ * - 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.
129
+ * - 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).
130
+ * - Billing applies only when the API return value is Code="OK". Other return results are not billed.
131
+ * - For the verifiable scope, see [ID Card Three Elements Verification](https://help.aliyun.com/document_detail/2844379.html).
132
+ * ### QPS limit
133
+ * - 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.
93
134
  *
94
135
  * @param request - CertNoThreeElementVerificationRequest
95
136
  * @returns CertNoThreeElementVerificationResponse
@@ -100,7 +141,14 @@ export default class Client extends OpenApi {
100
141
  }
101
142
 
102
143
  /**
103
- * 身份证二要素认证
144
+ * 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.
145
+ *
146
+ * @remarks
147
+ * - Before using this operation, make sure that you have fully understood the pricing of Cell Phone Number Service.
148
+ * - 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.
149
+ * - The operation is charged when the response contains Code="OK" and IsConsistent != 2. Other response results are not charged.
150
+ * ## QPS Limit
151
+ * 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.
104
152
  *
105
153
  * @param request - CertNoTwoElementVerificationRequest
106
154
  * @param runtime - runtime options for this request RuntimeOptions
@@ -151,7 +199,14 @@ export default class Client extends OpenApi {
151
199
  }
152
200
 
153
201
  /**
154
- * 身份证二要素认证
202
+ * 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.
203
+ *
204
+ * @remarks
205
+ * - Before using this operation, make sure that you have fully understood the pricing of Cell Phone Number Service.
206
+ * - 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.
207
+ * - The operation is charged when the response contains Code="OK" and IsConsistent != 2. Other response results are not charged.
208
+ * ## QPS Limit
209
+ * 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.
155
210
  *
156
211
  * @param request - CertNoTwoElementVerificationRequest
157
212
  * @returns CertNoTwoElementVerificationResponse
@@ -162,12 +217,14 @@ export default class Client extends OpenApi {
162
217
  }
163
218
 
164
219
  /**
165
- * Verifies whether the enterprise name, the business license number, and the name and ID card of the legal representative belong to the same enterprise. The verification is successful only when the preceding four elements belong to the same enterprise and the business status of the enterprise is Active.
220
+ * 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.
166
221
  *
167
222
  * @remarks
168
- * Before you call this operation, make sure that you are familiar with the billing of services related to four-element verification for enterprises. For more information, see [Billing](https://help.aliyun.com/document_detail/154751.html?spm=a2c4g.154007.0.0.3edd7eb6E90YT4).
169
- * * You are charged only if the value of VerifyResult is true or false and the value of ReasonCode is 0, 1, or 2.
170
- * * Before you call this operation, perform the following operations: 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). On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
223
+ * - 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).
224
+ * - Billing applies when VerifyResult returns true/false and ReasonCode is 0, 1, or 2 in the response. Billing does not apply in other cases.
225
+ * - 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.
226
+ * ### QPS limit
227
+ * 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.
171
228
  *
172
229
  * @param request - CompanyFourElementsVerificationRequest
173
230
  * @param runtime - runtime options for this request RuntimeOptions
@@ -226,12 +283,14 @@ export default class Client extends OpenApi {
226
283
  }
227
284
 
228
285
  /**
229
- * Verifies whether the enterprise name, the business license number, and the name and ID card of the legal representative belong to the same enterprise. The verification is successful only when the preceding four elements belong to the same enterprise and the business status of the enterprise is Active.
286
+ * 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.
230
287
  *
231
288
  * @remarks
232
- * Before you call this operation, make sure that you are familiar with the billing of services related to four-element verification for enterprises. For more information, see [Billing](https://help.aliyun.com/document_detail/154751.html?spm=a2c4g.154007.0.0.3edd7eb6E90YT4).
233
- * * You are charged only if the value of VerifyResult is true or false and the value of ReasonCode is 0, 1, or 2.
234
- * * Before you call this operation, perform the following operations: 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). On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
289
+ * - 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).
290
+ * - Billing applies when VerifyResult returns true/false and ReasonCode is 0, 1, or 2 in the response. Billing does not apply in other cases.
291
+ * - 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.
292
+ * ### QPS limit
293
+ * 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.
235
294
  *
236
295
  * @param request - CompanyFourElementsVerificationRequest
237
296
  * @returns CompanyFourElementsVerificationResponse
@@ -242,12 +301,14 @@ export default class Client extends OpenApi {
242
301
  }
243
302
 
244
303
  /**
245
- * Verifies whether the enterprise name, the business license number, and the name of the legal representative belong to the same enterprise. The verification is successful only when the three elements belong to the same enterprise and the business status of the enterprise is Active.
304
+ * 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.
246
305
  *
247
306
  * @remarks
248
- * Before you call this operation, make sure that you are familiar with the billing of services related to three-element verification for enterprises. For more information, see [Billing](https://help.aliyun.com/document_detail/154751.html?spm=a2c4g.154007.0.0.3edd7eb6E90YT4).
249
- * * You are charged only if the value of VerifyResult is true or false and the value of ReasonCode is 0, 1, or 2.
250
- * * Before you call this operation, perform the following operations: 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). On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
307
+ * - 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).
308
+ * - In the returned result, charges apply when VerifyResult is true/false and ReasonCode is 0/1/2. No charges apply in other cases.
309
+ * - 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.
310
+ * ### QPS limit
311
+ * 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.
251
312
  *
252
313
  * @param request - CompanyThreeElementsVerificationRequest
253
314
  * @param runtime - runtime options for this request RuntimeOptions
@@ -302,12 +363,14 @@ export default class Client extends OpenApi {
302
363
  }
303
364
 
304
365
  /**
305
- * Verifies whether the enterprise name, the business license number, and the name of the legal representative belong to the same enterprise. The verification is successful only when the three elements belong to the same enterprise and the business status of the enterprise is Active.
366
+ * 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.
306
367
  *
307
368
  * @remarks
308
- * Before you call this operation, make sure that you are familiar with the billing of services related to three-element verification for enterprises. For more information, see [Billing](https://help.aliyun.com/document_detail/154751.html?spm=a2c4g.154007.0.0.3edd7eb6E90YT4).
309
- * * You are charged only if the value of VerifyResult is true or false and the value of ReasonCode is 0, 1, or 2.
310
- * * Before you call this operation, perform the following operations: 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). On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
369
+ * - 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).
370
+ * - In the returned result, charges apply when VerifyResult is true/false and ReasonCode is 0/1/2. No charges apply in other cases.
371
+ * - 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.
372
+ * ### QPS limit
373
+ * 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.
311
374
  *
312
375
  * @param request - CompanyThreeElementsVerificationRequest
313
376
  * @returns CompanyThreeElementsVerificationResponse
@@ -318,12 +381,14 @@ export default class Client extends OpenApi {
318
381
  }
319
382
 
320
383
  /**
321
- * Verifies whether the enterprise name and the business license number belong to the same enterprise. The verification is successful only when the two elements belong to the same enterprise and the business status of the enterprise is Active.
384
+ * 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.
322
385
  *
323
386
  * @remarks
324
- * Before you call this operation, make sure that you are familiar with the billing of services related to two-element verification for enterprises. For more information, see [Billing](https://help.aliyun.com/document_detail/154751.html?spm=a2c4g.154007.0.0.3edd7eb6E90YT4).
325
- * * You are charged only if the value of VerifyResult is true or false and the value of ReasonCode is 0 or 1.
326
- * * Before you call this operation, perform the following operations: 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). On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
387
+ * - 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).
388
+ * - Billing applies when Code=OK and ReasonCode=0/1/3 in the returned result. Other cases are not billed.
389
+ * - 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.
390
+ * ### QPS limit
391
+ * 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.
327
392
  *
328
393
  * @param request - CompanyTwoElementsVerificationRequest
329
394
  * @param runtime - runtime options for this request RuntimeOptions
@@ -374,12 +439,14 @@ export default class Client extends OpenApi {
374
439
  }
375
440
 
376
441
  /**
377
- * Verifies whether the enterprise name and the business license number belong to the same enterprise. The verification is successful only when the two elements belong to the same enterprise and the business status of the enterprise is Active.
442
+ * 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.
378
443
  *
379
444
  * @remarks
380
- * Before you call this operation, make sure that you are familiar with the billing of services related to two-element verification for enterprises. For more information, see [Billing](https://help.aliyun.com/document_detail/154751.html?spm=a2c4g.154007.0.0.3edd7eb6E90YT4).
381
- * * You are charged only if the value of VerifyResult is true or false and the value of ReasonCode is 0 or 1.
382
- * * Before you call this operation, perform the following operations: 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). On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
445
+ * - 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).
446
+ * - Billing applies when Code=OK and ReasonCode=0/1/3 in the returned result. Other cases are not billed.
447
+ * - 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.
448
+ * ### QPS limit
449
+ * 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.
383
450
  *
384
451
  * @param request - CompanyTwoElementsVerificationRequest
385
452
  * @returns CompanyTwoElementsVerificationResponse
@@ -390,7 +457,10 @@ export default class Client extends OpenApi {
390
457
  }
391
458
 
392
459
  /**
393
- * 预警联系人删除
460
+ * Deletes a contact.
461
+ *
462
+ * @remarks
463
+ * - Make sure you have activated Phone Number Identity Service before calling this operation.
394
464
  *
395
465
  * @param request - DeleteContactsRequest
396
466
  * @param runtime - runtime options for this request RuntimeOptions
@@ -433,7 +503,10 @@ export default class Client extends OpenApi {
433
503
  }
434
504
 
435
505
  /**
436
- * 预警联系人删除
506
+ * Deletes a contact.
507
+ *
508
+ * @remarks
509
+ * - Make sure you have activated Phone Number Identity Service before calling this operation.
437
510
  *
438
511
  * @param request - DeleteContactsRequest
439
512
  * @returns DeleteContactsResponse
@@ -444,17 +517,17 @@ export default class Client extends OpenApi {
444
517
  }
445
518
 
446
519
  /**
447
- * Predicts whether a phone number is a nonexistent number by using AI algorithms.
520
+ * Predicts whether a phone number is invalid by using AI algorithms.
448
521
  *
449
522
  * @remarks
450
- * You can call this operation to verify whether a phone number is a nonexistent number. When you call this operation to verify a number, the system charges you CNY 0.01 per verification based on the number of verifications. **Before you call this operation, make sure that you are familiar with the billing of Cell Phone Number Service.**
451
- * * You are charged only if the value of Code is OK and the value of Status is not UNKNOWN.
452
- * * The prediction is not strictly accurate because Cell Phone Number Service predicts the nonexistent number probability by using AI algorithms. The accuracy rate of the prediction and the recall rate of empty numbers are about 95%. **Pay attention to this point when you call this operation**.
453
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
454
- * ### [](#qps)QPS limits
455
- * You can call this operation up to 100 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.
456
- * ### [](#)Authorization information
457
- * 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).
523
+ * - 本接口用于验证号码是否为空号。发起调用该接口验证号码请求时,系统会根据验证次数计费,标准价为0.01元/次。**请确保在使用该接口前,已充分了解本产品的收费方式和价格。**
524
+ * - 当返回结果中:Code="OK" Status != UNKNOWN 时计费,其他情况不计费。
525
+ * - 由于本产品通过AI算法预测手机号的空号概率,所以无法做到100%准确。当前评估的准确率和召回率约为95%左右。**调用时请注意差别**。
526
+ * - 使用本接口前,请登录号码百科控制台,在[标签广场](https://dytns.console.aliyun.com/analysis/square)页面,找到对应的标签,单击**申请开通**,填写申请资料,审批通过后即可使用。
527
+ * ### QPS限制
528
+ * 本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
529
+ * ### 授权信息
530
+ * 默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。具体请参见[RAM用户授权](https://help.aliyun.com/document_detail/154006.html)
458
531
  *
459
532
  * @param request - DescribeEmptyNumberRequest
460
533
  * @param runtime - runtime options for this request RuntimeOptions
@@ -505,17 +578,17 @@ export default class Client extends OpenApi {
505
578
  }
506
579
 
507
580
  /**
508
- * Predicts whether a phone number is a nonexistent number by using AI algorithms.
581
+ * Predicts whether a phone number is invalid by using AI algorithms.
509
582
  *
510
583
  * @remarks
511
- * You can call this operation to verify whether a phone number is a nonexistent number. When you call this operation to verify a number, the system charges you CNY 0.01 per verification based on the number of verifications. **Before you call this operation, make sure that you are familiar with the billing of Cell Phone Number Service.**
512
- * * You are charged only if the value of Code is OK and the value of Status is not UNKNOWN.
513
- * * The prediction is not strictly accurate because Cell Phone Number Service predicts the nonexistent number probability by using AI algorithms. The accuracy rate of the prediction and the recall rate of empty numbers are about 95%. **Pay attention to this point when you call this operation**.
514
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
515
- * ### [](#qps)QPS limits
516
- * You can call this operation up to 100 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.
517
- * ### [](#)Authorization information
518
- * 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).
584
+ * - 本接口用于验证号码是否为空号。发起调用该接口验证号码请求时,系统会根据验证次数计费,标准价为0.01元/次。**请确保在使用该接口前,已充分了解本产品的收费方式和价格。**
585
+ * - 当返回结果中:Code="OK" Status != UNKNOWN 时计费,其他情况不计费。
586
+ * - 由于本产品通过AI算法预测手机号的空号概率,所以无法做到100%准确。当前评估的准确率和召回率约为95%左右。**调用时请注意差别**。
587
+ * - 使用本接口前,请登录号码百科控制台,在[标签广场](https://dytns.console.aliyun.com/analysis/square)页面,找到对应的标签,单击**申请开通**,填写申请资料,审批通过后即可使用。
588
+ * ### QPS限制
589
+ * 本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
590
+ * ### 授权信息
591
+ * 默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。具体请参见[RAM用户授权](https://help.aliyun.com/document_detail/154006.html)
519
592
  *
520
593
  * @param request - DescribeEmptyNumberRequest
521
594
  * @returns DescribeEmptyNumberResponse
@@ -588,7 +661,15 @@ export default class Client extends OpenApi {
588
661
  }
589
662
 
590
663
  /**
591
- * Obtains the analysis results of a number.
664
+ * Obtains the result returned by phone number analysis.
665
+ *
666
+ * @remarks
667
+ * - 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.
668
+ * - 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.
669
+ * ### QPS limit
670
+ * 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.
671
+ * ### Authorization information
672
+ * 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).
592
673
  *
593
674
  * @param request - DescribePhoneNumberAnalysisRequest
594
675
  * @param runtime - runtime options for this request RuntimeOptions
@@ -647,7 +728,15 @@ export default class Client extends OpenApi {
647
728
  }
648
729
 
649
730
  /**
650
- * Obtains the analysis results of a number.
731
+ * Obtains the result returned by phone number analysis.
732
+ *
733
+ * @remarks
734
+ * - 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.
735
+ * - 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.
736
+ * ### QPS limit
737
+ * 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.
738
+ * ### Authorization information
739
+ * 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).
651
740
  *
652
741
  * @param request - DescribePhoneNumberAnalysisRequest
653
742
  * @returns DescribePhoneNumberAnalysisResponse
@@ -658,10 +747,11 @@ export default class Client extends OpenApi {
658
747
  }
659
748
 
660
749
  /**
661
- * Obtains the analysis results of a phone number.
750
+ * Get the phone number analysis result.
662
751
  *
663
752
  * @remarks
664
- * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the Labels page, find the label that you want to use, click Activate Now, enter the required information, and then submit your application. After your application is approved, you can use the label. Before you call this operation, make sure that you are familiar with the billing of Cell Phone Number Service.
753
+ * 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.
754
+ * Make sure that you fully understand the billing of the Cell Phone Number Service before you use this operation.
665
755
  *
666
756
  * @param request - DescribePhoneNumberAnalysisAIRequest
667
757
  * @param runtime - runtime options for this request RuntimeOptions
@@ -716,10 +806,11 @@ export default class Client extends OpenApi {
716
806
  }
717
807
 
718
808
  /**
719
- * Obtains the analysis results of a phone number.
809
+ * Get the phone number analysis result.
720
810
  *
721
811
  * @remarks
722
- * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the Labels page, find the label that you want to use, click Activate Now, enter the required information, and then submit your application. After your application is approved, you can use the label. Before you call this operation, make sure that you are familiar with the billing of Cell Phone Number Service.
812
+ * 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.
813
+ * Make sure that you fully understand the billing of the Cell Phone Number Service before you use this operation.
723
814
  *
724
815
  * @param request - DescribePhoneNumberAnalysisAIRequest
725
816
  * @returns DescribePhoneNumberAnalysisAIResponse
@@ -862,14 +953,6 @@ export default class Client extends OpenApi {
862
953
  }
863
954
 
864
955
  /**
865
- * Queries the carrier, registration location, and mobile number portability information of a phone number.
866
- *
867
- * @remarks
868
- * 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.
869
- * * 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).
870
- * ### [](#qps)QPS limits
871
- * 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.
872
- *
873
956
  * @deprecated OpenAPI DescribePhoneNumberAttribute is deprecated, please use Dytnsapi::2020-02-17::DescribePhoneNumberOperatorAttribute instead.
874
957
  *
875
958
  * @param request - DescribePhoneNumberAttributeRequest
@@ -913,14 +996,6 @@ export default class Client extends OpenApi {
913
996
  }
914
997
 
915
998
  /**
916
- * Queries the carrier, registration location, and mobile number portability information of a phone number.
917
- *
918
- * @remarks
919
- * 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.
920
- * * 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).
921
- * ### [](#qps)QPS limits
922
- * 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.
923
- *
924
999
  * @deprecated OpenAPI DescribePhoneNumberAttribute is deprecated, please use Dytnsapi::2020-02-17::DescribePhoneNumberOperatorAttribute instead.
925
1000
  *
926
1001
  * @param request - DescribePhoneNumberAttributeRequest
@@ -933,13 +1008,13 @@ export default class Client extends OpenApi {
933
1008
  }
934
1009
 
935
1010
  /**
936
- * Queries the usage period of a phone number of a user.
1011
+ * Queries the duration for which a mobile user has been registered on the carrier\\"s network.
937
1012
  *
938
1013
  * @remarks
939
- * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
940
- * * 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.
941
- * ### [](#qps)QPS limits
942
- * You can call this operation up to 200 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.
1014
+ * - 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.
1015
+ * - 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.
1016
+ * ### QPS limit
1017
+ * 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.
943
1018
  *
944
1019
  * @param request - DescribePhoneNumberOnlineTimeRequest
945
1020
  * @param runtime - runtime options for this request RuntimeOptions
@@ -994,13 +1069,13 @@ export default class Client extends OpenApi {
994
1069
  }
995
1070
 
996
1071
  /**
997
- * Queries the usage period of a phone number of a user.
1072
+ * Queries the duration for which a mobile user has been registered on the carrier\\"s network.
998
1073
  *
999
1074
  * @remarks
1000
- * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
1001
- * * 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.
1002
- * ### [](#qps)QPS limits
1003
- * You can call this operation up to 200 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.
1075
+ * - 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.
1076
+ * - 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.
1077
+ * ### QPS limit
1078
+ * 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.
1004
1079
  *
1005
1080
  * @param request - DescribePhoneNumberOnlineTimeRequest
1006
1081
  * @returns DescribePhoneNumberOnlineTimeResponse
@@ -1011,13 +1086,15 @@ export default class Client extends OpenApi {
1011
1086
  }
1012
1087
 
1013
1088
  /**
1014
- * Queries the attribute information about a phone number, including the registration province, registration city, basic carrier (such as China Mobile, China Unicom, China Telecom, or China Broadnet), reseller of mobile communications services (such as Alibaba Communications), mobile number portability, and the number segment to which the phone number belongs.
1089
+ * 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.
1015
1090
  *
1016
1091
  * @remarks
1017
- * Before you call this operation, make sure that you are familiar with the [billing](https://help.aliyun.com/document_detail/154008.html) of Cell Phone Number Service.
1018
- * * 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).
1019
- * * You can call this operation to obtain the carrier, registration location, and mobile number portability information about a phone number. You can query phone numbers in **plaintext** and phone numbers that are encrypted by using **MD5** and **SHA256**.
1020
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
1092
+ * - 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.
1093
+ * - 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).
1094
+ * - 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.
1095
+ * - 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.
1096
+ * ### QPS limit
1097
+ * 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.
1021
1098
  *
1022
1099
  * @param request - DescribePhoneNumberOperatorAttributeRequest
1023
1100
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1076,13 +1153,15 @@ export default class Client extends OpenApi {
1076
1153
  }
1077
1154
 
1078
1155
  /**
1079
- * Queries the attribute information about a phone number, including the registration province, registration city, basic carrier (such as China Mobile, China Unicom, China Telecom, or China Broadnet), reseller of mobile communications services (such as Alibaba Communications), mobile number portability, and the number segment to which the phone number belongs.
1156
+ * 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.
1080
1157
  *
1081
1158
  * @remarks
1082
- * Before you call this operation, make sure that you are familiar with the [billing](https://help.aliyun.com/document_detail/154008.html) of Cell Phone Number Service.
1083
- * * 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).
1084
- * * You can call this operation to obtain the carrier, registration location, and mobile number portability information about a phone number. You can query phone numbers in **plaintext** and phone numbers that are encrypted by using **MD5** and **SHA256**.
1085
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
1159
+ * - 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.
1160
+ * - 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).
1161
+ * - 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.
1162
+ * - 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.
1163
+ * ### QPS limit
1164
+ * 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.
1086
1165
  *
1087
1166
  * @param request - DescribePhoneNumberOperatorAttributeRequest
1088
1167
  * @returns DescribePhoneNumberOperatorAttributeResponse
@@ -1255,16 +1334,16 @@ export default class Client extends OpenApi {
1255
1334
  }
1256
1335
 
1257
1336
  /**
1258
- * Verifies whether a phone number is a reassigned phone number by calling this operation.
1337
+ * Quickly verify in a single request if a mobile phone number is a carrier\\"s secondary number assignment.
1259
1338
  *
1260
1339
  * @remarks
1261
- * 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.
1262
- * * You are charged for phone number verifications only if the value of Code is OK and the value of VerifyResult is not 0.
1263
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
1264
- * ## [](#qps)QPS limits
1265
- * You can call this operation up to 100 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.
1266
- * ## [](#)Authorization information
1267
- * 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).
1340
+ * - Before you use this API, make sure you understand the [pricing](https://help.aliyun.com/document_detail/154751.html) for Phone Number Verification Service.
1341
+ * - You are charged only when the API response returns `Code="OK"` and `VerifyResult` is not `0`. No charge is incurred in any other case.
1342
+ * - 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.
1343
+ * ## QPS limits
1344
+ * 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.
1345
+ * ## Authorization
1346
+ * 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).
1268
1347
  *
1269
1348
  * @param request - DescribePhoneTwiceTelVerifyRequest
1270
1349
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1319,16 +1398,16 @@ export default class Client extends OpenApi {
1319
1398
  }
1320
1399
 
1321
1400
  /**
1322
- * Verifies whether a phone number is a reassigned phone number by calling this operation.
1401
+ * Quickly verify in a single request if a mobile phone number is a carrier\\"s secondary number assignment.
1323
1402
  *
1324
1403
  * @remarks
1325
- * 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.
1326
- * * You are charged for phone number verifications only if the value of Code is OK and the value of VerifyResult is not 0.
1327
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
1328
- * ## [](#qps)QPS limits
1329
- * You can call this operation up to 100 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.
1330
- * ## [](#)Authorization information
1331
- * 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).
1404
+ * - Before you use this API, make sure you understand the [pricing](https://help.aliyun.com/document_detail/154751.html) for Phone Number Verification Service.
1405
+ * - You are charged only when the API response returns `Code="OK"` and `VerifyResult` is not `0`. No charge is incurred in any other case.
1406
+ * - 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.
1407
+ * ## QPS limits
1408
+ * 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.
1409
+ * ## Authorization
1410
+ * 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).
1332
1411
  *
1333
1412
  * @param request - DescribePhoneTwiceTelVerifyRequest
1334
1413
  * @returns DescribePhoneTwiceTelVerifyResponse
@@ -1339,7 +1418,97 @@ export default class Client extends OpenApi {
1339
1418
  }
1340
1419
 
1341
1420
  /**
1342
- * Obtains the signature of an authorization token when China Mobile, China Unicom, or China Telecom provides the Uniform Anonymous Identifier (UAID) capability.
1421
+ * This API only provides the signing functionality for acquiring an authorization token during UAID retrieval from the three-network operators.
1422
+ *
1423
+ * @remarks
1424
+ * 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.
1425
+ * - To generate the other parameters required to obtain the authorization token, refer to the respective operator\\"s documentation.
1426
+ * - 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.
1427
+ * - After obtaining the authorization token, call the [UAIDVerification](~~UAIDVerification~~) API to complete the UAID retrieval.
1428
+ * ### How to request an authorization token
1429
+ * >Notice:
1430
+ * When you request an authorization token, the client or H5 page must be connected to a cellular network.
1431
+ * #### China Mobile (CM)
1432
+ * Protocol: HTTPS + application/json
1433
+ * Method: POST
1434
+ * URL: https\\://msg.cmpassport.com/h5/getMobile
1435
+ * ##### Request parameters
1436
+ * Request example:
1437
+ * `{ "traceId": "mfawsxtcmyplwzpayzzvdvbsowxmkynr", "appId": "300011580392", "sign": "2c61b3c58ffbeed97461e31be4fd931a", "msgId": "redbyxsdetddwaaffajcwwapspykftzx", "expandParams": "", "businessType": "3", "version": "1.0", "timestamp": "20201125101540980" }`
1438
+ * Parameter description:
1439
+ * - `version`: Use `1.0`.
1440
+ * - `timestamp`: The request timestamp, with millisecond precision. This value and its format must match the `Time` input parameter for this API.
1441
+ * - `appId`: Use `300011580392`.
1442
+ * - `businessType`: Use `3`.
1443
+ * - `traceId`: The trace ID. This value must match this API\\"s `OutId` input parameter.
1444
+ * - `sign`: Obtained by calling this API.
1445
+ * - `msgId`: A unique message identifier.
1446
+ * ##### Response parameters
1447
+ * Response example:
1448
+ * `{ "header": { "appId": "300011580392", "msgId": "redbyxsdetddwaaffajcwwapspykftzx", "timestamp": "20201125101607932" }, "body": { "resultCode": "103000", "expandParams": "", "resultDesc": "成功", "token": "H5HTTPS4187AE9743AFCB14F8D99B9D65ED9E01" } }`
1449
+ * Retrieve the `token` from the response `body`.
1450
+ * #### China Unicom (CU)
1451
+ * Obtain the token in two steps.
1452
+ * ##### Step 1: Obtain the authurl
1453
+ * Send a request to the portal server to get the authentication server address (`authurl`).
1454
+ * Protocol: HTTPS + application/json
1455
+ * Method: GET
1456
+ * URL: https\\://nisportal.10010.com:9001/api
1457
+ * ###### Request parameters
1458
+ * Request examples:
1459
+ * JSON request: `?appid=1554778161153`
1460
+ * JSONP request: `?appid=1554778161153&callback=callbackFunction`
1461
+ * Parameter description:
1462
+ * - `appid`: Use 1554778161153.
1463
+ * - `callback`: The name of the JSONP callback function. This parameter is required only for JSONP requests.
1464
+ * ###### Response parameters
1465
+ * Response examples:
1466
+ * JSON response:
1467
+ * `{"authurl": "https://enrichgw.10010.com/d93222629f52ec79"}`
1468
+ * JSONP response:
1469
+ * `callbackFunction({"authurl":"https://enrichgw.10010.com/d93222629f52ec79"})`
1470
+ * Retrieve the `authurl` from the response.
1471
+ * ##### Step 2: Obtain the token
1472
+ * Protocol: HTTPS + application/json
1473
+ * Method: GET
1474
+ * URL: The authurl from Step 1, with /api appended.
1475
+ * Request URL example: `https://enrichgw.10010.com/d93222629f52ec79/api`
1476
+ * ###### Request parameters
1477
+ * Request examples:
1478
+ * JSON request: `?appid=1554778161153`
1479
+ * JSONP request: `?appid=1554778161153&callback=callbackFunction`
1480
+ * Parameter description:
1481
+ * - `appid`: Use 1554778161153.
1482
+ * - `callback`: The name of the JSONP callback function. This parameter is required only for JSONP requests.
1483
+ * ###### Response parameters
1484
+ * Response examples:
1485
+ * JSON response:
1486
+ * `{ "province": "1", "code": "7nHS1nggx2WP613750206700RN6oiRN1" }`
1487
+ * JSONP response:
1488
+ * `callbackFunction({"province":"1","code":"7nHS3Dnkd1BS701851092400RN6oiRN1"})`
1489
+ * Retrieve the `code` from the response.
1490
+ * #### China Telecom (CT)
1491
+ * Protocol: HTTPS + application/x-www-form-urlencoded;charset=UTF-8
1492
+ * Method: GET
1493
+ * URL: https\\://id6.me/gw/preuniq.do
1494
+ * ##### Request parameters
1495
+ * Request example:
1496
+ * `?clientType=30100&appId=9390188202&format=json&sign=D63C166FA19E1996EF********09C6A5397C10B4&paramKey=1D7C25EB8B0B8B4CB3CF8DC60628F6549********786B0AF1FEF93FA1335057A35BF5F0B39A3867EAA9BE14B3898********8B01DE34965060445B6E1F66401D714650E4AB161CD6DCF4A72********3B856F22A192B8B0C39D7A55B961062E68C89C928894F119B25********7C548355FE9DB82852EB93C939F2200B48CD17&paramStr=140********95AF8E138B94754CB4CF83BA6FB********52B258BFDFD38BF233&version=1.1`
1497
+ * Parameter description:
1498
+ * - `appId`: Use `9390188202`.
1499
+ * - `clientType`: The client type. This value must match the `ClientType` input parameter for this API.
1500
+ * - `format`: Use `json` or `jsonp`.
1501
+ * - `version`: Use `1.1`.
1502
+ * - `sign`: Obtained by calling this API.
1503
+ * - `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).
1504
+ * - `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`.
1505
+ * ##### Response parameters
1506
+ * Response example:
1507
+ * `callback?result=10000&msg=success&data=a35336711c70456cb883f4f224e9a259`
1508
+ * 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`.
1509
+ * Decrypted business result example:
1510
+ * `{"accessCode": "H5HTTPS4187AE9743AFCB14F8D99B9D65ED9E01"}`
1511
+ * Retrieve the `accessCode` from the decrypted result.
1343
1512
  *
1344
1513
  * @param request - GetUAIDApplyTokenSignRequest
1345
1514
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1410,7 +1579,97 @@ export default class Client extends OpenApi {
1410
1579
  }
1411
1580
 
1412
1581
  /**
1413
- * Obtains the signature of an authorization token when China Mobile, China Unicom, or China Telecom provides the Uniform Anonymous Identifier (UAID) capability.
1582
+ * This API only provides the signing functionality for acquiring an authorization token during UAID retrieval from the three-network operators.
1583
+ *
1584
+ * @remarks
1585
+ * 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.
1586
+ * - To generate the other parameters required to obtain the authorization token, refer to the respective operator\\"s documentation.
1587
+ * - 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.
1588
+ * - After obtaining the authorization token, call the [UAIDVerification](~~UAIDVerification~~) API to complete the UAID retrieval.
1589
+ * ### How to request an authorization token
1590
+ * >Notice:
1591
+ * When you request an authorization token, the client or H5 page must be connected to a cellular network.
1592
+ * #### China Mobile (CM)
1593
+ * Protocol: HTTPS + application/json
1594
+ * Method: POST
1595
+ * URL: https\\://msg.cmpassport.com/h5/getMobile
1596
+ * ##### Request parameters
1597
+ * Request example:
1598
+ * `{ "traceId": "mfawsxtcmyplwzpayzzvdvbsowxmkynr", "appId": "300011580392", "sign": "2c61b3c58ffbeed97461e31be4fd931a", "msgId": "redbyxsdetddwaaffajcwwapspykftzx", "expandParams": "", "businessType": "3", "version": "1.0", "timestamp": "20201125101540980" }`
1599
+ * Parameter description:
1600
+ * - `version`: Use `1.0`.
1601
+ * - `timestamp`: The request timestamp, with millisecond precision. This value and its format must match the `Time` input parameter for this API.
1602
+ * - `appId`: Use `300011580392`.
1603
+ * - `businessType`: Use `3`.
1604
+ * - `traceId`: The trace ID. This value must match this API\\"s `OutId` input parameter.
1605
+ * - `sign`: Obtained by calling this API.
1606
+ * - `msgId`: A unique message identifier.
1607
+ * ##### Response parameters
1608
+ * Response example:
1609
+ * `{ "header": { "appId": "300011580392", "msgId": "redbyxsdetddwaaffajcwwapspykftzx", "timestamp": "20201125101607932" }, "body": { "resultCode": "103000", "expandParams": "", "resultDesc": "成功", "token": "H5HTTPS4187AE9743AFCB14F8D99B9D65ED9E01" } }`
1610
+ * Retrieve the `token` from the response `body`.
1611
+ * #### China Unicom (CU)
1612
+ * Obtain the token in two steps.
1613
+ * ##### Step 1: Obtain the authurl
1614
+ * Send a request to the portal server to get the authentication server address (`authurl`).
1615
+ * Protocol: HTTPS + application/json
1616
+ * Method: GET
1617
+ * URL: https\\://nisportal.10010.com:9001/api
1618
+ * ###### Request parameters
1619
+ * Request examples:
1620
+ * JSON request: `?appid=1554778161153`
1621
+ * JSONP request: `?appid=1554778161153&callback=callbackFunction`
1622
+ * Parameter description:
1623
+ * - `appid`: Use 1554778161153.
1624
+ * - `callback`: The name of the JSONP callback function. This parameter is required only for JSONP requests.
1625
+ * ###### Response parameters
1626
+ * Response examples:
1627
+ * JSON response:
1628
+ * `{"authurl": "https://enrichgw.10010.com/d93222629f52ec79"}`
1629
+ * JSONP response:
1630
+ * `callbackFunction({"authurl":"https://enrichgw.10010.com/d93222629f52ec79"})`
1631
+ * Retrieve the `authurl` from the response.
1632
+ * ##### Step 2: Obtain the token
1633
+ * Protocol: HTTPS + application/json
1634
+ * Method: GET
1635
+ * URL: The authurl from Step 1, with /api appended.
1636
+ * Request URL example: `https://enrichgw.10010.com/d93222629f52ec79/api`
1637
+ * ###### Request parameters
1638
+ * Request examples:
1639
+ * JSON request: `?appid=1554778161153`
1640
+ * JSONP request: `?appid=1554778161153&callback=callbackFunction`
1641
+ * Parameter description:
1642
+ * - `appid`: Use 1554778161153.
1643
+ * - `callback`: The name of the JSONP callback function. This parameter is required only for JSONP requests.
1644
+ * ###### Response parameters
1645
+ * Response examples:
1646
+ * JSON response:
1647
+ * `{ "province": "1", "code": "7nHS1nggx2WP613750206700RN6oiRN1" }`
1648
+ * JSONP response:
1649
+ * `callbackFunction({"province":"1","code":"7nHS3Dnkd1BS701851092400RN6oiRN1"})`
1650
+ * Retrieve the `code` from the response.
1651
+ * #### China Telecom (CT)
1652
+ * Protocol: HTTPS + application/x-www-form-urlencoded;charset=UTF-8
1653
+ * Method: GET
1654
+ * URL: https\\://id6.me/gw/preuniq.do
1655
+ * ##### Request parameters
1656
+ * Request example:
1657
+ * `?clientType=30100&appId=9390188202&format=json&sign=D63C166FA19E1996EF********09C6A5397C10B4&paramKey=1D7C25EB8B0B8B4CB3CF8DC60628F6549********786B0AF1FEF93FA1335057A35BF5F0B39A3867EAA9BE14B3898********8B01DE34965060445B6E1F66401D714650E4AB161CD6DCF4A72********3B856F22A192B8B0C39D7A55B961062E68C89C928894F119B25********7C548355FE9DB82852EB93C939F2200B48CD17&paramStr=140********95AF8E138B94754CB4CF83BA6FB********52B258BFDFD38BF233&version=1.1`
1658
+ * Parameter description:
1659
+ * - `appId`: Use `9390188202`.
1660
+ * - `clientType`: The client type. This value must match the `ClientType` input parameter for this API.
1661
+ * - `format`: Use `json` or `jsonp`.
1662
+ * - `version`: Use `1.1`.
1663
+ * - `sign`: Obtained by calling this API.
1664
+ * - `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).
1665
+ * - `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`.
1666
+ * ##### Response parameters
1667
+ * Response example:
1668
+ * `callback?result=10000&msg=success&data=a35336711c70456cb883f4f224e9a259`
1669
+ * 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`.
1670
+ * Decrypted business result example:
1671
+ * `{"accessCode": "H5HTTPS4187AE9743AFCB14F8D99B9D65ED9E01"}`
1672
+ * Retrieve the `accessCode` from the decrypted result.
1414
1673
  *
1415
1674
  * @param request - GetUAIDApplyTokenSignRequest
1416
1675
  * @returns GetUAIDApplyTokenSignResponse
@@ -1503,7 +1762,17 @@ export default class Client extends OpenApi {
1503
1762
  }
1504
1763
 
1505
1764
  /**
1506
- * 历史三要素
1765
+ * Verifies whether a name, phone number, and ID number belonged to the same user at a specific point in time.
1766
+ *
1767
+ * @remarks
1768
+ * ## Usage notes
1769
+ * - Before you use this API, ensure you understand its [pricing](https://help.aliyun.com/zh/cpns/product-overview/pricing-of-cpns).
1770
+ * - 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.
1771
+ * - You are charged for a call only when the response returns `Code=\\"OK\\"` and `IsConsistent != 0`. No charges are incurred for any other results.
1772
+ * - 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.
1773
+ * - 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.
1774
+ * - The queries per second (QPS) limit per user is 200. Requests that exceed this limit are throttled.
1775
+ * - In the authorization information, the action is `dytns:HistoryThreeElementsVerification`, the access level is Read, and the resource type is All Resources.
1507
1776
  *
1508
1777
  * @param request - HistoryThreeElementsVerificationRequest
1509
1778
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1558,7 +1827,17 @@ export default class Client extends OpenApi {
1558
1827
  }
1559
1828
 
1560
1829
  /**
1561
- * 历史三要素
1830
+ * Verifies whether a name, phone number, and ID number belonged to the same user at a specific point in time.
1831
+ *
1832
+ * @remarks
1833
+ * ## Usage notes
1834
+ * - Before you use this API, ensure you understand its [pricing](https://help.aliyun.com/zh/cpns/product-overview/pricing-of-cpns).
1835
+ * - 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.
1836
+ * - You are charged for a call only when the response returns `Code=\\"OK\\"` and `IsConsistent != 0`. No charges are incurred for any other results.
1837
+ * - 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.
1838
+ * - 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.
1839
+ * - The queries per second (QPS) limit per user is 200. Requests that exceed this limit are throttled.
1840
+ * - In the authorization information, the action is `dytns:HistoryThreeElementsVerification`, the access level is Read, and the resource type is All Resources.
1562
1841
  *
1563
1842
  * @param request - HistoryThreeElementsVerificationRequest
1564
1843
  * @returns HistoryThreeElementsVerificationResponse
@@ -1569,12 +1848,12 @@ export default class Client extends OpenApi {
1569
1848
  }
1570
1849
 
1571
1850
  /**
1572
- * Filters invalid phone numbers.
1851
+ * Performs invalid phone number filtering operations.
1573
1852
  *
1574
1853
  * @remarks
1575
- * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
1576
- * ### [](#qps)QPS limits
1577
- * You can call this operation up to 1,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.
1854
+ * 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.
1855
+ * ### QPS limit
1856
+ * 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.
1578
1857
  *
1579
1858
  * @param request - InvalidPhoneNumberFilterRequest
1580
1859
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1625,12 +1904,12 @@ export default class Client extends OpenApi {
1625
1904
  }
1626
1905
 
1627
1906
  /**
1628
- * Filters invalid phone numbers.
1907
+ * Performs invalid phone number filtering operations.
1629
1908
  *
1630
1909
  * @remarks
1631
- * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
1632
- * ### [](#qps)QPS limits
1633
- * You can call this operation up to 1,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.
1910
+ * 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.
1911
+ * ### QPS limit
1912
+ * 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.
1634
1913
  *
1635
1914
  * @param request - InvalidPhoneNumberFilterRequest
1636
1915
  * @returns InvalidPhoneNumberFilterResponse
@@ -1641,7 +1920,10 @@ export default class Client extends OpenApi {
1641
1920
  }
1642
1921
 
1643
1922
  /**
1644
- * 预警联系人查询
1923
+ * Lists the alert contacts for Number Encyclopedia.
1924
+ *
1925
+ * @remarks
1926
+ * - Before using this API, ensure that you have activated Number Encyclopedia.
1645
1927
  *
1646
1928
  * @param request - ListContactsRequest
1647
1929
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1688,7 +1970,10 @@ export default class Client extends OpenApi {
1688
1970
  }
1689
1971
 
1690
1972
  /**
1691
- * 预警联系人查询
1973
+ * Lists the alert contacts for Number Encyclopedia.
1974
+ *
1975
+ * @remarks
1976
+ * - Before using this API, ensure that you have activated Number Encyclopedia.
1692
1977
  *
1693
1978
  * @param request - ListContactsRequest
1694
1979
  * @returns ListContactsResponse
@@ -1757,12 +2042,12 @@ export default class Client extends OpenApi {
1757
2042
  }
1758
2043
 
1759
2044
  /**
1760
- * Encrypts the original phone number into a virtual number that starts with 140. Cell Phone Number Service integrates the communications services provided by Alibaba Cloud. This allows you to initiate a call by using a virtual number that starts with 140.
2045
+ * 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.
1761
2046
  *
1762
2047
  * @remarks
1763
- * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
1764
- * ### [](#qps)QPS limits
1765
- * You can call this operation up to 1,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.
2048
+ * 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.
2049
+ * ### QPS limit
2050
+ * 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.
1766
2051
  *
1767
2052
  * @param request - PhoneNumberEncryptRequest
1768
2053
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1817,12 +2102,12 @@ export default class Client extends OpenApi {
1817
2102
  }
1818
2103
 
1819
2104
  /**
1820
- * Encrypts the original phone number into a virtual number that starts with 140. Cell Phone Number Service integrates the communications services provided by Alibaba Cloud. This allows you to initiate a call by using a virtual number that starts with 140.
2105
+ * 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.
1821
2106
  *
1822
2107
  * @remarks
1823
- * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
1824
- * ### [](#qps)QPS limits
1825
- * You can call this operation up to 1,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.
2108
+ * 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.
2109
+ * ### QPS limit
2110
+ * 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.
1826
2111
  *
1827
2112
  * @param request - PhoneNumberEncryptRequest
1828
2113
  * @returns PhoneNumberEncryptResponse
@@ -1833,14 +2118,15 @@ export default class Client extends OpenApi {
1833
2118
  }
1834
2119
 
1835
2120
  /**
1836
- * Queries the real-time service state of a phone number. The state includes NORMAL, SHUTDOWN, and NOT_EXIST. You can choose an encryption method for your phone number query, including plaintext, MD5, and SHA256.
2121
+ * 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.
1837
2122
  *
1838
2123
  * @remarks
1839
- * 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.
1840
- * * 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).
1841
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
1842
- * ### [](#qps)QPS limits
1843
- * You can call this operation up to 300 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.
2124
+ * - **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.**
2125
+ * - 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).
2126
+ * - 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.
2127
+ * - 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.
2128
+ * ### QPS limit
2129
+ * 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.
1844
2130
  *
1845
2131
  * @param request - PhoneNumberStatusForAccountRequest
1846
2132
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1891,14 +2177,15 @@ export default class Client extends OpenApi {
1891
2177
  }
1892
2178
 
1893
2179
  /**
1894
- * Queries the real-time service state of a phone number. The state includes NORMAL, SHUTDOWN, and NOT_EXIST. You can choose an encryption method for your phone number query, including plaintext, MD5, and SHA256.
2180
+ * 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.
1895
2181
  *
1896
2182
  * @remarks
1897
- * 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.
1898
- * * 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).
1899
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
1900
- * ### [](#qps)QPS limits
1901
- * You can call this operation up to 300 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.
2183
+ * - **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.**
2184
+ * - 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).
2185
+ * - 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.
2186
+ * - 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.
2187
+ * ### QPS limit
2188
+ * 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.
1902
2189
  *
1903
2190
  * @param request - PhoneNumberStatusForAccountRequest
1904
2191
  * @returns PhoneNumberStatusForAccountResponse
@@ -1909,14 +2196,15 @@ export default class Client extends OpenApi {
1909
2196
  }
1910
2197
 
1911
2198
  /**
1912
- * Queries the real-time service state of a phone number. The state includes NORMAL, SHUTDOWN, and NOT_EXIST. You can choose an encryption method for your phone number query, including plaintext, MD5, and SHA256.
2199
+ * 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.
1913
2200
  *
1914
2201
  * @remarks
1915
- * 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.
1916
- * * 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).
1917
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
1918
- * ### [](#qps)QPS limits
1919
- * You can call this operation up to 300 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.
2202
+ * - **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.**
2203
+ * - 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).
2204
+ * - 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.
2205
+ * - 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.
2206
+ * ### QPS limit
2207
+ * 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.
1920
2208
  *
1921
2209
  * @param request - PhoneNumberStatusForPublicRequest
1922
2210
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1967,14 +2255,15 @@ export default class Client extends OpenApi {
1967
2255
  }
1968
2256
 
1969
2257
  /**
1970
- * Queries the real-time service state of a phone number. The state includes NORMAL, SHUTDOWN, and NOT_EXIST. You can choose an encryption method for your phone number query, including plaintext, MD5, and SHA256.
2258
+ * 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.
1971
2259
  *
1972
2260
  * @remarks
1973
- * 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.
1974
- * * 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).
1975
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
1976
- * ### [](#qps)QPS limits
1977
- * You can call this operation up to 300 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.
2261
+ * - **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.**
2262
+ * - 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).
2263
+ * - 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.
2264
+ * - 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.
2265
+ * ### QPS limit
2266
+ * 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.
1978
2267
  *
1979
2268
  * @param request - PhoneNumberStatusForPublicRequest
1980
2269
  * @returns PhoneNumberStatusForPublicResponse
@@ -1985,14 +2274,15 @@ export default class Client extends OpenApi {
1985
2274
  }
1986
2275
 
1987
2276
  /**
1988
- * Queries the real-time service state of a phone number. The state includes NORMAL, SHUTDOWN, and NOT_EXIST. You can choose an encryption method for your phone number query, including plaintext, MD5, and SHA256.
2277
+ * 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.
1989
2278
  *
1990
2279
  * @remarks
1991
- * 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.
1992
- * * 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).
1993
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
1994
- * ### [](#qps)QPS limits
1995
- * You can call this operation up to 300 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.
2280
+ * - **Before calling this operation, ensure you fully understand the [pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Intelligence.**
2281
+ * - 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).
2282
+ * - 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.
2283
+ * - 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.
2284
+ * ### QPS limit
2285
+ * 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.
1996
2286
  *
1997
2287
  * @param request - PhoneNumberStatusForRealRequest
1998
2288
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2043,14 +2333,15 @@ export default class Client extends OpenApi {
2043
2333
  }
2044
2334
 
2045
2335
  /**
2046
- * Queries the real-time service state of a phone number. The state includes NORMAL, SHUTDOWN, and NOT_EXIST. You can choose an encryption method for your phone number query, including plaintext, MD5, and SHA256.
2336
+ * 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.
2047
2337
  *
2048
2338
  * @remarks
2049
- * 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.
2050
- * * 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).
2051
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
2052
- * ### [](#qps)QPS limits
2053
- * You can call this operation up to 300 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.
2339
+ * - **Before calling this operation, ensure you fully understand the [pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Intelligence.**
2340
+ * - 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).
2341
+ * - 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.
2342
+ * - 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.
2343
+ * ### QPS limit
2344
+ * 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.
2054
2345
  *
2055
2346
  * @param request - PhoneNumberStatusForRealRequest
2056
2347
  * @returns PhoneNumberStatusForRealResponse
@@ -2061,14 +2352,15 @@ export default class Client extends OpenApi {
2061
2352
  }
2062
2353
 
2063
2354
  /**
2064
- * Queries the real-time service state of a phone number. The state includes NORMAL, SHUTDOWN, and NOT_EXIST. You can choose an encryption method for your phone number query, including plaintext, MD5, and SHA256.
2355
+ * 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.
2065
2356
  *
2066
2357
  * @remarks
2067
- * 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.
2068
- * * 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).
2069
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
2070
- * ### [](#qps)QPS limits
2071
- * You can call this operation up to 300 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.
2358
+ * - **Before you call this operation, make sure you understand the [Product Pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Pedia**.
2359
+ * - 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).
2360
+ * - 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.
2361
+ * - 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.
2362
+ * ### QPS limit
2363
+ * 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.
2072
2364
  *
2073
2365
  * @param request - PhoneNumberStatusForSmsRequest
2074
2366
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2119,14 +2411,15 @@ export default class Client extends OpenApi {
2119
2411
  }
2120
2412
 
2121
2413
  /**
2122
- * Queries the real-time service state of a phone number. The state includes NORMAL, SHUTDOWN, and NOT_EXIST. You can choose an encryption method for your phone number query, including plaintext, MD5, and SHA256.
2414
+ * 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.
2123
2415
  *
2124
2416
  * @remarks
2125
- * 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.
2126
- * * 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).
2127
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
2128
- * ### [](#qps)QPS limits
2129
- * You can call this operation up to 300 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.
2417
+ * - **Before you call this operation, make sure you understand the [Product Pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Pedia**.
2418
+ * - 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).
2419
+ * - 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.
2420
+ * - 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.
2421
+ * ### QPS limit
2422
+ * 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.
2130
2423
  *
2131
2424
  * @param request - PhoneNumberStatusForSmsRequest
2132
2425
  * @returns PhoneNumberStatusForSmsResponse
@@ -2137,14 +2430,15 @@ export default class Client extends OpenApi {
2137
2430
  }
2138
2431
 
2139
2432
  /**
2140
- * Queries the real-time service state of a phone number. The state includes NORMAL, SHUTDOWN, and NOT_EXIST. You can choose an encryption method for your phone number query, including plaintext, MD5, and SHA256.
2433
+ * 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.
2141
2434
  *
2142
2435
  * @remarks
2143
- * 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.
2144
- * * 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).
2145
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
2146
- * ### [](#qps)QPS limits
2147
- * You can call this operation up to 300 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.
2436
+ * - **Before you use this API, make sure that you understand the [pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Encyclopedia**.
2437
+ * - 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).
2438
+ * - 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.
2439
+ * - 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.
2440
+ * ### QPS limit
2441
+ * 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.
2148
2442
  *
2149
2443
  * @param request - PhoneNumberStatusForVoiceRequest
2150
2444
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2195,14 +2489,15 @@ export default class Client extends OpenApi {
2195
2489
  }
2196
2490
 
2197
2491
  /**
2198
- * Queries the real-time service state of a phone number. The state includes NORMAL, SHUTDOWN, and NOT_EXIST. You can choose an encryption method for your phone number query, including plaintext, MD5, and SHA256.
2492
+ * 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.
2199
2493
  *
2200
2494
  * @remarks
2201
- * 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.
2202
- * * 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).
2203
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
2204
- * ### [](#qps)QPS limits
2205
- * You can call this operation up to 300 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.
2495
+ * - **Before you use this API, make sure that you understand the [pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Encyclopedia**.
2496
+ * - 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).
2497
+ * - 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.
2498
+ * - 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.
2499
+ * ### QPS limit
2500
+ * 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.
2206
2501
  *
2207
2502
  * @param request - PhoneNumberStatusForVoiceRequest
2208
2503
  * @returns PhoneNumberStatusForVoiceResponse
@@ -2267,7 +2562,7 @@ export default class Client extends OpenApi {
2267
2562
  }
2268
2563
 
2269
2564
  /**
2270
- * 套餐包类型信息查询
2565
+ * Queries package type information.
2271
2566
  *
2272
2567
  * @param request - QueryPackageTypeInfoRequest
2273
2568
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2310,7 +2605,7 @@ export default class Client extends OpenApi {
2310
2605
  }
2311
2606
 
2312
2607
  /**
2313
- * 套餐包类型信息查询
2608
+ * Queries package type information.
2314
2609
  *
2315
2610
  * @param request - QueryPackageTypeInfoRequest
2316
2611
  * @returns QueryPackageTypeInfoResponse
@@ -2503,7 +2798,7 @@ export default class Client extends OpenApi {
2503
2798
  }
2504
2799
 
2505
2800
  /**
2506
- * Queries information about tags.
2801
+ * Queries tag information.
2507
2802
  *
2508
2803
  * @param request - QueryTagInfoBySelectionRequest
2509
2804
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2554,7 +2849,7 @@ export default class Client extends OpenApi {
2554
2849
  }
2555
2850
 
2556
2851
  /**
2557
- * Queries information about tags.
2852
+ * Queries tag information.
2558
2853
  *
2559
2854
  * @param request - QueryTagInfoBySelectionRequest
2560
2855
  * @returns QueryTagInfoBySelectionResponse
@@ -2565,7 +2860,7 @@ export default class Client extends OpenApi {
2565
2860
  }
2566
2861
 
2567
2862
  /**
2568
- * Queries a list of tags by page.
2863
+ * Queries the tag list by page.
2569
2864
  *
2570
2865
  * @param request - QueryTagListPageRequest
2571
2866
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2612,7 +2907,7 @@ export default class Client extends OpenApi {
2612
2907
  }
2613
2908
 
2614
2909
  /**
2615
- * Queries a list of tags by page.
2910
+ * Queries the tag list by page.
2616
2911
  *
2617
2912
  * @param request - QueryTagListPageRequest
2618
2913
  * @returns QueryTagListPageResponse
@@ -2623,7 +2918,7 @@ export default class Client extends OpenApi {
2623
2918
  }
2624
2919
 
2625
2920
  /**
2626
- * 查询离线任务列表
2921
+ * Queries a list of offline tasks.
2627
2922
  *
2628
2923
  * @param tmpReq - QueryTaskListRequest
2629
2924
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2700,7 +2995,7 @@ export default class Client extends OpenApi {
2700
2995
  }
2701
2996
 
2702
2997
  /**
2703
- * 查询离线任务列表
2998
+ * Queries a list of offline tasks.
2704
2999
  *
2705
3000
  * @param request - QueryTaskListRequest
2706
3001
  * @returns QueryTaskListResponse
@@ -2711,7 +3006,7 @@ export default class Client extends OpenApi {
2711
3006
  }
2712
3007
 
2713
3008
  /**
2714
- * Queries the usage statistics based on tag IDs.
3009
+ * Queries usage statistics by tag ID.
2715
3010
  *
2716
3011
  * @param request - QueryUsageStatisticsByTagIdRequest
2717
3012
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2770,7 +3065,7 @@ export default class Client extends OpenApi {
2770
3065
  }
2771
3066
 
2772
3067
  /**
2773
- * Queries the usage statistics based on tag IDs.
3068
+ * Queries usage statistics by tag ID.
2774
3069
  *
2775
3070
  * @param request - QueryUsageStatisticsByTagIdRequest
2776
3071
  * @returns QueryUsageStatisticsByTagIdResponse
@@ -2781,7 +3076,10 @@ export default class Client extends OpenApi {
2781
3076
  }
2782
3077
 
2783
3078
  /**
2784
- * 预警联系人保存
3079
+ * Saves an alert contact.
3080
+ *
3081
+ * @remarks
3082
+ * - Before you call this operation, ensure you have activated Phone Number Intelligence.
2785
3083
  *
2786
3084
  * @param request - SaveContactsRequest
2787
3085
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2852,7 +3150,10 @@ export default class Client extends OpenApi {
2852
3150
  }
2853
3151
 
2854
3152
  /**
2855
- * 预警联系人保存
3153
+ * Saves an alert contact.
3154
+ *
3155
+ * @remarks
3156
+ * - Before you call this operation, ensure you have activated Phone Number Intelligence.
2856
3157
  *
2857
3158
  * @param request - SaveContactsRequest
2858
3159
  * @returns SaveContactsResponse
@@ -2863,14 +3164,15 @@ export default class Client extends OpenApi {
2863
3164
  }
2864
3165
 
2865
3166
  /**
2866
- * Verifies whether the name, phone number, and ID card number entered by a user belong to the same user.
3167
+ * 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.
2867
3168
  *
2868
3169
  * @remarks
2869
- * 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.
2870
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
2871
- * * You are charged only if the value of Code is OK and the value of IsConsistent is not 2.
2872
- * ### [](#qps)QPS limits
2873
- * You can call this operation up to 200 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.
3170
+ * - 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.
3171
+ * - 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.
3172
+ * - Billing applies when the API returns Code=\\"OK\\" and IsConsistent != 2. Other return results are not billed.
3173
+ * - The verification of virtual carrier numbers is not supported. Virtual carrier numbers refer to numbers that start with 170, 171, 162, or 165.
3174
+ * ### QPS limit
3175
+ * 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.
2874
3176
  *
2875
3177
  * @param request - ThreeElementsVerificationRequest
2876
3178
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2929,14 +3231,15 @@ export default class Client extends OpenApi {
2929
3231
  }
2930
3232
 
2931
3233
  /**
2932
- * Verifies whether the name, phone number, and ID card number entered by a user belong to the same user.
3234
+ * 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.
2933
3235
  *
2934
3236
  * @remarks
2935
- * 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.
2936
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
2937
- * * You are charged only if the value of Code is OK and the value of IsConsistent is not 2.
2938
- * ### [](#qps)QPS limits
2939
- * You can call this operation up to 200 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.
3237
+ * - 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.
3238
+ * - 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.
3239
+ * - Billing applies when the API returns Code=\\"OK\\" and IsConsistent != 2. Other return results are not billed.
3240
+ * - The verification of virtual carrier numbers is not supported. Virtual carrier numbers refer to numbers that start with 170, 171, 162, or 165.
3241
+ * ### QPS limit
3242
+ * 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.
2940
3243
  *
2941
3244
  * @param request - ThreeElementsVerificationRequest
2942
3245
  * @returns ThreeElementsVerificationResponse
@@ -2947,14 +3250,15 @@ export default class Client extends OpenApi {
2947
3250
  }
2948
3251
 
2949
3252
  /**
2950
- * Verifies whether the name and phone number entered by a user belong to the same user.
3253
+ * 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.
2951
3254
  *
2952
3255
  * @remarks
2953
- * 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.
2954
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
2955
- * * You are charged only if the value of Code is OK and the value of IsConsistent is not 2.
2956
- * ### [](#qps)QPS limits
2957
- * You can call this operation up to 200 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.
3256
+ * - 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.
3257
+ * - 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.
3258
+ * - Billing is applied when the API returns Code="OK" and IsConsistent != 2. Other return results are not billed.
3259
+ * - MVNO number verification is not supported. MVNO numbers refer to numbers starting with 170, 171, 162, and 165.
3260
+ * ### QPS limit
3261
+ * 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.
2958
3262
  *
2959
3263
  * @param request - TwoElementsVerificationRequest
2960
3264
  * @param runtime - runtime options for this request RuntimeOptions
@@ -3009,14 +3313,15 @@ export default class Client extends OpenApi {
3009
3313
  }
3010
3314
 
3011
3315
  /**
3012
- * Verifies whether the name and phone number entered by a user belong to the same user.
3316
+ * 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.
3013
3317
  *
3014
3318
  * @remarks
3015
- * 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.
3016
- * * Before you call this operation, perform the following operations: Log on to the Cell Phone Number Service console. On the [Labels](https://dytns.console.aliyun.com/analysis/square) page, find the label that you want to use, click **Activate Now**, enter the required information, and then submit your application. After your application is approved, you can use the label.
3017
- * * You are charged only if the value of Code is OK and the value of IsConsistent is not 2.
3018
- * ### [](#qps)QPS limits
3019
- * You can call this operation up to 200 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.
3319
+ * - 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.
3320
+ * - 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.
3321
+ * - Billing is applied when the API returns Code="OK" and IsConsistent != 2. Other return results are not billed.
3322
+ * - MVNO number verification is not supported. MVNO numbers refer to numbers starting with 170, 171, 162, and 165.
3323
+ * ### QPS limit
3324
+ * 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.
3020
3325
  *
3021
3326
  * @param request - TwoElementsVerificationRequest
3022
3327
  * @returns TwoElementsVerificationResponse
@@ -3171,7 +3476,14 @@ export default class Client extends OpenApi {
3171
3476
  }
3172
3477
 
3173
3478
  /**
3174
- * Obtains a Uniform Anonymous Identifier (UAID) based on the authorization token of a carrier. For more information about how to obtain the authorization token and its signature value, see the GetUAIDApplyTokenSign documentation.
3479
+ * Obtains a UAID based on the carrier authorization token.
3480
+ * For information about how to obtain the authorization token and its signature, see the GetUAIDApplyTokenSign API documentation.
3481
+ * 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.
3482
+ *
3483
+ * @remarks
3484
+ * 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.
3485
+ * Obtains a UAID based on the carrier authorization token.
3486
+ * For information about how to obtain the authorization token and its signature, see the GetUAIDApplyTokenSign API documentation.
3175
3487
  *
3176
3488
  * @param request - UAIDVerificationRequest
3177
3489
  * @param runtime - runtime options for this request RuntimeOptions
@@ -3238,7 +3550,14 @@ export default class Client extends OpenApi {
3238
3550
  }
3239
3551
 
3240
3552
  /**
3241
- * Obtains a Uniform Anonymous Identifier (UAID) based on the authorization token of a carrier. For more information about how to obtain the authorization token and its signature value, see the GetUAIDApplyTokenSign documentation.
3553
+ * Obtains a UAID based on the carrier authorization token.
3554
+ * For information about how to obtain the authorization token and its signature, see the GetUAIDApplyTokenSign API documentation.
3555
+ * 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.
3556
+ *
3557
+ * @remarks
3558
+ * 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.
3559
+ * Obtains a UAID based on the carrier authorization token.
3560
+ * For information about how to obtain the authorization token and its signature, see the GetUAIDApplyTokenSign API documentation.
3242
3561
  *
3243
3562
  * @param request - UAIDVerificationRequest
3244
3563
  * @returns UAIDVerificationResponse
@@ -3249,7 +3568,10 @@ export default class Client extends OpenApi {
3249
3568
  }
3250
3569
 
3251
3570
  /**
3252
- * 预警联系人更新
3571
+ * Updates an alert contact.
3572
+ *
3573
+ * @remarks
3574
+ * - Ensure that you have activated the Phone Number Information Service before calling this operation.
3253
3575
  *
3254
3576
  * @param request - UpdateContactsRequest
3255
3577
  * @param runtime - runtime options for this request RuntimeOptions
@@ -3320,7 +3642,10 @@ export default class Client extends OpenApi {
3320
3642
  }
3321
3643
 
3322
3644
  /**
3323
- * 预警联系人更新
3645
+ * Updates an alert contact.
3646
+ *
3647
+ * @remarks
3648
+ * - Ensure that you have activated the Phone Number Information Service before calling this operation.
3324
3649
  *
3325
3650
  * @param request - UpdateContactsRequest
3326
3651
  * @returns UpdateContactsResponse
@@ -3330,4 +3655,62 @@ export default class Client extends OpenApi {
3330
3655
  return await this.updateContactsWithOptions(request, runtime);
3331
3656
  }
3332
3657
 
3658
+ /**
3659
+ * 虚商三要素
3660
+ *
3661
+ * @param request - VirtualThreeElementsVerificationRequest
3662
+ * @param runtime - runtime options for this request RuntimeOptions
3663
+ * @returns VirtualThreeElementsVerificationResponse
3664
+ */
3665
+ async virtualThreeElementsVerificationWithOptions(request: $_model.VirtualThreeElementsVerificationRequest, runtime: $dara.RuntimeOptions): Promise<$_model.VirtualThreeElementsVerificationResponse> {
3666
+ request.validate();
3667
+ let query = { };
3668
+ if (!$dara.isNull(request.authCode)) {
3669
+ query["AuthCode"] = request.authCode;
3670
+ }
3671
+
3672
+ if (!$dara.isNull(request.certCode)) {
3673
+ query["CertCode"] = request.certCode;
3674
+ }
3675
+
3676
+ if (!$dara.isNull(request.certName)) {
3677
+ query["CertName"] = request.certName;
3678
+ }
3679
+
3680
+ if (!$dara.isNull(request.inputNumber)) {
3681
+ query["InputNumber"] = request.inputNumber;
3682
+ }
3683
+
3684
+ if (!$dara.isNull(request.mask)) {
3685
+ query["Mask"] = request.mask;
3686
+ }
3687
+
3688
+ let req = new $OpenApiUtil.OpenApiRequest({
3689
+ query: OpenApiUtil.query(query),
3690
+ });
3691
+ let params = new $OpenApiUtil.Params({
3692
+ action: "VirtualThreeElementsVerification",
3693
+ version: "2020-02-17",
3694
+ protocol: "HTTPS",
3695
+ pathname: "/",
3696
+ method: "POST",
3697
+ authType: "AK",
3698
+ style: "RPC",
3699
+ reqBodyType: "formData",
3700
+ bodyType: "json",
3701
+ });
3702
+ return $dara.cast<$_model.VirtualThreeElementsVerificationResponse>(await this.callApi(params, req, runtime), new $_model.VirtualThreeElementsVerificationResponse({}));
3703
+ }
3704
+
3705
+ /**
3706
+ * 虚商三要素
3707
+ *
3708
+ * @param request - VirtualThreeElementsVerificationRequest
3709
+ * @returns VirtualThreeElementsVerificationResponse
3710
+ */
3711
+ async virtualThreeElementsVerification(request: $_model.VirtualThreeElementsVerificationRequest): Promise<$_model.VirtualThreeElementsVerificationResponse> {
3712
+ let runtime = new $dara.RuntimeOptions({ });
3713
+ return await this.virtualThreeElementsVerificationWithOptions(request, runtime);
3714
+ }
3715
+
3333
3716
  }