Update API GetSmsSign: update response param.

Author: sdk-team

ChangeLog.md

@@ -1,3 +1,9 @@
+2025-01-03 Version: 3.1.1
+- Update API GetSmsSign: update response param.
+- Update API QueryExtCodeSign: update param ExtCode.
+- Update API QueryExtCodeSign: update param SignName.
+
+
 2024-10-24 Version: 3.1.0
 - Support API AddExtCodeSign.
 - Support API DeleteExtCodeSign.

src/Dysmsapi.php

@@ -1159,7 +1159,7 @@ public function deleteSmsTemplate($request)
     }
 
     /**
-     * @summary 查询卡片发送详情
+     * @summary Query card sending details
      *  *
      * @param GetCardSmsDetailsRequest $request GetCardSmsDetailsRequest
      * @param RuntimeOptions           $runtime runtime options for this request RuntimeOptions
@@ -1219,7 +1219,7 @@ public function getCardSmsDetailsWithOptions($request, $runtime)
     }
 
     /**
-     * @summary 查询卡片发送详情
+     * @summary Query card sending details
      *  *
      * @param GetCardSmsDetailsRequest $request GetCardSmsDetailsRequest
      *

src/Models/GetCardSmsDetailsRequest.php

@@ -9,27 +9,35 @@
 class GetCardSmsDetailsRequest extends Model
 {
     /**
+     * @description Card SMS sending ID, which is the BizCardId field in the response when calling SendCardSms or SendBatchCardSms.
+     *
      * @example 123456^0
      *
      * @var string
      */
     public $bizCardId;
 
     /**
+     * @description Digital SMS sending ID, which is the BizDigitalId field in the response when calling SendCardSms or SendBatchCardSms.
+     *
      * @example 12346^0
      *
      * @var string
      */
     public $bizDigitId;
 
     /**
+     * @description Text SMS sending ID, which is the BizSmsId field in the response when calling SendCardSms or SendBatchCardSms.
+     *
      * @example 1234576^0
      *
      * @var string
      */
     public $bizSmsId;
 
     /**
+     * @description For paginated viewing of sending records, specify the current page number of the sending records.
+     *
      * @example 1
      *
      * @var int
@@ -42,15 +50,19 @@ class GetCardSmsDetailsRequest extends Model
     public $ownerId;
 
     /**
+     * @description For paginated viewing of sending records, specify the number of card SMS records to display per page.
+     *
+     * The value range is 1~50.
      * @example 10
      *
      * @var int
      */
     public $pageSize;
 
     /**
-     * @description This parameter is required.
+     * @description Domestic phone number that received the SMS. Format: 11-digit phone number, for example, 1390000****.
      *
+     * This parameter is required.
      * @example 1390000****
      *
      * @var string
@@ -68,8 +80,9 @@ class GetCardSmsDetailsRequest extends Model
     public $resourceOwnerId;
 
     /**
-     * @description This parameter is required.
+     * @description Card SMS sending date, supports querying records from the last 30 days.
      *
+     * This parameter is required.
      * @example 20240112
      *
      * @var string

src/Models/GetCardSmsDetailsResponseBody.php

@@ -10,19 +10,25 @@
 class GetCardSmsDetailsResponseBody extends Model
 {
     /**
+     * @description Access denied detail; this field is returned only if the RAM check fails.
+     *
+     * @example 无
+     *
      * @var string
      */
     public $accessDeniedDetail;
 
     /**
-     * @description 卡片短信发送结果
+     * @description Card SMS sending result
      *
      * @var cardSendDetailDTO
      */
     public $cardSendDetailDTO;
 
     /**
-     * @description 状态码
+     * @description Request status code.
+     * OK indicates a successful request.
+     * For other error codes, see [API Error Codes](https://help.aliyun.com/document_detail/101346.html).
      *
      * @example OK
      *
@@ -31,7 +37,7 @@ class GetCardSmsDetailsResponseBody extends Model
     public $code;
 
     /**
-     * @description 状态描述
+     * @description Description of the status code.
      *
      * @example OK
      *
@@ -40,6 +46,8 @@ class GetCardSmsDetailsResponseBody extends Model
     public $message;
 
     /**
+     * @description Indicates whether the API call was successful. Values:
+     * - **true** - **false**
      * @example true
      *
      * @var bool

src/Models/GetCardSmsDetailsResponseBody/cardSendDetailDTO.php

@@ -10,7 +10,7 @@
 class cardSendDetailDTO extends Model
 {
     /**
-     * @description 页码
+     * @description Current page number
      *
      * @example 1
      *
@@ -19,7 +19,7 @@ class cardSendDetailDTO extends Model
     public $currentPage;
 
     /**
-     * @description 页数
+     * @description Page size
      *
      * @example 10
      *
@@ -28,12 +28,14 @@ class cardSendDetailDTO extends Model
     public $pageSize;
 
     /**
+     * @description List of card SMS sending records
+     *
      * @var records[]
      */
     public $records;
 
     /**
-     * @description 总量
+     * @description Total count
      *
      * @example 10
      *

src/Models/GetCardSmsDetailsResponseBody/cardSendDetailDTO/records.php

@@ -9,7 +9,7 @@
 class records extends Model
 {
     /**
-     * @description 发送错误码
+     * @description Error code for sending
      *
      * @example Success
      *
@@ -18,7 +18,7 @@ class records extends Model
     public $errCode;
 
     /**
-     * @description 客户传输outId
+     * @description Customer-transmitted outId
      *
      * @example 12345678
      *
@@ -27,7 +27,7 @@ class records extends Model
     public $outId;
 
     /**
-     * @description 接收短信手机号
+     * @description Phone number that received the SMS
      *
      * @example 156****9080
      *
@@ -36,7 +36,7 @@ class records extends Model
     public $phoneNumber;
 
     /**
-     * @description 接收时间
+     * @description Receive date
      *
      * @example 2024-09-27 11:26:35
      *
@@ -45,7 +45,7 @@ class records extends Model
     public $receiveDate;
 
     /**
-     * @description 接收短信类型
+     * @description Receive SMS type
      *
      * @example CARD_SMS
      *
@@ -54,7 +54,7 @@ class records extends Model
     public $receiveType;
 
     /**
-     * @description 渲染时间
+     * @description Render date
      *
      * @example 2024-09-27 12:13:39
      *
@@ -63,7 +63,7 @@ class records extends Model
     public $renderDate;
 
     /**
-     * @description 解析状态.。0：未解析；1：解析成功；3：未解析
+     * @description Render status. 0: Not rendered; 1: Rendered successfully; 3: Not rendered
      *
      * @example 1
      *
@@ -72,7 +72,7 @@ class records extends Model
     public $renderStatus;
 
     /**
-     * @description 短信发送时间
+     * @description Time when the SMS was sent
      *
      * @example 2024-09-27 11:26:32
      *
@@ -81,7 +81,7 @@ class records extends Model
     public $sendDate;
 
     /**
-     * @description 发送状态 1：发送中；2：发送失败；3：发送成功；4：寻址失败
+     * @description Sending status. 1: Sending; 2: Send failed; 3: Sent successfully; 4: Addressing failed
      *
      * @example 3
      *
@@ -90,7 +90,7 @@ class records extends Model
     public $sendStatus;
 
     /**
-     * @description 短信内容。只有文本短信有值
+     * @description SMS content. Only applicable for text messages.
      *
      * @example 您收到一条短信消息
      *
@@ -99,7 +99,7 @@ class records extends Model
     public $smsContent;
 
     /**
-     * @description 模板code
+     * @description Template code
      *
      * @example CARD_SMS_6***
      *

src/Models/GetSmsSignResponseBody.php

@@ -79,6 +79,11 @@ class GetSmsSignResponseBody extends Model
      */
     public $qualificationId;
 
