@alicloud/dytnsapi20200217 3.2.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 (228) hide show
  1. package/dist/client.d.ts +556 -226
  2. package/dist/client.js +660 -227
  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 +103 -0
  61. package/dist/models/HistoryThreeElementsVerificationRequest.js +70 -0
  62. package/dist/models/HistoryThreeElementsVerificationRequest.js.map +1 -0
  63. package/dist/models/HistoryThreeElementsVerificationResponse.d.ts +19 -0
  64. package/dist/models/HistoryThreeElementsVerificationResponse.js +69 -0
  65. package/dist/models/HistoryThreeElementsVerificationResponse.js.map +1 -0
  66. package/dist/models/HistoryThreeElementsVerificationResponseBody.d.ts +94 -0
  67. package/dist/models/HistoryThreeElementsVerificationResponseBody.js +90 -0
  68. package/dist/models/HistoryThreeElementsVerificationResponseBody.js.map +1 -0
  69. package/dist/models/InvalidPhoneNumberFilterRequest.d.ts +2 -2
  70. package/dist/models/InvalidPhoneNumberFilterResponseBody.d.ts +29 -19
  71. package/dist/models/InvalidPhoneNumberFilterResponseBody.js.map +1 -1
  72. package/dist/models/ListContactsRequest.d.ts +6 -0
  73. package/dist/models/ListContactsRequest.js.map +1 -1
  74. package/dist/models/ListContactsResponseBody.d.ts +60 -0
  75. package/dist/models/ListContactsResponseBody.js.map +1 -1
  76. package/dist/models/PhoneNumberEncryptRequest.d.ts +12 -4
  77. package/dist/models/PhoneNumberEncryptRequest.js.map +1 -1
  78. package/dist/models/PhoneNumberEncryptResponseBody.d.ts +16 -6
  79. package/dist/models/PhoneNumberEncryptResponseBody.js.map +1 -1
  80. package/dist/models/PhoneNumberStatusForAccountRequest.d.ts +20 -10
  81. package/dist/models/PhoneNumberStatusForAccountRequest.js.map +1 -1
  82. package/dist/models/PhoneNumberStatusForAccountResponseBody.d.ts +28 -19
  83. package/dist/models/PhoneNumberStatusForAccountResponseBody.js.map +1 -1
  84. package/dist/models/PhoneNumberStatusForPublicRequest.d.ts +17 -9
  85. package/dist/models/PhoneNumberStatusForPublicRequest.js.map +1 -1
  86. package/dist/models/PhoneNumberStatusForPublicResponseBody.d.ts +32 -22
  87. package/dist/models/PhoneNumberStatusForPublicResponseBody.js.map +1 -1
  88. package/dist/models/PhoneNumberStatusForRealRequest.d.ts +19 -9
  89. package/dist/models/PhoneNumberStatusForRealRequest.js.map +1 -1
  90. package/dist/models/PhoneNumberStatusForRealResponseBody.d.ts +33 -22
  91. package/dist/models/PhoneNumberStatusForRealResponseBody.js.map +1 -1
  92. package/dist/models/PhoneNumberStatusForSmsRequest.d.ts +20 -10
  93. package/dist/models/PhoneNumberStatusForSmsRequest.js.map +1 -1
  94. package/dist/models/PhoneNumberStatusForSmsResponseBody.d.ts +29 -20
  95. package/dist/models/PhoneNumberStatusForSmsResponseBody.js.map +1 -1
  96. package/dist/models/PhoneNumberStatusForVoiceRequest.d.ts +19 -9
  97. package/dist/models/PhoneNumberStatusForVoiceRequest.js.map +1 -1
  98. package/dist/models/PhoneNumberStatusForVoiceResponseBody.d.ts +31 -21
  99. package/dist/models/PhoneNumberStatusForVoiceResponseBody.js.map +1 -1
  100. package/dist/models/QueryAvailableAuthCodeRequest.d.ts +1 -1
  101. package/dist/models/QueryAvailableAuthCodeResponseBody.d.ts +8 -7
  102. package/dist/models/QueryAvailableAuthCodeResponseBody.js.map +1 -1
  103. package/dist/models/QueryPackageTypeInfoRequest.d.ts +1 -1
  104. package/dist/models/QueryPackageTypeInfoResponseBody.d.ts +31 -4
  105. package/dist/models/QueryPackageTypeInfoResponseBody.js.map +1 -1
  106. package/dist/models/QueryTagApplyRuleResponseBody.d.ts +28 -15
  107. package/dist/models/QueryTagApplyRuleResponseBody.js.map +1 -1
  108. package/dist/models/QueryTagInfoBySelectionResponseBody.d.ts +33 -18
  109. package/dist/models/QueryTagInfoBySelectionResponseBody.js.map +1 -1
  110. package/dist/models/QueryTagListPageResponseBody.d.ts +23 -21
  111. package/dist/models/QueryTagListPageResponseBody.js.map +1 -1
  112. package/dist/models/QueryTaskListRequest.d.ts +24 -1
  113. package/dist/models/QueryTaskListRequest.js.map +1 -1
  114. package/dist/models/QueryTaskListResponseBody.d.ts +31 -0
  115. package/dist/models/QueryTaskListResponseBody.js.map +1 -1
  116. package/dist/models/QueryTaskListShrinkRequest.d.ts +24 -1
  117. package/dist/models/QueryTaskListShrinkRequest.js.map +1 -1
  118. package/dist/models/QueryUsageStatisticsByTagIdRequest.d.ts +5 -5
  119. package/dist/models/QueryUsageStatisticsByTagIdResponseBody.d.ts +23 -24
  120. package/dist/models/QueryUsageStatisticsByTagIdResponseBody.js.map +1 -1
  121. package/dist/models/SaveContactsRequest.d.ts +26 -0
  122. package/dist/models/SaveContactsRequest.js.map +1 -1
  123. package/dist/models/SaveContactsResponseBody.d.ts +12 -0
  124. package/dist/models/SaveContactsResponseBody.js.map +1 -1
  125. package/dist/models/ThreeElementsVerificationRequest.d.ts +19 -17
  126. package/dist/models/ThreeElementsVerificationRequest.js.map +1 -1
  127. package/dist/models/ThreeElementsVerificationResponseBody.d.ts +23 -21
  128. package/dist/models/ThreeElementsVerificationResponseBody.js.map +1 -1
  129. package/dist/models/TwoElementsVerificationRequest.d.ts +15 -13
  130. package/dist/models/TwoElementsVerificationRequest.js.map +1 -1
  131. package/dist/models/TwoElementsVerificationResponseBody.d.ts +26 -22
  132. package/dist/models/TwoElementsVerificationResponseBody.js.map +1 -1
  133. package/dist/models/UaidverificationRequest.d.ts +28 -2
  134. package/dist/models/UaidverificationRequest.js.map +1 -1
  135. package/dist/models/UaidverificationResponseBody.d.ts +21 -0
  136. package/dist/models/UaidverificationResponseBody.js.map +1 -1
  137. package/dist/models/UpdateContactsRequest.d.ts +36 -0
  138. package/dist/models/UpdateContactsRequest.js.map +1 -1
  139. package/dist/models/UpdateContactsResponseBody.d.ts +12 -0
  140. package/dist/models/UpdateContactsResponseBody.js.map +1 -1
  141. package/dist/models/VirtualThreeElementsVerificationRequest.d.ts +53 -0
  142. package/dist/models/VirtualThreeElementsVerificationRequest.js +66 -0
  143. package/dist/models/VirtualThreeElementsVerificationRequest.js.map +1 -0
  144. package/dist/models/VirtualThreeElementsVerificationResponse.d.ts +19 -0
  145. package/dist/models/VirtualThreeElementsVerificationResponse.js +69 -0
  146. package/dist/models/VirtualThreeElementsVerificationResponse.js.map +1 -0
  147. package/dist/models/VirtualThreeElementsVerificationResponseBody.d.ts +35 -0
  148. package/dist/models/VirtualThreeElementsVerificationResponseBody.js +88 -0
  149. package/dist/models/VirtualThreeElementsVerificationResponseBody.js.map +1 -0
  150. package/dist/models/model.d.ts +8 -0
  151. package/dist/models/model.js +20 -4
  152. package/dist/models/model.js.map +1 -1
  153. package/package.json +1 -1
  154. package/src/client.ts +676 -227
  155. package/src/models/CertNoThreeElementVerificationRequest.ts +15 -2
  156. package/src/models/CertNoThreeElementVerificationResponseBody.ts +33 -0
  157. package/src/models/CertNoTwoElementVerificationRequest.ts +10 -2
  158. package/src/models/CertNoTwoElementVerificationResponseBody.ts +25 -0
  159. package/src/models/CompanyFourElementsVerificationRequest.ts +10 -13
  160. package/src/models/CompanyFourElementsVerificationResponseBody.ts +21 -18
  161. package/src/models/CompanyThreeElementsVerificationRequest.ts +7 -8
  162. package/src/models/CompanyThreeElementsVerificationResponseBody.ts +26 -20
  163. package/src/models/CompanyTwoElementsVerificationRequest.ts +5 -5
  164. package/src/models/CompanyTwoElementsVerificationResponseBody.ts +26 -16
  165. package/src/models/DeleteContactsRequest.ts +2 -0
  166. package/src/models/DeleteContactsResponseBody.ts +17 -0
  167. package/src/models/DescribeEmptyNumberRequest.ts +10 -7
  168. package/src/models/DescribeEmptyNumberResponseBody.ts +16 -12
  169. package/src/models/DescribePhoneNumberAnalysisAirequest.ts +5 -5
  170. package/src/models/DescribePhoneNumberAnalysisAiresponseBody.ts +16 -10
  171. package/src/models/DescribePhoneNumberAnalysisRequest.ts +29 -2
  172. package/src/models/DescribePhoneNumberAnalysisResponseBody.ts +36 -1
  173. package/src/models/DescribePhoneNumberAnalysisTransparentResponseBody.ts +0 -16
  174. package/src/models/DescribePhoneNumberAttributeRequest.ts +0 -5
  175. package/src/models/DescribePhoneNumberAttributeResponseBody.ts +0 -67
  176. package/src/models/DescribePhoneNumberOnlineTimeRequest.ts +13 -14
  177. package/src/models/DescribePhoneNumberOnlineTimeResponseBody.ts +21 -21
  178. package/src/models/DescribePhoneNumberOperatorAttributeRequest.ts +20 -12
  179. package/src/models/DescribePhoneNumberOperatorAttributeResponseBody.ts +30 -22
  180. package/src/models/DescribePhoneTwiceTelVerifyRequest.ts +19 -15
  181. package/src/models/DescribePhoneTwiceTelVerifyResponseBody.ts +29 -19
  182. package/src/models/GetUaidapplyTokenSignRequest.ts +35 -0
  183. package/src/models/GetUaidapplyTokenSignResponseBody.ts +33 -0
  184. package/src/models/HistoryThreeElementsVerificationRequest.ts +128 -0
  185. package/src/models/HistoryThreeElementsVerificationResponse.ts +40 -0
  186. package/src/models/HistoryThreeElementsVerificationResponseBody.ts +130 -0
  187. package/src/models/InvalidPhoneNumberFilterRequest.ts +2 -2
  188. package/src/models/InvalidPhoneNumberFilterResponseBody.ts +29 -19
  189. package/src/models/ListContactsRequest.ts +6 -0
  190. package/src/models/ListContactsResponseBody.ts +60 -0
  191. package/src/models/PhoneNumberEncryptRequest.ts +12 -4
  192. package/src/models/PhoneNumberEncryptResponseBody.ts +16 -6
  193. package/src/models/PhoneNumberStatusForAccountRequest.ts +20 -10
  194. package/src/models/PhoneNumberStatusForAccountResponseBody.ts +28 -19
  195. package/src/models/PhoneNumberStatusForPublicRequest.ts +17 -9
  196. package/src/models/PhoneNumberStatusForPublicResponseBody.ts +32 -22
  197. package/src/models/PhoneNumberStatusForRealRequest.ts +19 -9
  198. package/src/models/PhoneNumberStatusForRealResponseBody.ts +33 -22
  199. package/src/models/PhoneNumberStatusForSmsRequest.ts +20 -10
  200. package/src/models/PhoneNumberStatusForSmsResponseBody.ts +29 -20
  201. package/src/models/PhoneNumberStatusForVoiceRequest.ts +19 -9
  202. package/src/models/PhoneNumberStatusForVoiceResponseBody.ts +31 -21
  203. package/src/models/QueryAvailableAuthCodeRequest.ts +1 -1
  204. package/src/models/QueryAvailableAuthCodeResponseBody.ts +8 -7
  205. package/src/models/QueryPackageTypeInfoRequest.ts +1 -1
  206. package/src/models/QueryPackageTypeInfoResponseBody.ts +31 -4
  207. package/src/models/QueryTagApplyRuleResponseBody.ts +28 -15
  208. package/src/models/QueryTagInfoBySelectionResponseBody.ts +33 -18
  209. package/src/models/QueryTagListPageResponseBody.ts +23 -21
  210. package/src/models/QueryTaskListRequest.ts +24 -1
  211. package/src/models/QueryTaskListResponseBody.ts +31 -0
  212. package/src/models/QueryTaskListShrinkRequest.ts +24 -1
  213. package/src/models/QueryUsageStatisticsByTagIdRequest.ts +5 -5
  214. package/src/models/QueryUsageStatisticsByTagIdResponseBody.ts +23 -24
  215. package/src/models/SaveContactsRequest.ts +26 -0
  216. package/src/models/SaveContactsResponseBody.ts +12 -0
  217. package/src/models/ThreeElementsVerificationRequest.ts +19 -17
  218. package/src/models/ThreeElementsVerificationResponseBody.ts +23 -21
  219. package/src/models/TwoElementsVerificationRequest.ts +15 -13
  220. package/src/models/TwoElementsVerificationResponseBody.ts +26 -22
  221. package/src/models/UaidverificationRequest.ts +28 -2
  222. package/src/models/UaidverificationResponseBody.ts +21 -0
  223. package/src/models/UpdateContactsRequest.ts +36 -0
  224. package/src/models/UpdateContactsResponseBody.ts +12 -0
  225. package/src/models/VirtualThreeElementsVerificationRequest.ts +74 -0
  226. package/src/models/VirtualThreeElementsVerificationResponse.ts +40 -0
  227. package/src/models/VirtualThreeElementsVerificationResponseBody.ts +69 -0
  228. package/src/models/model.ts +8 -0
