@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
@@ -5,15 +5,17 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class PhoneNumberStatusForPublicResponseBodyData extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The basic carrier who assigns the phone number. If the queried phone number involves mobile number portability, the carrier after mobile number portability is returned.
8
+ * The basic carrier of the number. If the number has been ported, this parameter returns the current carrier.
9
9
  *
10
10
  * Valid values:
11
11
  *
12
- * * **CMCC**: China Mobile
13
- * * **CUCC**: China Unicom
14
- * * **CTCC**: China Telecom
12
+ * - **CMCC**: China Mobile
15
13
  *
16
- * > You are not allowed to query the phone numbers assigned by China Broadnet.
14
+ * - **CUCC**: China Unicom
15
+ *
16
+ * - **CTCC**: China Telecom
17
+ *
18
+ * - **CBN**: China Broadnet
17
19
  *
18
20
  * @example
19
21
  * CMCC
@@ -21,17 +23,23 @@ export class PhoneNumberStatusForPublicResponseBodyData extends $dara.Model {
21
23
  carrier?: string;
22
24
  /**
23
25
  * @remarks
24
- * The returned status for the queried phone number. Valid values:
26
+ * The status of the queried phone number. Valid values:
27
+ *
28
+ * - **NORMAL**: The number is in service.
29
+ *
30
+ * - **SHUTDOWN**: The service for the number is suspended.
31
+ *
32
+ * - **POWER_OFF**: The phone is powered off.
25
33
  *
26
- * * **NORMAL**: The queried phone number can be reached.
27
- * * **SHUTDOWN**: The queried phone number is suspended.
28
- * * **POWER_OFF**: The phone is powered off.
29
- * * **NOT_EXIST**: The queried phone number is a nonexistent number.
30
- * * **SUSPECTED_POWER_OFF**: The phone is suspected to be powered off.
31
- * * **BUSY**: The queried phone number is busy.
32
- * * **UNKNOWN**: The queried phone number is unknown.
34
+ * - **NOT_EXIST**: The number is non-existent.
33
35
  *
34
- * > Due to system adjustment of the carrier, the BUSY and POWER_OFF states cannot be returned for the numbers assigned by China Telecom. [For more information, see the official announcements](https://help.aliyun.com/document_detail/2489709.html).
36
+ * - **SUSPECTED_POWER_OFF**: The phone is suspected to be powered off.
37
+ *
38
+ * - **BUSY**: The line is busy.
39
+ *
40
+ * - **UNKNOWN**: The status is unknown.
41
+ *
42
+ * > Due to carrier system adjustments, the `BUSY`, `SUSPECTED_POWER_OFF`, and `POWER_OFF` statuses are not returned for China Telecom numbers. For more information, see the [official announcement](https://help.aliyun.com/document_detail/2489709.html).
35
43
  *
36
44
  * @example
37
45
  * NORMAL
@@ -63,13 +71,15 @@ export class PhoneNumberStatusForPublicResponseBodyData extends $dara.Model {
63
71
  export class PhoneNumberStatusForPublicResponseBody extends $dara.Model {
64
72
  /**
65
73
  * @remarks
66
- * The response code. Valid values:
74
+ * The status code of the request. Valid values:
75
+ *
76
+ * - **OK**: The request was successful.
77
+ *
78
+ * - **OperatorLimit**: The query for the phone number is prohibited by the carrier.
67
79
  *
68
- * * **OK**: The request is successful.
69
- * * **OperatorLimit**: The carrier prohibits the query of the phone number.
70
- * * **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.
80
+ * - **RequestFrequencyLimit**: Carrier restrictions prohibit frequent queries for the same number in a short period. If this error code is returned, try again later.
71
81
  *
72
- * > For a list of error codes, see [Service error codes](https://next.api.aliyun.com/document/Dytnsapi/2020-02-17/errorCode).
82
+ * > For a list of other error codes, see [API Error Center](https://next.api.aliyun.com/document/Dytnsapi/2020-02-17/errorCode).
73
83
  *
74
84
  * @example
75
85
  * OK
@@ -77,12 +87,12 @@ export class PhoneNumberStatusForPublicResponseBody extends $dara.Model {
77
87
  code?: string;
78
88
  /**
79
89
  * @remarks
80
- * The response parameters.
90
+ * The returned data.
81
91
  */
82
92
  data?: PhoneNumberStatusForPublicResponseBodyData;
83
93
  /**
84
94
  * @remarks
85
- * The returned message.
95
+ * The description of the status code.
86
96
  *
87
97
  * @example
88
98
  * OK
@@ -90,7 +100,7 @@ export class PhoneNumberStatusForPublicResponseBody extends $dara.Model {
90
100
  message?: string;
91
101
  /**
92
102
  * @remarks
93
- * The unique request ID. It is a common parameter and can be used to troubleshoot issues.
103
+ * The ID of the request.
94
104
  *
95
105
  * @example
96
106
  * CC3BB6D2-****-****-9DCE-B38165CE4C47
@@ -7,7 +7,7 @@ export class PhoneNumberStatusForRealRequest extends $dara.Model {
7
7
  * @remarks
8
8
  * The authorization code.
9
9
  *
10
- * > On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization ID.
10
+ * > On the **My Applications** page in the [Phone Number Intelligence console](https://dytns.console.aliyun.com/analysis/apply), you can find the authorization code for your API calls.
11
11
  *
12
12
  * This parameter is required.
13
13
  *
@@ -17,13 +17,19 @@ export class PhoneNumberStatusForRealRequest extends $dara.Model {
17
17
  authCode?: string;
18
18
  /**
19
19
  * @remarks
20
- * The phone number to be queried.
20
+ * The phone number to query.
21
21
  *
22
- * * If the value of Mask is NORMAL, the value of this field is an 11-digit phone number.
23
- * * If the value of Mask is MD5, the value of this field is a 32-bit encrypted string.
24
- * * If the value of Mask is SHA256, the value of this field is a 64-bit encrypted string.
22
+ * - If `Mask` is set to `NORMAL`, this parameter specifies an 11-digit mobile phone number.
25
23
  *
26
- * > Letters in the encrypted strings are not case-sensitive.
24
+ * - If `Mask` is set to `MD5`, this parameter specifies a 32-character encrypted string.
25
+ *
26
+ * - If `Mask` is set to `SHA256`, this parameter specifies a 64-character encrypted string.
27
+ *
28
+ * - If `Mask` is set to `SM3`, this parameter specifies a 64-character encrypted string.
29
+ *
30
+ * >Notice:
31
+ *
32
+ * The encrypted string is not case-sensitive.
27
33
  *
28
34
  * This parameter is required.
29
35
  *
@@ -35,9 +41,13 @@ export class PhoneNumberStatusForRealRequest extends $dara.Model {
35
41
  * @remarks
36
42
  * The encryption method of the phone number. Valid values:
37
43
  *
38
- * * **NORMAL**: The phone number is not encrypted.
39
- * * **MD5**
40
- * * **SHA256**
44
+ * - **NORMAL**: The number is not encrypted.
45
+ *
46
+ * - **MD5**
47
+ *
48
+ * - **SHA256**
49
+ *
50
+ * - **SM3**
41
51
  *
42
52
  * This parameter is required.
43
53
  *
@@ -5,13 +5,15 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class PhoneNumberStatusForRealResponseBodyData extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The basic carrier who assigns the phone number. If the queried phone number involves mobile number portability, the carrier after mobile number portability is returned. Valid values:
8
+ * The carrier that provides service for the phone number. If the number has been ported through mobile number portability (MNP), this field returns the new carrier. Valid values:
9
9
  *
10
- * * **CMCC**: China Mobile
11
- * * **CUCC**: China Unicom
12
- * * **CTCC**: China Telecom
10
+ * - **CMCC**: China Mobile.
13
11
  *
14
- * > You are not allowed to query the phone numbers assigned by China Broadnet.
12
+ * - **CUCC**: China Unicom.
13
+ *
14
+ * - **CTCC**: China Telecom.
15
+ *
16
+ * > Queries for China Broadnet numbers are not supported.
15
17
  *
16
18
  * @example
17
19
  * CMCC
@@ -19,18 +21,25 @@ export class PhoneNumberStatusForRealResponseBodyData extends $dara.Model {
19
21
  carrier?: string;
20
22
  /**
21
23
  * @remarks
22
- * The returned status for the queried phone number. Valid values:
24
+ * The status of the phone number. Valid values:
25
+ *
26
+ * - **NORMAL**: The number is in service.
27
+ *
28
+ * - **SHUTDOWN**: The service for the number is suspended.
29
+ *
30
+ * - **POWER_OFF**: The phone is powered off.
31
+ *
32
+ * - **NOT_EXIST**: The number is not in service.
23
33
  *
24
- * * **NORMAL**: The queried phone number can be reached.
25
- * * **SHUTDOWN**: The queried phone number is suspended.
26
- * * **POWER_OFF**: The phone is powered off.
27
- * * **NOT_EXIST**: The queried phone number is a nonexistent number.
28
- * * **BUSY**: The queried phone number is busy.
29
- * * **SUSPECTED_POWER_OFF**: The phone is suspected to be powered off.
30
- * * **DEFECT**: The queried phone number is invalid.
31
- * * **UNKNOWN**: The queried phone number is unknown.
34
+ * - **BUSY**: The line is busy.
32
35
  *
33
- * > Due to system adjustment of the carrier, the BUSY and POWER_OFF states cannot be returned for the numbers assigned by China Telecom. [For more information, see the official announcements](https://help.aliyun.com/document_detail/2489709.html).
36
+ * - **SUSPECTED_POWER_OFF**: The phone is suspected to be powered off.
37
+ *
38
+ * - **DEFECT**: The number is invalid.
39
+ *
40
+ * - **UNKNOWN**: The status is unknown.
41
+ *
42
+ * > Due to carrier system adjustments, China Telecom numbers no longer return the `BUSY`, `SUSPECTED_POWER_OFF`, and `POWER_OFF` statuses. For more information, see the [official announcement](https://help.aliyun.com/document_detail/2489709.html).
34
43
  *
35
44
  * @example
36
45
  * NORMAL
@@ -62,11 +71,13 @@ export class PhoneNumberStatusForRealResponseBodyData extends $dara.Model {
62
71
  export class PhoneNumberStatusForRealResponseBody extends $dara.Model {
63
72
  /**
64
73
  * @remarks
65
- * The response code. Valid values:
74
+ * The request status code. Valid values:
75
+ *
76
+ * - **OK**: The request was successful.
77
+ *
78
+ * - **OperatorLimit**: The query for the phone number is restricted by the carrier.
66
79
  *
67
- * * **OK**: The request is successful.
68
- * * **OperatorLimit**: The carrier prohibits the query of the phone number.
69
- * * **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.
80
+ * - **RequestFrequencyLimit**: Carriers prohibit high-frequency queries for the same number within a short period. If this error code is returned, try again later.
70
81
  *
71
82
  * @example
72
83
  * OK
@@ -74,12 +85,12 @@ export class PhoneNumberStatusForRealResponseBody extends $dara.Model {
74
85
  code?: string;
75
86
  /**
76
87
  * @remarks
77
- * The response parameters.
88
+ * The data returned for the request.
78
89
  */
79
90
  data?: PhoneNumberStatusForRealResponseBodyData;
80
91
  /**
81
92
  * @remarks
82
- * The returned message.
93
+ * The description of the status code.
83
94
  *
84
95
  * @example
85
96
  * OK
@@ -87,7 +98,7 @@ export class PhoneNumberStatusForRealResponseBody extends $dara.Model {
87
98
  message?: string;
88
99
  /**
89
100
  * @remarks
90
- * The unique request ID. It is a common parameter and can be used to troubleshoot issues.
101
+ * A unique identifier for the request. You can use this ID to troubleshoot issues.
91
102
  *
92
103
  * @example
93
104
  * CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
@@ -7,7 +7,7 @@ export class PhoneNumberStatusForSmsRequest extends $dara.Model {
7
7
  * @remarks
8
8
  * The authorization code.
9
9
  *
10
- * > On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization code (also known as authorization ID).
10
+ * > On the **My Applications** page in the [Phone Number Pedia console](https://dytns.console.aliyun.com/analysis/apply), obtain the authorization ID and use it as the value for this parameter.
11
11
  *
12
12
  * This parameter is required.
13
13
  *
@@ -17,13 +17,19 @@ export class PhoneNumberStatusForSmsRequest extends $dara.Model {
17
17
  authCode?: string;
18
18
  /**
19
19
  * @remarks
20
- * The phone number to be queried.
20
+ * The phone number to query.
21
21
  *
22
- * * If the value of Mask is NORMAL, specify an 11-digit phone number in plaintext.
23
- * * If the value of Mask is MD5, specify a 32-bit string that is encrypted by using MD5.
24
- * * If the value of Mask is SHA256, specify a 64-bit string that is encrypted by using SHA256.
22
+ * - If `Mask` is set to `NORMAL`, specify an 11-digit phone number.
25
23
  *
26
- * > Letters in the encrypted strings are not case-sensitive.
24
+ * - If `Mask` is set to `MD5`, specify a 32-character encrypted string.
25
+ *
26
+ * - If `Mask` is set to `SHA256`, specify a 64-character encrypted string.
27
+ *
28
+ * - If `Mask` is set to `SM3`, specify a 64-character encrypted string.
29
+ *
30
+ * >Notice:
31
+ *
32
+ * The encrypted string is not case-sensitive.
27
33
  *
28
34
  * This parameter is required.
29
35
  *
@@ -33,11 +39,15 @@ export class PhoneNumberStatusForSmsRequest extends $dara.Model {
33
39
  inputNumber?: string;
34
40
  /**
35
41
  * @remarks
36
- * The encryption method of the phone number. Valid values:
42
+ * The encryption method for the phone number. Valid values:
43
+ *
44
+ * - **NORMAL**: The number is not encrypted.
45
+ *
46
+ * - **MD5**
47
+ *
48
+ * - **SHA256**
37
49
  *
38
- * * **NORMAL**: plaintext
39
- * * **MD5**
40
- * * **SHA256**
50
+ * - **SM3**
41
51
  *
42
52
  * This parameter is required.
43
53
  *
@@ -5,13 +5,15 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class PhoneNumberStatusForSmsResponseBodyData extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The basic carrier who assigns the phone number. If the queried phone number involves mobile number portability, the carrier after mobile number portability is returned. Valid values:
8
+ * The carrier of the phone number. If the number has been ported, this parameter returns the current carrier. Valid values:
9
9
  *
10
- * * **CMCC**: China Mobile
11
- * * **CUCC**: China Unicom
12
- * * **CTCC**: China Telecom
10
+ * - **CMCC**: China Mobile.
13
11
  *
14
- * > You are not allowed to query the phone numbers assigned by China Broadnet.
12
+ * - **CUCC**: China Unicom.
13
+ *
14
+ * - **CTCC**: China Telecom.
15
+ *
16
+ * > Queries for China Broadnet numbers are not supported.
15
17
  *
16
18
  * @example
17
19
  * CMCC
@@ -19,16 +21,21 @@ export class PhoneNumberStatusForSmsResponseBodyData extends $dara.Model {
19
21
  carrier?: string;
20
22
  /**
21
23
  * @remarks
22
- * The returned status for the queried phone number. Valid values:
24
+ * The status of the phone number. Valid values:
25
+ *
26
+ * - **NORMAL**: Active.
27
+ *
28
+ * - **SHUTDOWN**: Shutdown.
29
+ *
30
+ * - **POWER_OFF**: Powered off.
23
31
  *
24
- * * **NORMAL**: The queried phone number can be reached.
25
- * * **SHUTDOWN**: The queried phone number is suspended.
26
- * * **POWER_OFF**: The phone is powered off.
27
- * * **NOT_EXIST**: The queried phone number is a nonexistent number.
28
- * * **DEFECT**: The queried phone number is invalid.
29
- * * **UNKNOWN**: The queried phone number is unknown.
32
+ * - **NOT_EXIST**: Non-existent number.
30
33
  *
31
- * > Due to system adjustment of the carrier, the BUSY, SUSPECTED_POWER_OFF, and POWER_OFF states cannot be returned for the numbers assigned by China Telecom. [For more information, see the official announcements](https://help.aliyun.com/document_detail/2489709.html).
34
+ * - **DEFECT**: Invalid number.
35
+ *
36
+ * - **UNKNOWN**: Unknown.
37
+ *
38
+ * > Due to carrier system adjustments, the statuses for busy, suspected to be powered off, and powered off are not returned for China Telecom numbers. For more information, see the [official announcement](https://help.aliyun.com/document_detail/2489709.html).
32
39
  *
33
40
  * @example
34
41
  * NORMAL
@@ -60,11 +67,13 @@ export class PhoneNumberStatusForSmsResponseBodyData extends $dara.Model {
60
67
  export class PhoneNumberStatusForSmsResponseBody extends $dara.Model {
61
68
  /**
62
69
  * @remarks
63
- * The response code. Valid values:
70
+ * The request status code. Valid values:
71
+ *
72
+ * - **OK**: The request was successful.
73
+ *
74
+ * - **OperatorLimit**: The carrier restricts queries for this phone number.
64
75
  *
65
- * * **OK**: The request is successful.
66
- * * **OperatorLimit**: The carrier prohibits the query of the phone number.
67
- * * **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.
76
+ * - **RequestFrequencyLimit**: Indicates that requests for a single number are too frequent. Due to carrier restrictions, repeated queries for the same number within a short period are prohibited. If you receive this error code, try again later.
68
77
  *
69
78
  * @example
70
79
  * OK
@@ -72,12 +81,12 @@ export class PhoneNumberStatusForSmsResponseBody extends $dara.Model {
72
81
  code?: string;
73
82
  /**
74
83
  * @remarks
75
- * The response parameters.
84
+ * A container for the returned data.
76
85
  */
77
86
  data?: PhoneNumberStatusForSmsResponseBodyData;
78
87
  /**
79
88
  * @remarks
80
- * The returned message.
89
+ * The description of the status code.
81
90
  *
82
91
  * @example
83
92
  * OK
@@ -85,7 +94,7 @@ export class PhoneNumberStatusForSmsResponseBody extends $dara.Model {
85
94
  message?: string;
86
95
  /**
87
96
  * @remarks
88
- * The unique request ID. It is a common parameter and can be used to troubleshoot issues.
97
+ * The unique ID of the request. Use this ID to troubleshoot issues.
89
98
  *
90
99
  * @example
91
100
  * 68A40250-50CD-034C-B728-0BD135850177
@@ -7,7 +7,7 @@ export class PhoneNumberStatusForVoiceRequest extends $dara.Model {
7
7
  * @remarks
8
8
  * The authorization code.
9
9
  *
10
- * > On the **My Applications** page in the [Cell Phone Number Service console](https://dytns.console.aliyun.com/analysis/apply), you can obtain the authorization code (also known as authorization ID).
10
+ * > The authorization code is the authorization ID that you can find on the **My Applications** page of the [Phone Number Encyclopedia console](https://dytns.console.aliyun.com/analysis/apply).
11
11
  *
12
12
  * This parameter is required.
13
13
  *
@@ -17,13 +17,19 @@ export class PhoneNumberStatusForVoiceRequest extends $dara.Model {
17
17
  authCode?: string;
18
18
  /**
19
19
  * @remarks
20
- * The phone number to be queried.
20
+ * The phone number to query.
21
21
  *
22
- * * If the value of Mask is NORMAL, specify an 11-digit phone number in plaintext.
23
- * * If the value of Mask is MD5, specify a 32-bit string that is encrypted by using MD5.
24
- * * If the value of Mask is SHA256, specify a 64-bit string that is encrypted by using SHA256.
22
+ * - If you set `Mask` to `NORMAL`, specify an 11-digit mobile number.
25
23
  *
26
- * > Letters in the encrypted strings are not case-sensitive.
24
+ * - If you set `Mask` to `MD5`, specify a 32-bit encrypted string.
25
+ *
26
+ * - If you set `Mask` to `SHA256`, specify a 64-bit encrypted string.
27
+ *
28
+ * - If you set `Mask` to `SM3`, specify a 64-bit encrypted string.
29
+ *
30
+ * >Notice:
31
+ *
32
+ * The letters in the encrypted string are not case-sensitive.
27
33
  *
28
34
  * This parameter is required.
29
35
  *
@@ -35,9 +41,13 @@ export class PhoneNumberStatusForVoiceRequest extends $dara.Model {
35
41
  * @remarks
36
42
  * The encryption method. Valid values:
37
43
  *
38
- * * **NORMAL**: plaintext
39
- * * **MD5**
40
- * * **SHA256**
44
+ * - **NORMAL**: The number is in plaintext.
45
+ *
46
+ * - **MD5**
47
+ *
48
+ * - **SHA256**
49
+ *
50
+ * - **SM3**
41
51
  *
42
52
  * This parameter is required.
43
53
  *
@@ -5,13 +5,15 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class PhoneNumberStatusForVoiceResponseBodyData extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The basic carrier who assigns the phone number. If the queried phone number involves mobile number portability, the carrier after mobile number portability is returned. Valid values:
8
+ * The current carrier for the number. If the number has been ported, this field returns the new carrier. Valid values:
9
9
  *
10
- * * **CMCC**: China Mobile
11
- * * **CUCC**: China Unicom
12
- * * **CTCC**: China Telecom
10
+ * - **CMCC**: China Mobile
13
11
  *
14
- * > You are not allowed to query the phone numbers assigned by China Broadnet.
12
+ * - **CUCC**: China Unicom
13
+ *
14
+ * - **CTCC**: China Telecom
15
+ *
16
+ * > Queries for China Broadnet numbers are not supported.
15
17
  *
16
18
  * @example
17
19
  * CTCC
@@ -19,17 +21,23 @@ export class PhoneNumberStatusForVoiceResponseBodyData extends $dara.Model {
19
21
  carrier?: string;
20
22
  /**
21
23
  * @remarks
22
- * The returned status for the queried phone number. Valid values:
24
+ * The status of the phone number. Valid values:
25
+ *
26
+ * - **NORMAL**: The number is active.
27
+ *
28
+ * - **SHUTDOWN**: The service for the number is suspended.
29
+ *
30
+ * - **POWER_OFF**: The phone is powered off.
23
31
  *
24
- * * **NORMAL**: The queried phone number can be reached.
25
- * * **SHUTDOWN**: The queried phone number is suspended.
26
- * * **POWER_OFF**: The phone is powered off.
27
- * * **NOT_EXIST**: The queried phone number is a nonexistent number.
28
- * * **SUSPECTED_POWER_OFF**: The phone is suspected to be powered off.
29
- * * **DEFECT**: The queried phone number is invalid.
30
- * * **UNKNOWN**: The queried phone number is unknown.
32
+ * - **NOT_EXIST**: The number does not exist.
31
33
  *
32
- * > Due to system adjustment of the carrier, the BUSY, SUSPECTED_POWER_OFF, and POWER_OFF states cannot be returned for the numbers assigned by China Telecom. [For more information, see the official announcements](https://help.aliyun.com/document_detail/2489709.html).
34
+ * - **SUSPECTED_POWER_OFF**: The phone is likely powered off.
35
+ *
36
+ * - **DEFECT**: The number is invalid.
37
+ *
38
+ * - **UNKNOWN**: The status is unknown.
39
+ *
40
+ * > Due to carrier system adjustments, the `SUSPECTED_POWER_OFF` and `POWER_OFF` statuses are not returned for China Telecom numbers. [For more information, see the official announcement.](https://help.aliyun.com/document_detail/2489709.html)
33
41
  *
34
42
  * @example
35
43
  * NORMAL
@@ -61,11 +69,13 @@ export class PhoneNumberStatusForVoiceResponseBodyData extends $dara.Model {
61
69
  export class PhoneNumberStatusForVoiceResponseBody extends $dara.Model {
62
70
  /**
63
71
  * @remarks
64
- * The response code. Valid values:
72
+ * The status code of the request. Valid values:
73
+ *
74
+ * - **OK**: The request was successful.
75
+ *
76
+ * - **OperatorLimit**: The carrier restricts queries for this phone number.
65
77
  *
66
- * * **OK**: The request is successful.
67
- * * **OperatorLimit**: The carrier prohibits the query of the phone number.
68
- * * **RequestFrequencyLimit**: Repeated queries for the same phone number at a high frequency within a short period of time are prohibited due to restrictions that are set by carriers. If this error code is returned, please try again later.
78
+ * - **RequestFrequencyLimit**: Carrier restrictions limit how frequently you can query the same number. If you receive this error, try again later.
69
79
  *
70
80
  * @example
71
81
  * OK
@@ -73,12 +83,12 @@ export class PhoneNumberStatusForVoiceResponseBody extends $dara.Model {
73
83
  code?: string;
74
84
  /**
75
85
  * @remarks
76
- * The response parameters.
86
+ * The returned data.
77
87
  */
78
88
  data?: PhoneNumberStatusForVoiceResponseBodyData;
79
89
  /**
80
90
  * @remarks
81
- * The returned message.
91
+ * The description of the status code.
82
92
  *
83
93
  * @example
84
94
  * OK
@@ -86,7 +96,7 @@ export class PhoneNumberStatusForVoiceResponseBody extends $dara.Model {
86
96
  message?: string;
87
97
  /**
88
98
  * @remarks
89
- * The unique request ID. It is a common parameter and can be used to troubleshoot issues.
99
+ * The request ID. This is a common parameter. Each request has a unique ID that you can use to troubleshoot issues.
90
100
  *
91
101
  * @example
92
102
  * CC3BB6D2-2FDF-4321-9DCE-B38165CE4C47
@@ -8,7 +8,7 @@ export class QueryAvailableAuthCodeRequest extends $dara.Model {
8
8
  resourceOwnerId?: number;
9
9
  /**
10
10
  * @remarks
11
- * The tag ID.
11
+ * The tag ID. You can call the [QueryTagListPage](~~QueryTagListPage~~) operation to query tag IDs.
12
12
  *
13
13
  * @example
14
14
  * 22
@@ -5,7 +5,7 @@ import * as $dara from '@darabonba/typescript';
5
5
  export class QueryAvailableAuthCodeResponseBody extends $dara.Model {
6
6
  /**
7
7
  * @remarks
8
- * The response code. **OK** indicates that the request is successful.
8
+ * The status code returned. **OK** indicates that the request was successful.
9
9
  *
10
10
  * @example
11
11
  * OK
@@ -13,12 +13,12 @@ export class QueryAvailableAuthCodeResponseBody extends $dara.Model {
13
13
  code?: string;
14
14
  /**
15
15
  * @remarks
16
- * The returned data.
16
+ * The data returned.
17
17
  */
18
18
  data?: string[];
19
19
  /**
20
20
  * @remarks
21
- * The returned message.
21
+ * The description of the status code returned.
22
22
  *
23
23
  * @example
24
24
  * OK
@@ -34,13 +34,14 @@ export class QueryAvailableAuthCodeResponseBody extends $dara.Model {
34
34
  requestId?: string;
35
35
  /**
36
36
  * @remarks
37
- * Indicates whether the request is successful. Valid values:
37
+ * Indicates whether the request was successful. Valid values:
38
38
  *
39
- * * true
40
- * * false
39
+ * - true: successful.
40
+ *
41
+ * - false: failed.
41
42
  *
42
43
  * @example
43
- * false
44
+ * true
44
45
  */
45
46
  success?: boolean;
46
47
  static names(): { [key: string]: string } {
@@ -6,7 +6,7 @@ export class QueryPackageTypeInfoRequest extends $dara.Model {
6
6
  ownerId?: number;
7
7
  /**
8
8
  * @remarks
9
- * 产品名称,如dysms
9
+ * The product name. The value must be dytns.
10
10
  *
11
11
  * @example
12
12
  * dytns
@@ -4,24 +4,51 @@ import * as $dara from '@darabonba/typescript';
4
4
 
5
5
  export class QueryPackageTypeInfoResponseBody extends $dara.Model {
6
6
  /**
7
+ * @remarks
8
+ * The status code.
9
+ *
10
+ * - OK indicates that the request is successful.
11
+ *
12
+ * - For other error codes, see the [error code list](https://help.aliyun.com/document_detail/109196.html).
13
+ *
7
14
  * @example
8
- * 示例值示例值
15
+ * Example
9
16
  */
10
17
  code?: string;
18
+ /**
19
+ * @remarks
20
+ * The response data.
21
+ *
22
+ * @example
23
+ * {"efactorVerification":"平台风控-二要素核验查询套餐包"}
24
+ */
11
25
  data?: { [key: string]: any };
12
26
  /**
27
+ * @remarks
28
+ * The response message.
29
+ *
13
30
  * @example
14
- * 示例值示例值示例值
31
+ * Example
15
32
  */
16
33
  message?: string;
17
34
  /**
35
+ * @remarks
36
+ * The request ID.
37
+ *
18
38
  * @example
19
- * 示例值示例值示例值
39
+ * Example
20
40
  */
21
41
  requestId?: string;
22
42
  /**
43
+ * @remarks
44
+ * Indicates whether the request was successful. Valid values:
45
+ *
46
+ * - true: The request was successful.
47
+ *
48
+ * - false: The request failed.
49
+ *
23
50
  * @example
24
- * false
51
+ * true
25
52
  */
26
53
  success?: boolean;
27
54
  static names(): { [key: string]: string } {