+    /**
+     * @var int
+     */
+    public $registerResult;
+
     /**
      * @description Explanation of the SMS signature scenario, with a maximum length of 200 characters.
      *
@@ -165,6 +170,7 @@ class GetSmsSignResponseBody extends Model
         'message'         => 'Message',
         'orderId'         => 'OrderId',
         'qualificationId' => 'QualificationId',
+        'registerResult'  => 'RegisterResult',
         'remark'          => 'Remark',
         'requestId'       => 'RequestId',
         'signCode'        => 'SignCode',
@@ -206,6 +212,9 @@ public function toMap()
         if (null !== $this->qualificationId) {
             $res['QualificationId'] = $this->qualificationId;
         }
+        if (null !== $this->registerResult) {
+            $res['RegisterResult'] = $this->registerResult;
+        }
         if (null !== $this->remark) {
             $res['Remark'] = $this->remark;
         }
@@ -268,6 +277,9 @@ public static function fromMap($map = [])
         if (isset($map['QualificationId'])) {
             $model->qualificationId = $map['QualificationId'];
         }
+        if (isset($map['RegisterResult'])) {
+            $model->registerResult = $map['RegisterResult'];
+        }
         if (isset($map['Remark'])) {
             $model->remark = $map['Remark'];
         }

src/Models/QueryExtCodeSignRequest.php

@@ -11,7 +11,6 @@ class QueryExtCodeSignRequest extends Model
     /**
      * @description 扩展码A3
      *
-     * This parameter is required.
      * @example 01
      *
      * @var string
@@ -50,7 +49,6 @@ class QueryExtCodeSignRequest extends Model
     /**
      * @description 签名
      *
-     * This parameter is required.
      * @example 示例值示例值
      *
      * @var string