package/dist/client.js CHANGED
@@ -48,7 +48,32 @@ __exportStar(require("./models/model"), exports);
48
48
  class Client extends openapi_core_1.default {
49
49
  constructor(config) {
50
50
  super(config);
51
- this._endpointRule = "central";
51
+ this._endpointRule = "regional";
52
+ this._endpointMap = {
53
+ 'us-west-1': "dytnsapi.aliyuncs.com",
54
+ 'us-east-1': "dytnsapi.aliyuncs.com",
55
+ 'me-east-1': "dytnsapi.aliyuncs.com",
56
+ 'eu-west-1': "dytnsapi.aliyuncs.com",
57
+ 'eu-central-1': "dytnsapi.aliyuncs.com",
58
+ 'cn-zhangjiakou': "dytnsapi.aliyuncs.com",
59
+ 'cn-wulanchabu': "dytnsapi.aliyuncs.com",
60
+ 'cn-shenzhen-finance-1': "dytnsapi.aliyuncs.com",
61
+ 'cn-shenzhen': "dytnsapi.aliyuncs.com",
62
+ 'cn-shanghai-finance-1': "dytnsapi.aliyuncs.com",
63
+ 'cn-shanghai': "dytnsapi.aliyuncs.com",
64
+ 'cn-qingdao': "dytnsapi.aliyuncs.com",
65
+ 'cn-huhehaote': "dytnsapi.aliyuncs.com",
66
+ 'cn-hongkong': "dytnsapi.aliyuncs.com",
67
+ 'cn-hangzhou-finance': "dytnsapi.aliyuncs.com",
68
+ 'cn-hangzhou': "dytnsapi.aliyuncs.com",
69
+ 'cn-chengdu': "dytnsapi.aliyuncs.com",
70
+ 'cn-beijing-finance-1': "dytnsapi.aliyuncs.com",
71
+ 'cn-beijing': "dytnsapi.aliyuncs.com",
72
+ 'ap-southeast-5': "dytnsapi.aliyuncs.com",
73
+ 'ap-southeast-3': "dytnsapi.aliyuncs.com",
74
+ 'ap-southeast-1': "dytnsapi.aliyuncs.com",
75
+ 'ap-northeast-1': "dytnsapi.aliyuncs.com",
76
+ };
52
77
  this.checkConfig(config);
53
78
  this._endpoint = this.getEndpoint("dytnsapi", this._regionId, this._endpointRule, this._network, this._suffix, this._endpointMap, this._endpoint);
54
79
  }
@@ -62,7 +87,15 @@ class Client extends openapi_core_1.default {
62
87
  return openapi_core_2.OpenApiUtil.getEndpointRules(productId, regionId, endpointRule, network, suffix);
63
88
  }
64
89
  /**
65
- * 身份证三要素
90
+ * 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.
91
+ *
92
+ * @remarks
93
+ * - 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.
94
+ * - 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).
95
+ * - Billing applies only when the API return value is Code="OK". Other return results are not billed.
96
+ * - For the verifiable scope, see [ID Card Three Elements Verification](https://help.aliyun.com/document_detail/2844379.html).
97
+ * ### QPS limit
98
+ * - 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.
66
99
  *
67
100
  * @param request - CertNoThreeElementVerificationRequest
68
101
  * @param runtime - runtime options for this request RuntimeOptions
@@ -112,7 +145,15 @@ class Client extends openapi_core_1.default {
112
145
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.CertNoThreeElementVerificationResponse({}));
113
146
  }
114
147
  /**
115
- * 身份证三要素
148
+ * 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.
149
+ *
150
+ * @remarks
151
+ * - 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.
152
+ * - 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).
153
+ * - Billing applies only when the API return value is Code="OK". Other return results are not billed.
154
+ * - For the verifiable scope, see [ID Card Three Elements Verification](https://help.aliyun.com/document_detail/2844379.html).
155
+ * ### QPS limit
156
+ * - 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.
116
157
  *
117
158
  * @param request - CertNoThreeElementVerificationRequest
118
159
  * @returns CertNoThreeElementVerificationResponse
@@ -122,7 +163,14 @@ class Client extends openapi_core_1.default {
122
163
  return await this.certNoThreeElementVerificationWithOptions(request, runtime);
123
164
  }
124
165
  /**
125
- * 身份证二要素认证
166
+ * 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.
167
+ *
168
+ * @remarks
169
+ * - Before using this operation, make sure that you have fully understood the pricing of Cell Phone Number Service.
170
+ * - 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.
171
+ * - The operation is charged when the response contains Code="OK" and IsConsistent != 2. Other response results are not charged.
172
+ * ## QPS Limit
173
+ * 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.
126
174
  *
127
175
  * @param request - CertNoTwoElementVerificationRequest
128
176
  * @param runtime - runtime options for this request RuntimeOptions
@@ -166,7 +214,14 @@ class Client extends openapi_core_1.default {
166
214
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.CertNoTwoElementVerificationResponse({}));
167
215
  }
168
216
  /**
169
- * 身份证二要素认证
217
+ * 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.
218
+ *
219
+ * @remarks
220
+ * - Before using this operation, make sure that you have fully understood the pricing of Cell Phone Number Service.
221
+ * - 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.
222
+ * - The operation is charged when the response contains Code="OK" and IsConsistent != 2. Other response results are not charged.
223
+ * ## QPS Limit
224
+ * 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.
170
225
  *
171
226
  * @param request - CertNoTwoElementVerificationRequest
172
227
  * @returns CertNoTwoElementVerificationResponse
@@ -176,12 +231,14 @@ class Client extends openapi_core_1.default {
176
231
  return await this.certNoTwoElementVerificationWithOptions(request, runtime);
177
232
  }
178
233
  /**
179
- * 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.
234
+ * 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.
180
235
  *
181
236
  * @remarks
182
- * 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).
183
- * * You are charged only if the value of VerifyResult is true or false and the value of ReasonCode is 0, 1, or 2.
184
- * * 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.
237
+ * - 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).
238
+ * - Billing applies when VerifyResult returns true/false and ReasonCode is 0, 1, or 2 in the response. Billing does not apply in other cases.
239
+ * - 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.
240
+ * ### QPS limit
241
+ * 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.
185
242
  *
186
243
  * @param request - CompanyFourElementsVerificationRequest
187
244
  * @param runtime - runtime options for this request RuntimeOptions
@@ -231,12 +288,14 @@ class Client extends openapi_core_1.default {
231
288
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.CompanyFourElementsVerificationResponse({}));
232
289
  }
233
290
  /**
234
- * 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.
291
+ * 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.
235
292
  *
236
293
  * @remarks
237
- * 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).
238
- * * You are charged only if the value of VerifyResult is true or false and the value of ReasonCode is 0, 1, or 2.
239
- * * 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.
294
+ * - 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).
295
+ * - Billing applies when VerifyResult returns true/false and ReasonCode is 0, 1, or 2 in the response. Billing does not apply in other cases.
296
+ * - 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.
297
+ * ### QPS limit
298
+ * 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.
240
299
  *
241
300
  * @param request - CompanyFourElementsVerificationRequest
242
301
  * @returns CompanyFourElementsVerificationResponse
@@ -246,12 +305,14 @@ class Client extends openapi_core_1.default {
246
305
  return await this.companyFourElementsVerificationWithOptions(request, runtime);
247
306
  }
248
307
  /**
249
- * 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.
308
+ * 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.
250
309
  *
251
310
  * @remarks
252
- * 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).
253
- * * You are charged only if the value of VerifyResult is true or false and the value of ReasonCode is 0, 1, or 2.
254
- * * 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.
311
+ * - 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).
312
+ * - In the returned result, charges apply when VerifyResult is true/false and ReasonCode is 0/1/2. No charges apply in other cases.
313
+ * - 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.
314
+ * ### QPS limit
315
+ * 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.
255
316
  *
256
317
  * @param request - CompanyThreeElementsVerificationRequest
257
318
  * @param runtime - runtime options for this request RuntimeOptions
@@ -298,12 +359,14 @@ class Client extends openapi_core_1.default {
298
359
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.CompanyThreeElementsVerificationResponse({}));
299
360
  }
300
361
  /**
301
- * 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.
362
+ * 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.
302
363
  *
303
364
  * @remarks
304
- * 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).
305
- * * You are charged only if the value of VerifyResult is true or false and the value of ReasonCode is 0, 1, or 2.
306
- * * 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.
365
+ * - 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).
366
+ * - In the returned result, charges apply when VerifyResult is true/false and ReasonCode is 0/1/2. No charges apply in other cases.
367
+ * - 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.
368
+ * ### QPS limit
369
+ * 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.
307
370
  *
308
371
  * @param request - CompanyThreeElementsVerificationRequest
309
372
  * @returns CompanyThreeElementsVerificationResponse
@@ -313,12 +376,14 @@ class Client extends openapi_core_1.default {
313
376
  return await this.companyThreeElementsVerificationWithOptions(request, runtime);
314
377
  }
315
378
  /**
316
- * 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.
379
+ * 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.
317
380
  *
318
381
  * @remarks
319
- * 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).
320
- * * You are charged only if the value of VerifyResult is true or false and the value of ReasonCode is 0 or 1.
321
- * * 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.
382
+ * - 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).
383
+ * - Billing applies when Code=OK and ReasonCode=0/1/3 in the returned result. Other cases are not billed.
384
+ * - 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.
385
+ * ### QPS limit
386
+ * 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.
322
387
  *
323
388
  * @param request - CompanyTwoElementsVerificationRequest
324
389
  * @param runtime - runtime options for this request RuntimeOptions
@@ -362,12 +427,14 @@ class Client extends openapi_core_1.default {
362
427
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.CompanyTwoElementsVerificationResponse({}));
363
428
  }
364
429
  /**
365
- * 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.
430
+ * 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.
366
431
  *
367
432
  * @remarks
368
- * 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).
369
- * * You are charged only if the value of VerifyResult is true or false and the value of ReasonCode is 0 or 1.
370
- * * 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.
433
+ * - 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).
434
+ * - Billing applies when Code=OK and ReasonCode=0/1/3 in the returned result. Other cases are not billed.
435
+ * - 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.
436
+ * ### QPS limit
437
+ * 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.
371
438
  *
372
439
  * @param request - CompanyTwoElementsVerificationRequest
373
440
  * @returns CompanyTwoElementsVerificationResponse
@@ -377,7 +444,10 @@ class Client extends openapi_core_1.default {
377
444
  return await this.companyTwoElementsVerificationWithOptions(request, runtime);
378
445
  }
379
446
  /**
380
- * 预警联系人删除
447
+ * Deletes a contact.
448
+ *
449
+ * @remarks
450
+ * - Make sure you have activated Phone Number Identity Service before calling this operation.
381
451
  *
382
452
  * @param request - DeleteContactsRequest
383
453
  * @param runtime - runtime options for this request RuntimeOptions
@@ -415,7 +485,10 @@ class Client extends openapi_core_1.default {
415
485
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.DeleteContactsResponse({}));
416
486
  }
417
487
  /**
418
- * 预警联系人删除
488
+ * Deletes a contact.
489
+ *
490
+ * @remarks
491
+ * - Make sure you have activated Phone Number Identity Service before calling this operation.
419
492
  *
420
493
  * @param request - DeleteContactsRequest
421
494
  * @returns DeleteContactsResponse
@@ -425,17 +498,17 @@ class Client extends openapi_core_1.default {
425
498
  return await this.deleteContactsWithOptions(request, runtime);
426
499
  }
427
500
  /**
428
- * Predicts whether a phone number is a nonexistent number by using AI algorithms.
501
+ * Predicts whether a phone number is invalid by using AI algorithms.
429
502
  *
430
503
  * @remarks
431
- * 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.**
432
- * * You are charged only if the value of Code is OK and the value of Status is not UNKNOWN.
433
- * * 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**.
434
- * * 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.
435
- * ### [](#qps)QPS limits
436
- * 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.
437
- * ### [](#)Authorization information
438
- * 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).
504
+ * - 本接口用于验证号码是否为空号。发起调用该接口验证号码请求时,系统会根据验证次数计费,标准价为0.01元/次。**请确保在使用该接口前,已充分了解本产品的收费方式和价格。**
505
+ * - 当返回结果中:Code="OK" Status != UNKNOWN 时计费,其他情况不计费。
506
+ * - 由于本产品通过AI算法预测手机号的空号概率,所以无法做到100%准确。当前评估的准确率和召回率约为95%左右。**调用时请注意差别**。
507
+ * - 使用本接口前,请登录号码百科控制台,在[标签广场](https://dytns.console.aliyun.com/analysis/square)页面,找到对应的标签,单击**申请开通**,填写申请资料,审批通过后即可使用。
508
+ * ### QPS限制
509
+ * 本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
510
+ * ### 授权信息
511
+ * 默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。具体请参见[RAM用户授权](https://help.aliyun.com/document_detail/154006.html)
439
512
  *
440
513
  * @param request - DescribeEmptyNumberRequest
441
514
  * @param runtime - runtime options for this request RuntimeOptions
@@ -479,17 +552,17 @@ class Client extends openapi_core_1.default {
479
552
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribeEmptyNumberResponse({}));
480
553
  }
481
554
  /**
482
- * Predicts whether a phone number is a nonexistent number by using AI algorithms.
555
+ * Predicts whether a phone number is invalid by using AI algorithms.
483
556
  *
484
557
  * @remarks
485
- * 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.**
486
- * * You are charged only if the value of Code is OK and the value of Status is not UNKNOWN.
487
- * * 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**.
488
- * * 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.
489
- * ### [](#qps)QPS limits
490
- * 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.
491
- * ### [](#)Authorization information
492
- * 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).
558
+ * - 本接口用于验证号码是否为空号。发起调用该接口验证号码请求时,系统会根据验证次数计费,标准价为0.01元/次。**请确保在使用该接口前,已充分了解本产品的收费方式和价格。**
559
+ * - 当返回结果中:Code="OK" Status != UNKNOWN 时计费,其他情况不计费。
560
+ * - 由于本产品通过AI算法预测手机号的空号概率,所以无法做到100%准确。当前评估的准确率和召回率约为95%左右。**调用时请注意差别**。
561
+ * - 使用本接口前,请登录号码百科控制台,在[标签广场](https://dytns.console.aliyun.com/analysis/square)页面,找到对应的标签,单击**申请开通**,填写申请资料,审批通过后即可使用。
562
+ * ### QPS限制
563
+ * 本接口的单用户QPS限制为100次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。
564
+ * ### 授权信息
565
+ * 默认仅限阿里云账号使用本接口,RAM用户只有在被授予了相关API操作权限后方可使用。具体请参见[RAM用户授权](https://help.aliyun.com/document_detail/154006.html)
493
566
  *
494
567
  * @param request - DescribeEmptyNumberRequest
495
568
  * @returns DescribeEmptyNumberResponse
@@ -553,7 +626,15 @@ class Client extends openapi_core_1.default {
553
626
  return await this.describeMobileOperatorAttributeWithOptions(request, runtime);
554
627
  }
555
628
  /**
556
- * 号码分析实时查询蚂蚁
629
+ * Obtains the result returned by phone number analysis.
630
+ *
631
+ * @remarks
632
+ * - 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.
633
+ * - 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.
634
+ * ### QPS limit
635
+ * 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.
636
+ * ### Authorization information
637
+ * 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).
557
638
  *
558
639
  * @param request - DescribePhoneNumberAnalysisRequest
559
640
  * @param runtime - runtime options for this request RuntimeOptions
@@ -603,7 +684,15 @@ class Client extends openapi_core_1.default {
603
684
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribePhoneNumberAnalysisResponse({}));
604
685
  }
605
686
  /**
606
- * 号码分析实时查询蚂蚁
687
+ * Obtains the result returned by phone number analysis.
688
+ *
689
+ * @remarks
690
+ * - 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.
691
+ * - 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.
692
+ * ### QPS limit
693
+ * 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.
694
+ * ### Authorization information
695
+ * 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).
607
696
  *
608
697
  * @param request - DescribePhoneNumberAnalysisRequest
609
698
  * @returns DescribePhoneNumberAnalysisResponse
@@ -613,10 +702,11 @@ class Client extends openapi_core_1.default {
613
702
  return await this.describePhoneNumberAnalysisWithOptions(request, runtime);
614
703
  }
615
704
  /**
616
- * Obtains the analysis results of a phone number.
705
+ * Get the phone number analysis result.
617
706
  *
618
707
  * @remarks
619
- * 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.
708
+ * 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.
709
+ * Make sure that you fully understand the billing of the Cell Phone Number Service before you use this operation.
620
710
  *
621
711
  * @param request - DescribePhoneNumberAnalysisAIRequest
622
712
  * @param runtime - runtime options for this request RuntimeOptions
@@ -663,10 +753,11 @@ class Client extends openapi_core_1.default {
663
753
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribePhoneNumberAnalysisAIResponse({}));
664
754
  }
665
755
  /**
666
- * Obtains the analysis results of a phone number.
756
+ * Get the phone number analysis result.
667
757
  *
668
758
  * @remarks
669
- * 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.
759
+ * 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.
760
+ * Make sure that you fully understand the billing of the Cell Phone Number Service before you use this operation.
670
761
  *
671
762
  * @param request - DescribePhoneNumberAnalysisAIRequest
672
763
  * @returns DescribePhoneNumberAnalysisAIResponse
@@ -790,14 +881,6 @@ class Client extends openapi_core_1.default {
790
881
  return await this.describePhoneNumberAnalysisTransparentWithOptions(request, runtime);
791
882
  }
792
883
  /**
793
- * Queries the carrier, registration location, and mobile number portability information of a phone number.
794
- *
795
- * @remarks
796
- * 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.
797
- * * 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).
798
- * ### [](#qps)QPS limits
799
- * 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.
800
- *
801
884
  * @deprecated OpenAPI DescribePhoneNumberAttribute is deprecated, please use Dytnsapi::2020-02-17::DescribePhoneNumberOperatorAttribute instead.
802
885
  *
803
886
  * @param request - DescribePhoneNumberAttributeRequest
@@ -836,14 +919,6 @@ class Client extends openapi_core_1.default {
836
919
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribePhoneNumberAttributeResponse({}));
837
920
  }
838
921
  /**
839
- * Queries the carrier, registration location, and mobile number portability information of a phone number.
840
- *
841
- * @remarks
842
- * 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.
843
- * * 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).
844
- * ### [](#qps)QPS limits
845
- * 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.
846
- *
847
922
  * @deprecated OpenAPI DescribePhoneNumberAttribute is deprecated, please use Dytnsapi::2020-02-17::DescribePhoneNumberOperatorAttribute instead.
848
923
  *
849
924
  * @param request - DescribePhoneNumberAttributeRequest
@@ -855,13 +930,13 @@ class Client extends openapi_core_1.default {
855
930
  return await this.describePhoneNumberAttributeWithOptions(request, runtime);
856
931
  }
857
932
  /**
858
- * Queries the usage period of a phone number of a user.
933
+ * Queries the duration for which a mobile user has been registered on the carrier\\"s network.
859
934
  *
860
935
  * @remarks
861
- * 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.
862
- * * 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.
863
- * ### [](#qps)QPS limits
864
- * 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.
936
+ * - 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.
937
+ * - 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.
938
+ * ### QPS limit
939
+ * 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.
865
940
  *
866
941
  * @param request - DescribePhoneNumberOnlineTimeRequest
867
942
  * @param runtime - runtime options for this request RuntimeOptions
@@ -908,13 +983,13 @@ class Client extends openapi_core_1.default {
908
983
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribePhoneNumberOnlineTimeResponse({}));
909
984
  }
910
985
  /**
911
- * Queries the usage period of a phone number of a user.
986
+ * Queries the duration for which a mobile user has been registered on the carrier\\"s network.
912
987
  *
913
988
  * @remarks
914
- * 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.
915
- * * 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.
916
- * ### [](#qps)QPS limits
917
- * 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.
989
+ * - 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.
990
+ * - 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.
991
+ * ### QPS limit
992
+ * 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.
918
993
  *
919
994
  * @param request - DescribePhoneNumberOnlineTimeRequest
920
995
  * @returns DescribePhoneNumberOnlineTimeResponse
@@ -924,13 +999,15 @@ class Client extends openapi_core_1.default {
924
999
  return await this.describePhoneNumberOnlineTimeWithOptions(request, runtime);
925
1000
  }
926
1001
  /**
927
- * 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.
1002
+ * 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.
928
1003
  *
929
1004
  * @remarks
930
- * 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.
931
- * * 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).
932
- * * 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**.
933
- * * 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.
1005
+ * - 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.
1006
+ * - 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).
1007
+ * - 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.
1008
+ * - 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.
1009
+ * ### QPS limit
1010
+ * 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.
934
1011
  *
935
1012
  * @param request - DescribePhoneNumberOperatorAttributeRequest
936
1013
  * @param runtime - runtime options for this request RuntimeOptions
@@ -980,13 +1057,15 @@ class Client extends openapi_core_1.default {
980
1057
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribePhoneNumberOperatorAttributeResponse({}));
981
1058
  }
982
1059
  /**
983
- * 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.
1060
+ * 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.
984
1061
  *
985
1062
  * @remarks
986
- * 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.
987
- * * 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).
988
- * * 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**.
989
- * * 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.
1063
+ * - 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.
1064
+ * - 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).
1065
+ * - 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.
1066
+ * - 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.
1067
+ * ### QPS limit
1068
+ * 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.
990
1069
  *
991
1070
  * @param request - DescribePhoneNumberOperatorAttributeRequest
992
1071
  * @returns DescribePhoneNumberOperatorAttributeResponse
@@ -1140,16 +1219,16 @@ class Client extends openapi_core_1.default {
1140
1219
  return await this.describePhoneNumberRiskWithOptions(request, runtime);
1141
1220
  }
1142
1221
  /**
1143
- * Verifies whether a phone number is a reassigned phone number by calling this operation.
1222
+ * Quickly verify in a single request if a mobile phone number is a carrier\\"s secondary number assignment.
1144
1223
  *
1145
1224
  * @remarks
1146
- * 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.
1147
- * * You are charged for phone number verifications only if the value of Code is OK and the value of VerifyResult is not 0.
1148
- * * 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.
1149
- * ## [](#qps)QPS limits
1150
- * 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.
1151
- * ## [](#)Authorization information
1152
- * 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).
1225
+ * - Before you use this API, make sure you understand the [pricing](https://help.aliyun.com/document_detail/154751.html) for Phone Number Verification Service.
1226
+ * - You are charged only when the API response returns `Code="OK"` and `VerifyResult` is not `0`. No charge is incurred in any other case.
1227
+ * - 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.
1228
+ * ## QPS limits
1229
+ * 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.
1230
+ * ## Authorization
1231
+ * 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).
1153
1232
  *
1154
1233
  * @param request - DescribePhoneTwiceTelVerifyRequest
1155
1234
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1196,16 +1275,16 @@ class Client extends openapi_core_1.default {
1196
1275
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.DescribePhoneTwiceTelVerifyResponse({}));
1197
1276
  }
1198
1277
  /**
1199
- * Verifies whether a phone number is a reassigned phone number by calling this operation.
1278
+ * Quickly verify in a single request if a mobile phone number is a carrier\\"s secondary number assignment.
1200
1279
  *
1201
1280
  * @remarks
1202
- * 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.
1203
- * * You are charged for phone number verifications only if the value of Code is OK and the value of VerifyResult is not 0.
1204
- * * 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.
1205
- * ## [](#qps)QPS limits
1206
- * 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.
1207
- * ## [](#)Authorization information
1208
- * 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).
1281
+ * - Before you use this API, make sure you understand the [pricing](https://help.aliyun.com/document_detail/154751.html) for Phone Number Verification Service.
1282
+ * - You are charged only when the API response returns `Code="OK"` and `VerifyResult` is not `0`. No charge is incurred in any other case.
1283
+ * - 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.
1284
+ * ## QPS limits
1285
+ * 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.
1286
+ * ## Authorization
1287
+ * 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).
1209
1288
  *
1210
1289
  * @param request - DescribePhoneTwiceTelVerifyRequest
1211
1290
  * @returns DescribePhoneTwiceTelVerifyResponse
@@ -1215,7 +1294,97 @@ class Client extends openapi_core_1.default {
1215
1294
  return await this.describePhoneTwiceTelVerifyWithOptions(request, runtime);
1216
1295
  }
1217
1296
  /**
1218
- * 获取UAID申请Token所需的签名字段
1297
+ * This API only provides the signing functionality for acquiring an authorization token during UAID retrieval from the three-network operators.
1298
+ *
1299
+ * @remarks
1300
+ * 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.
1301
+ * - To generate the other parameters required to obtain the authorization token, refer to the respective operator\\"s documentation.
1302
+ * - 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.
1303
+ * - After obtaining the authorization token, call the [UAIDVerification](~~UAIDVerification~~) API to complete the UAID retrieval.
1304
+ * ### How to request an authorization token
1305
+ * >Notice:
1306
+ * When you request an authorization token, the client or H5 page must be connected to a cellular network.
1307
+ * #### China Mobile (CM)
1308
+ * Protocol: HTTPS + application/json
1309
+ * Method: POST
1310
+ * URL: https\\://msg.cmpassport.com/h5/getMobile
1311
+ * ##### Request parameters
1312
+ * Request example:
1313
+ * `{ "traceId": "mfawsxtcmyplwzpayzzvdvbsowxmkynr", "appId": "300011580392", "sign": "2c61b3c58ffbeed97461e31be4fd931a", "msgId": "redbyxsdetddwaaffajcwwapspykftzx", "expandParams": "", "businessType": "3", "version": "1.0", "timestamp": "20201125101540980" }`
1314
+ * Parameter description:
1315
+ * - `version`: Use `1.0`.
1316
+ * - `timestamp`: The request timestamp, with millisecond precision. This value and its format must match the `Time` input parameter for this API.
1317
+ * - `appId`: Use `300011580392`.
1318
+ * - `businessType`: Use `3`.
1319
+ * - `traceId`: The trace ID. This value must match this API\\"s `OutId` input parameter.
1320
+ * - `sign`: Obtained by calling this API.
1321
+ * - `msgId`: A unique message identifier.
1322
+ * ##### Response parameters
1323
+ * Response example:
1324
+ * `{ "header": { "appId": "300011580392", "msgId": "redbyxsdetddwaaffajcwwapspykftzx", "timestamp": "20201125101607932" }, "body": { "resultCode": "103000", "expandParams": "", "resultDesc": "成功", "token": "H5HTTPS4187AE9743AFCB14F8D99B9D65ED9E01" } }`
1325
+ * Retrieve the `token` from the response `body`.
1326
+ * #### China Unicom (CU)
1327
+ * Obtain the token in two steps.
1328
+ * ##### Step 1: Obtain the authurl
1329
+ * Send a request to the portal server to get the authentication server address (`authurl`).
1330
+ * Protocol: HTTPS + application/json
1331
+ * Method: GET
1332
+ * URL: https\\://nisportal.10010.com:9001/api
1333
+ * ###### Request parameters
1334
+ * Request examples:
1335
+ * JSON request: `?appid=1554778161153`
1336
+ * JSONP request: `?appid=1554778161153&callback=callbackFunction`
1337
+ * Parameter description:
1338
+ * - `appid`: Use 1554778161153.
1339
+ * - `callback`: The name of the JSONP callback function. This parameter is required only for JSONP requests.
1340
+ * ###### Response parameters
1341
+ * Response examples:
1342
+ * JSON response:
1343
+ * `{"authurl": "https://enrichgw.10010.com/d93222629f52ec79"}`
1344
+ * JSONP response:
1345
+ * `callbackFunction({"authurl":"https://enrichgw.10010.com/d93222629f52ec79"})`
1346
+ * Retrieve the `authurl` from the response.
1347
+ * ##### Step 2: Obtain the token
1348
+ * Protocol: HTTPS + application/json
1349
+ * Method: GET
1350
+ * URL: The authurl from Step 1, with /api appended.
1351
+ * Request URL example: `https://enrichgw.10010.com/d93222629f52ec79/api`
1352
+ * ###### Request parameters
1353
+ * Request examples:
1354
+ * JSON request: `?appid=1554778161153`
1355
+ * JSONP request: `?appid=1554778161153&callback=callbackFunction`
1356
+ * Parameter description:
1357
+ * - `appid`: Use 1554778161153.
1358
+ * - `callback`: The name of the JSONP callback function. This parameter is required only for JSONP requests.
1359
+ * ###### Response parameters
1360
+ * Response examples:
1361
+ * JSON response:
1362
+ * `{ "province": "1", "code": "7nHS1nggx2WP613750206700RN6oiRN1" }`
1363
+ * JSONP response:
1364
+ * `callbackFunction({"province":"1","code":"7nHS3Dnkd1BS701851092400RN6oiRN1"})`
1365
+ * Retrieve the `code` from the response.
1366
+ * #### China Telecom (CT)
1367
+ * Protocol: HTTPS + application/x-www-form-urlencoded;charset=UTF-8
1368
+ * Method: GET
1369
+ * URL: https\\://id6.me/gw/preuniq.do
1370
+ * ##### Request parameters
1371
+ * Request example:
1372
+ * `?clientType=30100&appId=9390188202&format=json&sign=D63C166FA19E1996EF********09C6A5397C10B4&paramKey=1D7C25EB8B0B8B4CB3CF8DC60628F6549********786B0AF1FEF93FA1335057A35BF5F0B39A3867EAA9BE14B3898********8B01DE34965060445B6E1F66401D714650E4AB161CD6DCF4A72********3B856F22A192B8B0C39D7A55B961062E68C89C928894F119B25********7C548355FE9DB82852EB93C939F2200B48CD17&paramStr=140********95AF8E138B94754CB4CF83BA6FB********52B258BFDFD38BF233&version=1.1`
1373
+ * Parameter description:
1374
+ * - `appId`: Use `9390188202`.
1375
+ * - `clientType`: The client type. This value must match the `ClientType` input parameter for this API.
1376
+ * - `format`: Use `json` or `jsonp`.
1377
+ * - `version`: Use `1.1`.
1378
+ * - `sign`: Obtained by calling this API.
1379
+ * - `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).
1380
+ * - `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`.
1381
+ * ##### Response parameters
1382
+ * Response example:
1383
+ * `callback?result=10000&msg=success&data=a35336711c70456cb883f4f224e9a259`
1384
+ * 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`.
1385
+ * Decrypted business result example:
1386
+ * `{"accessCode": "H5HTTPS4187AE9743AFCB14F8D99B9D65ED9E01"}`
1387
+ * Retrieve the `accessCode` from the decrypted result.
1219
1388
  *
1220
1389
  * @param request - GetUAIDApplyTokenSignRequest
1221
1390
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1274,7 +1443,97 @@ class Client extends openapi_core_1.default {
1274
1443
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.GetUAIDApplyTokenSignResponse({}));
1275
1444
  }
1276
1445
  /**
1277
- * 获取UAID申请Token所需的签名字段
1446
+ * This API only provides the signing functionality for acquiring an authorization token during UAID retrieval from the three-network operators.
1447
+ *
1448
+ * @remarks
1449
+ * 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.
1450
+ * - To generate the other parameters required to obtain the authorization token, refer to the respective operator\\"s documentation.
1451
+ * - 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.
1452
+ * - After obtaining the authorization token, call the [UAIDVerification](~~UAIDVerification~~) API to complete the UAID retrieval.
1453
+ * ### How to request an authorization token
1454
+ * >Notice:
1455
+ * When you request an authorization token, the client or H5 page must be connected to a cellular network.
1456
+ * #### China Mobile (CM)
1457
+ * Protocol: HTTPS + application/json
1458
+ * Method: POST
1459
+ * URL: https\\://msg.cmpassport.com/h5/getMobile
1460
+ * ##### Request parameters
1461
+ * Request example:
1462
+ * `{ "traceId": "mfawsxtcmyplwzpayzzvdvbsowxmkynr", "appId": "300011580392", "sign": "2c61b3c58ffbeed97461e31be4fd931a", "msgId": "redbyxsdetddwaaffajcwwapspykftzx", "expandParams": "", "businessType": "3", "version": "1.0", "timestamp": "20201125101540980" }`
1463
+ * Parameter description:
1464
+ * - `version`: Use `1.0`.
1465
+ * - `timestamp`: The request timestamp, with millisecond precision. This value and its format must match the `Time` input parameter for this API.
1466
+ * - `appId`: Use `300011580392`.
1467
+ * - `businessType`: Use `3`.
1468
+ * - `traceId`: The trace ID. This value must match this API\\"s `OutId` input parameter.
1469
+ * - `sign`: Obtained by calling this API.
1470
+ * - `msgId`: A unique message identifier.
1471
+ * ##### Response parameters
1472
+ * Response example:
1473
+ * `{ "header": { "appId": "300011580392", "msgId": "redbyxsdetddwaaffajcwwapspykftzx", "timestamp": "20201125101607932" }, "body": { "resultCode": "103000", "expandParams": "", "resultDesc": "成功", "token": "H5HTTPS4187AE9743AFCB14F8D99B9D65ED9E01" } }`
1474
+ * Retrieve the `token` from the response `body`.
1475
+ * #### China Unicom (CU)
1476
+ * Obtain the token in two steps.
1477
+ * ##### Step 1: Obtain the authurl
1478
+ * Send a request to the portal server to get the authentication server address (`authurl`).
1479
+ * Protocol: HTTPS + application/json
1480
+ * Method: GET
1481
+ * URL: https\\://nisportal.10010.com:9001/api
1482
+ * ###### Request parameters
1483
+ * Request examples:
1484
+ * JSON request: `?appid=1554778161153`
1485
+ * JSONP request: `?appid=1554778161153&callback=callbackFunction`
1486
+ * Parameter description:
1487
+ * - `appid`: Use 1554778161153.
1488
+ * - `callback`: The name of the JSONP callback function. This parameter is required only for JSONP requests.
1489
+ * ###### Response parameters
1490
+ * Response examples:
1491
+ * JSON response:
1492
+ * `{"authurl": "https://enrichgw.10010.com/d93222629f52ec79"}`
1493
+ * JSONP response:
1494
+ * `callbackFunction({"authurl":"https://enrichgw.10010.com/d93222629f52ec79"})`
1495
+ * Retrieve the `authurl` from the response.
1496
+ * ##### Step 2: Obtain the token
1497
+ * Protocol: HTTPS + application/json
1498
+ * Method: GET
1499
+ * URL: The authurl from Step 1, with /api appended.
1500
+ * Request URL example: `https://enrichgw.10010.com/d93222629f52ec79/api`
1501
+ * ###### Request parameters
1502
+ * Request examples:
1503
+ * JSON request: `?appid=1554778161153`
1504
+ * JSONP request: `?appid=1554778161153&callback=callbackFunction`
1505
+ * Parameter description:
1506
+ * - `appid`: Use 1554778161153.
1507
+ * - `callback`: The name of the JSONP callback function. This parameter is required only for JSONP requests.
1508
+ * ###### Response parameters
1509
+ * Response examples:
1510
+ * JSON response:
1511
+ * `{ "province": "1", "code": "7nHS1nggx2WP613750206700RN6oiRN1" }`
1512
+ * JSONP response:
1513
+ * `callbackFunction({"province":"1","code":"7nHS3Dnkd1BS701851092400RN6oiRN1"})`
1514
+ * Retrieve the `code` from the response.
1515
+ * #### China Telecom (CT)
1516
+ * Protocol: HTTPS + application/x-www-form-urlencoded;charset=UTF-8
1517
+ * Method: GET
1518
+ * URL: https\\://id6.me/gw/preuniq.do
1519
+ * ##### Request parameters
1520
+ * Request example:
1521
+ * `?clientType=30100&appId=9390188202&format=json&sign=D63C166FA19E1996EF********09C6A5397C10B4&paramKey=1D7C25EB8B0B8B4CB3CF8DC60628F6549********786B0AF1FEF93FA1335057A35BF5F0B39A3867EAA9BE14B3898********8B01DE34965060445B6E1F66401D714650E4AB161CD6DCF4A72********3B856F22A192B8B0C39D7A55B961062E68C89C928894F119B25********7C548355FE9DB82852EB93C939F2200B48CD17&paramStr=140********95AF8E138B94754CB4CF83BA6FB********52B258BFDFD38BF233&version=1.1`
1522
+ * Parameter description:
1523
+ * - `appId`: Use `9390188202`.
1524
+ * - `clientType`: The client type. This value must match the `ClientType` input parameter for this API.
1525
+ * - `format`: Use `json` or `jsonp`.
1526
+ * - `version`: Use `1.1`.
1527
+ * - `sign`: Obtained by calling this API.
1528
+ * - `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).
1529
+ * - `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`.
1530
+ * ##### Response parameters
1531
+ * Response example:
1532
+ * `callback?result=10000&msg=success&data=a35336711c70456cb883f4f224e9a259`
1533
+ * 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`.
1534
+ * Decrypted business result example:
1535
+ * `{"accessCode": "H5HTTPS4187AE9743AFCB14F8D99B9D65ED9E01"}`
1536
+ * Retrieve the `accessCode` from the decrypted result.
1278
1537
  *
1279
1538
  * @param request - GetUAIDApplyTokenSignRequest
1280
1539
  * @returns GetUAIDApplyTokenSignResponse
@@ -1353,12 +1612,89 @@ class Client extends openapi_core_1.default {
1353
1612
  return await this.getUAIDConversionSignWithOptions(request, runtime);
1354
1613
  }
1355
1614
  /**
1356
- * Filters invalid phone numbers.
1615
+ * Verifies whether a name, phone number, and ID number belonged to the same user at a specific point in time.
1616
+ *
1617
+ * @remarks
1618
+ * ## Usage notes
1619
+ * - Before you use this API, ensure you understand its [pricing](https://help.aliyun.com/zh/cpns/product-overview/pricing-of-cpns).
1620
+ * - 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.
1621
+ * - You are charged for a call only when the response returns `Code=\\"OK\\"` and `IsConsistent != 0`. No charges are incurred for any other results.
1622
+ * - 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.
1623
+ * - 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.
1624
+ * - The queries per second (QPS) limit per user is 200. Requests that exceed this limit are throttled.
1625
+ * - In the authorization information, the action is `dytns:HistoryThreeElementsVerification`, the access level is Read, and the resource type is All Resources.
1626
+ *
1627
+ * @param request - HistoryThreeElementsVerificationRequest
1628
+ * @param runtime - runtime options for this request RuntimeOptions
1629
+ * @returns HistoryThreeElementsVerificationResponse
1630
+ */
1631
+ async historyThreeElementsVerificationWithOptions(request, runtime) {
1632
+ request.validate();
1633
+ let query = {};
1634
+ if (!$dara.isNull(request.authCode)) {
1635
+ query["AuthCode"] = request.authCode;
1636
+ }
1637
+ if (!$dara.isNull(request.carrier)) {
1638
+ query["Carrier"] = request.carrier;
1639
+ }
1640
+ if (!$dara.isNull(request.certCode)) {
1641
+ query["CertCode"] = request.certCode;
1642
+ }
1643
+ if (!$dara.isNull(request.inputNumber)) {
1644
+ query["InputNumber"] = request.inputNumber;
1645
+ }
1646
+ if (!$dara.isNull(request.mask)) {
1647
+ query["Mask"] = request.mask;
1648
+ }
1649
+ if (!$dara.isNull(request.name)) {
1650
+ query["Name"] = request.name;
1651
+ }
1652
+ if (!$dara.isNull(request.verificationTime)) {
1653
+ query["VerificationTime"] = request.verificationTime;
1654
+ }
1655
+ let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
1656
+ query: openapi_core_2.OpenApiUtil.query(query),
1657
+ });
1658
+ let params = new openapi_core_2.$OpenApiUtil.Params({
1659
+ action: "HistoryThreeElementsVerification",
1660
+ version: "2020-02-17",
1661
+ protocol: "HTTPS",
1662
+ pathname: "/",
1663
+ method: "POST",
1664
+ authType: "AK",
1665
+ style: "RPC",
1666
+ reqBodyType: "formData",
1667
+ bodyType: "json",
1668
+ });
1669
+ return $dara.cast(await this.callApi(params, req, runtime), new $_model.HistoryThreeElementsVerificationResponse({}));
1670
+ }
1671
+ /**
1672
+ * Verifies whether a name, phone number, and ID number belonged to the same user at a specific point in time.
1673
+ *
1674
+ * @remarks
1675
+ * ## Usage notes
1676
+ * - Before you use this API, ensure you understand its [pricing](https://help.aliyun.com/zh/cpns/product-overview/pricing-of-cpns).
1677
+ * - 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.
1678
+ * - You are charged for a call only when the response returns `Code=\\"OK\\"` and `IsConsistent != 0`. No charges are incurred for any other results.
1679
+ * - 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.
1680
+ * - 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.
1681
+ * - The queries per second (QPS) limit per user is 200. Requests that exceed this limit are throttled.
1682
+ * - In the authorization information, the action is `dytns:HistoryThreeElementsVerification`, the access level is Read, and the resource type is All Resources.
1683
+ *
1684
+ * @param request - HistoryThreeElementsVerificationRequest
1685
+ * @returns HistoryThreeElementsVerificationResponse
1686
+ */
1687
+ async historyThreeElementsVerification(request) {
1688
+ let runtime = new $dara.RuntimeOptions({});
1689
+ return await this.historyThreeElementsVerificationWithOptions(request, runtime);
1690
+ }
1691
+ /**
1692
+ * Performs invalid phone number filtering operations.
1357
1693
  *
1358
1694
  * @remarks
1359
- * 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.
1360
- * ### [](#qps)QPS limits
1361
- * 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.
1695
+ * 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.
1696
+ * ### QPS limit
1697
+ * 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.
1362
1698
  *
1363
1699
  * @param request - InvalidPhoneNumberFilterRequest
1364
1700
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1402,12 +1738,12 @@ class Client extends openapi_core_1.default {
1402
1738
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.InvalidPhoneNumberFilterResponse({}));
1403
1739
  }
1404
1740
  /**
1405
- * Filters invalid phone numbers.
1741
+ * Performs invalid phone number filtering operations.
1406
1742
  *
1407
1743
  * @remarks
1408
- * 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.
1409
- * ### [](#qps)QPS limits
1410
- * 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.
1744
+ * 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.
1745
+ * ### QPS limit
1746
+ * 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.
1411
1747
  *
1412
1748
  * @param request - InvalidPhoneNumberFilterRequest
1413
1749
  * @returns InvalidPhoneNumberFilterResponse
@@ -1417,7 +1753,10 @@ class Client extends openapi_core_1.default {
1417
1753
  return await this.invalidPhoneNumberFilterWithOptions(request, runtime);
1418
1754
  }
1419
1755
  /**
1420
- * 预警联系人查询
1756
+ * Lists the alert contacts for Number Encyclopedia.
1757
+ *
1758
+ * @remarks
1759
+ * - Before using this API, ensure that you have activated Number Encyclopedia.
1421
1760
  *
1422
1761
  * @param request - ListContactsRequest
1423
1762
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1458,7 +1797,10 @@ class Client extends openapi_core_1.default {
1458
1797
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.ListContactsResponse({}));
1459
1798
  }
1460
1799
  /**
1461
- * 预警联系人查询
1800
+ * Lists the alert contacts for Number Encyclopedia.
1801
+ *
1802
+ * @remarks
1803
+ * - Before using this API, ensure that you have activated Number Encyclopedia.
1462
1804
  *
1463
1805
  * @param request - ListContactsRequest
1464
1806
  * @returns ListContactsResponse
@@ -1518,12 +1860,12 @@ class Client extends openapi_core_1.default {
1518
1860
  return await this.phoneNumberConvertServiceWithOptions(request, runtime);
1519
1861
  }
1520
1862
  /**
1521
- * 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.
1863
+ * 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.
1522
1864
  *
1523
1865
  * @remarks
1524
- * 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.
1525
- * ### [](#qps)QPS limits
1526
- * 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.
1866
+ * 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.
1867
+ * ### QPS limit
1868
+ * 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.
1527
1869
  *
1528
1870
  * @param request - PhoneNumberEncryptRequest
1529
1871
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1570,12 +1912,12 @@ class Client extends openapi_core_1.default {
1570
1912
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.PhoneNumberEncryptResponse({}));
1571
1913
  }
1572
1914
  /**
1573
- * 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.
1915
+ * 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.
1574
1916
  *
1575
1917
  * @remarks
1576
- * 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.
1577
- * ### [](#qps)QPS limits
1578
- * 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.
1918
+ * 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.
1919
+ * ### QPS limit
1920
+ * 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.
1579
1921
  *
1580
1922
  * @param request - PhoneNumberEncryptRequest
1581
1923
  * @returns PhoneNumberEncryptResponse
@@ -1585,14 +1927,15 @@ class Client extends openapi_core_1.default {
1585
1927
  return await this.phoneNumberEncryptWithOptions(request, runtime);
1586
1928
  }
1587
1929
  /**
1588
- * 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.
1930
+ * 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.
1589
1931
  *
1590
1932
  * @remarks
1591
- * 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.
1592
- * * 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).
1593
- * * 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.
1594
- * ### [](#qps)QPS limits
1595
- * 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.
1933
+ * - **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.**
1934
+ * - 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).
1935
+ * - 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.
1936
+ * - 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.
1937
+ * ### QPS limit
1938
+ * 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.
1596
1939
  *
1597
1940
  * @param request - PhoneNumberStatusForAccountRequest
1598
1941
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1636,14 +1979,15 @@ class Client extends openapi_core_1.default {
1636
1979
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.PhoneNumberStatusForAccountResponse({}));
1637
1980
  }
1638
1981
  /**
1639
- * 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.
1982
+ * 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.
1640
1983
  *
1641
1984
  * @remarks
1642
- * 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.
1643
- * * 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).
1644
- * * 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.
1645
- * ### [](#qps)QPS limits
1646
- * 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.
1985
+ * - **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.**
1986
+ * - 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).
1987
+ * - 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.
1988
+ * - 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.
1989
+ * ### QPS limit
1990
+ * 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.
1647
1991
  *
1648
1992
  * @param request - PhoneNumberStatusForAccountRequest
1649
1993
  * @returns PhoneNumberStatusForAccountResponse
@@ -1653,14 +1997,15 @@ class Client extends openapi_core_1.default {
1653
1997
  return await this.phoneNumberStatusForAccountWithOptions(request, runtime);
1654
1998
  }
1655
1999
  /**
1656
- * 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.
2000
+ * 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.
1657
2001
  *
1658
2002
  * @remarks
1659
- * 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.
1660
- * * 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).
1661
- * * 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.
1662
- * ### [](#qps)QPS limits
1663
- * 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.
2003
+ * - **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.**
2004
+ * - 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).
2005
+ * - 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.
2006
+ * - 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.
2007
+ * ### QPS limit
2008
+ * 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.
1664
2009
  *
1665
2010
  * @param request - PhoneNumberStatusForPublicRequest
1666
2011
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1704,14 +2049,15 @@ class Client extends openapi_core_1.default {
1704
2049
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.PhoneNumberStatusForPublicResponse({}));
1705
2050
  }
1706
2051
  /**
1707
- * 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.
2052
+ * 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.
1708
2053
  *
1709
2054
  * @remarks
1710
- * 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.
1711
- * * 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).
1712
- * * 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.
1713
- * ### [](#qps)QPS limits
1714
- * 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.
2055
+ * - **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.**
2056
+ * - 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).
2057
+ * - 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.
2058
+ * - 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.
2059
+ * ### QPS limit
2060
+ * 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.
1715
2061
  *
1716
2062
  * @param request - PhoneNumberStatusForPublicRequest
1717
2063
  * @returns PhoneNumberStatusForPublicResponse
@@ -1721,14 +2067,15 @@ class Client extends openapi_core_1.default {
1721
2067
  return await this.phoneNumberStatusForPublicWithOptions(request, runtime);
1722
2068
  }
1723
2069
  /**
1724
- * 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.
2070
+ * 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.
1725
2071
  *
1726
2072
  * @remarks
1727
- * 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.
1728
- * * 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).
1729
- * * 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.
1730
- * ### [](#qps)QPS limits
1731
- * 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.
2073
+ * - **Before calling this operation, ensure you fully understand the [pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Intelligence.**
2074
+ * - 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).
2075
+ * - 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.
2076
+ * - 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.
2077
+ * ### QPS limit
2078
+ * 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.
1732
2079
  *
1733
2080
  * @param request - PhoneNumberStatusForRealRequest
1734
2081
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1772,14 +2119,15 @@ class Client extends openapi_core_1.default {
1772
2119
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.PhoneNumberStatusForRealResponse({}));
1773
2120
  }
1774
2121
  /**
1775
- * 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.
2122
+ * 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.
1776
2123
  *
1777
2124
  * @remarks
1778
- * 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.
1779
- * * 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).
1780
- * * 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.
1781
- * ### [](#qps)QPS limits
1782
- * 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.
2125
+ * - **Before calling this operation, ensure you fully understand the [pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Intelligence.**
2126
+ * - 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).
2127
+ * - 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.
2128
+ * - 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.
2129
+ * ### QPS limit
2130
+ * 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.
1783
2131
  *
1784
2132
  * @param request - PhoneNumberStatusForRealRequest
1785
2133
  * @returns PhoneNumberStatusForRealResponse
@@ -1789,14 +2137,15 @@ class Client extends openapi_core_1.default {
1789
2137
  return await this.phoneNumberStatusForRealWithOptions(request, runtime);
1790
2138
  }
1791
2139
  /**
1792
- * 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.
2140
+ * 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.
1793
2141
  *
1794
2142
  * @remarks
1795
- * 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.
1796
- * * 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).
1797
- * * 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.
1798
- * ### [](#qps)QPS limits
1799
- * 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.
2143
+ * - **Before you call this operation, make sure you understand the [Product Pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Pedia**.
2144
+ * - 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).
2145
+ * - 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.
2146
+ * - 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.
2147
+ * ### QPS limit
2148
+ * 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.
1800
2149
  *
1801
2150
  * @param request - PhoneNumberStatusForSmsRequest
1802
2151
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1840,14 +2189,15 @@ class Client extends openapi_core_1.default {
1840
2189
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.PhoneNumberStatusForSmsResponse({}));
1841
2190
  }
1842
2191
  /**
1843
- * 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.
2192
+ * 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.
1844
2193
  *
1845
2194
  * @remarks
1846
- * 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.
1847
- * * 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).
1848
- * * 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.
1849
- * ### [](#qps)QPS limits
1850
- * 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.
2195
+ * - **Before you call this operation, make sure you understand the [Product Pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Pedia**.
2196
+ * - 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).
2197
+ * - 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.
2198
+ * - 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.
2199
+ * ### QPS limit
2200
+ * 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.
1851
2201
  *
1852
2202
  * @param request - PhoneNumberStatusForSmsRequest
1853
2203
  * @returns PhoneNumberStatusForSmsResponse
@@ -1857,14 +2207,15 @@ class Client extends openapi_core_1.default {
1857
2207
  return await this.phoneNumberStatusForSmsWithOptions(request, runtime);
1858
2208
  }
1859
2209
  /**
1860
- * 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.
2210
+ * 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.
1861
2211
  *
1862
2212
  * @remarks
1863
- * 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.
1864
- * * 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).
1865
- * * 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.
1866
- * ### [](#qps)QPS limits
1867
- * 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.
2213
+ * - **Before you use this API, make sure that you understand the [pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Encyclopedia**.
2214
+ * - 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).
2215
+ * - 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.
2216
+ * - 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.
2217
+ * ### QPS limit
2218
+ * 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.
1868
2219
  *
1869
2220
  * @param request - PhoneNumberStatusForVoiceRequest
1870
2221
  * @param runtime - runtime options for this request RuntimeOptions
@@ -1908,14 +2259,15 @@ class Client extends openapi_core_1.default {
1908
2259
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.PhoneNumberStatusForVoiceResponse({}));
1909
2260
  }
1910
2261
  /**
1911
- * 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.
2262
+ * 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.
1912
2263
  *
1913
2264
  * @remarks
1914
- * 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.
1915
- * * 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).
1916
- * * 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.
1917
- * ### [](#qps)QPS limits
1918
- * 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.
2265
+ * - **Before you use this API, make sure that you understand the [pricing](https://help.aliyun.com/document_detail/154751.html) of Phone Number Encyclopedia**.
2266
+ * - 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).
2267
+ * - 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.
2268
+ * - 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.
2269
+ * ### QPS limit
2270
+ * 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.
1919
2271
  *
1920
2272
  * @param request - PhoneNumberStatusForVoiceRequest
1921
2273
  * @returns PhoneNumberStatusForVoiceResponse
@@ -1973,7 +2325,7 @@ class Client extends openapi_core_1.default {
1973
2325
  return await this.queryAvailableAuthCodeWithOptions(request, runtime);
1974
2326
  }
1975
2327
  /**
1976
- * 套餐包类型信息查询
2328
+ * Queries package type information.
1977
2329
  *
1978
2330
  * @param request - QueryPackageTypeInfoRequest
1979
2331
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2011,7 +2363,7 @@ class Client extends openapi_core_1.default {
2011
2363
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.QueryPackageTypeInfoResponse({}));
2012
2364
  }
2013
2365
  /**
2014
- * 套餐包类型信息查询
2366
+ * Queries package type information.
2015
2367
  *
2016
2368
  * @param request - QueryPackageTypeInfoRequest
2017
2369
  * @returns QueryPackageTypeInfoResponse
@@ -2180,7 +2532,7 @@ class Client extends openapi_core_1.default {
2180
2532
  return await this.queryTagApplyRuleWithOptions(request, runtime);
2181
2533
  }
2182
2534
  /**
2183
- * Queries information about tags.
2535
+ * Queries tag information.
2184
2536
  *
2185
2537
  * @param request - QueryTagInfoBySelectionRequest
2186
2538
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2224,7 +2576,7 @@ class Client extends openapi_core_1.default {
2224
2576
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.QueryTagInfoBySelectionResponse({}));
2225
2577
  }
2226
2578
  /**
2227
- * Queries information about tags.
2579
+ * Queries tag information.
2228
2580
  *
2229
2581
  * @param request - QueryTagInfoBySelectionRequest
2230
2582
  * @returns QueryTagInfoBySelectionResponse
@@ -2234,7 +2586,7 @@ class Client extends openapi_core_1.default {
2234
2586
  return await this.queryTagInfoBySelectionWithOptions(request, runtime);
2235
2587
  }
2236
2588
  /**
2237
- * Queries a list of tags by page.
2589
+ * Queries the tag list by page.
2238
2590
  *
2239
2591
  * @param request - QueryTagListPageRequest
2240
2592
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2275,7 +2627,7 @@ class Client extends openapi_core_1.default {
2275
2627
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.QueryTagListPageResponse({}));
2276
2628
  }
2277
2629
  /**
2278
- * Queries a list of tags by page.
2630
+ * Queries the tag list by page.
2279
2631
  *
2280
2632
  * @param request - QueryTagListPageRequest
2281
2633
  * @returns QueryTagListPageResponse
@@ -2285,7 +2637,7 @@ class Client extends openapi_core_1.default {
2285
2637
  return await this.queryTagListPageWithOptions(request, runtime);
2286
2638
  }
2287
2639
  /**
2288
- * 查询离线任务列表
2640
+ * Queries a list of offline tasks.
2289
2641
  *
2290
2642
  * @param tmpReq - QueryTaskListRequest
2291
2643
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2349,7 +2701,7 @@ class Client extends openapi_core_1.default {
2349
2701
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.QueryTaskListResponse({}));
2350
2702
  }
2351
2703
  /**
2352
- * 查询离线任务列表
2704
+ * Queries a list of offline tasks.
2353
2705
  *
2354
2706
  * @param request - QueryTaskListRequest
2355
2707
  * @returns QueryTaskListResponse
@@ -2359,7 +2711,7 @@ class Client extends openapi_core_1.default {
2359
2711
  return await this.queryTaskListWithOptions(request, runtime);
2360
2712
  }
2361
2713
  /**
2362
- * Queries the usage statistics based on tag IDs.
2714
+ * Queries usage statistics by tag ID.
2363
2715
  *
2364
2716
  * @param request - QueryUsageStatisticsByTagIdRequest
2365
2717
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2409,7 +2761,7 @@ class Client extends openapi_core_1.default {
2409
2761
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.QueryUsageStatisticsByTagIdResponse({}));
2410
2762
  }
2411
2763
  /**
2412
- * Queries the usage statistics based on tag IDs.
2764
+ * Queries usage statistics by tag ID.
2413
2765
  *
2414
2766
  * @param request - QueryUsageStatisticsByTagIdRequest
2415
2767
  * @returns QueryUsageStatisticsByTagIdResponse
@@ -2419,7 +2771,10 @@ class Client extends openapi_core_1.default {
2419
2771
  return await this.queryUsageStatisticsByTagIdWithOptions(request, runtime);
2420
2772
  }
2421
2773
  /**
2422
- * 预警联系人保存
2774
+ * Saves an alert contact.
2775
+ *
2776
+ * @remarks
2777
+ * - Before you call this operation, ensure you have activated Phone Number Intelligence.
2423
2778
  *
2424
2779
  * @param request - SaveContactsRequest
2425
2780
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2478,7 +2833,10 @@ class Client extends openapi_core_1.default {
2478
2833
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.SaveContactsResponse({}));
2479
2834
  }
2480
2835
  /**
2481
- * 预警联系人保存
2836
+ * Saves an alert contact.
2837
+ *
2838
+ * @remarks
2839
+ * - Before you call this operation, ensure you have activated Phone Number Intelligence.
2482
2840
  *
2483
2841
  * @param request - SaveContactsRequest
2484
2842
  * @returns SaveContactsResponse
@@ -2488,14 +2846,15 @@ class Client extends openapi_core_1.default {
2488
2846
  return await this.saveContactsWithOptions(request, runtime);
2489
2847
  }
2490
2848
  /**
2491
- * Verifies whether the name, phone number, and ID card number entered by a user belong to the same user.
2849
+ * 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.
2492
2850
  *
2493
2851
  * @remarks
2494
- * 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.
2495
- * * 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.
2496
- * * You are charged only if the value of Code is OK and the value of IsConsistent is not 2.
2497
- * ### [](#qps)QPS limits
2498
- * 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.
2852
+ * - 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.
2853
+ * - 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.
2854
+ * - Billing applies when the API returns Code=\\"OK\\" and IsConsistent != 2. Other return results are not billed.
2855
+ * - The verification of virtual carrier numbers is not supported. Virtual carrier numbers refer to numbers that start with 170, 171, 162, or 165.
2856
+ * ### QPS limit
2857
+ * 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.
2499
2858
  *
2500
2859
  * @param request - ThreeElementsVerificationRequest
2501
2860
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2545,14 +2904,15 @@ class Client extends openapi_core_1.default {
2545
2904
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.ThreeElementsVerificationResponse({}));
2546
2905
  }
2547
2906
  /**
2548
- * Verifies whether the name, phone number, and ID card number entered by a user belong to the same user.
2907
+ * 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.
2549
2908
  *
2550
2909
  * @remarks
2551
- * 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.
2552
- * * 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.
2553
- * * You are charged only if the value of Code is OK and the value of IsConsistent is not 2.
2554
- * ### [](#qps)QPS limits
2555
- * 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.
2910
+ * - 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.
2911
+ * - 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.
2912
+ * - Billing applies when the API returns Code=\\"OK\\" and IsConsistent != 2. Other return results are not billed.
2913
+ * - The verification of virtual carrier numbers is not supported. Virtual carrier numbers refer to numbers that start with 170, 171, 162, or 165.
2914
+ * ### QPS limit
2915
+ * 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.
2556
2916
  *
2557
2917
  * @param request - ThreeElementsVerificationRequest
2558
2918
  * @returns ThreeElementsVerificationResponse
@@ -2562,14 +2922,15 @@ class Client extends openapi_core_1.default {
2562
2922
  return await this.threeElementsVerificationWithOptions(request, runtime);
2563
2923
  }
2564
2924
  /**
2565
- * Verifies whether the name and phone number entered by a user belong to the same user.
2925
+ * 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.
2566
2926
  *
2567
2927
  * @remarks
2568
- * 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.
2569
- * * 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.
2570
- * * You are charged only if the value of Code is OK and the value of IsConsistent is not 2.
2571
- * ### [](#qps)QPS limits
2572
- * 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.
2928
+ * - 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.
2929
+ * - 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.
2930
+ * - Billing is applied when the API returns Code="OK" and IsConsistent != 2. Other return results are not billed.
2931
+ * - MVNO number verification is not supported. MVNO numbers refer to numbers starting with 170, 171, 162, and 165.
2932
+ * ### QPS limit
2933
+ * 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.
2573
2934
  *
2574
2935
  * @param request - TwoElementsVerificationRequest
2575
2936
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2616,14 +2977,15 @@ class Client extends openapi_core_1.default {
2616
2977
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.TwoElementsVerificationResponse({}));
2617
2978
  }
2618
2979
  /**
2619
- * Verifies whether the name and phone number entered by a user belong to the same user.
2980
+ * 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.
2620
2981
  *
2621
2982
  * @remarks
2622
- * 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.
2623
- * * 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.
2624
- * * You are charged only if the value of Code is OK and the value of IsConsistent is not 2.
2625
- * ### [](#qps)QPS limits
2626
- * 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.
2983
+ * - 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.
2984
+ * - 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.
2985
+ * - Billing is applied when the API returns Code="OK" and IsConsistent != 2. Other return results are not billed.
2986
+ * - MVNO number verification is not supported. MVNO numbers refer to numbers starting with 170, 171, 162, and 165.
2987
+ * ### QPS limit
2988
+ * 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.
2627
2989
  *
2628
2990
  * @param request - TwoElementsVerificationRequest
2629
2991
  * @returns TwoElementsVerificationResponse
@@ -2756,7 +3118,14 @@ class Client extends openapi_core_1.default {
2756
3118
  return await this.uAIDConversionWithOptions(request, runtime);
2757
3119
  }
2758
3120
  /**
2759
- * 获取UAID
3121
+ * Obtains a UAID based on the carrier authorization token.
3122
+ * For information about how to obtain the authorization token and its signature, see the GetUAIDApplyTokenSign API documentation.
3123
+ * 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.
3124
+ *
3125
+ * @remarks
3126
+ * 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.
3127
+ * Obtains a UAID based on the carrier authorization token.
3128
+ * For information about how to obtain the authorization token and its signature, see the GetUAIDApplyTokenSign API documentation.
2760
3129
  *
2761
3130
  * @param request - UAIDVerificationRequest
2762
3131
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2812,7 +3181,14 @@ class Client extends openapi_core_1.default {
2812
3181
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.UAIDVerificationResponse({}));
2813
3182
  }
2814
3183
  /**
2815
- * 获取UAID
3184
+ * Obtains a UAID based on the carrier authorization token.
3185
+ * For information about how to obtain the authorization token and its signature, see the GetUAIDApplyTokenSign API documentation.
3186
+ * 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.
3187
+ *
3188
+ * @remarks
3189
+ * 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.
3190
+ * Obtains a UAID based on the carrier authorization token.
3191
+ * For information about how to obtain the authorization token and its signature, see the GetUAIDApplyTokenSign API documentation.
2816
3192
  *
2817
3193
  * @param request - UAIDVerificationRequest
2818
3194
  * @returns UAIDVerificationResponse
@@ -2822,7 +3198,10 @@ class Client extends openapi_core_1.default {
2822
3198
  return await this.uAIDVerificationWithOptions(request, runtime);
2823
3199
  }
2824
3200
  /**
2825
- * 预警联系人更新
3201
+ * Updates an alert contact.
3202
+ *
3203
+ * @remarks
3204
+ * - Ensure that you have activated the Phone Number Information Service before calling this operation.
2826
3205
  *
2827
3206
  * @param request - UpdateContactsRequest
2828
3207
  * @param runtime - runtime options for this request RuntimeOptions
@@ -2881,7 +3260,10 @@ class Client extends openapi_core_1.default {
2881
3260
  return $dara.cast(await this.callApi(params, req, runtime), new $_model.UpdateContactsResponse({}));
2882
3261
  }
2883
3262
  /**
2884
- * 预警联系人更新
3263
+ * Updates an alert contact.
3264
+ *
3265
+ * @remarks
3266
+ * - Ensure that you have activated the Phone Number Information Service before calling this operation.
2885
3267
  *
2886
3268
  * @param request - UpdateContactsRequest
2887
3269
  * @returns UpdateContactsResponse
@@ -2890,6 +3272,57 @@ class Client extends openapi_core_1.default {
2890
3272
  let runtime = new $dara.RuntimeOptions({});
2891
3273
  return await this.updateContactsWithOptions(request, runtime);
2892
3274
  }
3275
+ /**
3276
+ * 虚商三要素
3277
+ *
3278
+ * @param request - VirtualThreeElementsVerificationRequest
3279
+ * @param runtime - runtime options for this request RuntimeOptions
3280
+ * @returns VirtualThreeElementsVerificationResponse
3281
+ */
3282
+ async virtualThreeElementsVerificationWithOptions(request, runtime) {
3283
+ request.validate();
3284
+ let query = {};
3285
+ if (!$dara.isNull(request.authCode)) {
3286
+ query["AuthCode"] = request.authCode;
3287
+ }
3288
+ if (!$dara.isNull(request.certCode)) {
3289
+ query["CertCode"] = request.certCode;
3290
+ }
3291
+ if (!$dara.isNull(request.certName)) {
3292
+ query["CertName"] = request.certName;
3293
+ }
3294
+ if (!$dara.isNull(request.inputNumber)) {
3295
+ query["InputNumber"] = request.inputNumber;
3296
+ }
3297
+ if (!$dara.isNull(request.mask)) {
3298
+ query["Mask"] = request.mask;
3299
+ }
3300
+ let req = new openapi_core_2.$OpenApiUtil.OpenApiRequest({
3301
+ query: openapi_core_2.OpenApiUtil.query(query),
3302
+ });
3303
+ let params = new openapi_core_2.$OpenApiUtil.Params({
3304
+ action: "VirtualThreeElementsVerification",
3305
+ version: "2020-02-17",
3306
+ protocol: "HTTPS",
3307
+ pathname: "/",
3308
+ method: "POST",
3309
+ authType: "AK",
3310
+ style: "RPC",
3311
+ reqBodyType: "formData",
3312
+ bodyType: "json",
3313
+ });
3314
+ return $dara.cast(await this.callApi(params, req, runtime), new $_model.VirtualThreeElementsVerificationResponse({}));
3315
+ }
3316
+ /**
3317
+ * 虚商三要素
3318
+ *
3319
+ * @param request - VirtualThreeElementsVerificationRequest
3320
+ * @returns VirtualThreeElementsVerificationResponse
3321
+ */
3322
+ async virtualThreeElementsVerification(request) {
3323
+ let runtime = new $dara.RuntimeOptions({});
3324
+ return await this.virtualThreeElementsVerificationWithOptions(request, runtime);
3325
+ }
2893
3326
  }
2894
3327
  exports.default = Client;
2895
3328
  //# sourceMappingURL=client.js.map