diff options
Diffstat (limited to 'data/en_us/dysmsapi')
| -rw-r--r-- | data/en_us/dysmsapi/2017-05-25/api-docs.php | 11753 | ||||
| -rw-r--r-- | data/en_us/dysmsapi/2018-05-01/api-docs.php | 1193 |
2 files changed, 12946 insertions, 0 deletions
diff --git a/data/en_us/dysmsapi/2017-05-25/api-docs.php b/data/en_us/dysmsapi/2017-05-25/api-docs.php new file mode 100644 index 0000000..37bf5ff --- /dev/null +++ b/data/en_us/dysmsapi/2017-05-25/api-docs.php @@ -0,0 +1,11753 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dysmsapi', + 'version' => '2017-05-25', + ], + 'directories' => [ + [ + 'id' => 402523, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'SubmitSmsQualification', + 'QuerySmsQualificationRecord', + 'QuerySingleSmsQualification', + 'UpdateSmsQualification', + 'DeleteSmsQualification', + 'RequiredPhoneCode', + 'ValidPhoneCode', + ], + ], + [ + 'id' => 402531, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateSmsAuthorizationLetter', + 'QuerySmsAuthorizationLetter', + ], + ], + [ + 'id' => 402534, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateSmsSign', + 'GetSmsSign', + 'QuerySmsSignList', + 'UpdateSmsSign', + 'DeleteSmsSign', + 'ChangeSignatureQualification', + 'AddSmsSign', + 'ModifySmsSign', + 'QuerySmsSign', + ], + ], + [ + 'id' => 402544, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateSmsTrademark', + 'QuerySmsTrademark', + 'CreateSmsAppIcpRecord', + 'QuerySmsAppIcpRecord', + ], + ], + [ + 'id' => 402549, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateSmsTemplate', + 'GetSmsTemplate', + 'QuerySmsTemplateList', + 'UpdateSmsTemplate', + 'DeleteSmsTemplate', + 'AddSmsTemplate', + 'ModifySmsTemplate', + 'QuerySmsTemplate', + ], + ], + [ + 'id' => 402558, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'SendSms', + 'SendBatchSms', + ], + ], + [ + 'id' => 402561, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'QuerySendDetails', + 'QuerySendStatistics', + ], + ], + [ + 'id' => 402564, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'CreateDigitalSignOrder', + 'QueryDigitalSignByName', + 'CreateDigitalSmsTemplate', + ], + ], + [ + 'id' => 402568, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetOSSInfoForCardTemplate', + 'GetMediaResourceId', + 'CreateCardSmsTemplate', + 'QueryCardSmsTemplate', + 'CheckMobilesCardSupport', + 'QueryMobilesCardSupport', + 'GetCardSmsLink', + 'GetCardSmsDetails', + 'QueryCardSmsTemplateReport', + 'SendCardSms', + 'SendBatchCardSms', + ], + ], + [ + 'id' => 402580, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'GetQualificationOssInfo', + 'GetOSSInfoForUploadFile', + 'GetSmsOcrOssInfo', + ], + ], + [ + 'id' => 402584, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'SmsConversionIntl', + 'ConversionDataIntl', + ], + ], + [ + 'id' => 402587, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'AddShortUrl', + 'DeleteShortUrl', + 'QueryShortUrl', + ], + ], + [ + 'id' => 402591, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ListTagResources', + 'TagResources', + 'UntagResources', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'GetSmsTemplateList', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'SubmitSmsQualification' => [ + 'summary' => '创建资质对客openAPI', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264876', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'QualificationName', + 'in' => 'query', + 'schema' => [ + 'title' => '资质名称,名称不能重复', + 'description' => '资质名称,名称不能重复', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'UseBySelf', + 'in' => 'query', + 'schema' => [ + 'title' => '资质是自用还是他用，true：自用，false：他用', + 'description' => '资质是自用还是他用，true：自用，false：他用', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'CompanyType', + 'in' => 'query', + 'schema' => [ + 'title' => '企业类型, COMPANY:公司;NON_PROFIT_ORGANIZATION:政府或者事业单位', + 'description' => '企业类型, COMPANY:公司;NON_PROFIT_ORGANIZATION:政府或者事业单位', + 'type' => 'string', + 'required' => true, + 'example' => 'COMPANY', + ], + ], + [ + 'name' => 'BusinessLicensePics', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '企业营业证件信息，非大客户必填', + 'description' => '企业营业证件信息，非大客户必填', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '营业证件类型，businessLicense:营业执照;organizationCodeLicense:组织机构代码证;taxRegistrationLicense:税务登记证;socialCreditLicense:社会信用代码证书;newStyleBusinessLicense:三证合一;signLegalLicense:签名归属方的事业单位法人证书;otherLicense:其他类型执照证书', + 'description' => '营业证件类型，businessLicense:营业执照;organizationCodeLicense:组织机构代码证;taxRegistrationLicense:税务登记证;socialCreditLicense:社会信用代码证书;newStyleBusinessLicense:三证合一;signLegalLicense:签名归属方的事业单位法人证书;otherLicense:其他类型执照证书', + 'type' => 'string', + 'required' => false, + 'example' => 'businessLicense', + ], + 'LicensePic' => [ + 'title' => '营业证件图片标识的osskey', + 'description' => '营业证件图片标识的osskey', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CompanyName', + 'in' => 'query', + 'schema' => [ + 'title' => '公司名称', + 'description' => '公司名称', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'OrganizationCode', + 'in' => 'query', + 'schema' => [ + 'title' => '社会统一信用代码', + 'description' => '社会统一信用代码', + 'type' => 'string', + 'required' => true, + 'example' => '910X********0012', + ], + ], + [ + 'name' => 'BussinessLicenseExpDate', + 'in' => 'query', + 'schema' => [ + 'title' => '企业营业时间开始和结束字符串，格式示例2023-01-01~2033-01-01', + 'description' => '企业营业时间开始和结束字符串，格式示例2023-01-01~2033-01-01', + 'type' => 'string', + 'required' => true, + 'example' => '2023-01-01~2033-01-01', + ], + ], + [ + 'name' => 'LegalPersonIdCardFrontSide', + 'in' => 'query', + 'schema' => [ + 'title' => '法人身份证照片国徽面', + 'description' => '法人身份证照片国徽面', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png', + ], + ], + [ + 'name' => 'LegalPersonIdCardBackSide', + 'in' => 'query', + 'schema' => [ + 'title' => '法人身份证照片人像面', + 'description' => '法人身份证照片人像面', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png', + ], + ], + [ + 'name' => 'LegalPersonName', + 'in' => 'query', + 'schema' => [ + 'title' => '法人姓名', + 'description' => '法人姓名', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'LegalPersonIDCardNo', + 'in' => 'query', + 'schema' => [ + 'title' => '法人身份证号码', + 'description' => '法人身份证号码', + 'type' => 'string', + 'required' => true, + 'example' => '511391********5123', + ], + ], + [ + 'name' => 'LegalPersonIdCardEffTime', + 'in' => 'query', + 'schema' => [ + 'title' => '法人身份证有效期', + 'description' => '法人身份证有效期', + 'type' => 'string', + 'required' => true, + 'example' => '2023-01-01~2033-01-01', + ], + ], + [ + 'name' => 'LegalPersonIDCardType', + 'in' => 'query', + 'schema' => [ + 'title' => '法人身份证类型。identityCard:中国居民身份证;passport:护照;homeReturnPermit:港澳居民来往内地通行证;TaiwanCompatriotPermit:台湾居民来往大陆通行证;residencePermit:港澳台居民居住证";other:其他', + 'description' => '法人身份证类型。identityCard:中国居民身份证;passport:护照;homeReturnPermit:港澳居民来往内地通行证;TaiwanCompatriotPermit:台湾居民来往大陆通行证;residencePermit:港澳台居民居住证";other:其他', + 'type' => 'string', + 'required' => true, + 'example' => 'identityCard', + ], + ], + [ + 'name' => 'AdminIDCardPic', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人身份证照片人像面', + 'description' => '经办人身份证照片人像面', + 'type' => 'string', + 'required' => true, + 'example' => '123456/111.png', + ], + ], + [ + 'name' => 'AdminIDCardFrontFace', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人身份证照片国徽面', + 'description' => '经办人身份证照片国徽面', + 'type' => 'string', + 'required' => true, + 'example' => '123456/111.png', + ], + ], + [ + 'name' => 'AdminName', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人姓名', + 'description' => '经办人姓名', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'AdminIDCardNo', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人身份证号码', + 'description' => '经办人身份证号码', + 'type' => 'string', + 'required' => true, + 'example' => '511391********5123', + ], + ], + [ + 'name' => 'AdminIDCardType', + 'in' => 'query', + 'schema' => [ + 'title' => '管理员身份证类型。identityCard:中国居民身份证;passport:护照;homeReturnPermit:港澳居民来往内地通行证;TaiwanCompatriotPermit:台湾居民来往大陆通行证;residencePermit:港澳台居民居住证";other:其他', + 'description' => '管理员身份证类型。identityCard:中国居民身份证;passport:护照;homeReturnPermit:港澳居民来往内地通行证;TaiwanCompatriotPermit:台湾居民来往大陆通行证;residencePermit:港澳台居民居住证";other:其他', + 'type' => 'string', + 'required' => true, + 'example' => 'identityCard', + ], + ], + [ + 'name' => 'AdminIDCardExpDate', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人身份证有效期，格式示例2023-01-01~2033-01-01', + 'description' => '经办人身份证有效期，格式示例2023-01-01~2033-01-01', + 'type' => 'string', + 'required' => true, + 'example' => '2023-01-01~2033-01-01', + ], + ], + [ + 'name' => 'AdminPhoneNo', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人手机号码', + 'description' => '经办人手机号码', + 'type' => 'string', + 'required' => true, + 'example' => '137****1234', + ], + ], + [ + 'name' => 'CertifyCode', + 'in' => 'query', + 'schema' => [ + 'title' => '手机号验证码', + 'description' => '手机号验证码', + 'type' => 'string', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'OtherFiles', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '更多资料', + 'description' => '更多资料', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LicensePic' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'WhetherShare', + 'in' => 'query', + 'schema' => [ + 'title' => '是否同意与其他业务线共享', + 'description' => '是否同意与其他业务线共享', + 'type' => 'boolean', + 'required' => true, + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'title' => '备注', + 'description' => '备注', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '1000****', + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AdminBackOssFileNotUploadError', + 'errorMessage' => 'Administrator ID card portrait photo not uploaded.', + ], + [ + 'errorCode' => 'AdminDateNotValid', + 'errorMessage' => 'Current time is outside the administrator ID card validity period.', + ], + [ + 'errorCode' => 'AdminIdcardExpdateNotMatchRegexError', + 'errorMessage' => 'Invalid administrator ID card expiration time format.', + ], + [ + 'errorCode' => 'AdminIdcardFrontFaceFileError', + 'errorMessage' => 'Invalid format for administrator\'s ID card national emblem photo.', + ], + [ + 'errorCode' => 'AdminIdcardFrontFaceNullError', + 'errorMessage' => 'Administrator\'s ID card national emblem photo cannot be empty.', + ], + [ + 'errorCode' => 'AdminIdcardNoNullError', + 'errorMessage' => 'Administrator\'s ID number cannot be empty.', + ], + [ + 'errorCode' => 'AdminIdcardNotMatchRegex', + 'errorMessage' => 'Invalid administrator ID number format.', + ], + [ + 'errorCode' => 'AdminIdcardPicsFileError', + 'errorMessage' => 'Invalid format for administrator\'s ID card portrait photo.', + ], + [ + 'errorCode' => 'AdminIdcardPicsNullError', + 'errorMessage' => 'Administrator\'s ID card portrait photo cannot be empty.', + ], + [ + 'errorCode' => 'AdminIdcardTypeError', + 'errorMessage' => 'Invalid administrator ID card type.', + ], + [ + 'errorCode' => 'AdminNameNullError', + 'errorMessage' => 'Administrator\'s name cannot be empty.', + ], + [ + 'errorCode' => 'BusinessLicenseDateNotMatchRegexError', + 'errorMessage' => 'Invalid business license expiration time format.', + ], + [ + 'errorCode' => 'BusinessLicenseDateNotValid', + 'errorMessage' => 'Current time is outside the business license validity period.', + ], + [ + 'errorCode' => 'BusinessLicenseOssFileNotUploadError', + 'errorMessage' => 'Business license file not uploaded.', + ], + [ + 'errorCode' => 'BusinessLicensePicsFileError', + 'errorMessage' => 'Invalid business license file format.', + ], + [ + 'errorCode' => 'BusinessLicensePicsNullError', + 'errorMessage' => 'Business license documents cannot be empty.', + ], + [ + 'errorCode' => 'BusinessLicenseTypeError', + 'errorMessage' => 'Invalid business license type.', + ], + [ + 'errorCode' => 'CertifyCodeError', + 'errorMessage' => 'SMS verification code is incorrect.', + ], + [ + 'errorCode' => 'CompanyNameNullError', + 'errorMessage' => 'Company name cannot be empty.', + ], + [ + 'errorCode' => 'CompanyTypeError', + 'errorMessage' => 'Invalid company type.', + ], + [ + 'errorCode' => 'QualificationNameNullError', + 'errorMessage' => 'Qualification name cannot be empty.', + ], + [ + 'errorCode' => 'QualificationNameNotMatchRegex', + 'errorMessage' => 'Qualification names must be in Chinese, English, or alphanumeric combinations. Symbols or pure numbers are not supported.', + ], + [ + 'errorCode' => 'QualificationNameAlreadyExist', + 'errorMessage' => 'The qualification name already exists. Please modify and resubmit.', + ], + [ + 'errorCode' => 'OtherFileTypeError', + 'errorMessage' => 'Invalid file format for other documents.', + ], + [ + 'errorCode' => 'LegalPersonIdcardTypeError', + 'errorMessage' => 'Invalid legal person ID card type.', + ], + [ + 'errorCode' => 'LegalIdCardNoNullError', + 'errorMessage' => 'Legal person\'s ID number cannot be empty.', + ], + [ + 'errorCode' => 'LegalIdCardNotMatchRegex', + 'errorMessage' => 'Invalid legal person ID number format.', + ], + [ + 'errorCode' => 'LegalPersonNameNullError', + 'errorMessage' => 'Legal person\'s name cannot be empty.', + ], + [ + 'errorCode' => 'OrganizationCodeNullError', + 'errorMessage' => 'Unified Social Credit Code cannot be empty.', + ], + [ + 'errorCode' => 'LegalPersonIdcardEfftimeNotMatchRegexError', + 'errorMessage' => 'Invalid legal person ID card expiration time format.', + ], + [ + 'errorCode' => 'LegalDateNotValid', + 'errorMessage' => 'Current time is outside the legal person ID card validity period.', + ], + [ + 'errorCode' => 'LegalFrontOssFileNotUploadError', + 'errorMessage' => 'Legal person ID card national emblem photo not uploaded.', + ], + [ + 'errorCode' => 'LegalBackOssFileNotUploadError', + 'errorMessage' => 'Legal person ID card portrait photo not uploaded.', + ], + [ + 'errorCode' => 'AdminFrontOssFileNotUploadError', + 'errorMessage' => 'Administrator ID card national emblem photo not uploaded.', + ], + [ + 'errorCode' => 'OtherOssFileNotUploadError', + 'errorMessage' => 'Other files not uploaded.', + ], + [ + 'errorCode' => 'GrayCustAccessError', + 'errorMessage' => 'This customer is not authorized to use the OpenAPI. Please contact support for whitelisting.', + ], + [ + 'errorCode' => 'CustNotExistError', + 'errorMessage' => 'Customer\'s cloud communication information is invalid.', + ], + [ + 'errorCode' => 'NotEnterpriseCertifyCustCheckError', + 'errorMessage' => 'Non-enterprise certified customers are not allowed to access.', + ], + [ + 'errorCode' => 'PhoneNoCertifyCodeNullError', + 'errorMessage' => 'Phone number and verification code cannot be empty.', + ], + [ + 'errorCode' => 'CompanyVerificationFailedCompanyStateInvalid', + 'errorMessage' => 'Four Elements Verification Failed: Company is not in normal operation.', + ], + [ + 'errorCode' => 'CompanyVerificationFailedFourElementsError', + 'errorMessage' => 'Four Elements Verification Failed: Authentication Failed.', + ], + [ + 'errorCode' => 'CompanyVerificationFailedMismatch', + 'errorMessage' => 'Four Elements Verification Failed: Mismatch between Legal Representative and Company Information.', + ], + [ + 'errorCode' => 'CompanyVerificationFailedNoCompany', + 'errorMessage' => 'Four Elements Verification Failed: Company Not Found.', + ], + [ + 'errorCode' => 'CompanyVerificationFailedNoLegalPerson', + 'errorMessage' => 'Four Elements Verification Failed: Legal Representative Not Found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"25D5AFDE-8EBC-132E-8909-1FDC071DA\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"1000****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'QuerySmsQualificationRecord' => [ + 'summary' => '查询资质审核列表页', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264880', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + 'FEATUREdysms2H0K7P', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'QualificationGroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '资质组名称', + 'description' => '资质组名称', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'CompanyName', + 'in' => 'query', + 'schema' => [ + 'title' => '公司名', + 'description' => '公司名', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'title' => '审核状态。INT:审核中FAILED:审核失败,PASSED:审核通过,NOT_FINISH:资料待补充,CANCELED:已撤回', + 'description' => '审核状态。INT:审核中FAILED:审核失败,PASSED:审核通过,NOT_FINISH:资料待补充,CANCELED:已撤回', + 'type' => 'string', + 'required' => false, + 'example' => 'PASSED', + ], + ], + [ + 'name' => 'WorkOrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '工单ID', + 'description' => '工单ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2001****', + ], + ], + [ + 'name' => 'LegalPersonName', + 'in' => 'query', + 'schema' => [ + 'title' => '法人姓名', + 'description' => '法人姓名', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'UseBySelf', + 'in' => 'query', + 'schema' => [ + 'title' => '是否自用', + 'description' => '是否自用', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Total' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '25', + ], + 'PageNo' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'List' => [ + 'title' => '', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LegalPersonName' => [ + 'title' => '法人名称', + 'description' => '法人名称', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'AuditRemark' => [ + 'title' => '审核备注', + 'description' => '审核备注', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'CompanyName' => [ + 'title' => '公司名称或实人认证姓名', + 'description' => '公司名称或实人认证姓名', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'WorkOrderId' => [ + 'title' => '工单ID', + 'description' => '工单ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2001****', + ], + 'StateName' => [ + 'title' => '审核状态名', + 'description' => '审核状态名', + 'type' => 'string', + 'example' => 'INT', + ], + 'AuditTime' => [ + 'title' => '审核时间', + 'description' => '审核时间', + 'type' => 'string', + 'example' => '2024-12-26 17:29:04', + ], + 'CreateDate' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '2025-02-20 11:59:30', + ], + 'QualificationGroupName' => [ + 'title' => '资质组名称', + 'description' => '资质组名称', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'GroupId' => [ + 'title' => '资质组ID', + 'description' => '资质组ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000****', + ], + 'UseBySelf' => [ + 'title' => '是否自用', + 'description' => '是否自用', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'example' => '', + ], + ], + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"25D5AFDE-8EBC-132E-8909-1FDC071DA\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"PageSize\\": 20,\\n \\"Total\\": 25,\\n \\"PageNo\\": 1,\\n \\"List\\": [\\n {\\n \\"LegalPersonName\\": \\"李华\\",\\n \\"AuditRemark\\": \\"无\\",\\n \\"CompanyName\\": \\"阿里云云通信有限公司\\",\\n \\"WorkOrderId\\": 0,\\n \\"StateName\\": \\"INIT\\",\\n \\"AuditTime\\": \\"2024-12-26 17:29:04\\",\\n \\"CreateDate\\": \\"2025-02-20 11:59:30\\",\\n \\"QualificationGroupName\\": \\"阿里云云通信有限公司李华\\",\\n \\"GroupId\\": 0,\\n \\"UseBySelf\\": \\"true\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'QuerySingleSmsQualification' => [ + 'summary' => '查询单个资质详情', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264878', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'QualificationGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '资质id', + 'description' => '资质id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000****', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '工单id', + 'description' => '工单id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2001****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AdminIDCardExpDate' => [ + 'title' => '经办人身份证有效期', + 'description' => '经办人身份证有效期', + 'type' => 'string', + 'example' => '2023-01-01~2033-01-01', + ], + 'BusinessType' => [ + 'title' => '行业类型，在当前模式下是可以用产品线code来区分', + 'description' => '行业类型，在当前模式下是可以用产品线code来区分', + 'type' => 'string', + 'example' => 'dysms', + ], + 'AdminIDCardFrontFace' => [ + 'title' => '经办人身份证国徽面，产品需求，要求身份证可以分正反面上传', + 'description' => '经办人身份证国徽面，产品需求，要求身份证可以分正反面上传', + 'type' => 'string', + 'example' => 'https://******.aliyuncs.com/******', + ], + 'Remark' => [ + 'title' => '备注', + 'description' => '备注', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'LegalPersonName' => [ + 'title' => '法人姓名', + 'description' => '法人姓名', + 'type' => 'string', + 'example' => '示例值', + ], + 'CompanyName' => [ + 'title' => '公司名称', + 'description' => '公司名称', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'LegalPersonIDCardNo' => [ + 'title' => '法人身份证号码', + 'description' => '法人身份证号码', + 'type' => 'string', + 'example' => '511391********5123'."\n", + ], + 'BusinessLicensePics' => [ + 'title' => '证件信息', + 'description' => '证件信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'businessLicense', + ], + 'LicensePic' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '123456/111.png', + ], + 'PicUrl' => [ + 'title' => '文件的完整路径', + 'description' => '文件的完整路径', + 'type' => 'string', + 'example' => 'https://******.aliyuncs.com/******'."\n", + ], + ], + ], + 'example' => '', + ], + 'AdminIDCardNo' => [ + 'title' => '经办人身份证号码', + 'description' => '经办人身份证号码', + 'type' => 'string', + 'example' => '511391********5123', + ], + 'OrganizationCode' => [ + 'title' => '社会统一信用代码', + 'description' => '社会统一信用代码', + 'type' => 'string', + 'example' => '910X********0012'."\n", + ], + 'LegalPersonIdCardEffTime' => [ + 'title' => '法人身份证有效期', + 'description' => '法人身份证有效期', + 'type' => 'string', + 'example' => '2023-01-01~2033-01-01', + ], + 'AdminPhoneNo' => [ + 'title' => '经办人手机号码', + 'description' => '经办人手机号码', + 'type' => 'string', + 'example' => '137*******', + ], + 'QualificationName' => [ + 'title' => '资质名称', + 'description' => '资质名称', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'AdminName' => [ + 'title' => '经办人姓名', + 'description' => '经办人姓名', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'CompanyType' => [ + 'title' => '企业类型, COMPANY:公司，政府或者事业单位:NON_PROFIT_ORGANIZATION', + 'description' => '企业类型, COMPANY:公司，政府或者事业单位:NON_PROFIT_ORGANIZATION', + 'type' => 'string', + 'example' => 'COMPANY', + ], + 'AdminIDCardType' => [ + 'title' => '管理员身份证类型', + 'description' => '管理员身份证类型', + 'type' => 'string', + 'example' => 'identityCard', + ], + 'UseBySelf' => [ + 'title' => '是否自用', + 'description' => '是否自用', + 'type' => 'boolean', + 'example' => 'false', + ], + 'EffTimeStr' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '2023-01-01~2033-01-01'."\n", + ], + 'QualificationGroupId' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000****', + ], + 'WhetherShare' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'WorkOrderId' => [ + 'title' => '乾坤袋工单ID', + 'description' => '乾坤袋工单ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2001****', + ], + 'State' => [ + 'title' => '当前审核状态', + 'description' => '当前审核状态', + 'type' => 'string', + 'enumValueTitles' => [ + 'NOT_FINISH' => '', + 'FAILED' => '', + 'CANCELED' => '', + 'INT' => '', + 'PASSED' => '', + ], + 'example' => 'PASSED', + ], + 'OtherFiles' => [ + 'title' => '更多资料', + 'description' => '更多资料', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LicensePic' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '123456/111.png', + ], + 'PicUrl' => [ + 'title' => '文件的完整路径', + 'description' => '文件的完整路径', + 'type' => 'string', + 'example' => 'https://******.aliyuncs.com/******', + ], + ], + ], + 'example' => '', + ], + 'LegalPersonIDCardType' => [ + 'title' => '法人身份证类型', + 'description' => '法人身份证类型', + 'type' => 'string', + 'example' => 'identityCard', + ], + 'AdminIDCardPic' => [ + 'title' => '经办人身份证图片地址，正反面合一', + 'description' => '经办人身份证图片地址，正反面合一', + 'type' => 'string', + 'example' => 'https://******.aliyuncs.com/******', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"25D5AFDE-8EBC-132E-8909-1FDC071DA\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"AdminIDCardExpDate\\": \\"2023-01-01~2033-01-01\\",\\n \\"BusinessType\\": \\"dysms\\",\\n \\"AdminIDCardFrontFace\\": \\"https://******.aliyuncs.com/******\\",\\n \\"Remark\\": \\"无\\",\\n \\"LegalPersonName\\": \\"李华\\",\\n \\"CompanyName\\": \\"阿里云云通信有限公司\\",\\n \\"LegalPersonIDCardNo\\": \\"511391********5123\\\\n\\",\\n \\"BusinessLicensePics\\": [\\n {\\n \\"Type\\": \\"businessLicense\\",\\n \\"LicensePic\\": \\"123456/111.png\\",\\n \\"PicUrl\\": \\"https://******.aliyuncs.com/******\\\\n\\"\\n }\\n ],\\n \\"AdminIDCardNo\\": \\"511391********5123\\",\\n \\"OrganizationCode\\": \\"910X********0012\\\\n\\",\\n \\"LegalPersonIdCardEffTime\\": \\"2023-01-01~2033-01-01\\",\\n \\"AdminPhoneNo\\": \\"137*******\\",\\n \\"QualificationName\\": \\"阿里云云通信有限公司资质李华\\\\n\\",\\n \\"AdminName\\": \\"李华\\",\\n \\"CompanyType\\": \\"COMPANY\\",\\n \\"AdminIDCardType\\": \\"identityCard\\",\\n \\"UseBySelf\\": false,\\n \\"EffTimeStr\\": \\"2023-01-01~2033-01-01\\\\n\\",\\n \\"QualificationGroupId\\": 0,\\n \\"WhetherShare\\": false,\\n \\"WorkOrderId\\": 0,\\n \\"State\\": \\"PASSED\\",\\n \\"OtherFiles\\": [\\n {\\n \\"LicensePic\\": \\"123456/111.png\\",\\n \\"PicUrl\\": \\"https://******.aliyuncs.com/******\\"\\n }\\n ],\\n \\"LegalPersonIDCardType\\": \\"identityCard\\",\\n \\"AdminIDCardPic\\": \\"https://******.aliyuncs.com/******\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'UpdateSmsQualification' => [ + 'summary' => '修改资质对客openAPI', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264875', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'QualificationGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '资质组ID', + 'description' => '资质组ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000****', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '工单ID', + 'description' => '工单ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2001*****', + ], + ], + [ + 'name' => 'BusinessLicensePics', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '企业证件信息', + 'description' => '企业证件信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '企业证件类型，businessLicense:营业执照;organizationCodeLicense:组织机构代码证;taxRegistrationLicense:税务登记证;socialCreditLicense:社会信用代码证书;newStyleBusinessLicense:三证合一;signLegalLicense:签名归属方的事业单位法人证书;otherLicense:其他类型执照证书', + 'description' => '企业证件类型，businessLicense:营业执照;organizationCodeLicense:组织机构代码证;taxRegistrationLicense:税务登记证;socialCreditLicense:社会信用代码证书;newStyleBusinessLicense:三证合一;signLegalLicense:签名归属方的事业单位法人证书;otherLicense:其他类型执照证书', + 'type' => 'string', + 'required' => false, + 'example' => 'businessLicense', + ], + 'LicensePic' => [ + 'title' => '证件图片标识的osskey', + 'description' => '证件图片标识的osskey', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CompanyName', + 'in' => 'query', + 'schema' => [ + 'title' => '公司名称', + 'description' => '公司名称', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'BussinessLicenseExpDate', + 'in' => 'query', + 'schema' => [ + 'title' => '企业营业时间开始和结束字符串，格式示例2023-01-01~2033-01-01', + 'description' => '企业营业时间开始和结束字符串，格式示例2023-01-01~2033-01-01', + 'type' => 'string', + 'required' => false, + 'example' => '2023-01-01~2033-01-01', + ], + ], + [ + 'name' => 'LegalPersonIdCardFrontSide', + 'in' => 'query', + 'schema' => [ + 'title' => '法人身份照片证国徽面', + 'description' => '法人身份照片证国徽面', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png'."\n", + ], + ], + [ + 'name' => 'LegalPersonIdCardBackSide', + 'in' => 'query', + 'schema' => [ + 'title' => '法人身份证照片人像面', + 'description' => '法人身份证照片人像面', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png'."\n", + ], + ], + [ + 'name' => 'LegalPersonName', + 'in' => 'query', + 'schema' => [ + 'title' => '法人姓名', + 'description' => '法人姓名', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'LegalPersonIDCardNo', + 'in' => 'query', + 'schema' => [ + 'title' => '法人身份证号码', + 'description' => '法人身份证号码', + 'type' => 'string', + 'required' => false, + 'example' => ' '."\n" + .'511391********5123'."\n", + ], + ], + [ + 'name' => 'LegalPersonIdCardEffTime', + 'in' => 'query', + 'schema' => [ + 'title' => '法人身份证有效期，格式示例2023-01-01~2033-01-01', + 'description' => '法人身份证有效期，格式示例2023-01-01~2033-01-01', + 'type' => 'string', + 'required' => false, + 'example' => '2023-01-01~2033-01-01', + ], + ], + [ + 'name' => 'LegalPersonIDCardType', + 'in' => 'query', + 'schema' => [ + 'title' => '法人身份证类型。identityCard:中国居民身份证;passport:护照;homeReturnPermit:港澳居民来往内地通行证;TaiwanCompatriotPermit:台湾居民来往大陆通行证;residencePermit:港澳台居民居住证";other:其他', + 'description' => '法人身份证类型。identityCard:中国居民身份证;passport:护照;homeReturnPermit:港澳居民来往内地通行证;TaiwanCompatriotPermit:台湾居民来往大陆通行证;residencePermit:港澳台居民居住证";other:其他', + 'type' => 'string', + 'required' => false, + 'example' => 'identityCard', + ], + ], + [ + 'name' => 'AdminIDCardPic', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人身份证照片人像面', + 'description' => '经办人身份证照片人像面', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png'."\n", + ], + ], + [ + 'name' => 'AdminIDCardFrontFace', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人身份证照片国徽面', + 'description' => '经办人身份证照片国徽面', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png'."\n", + ], + ], + [ + 'name' => 'AdminName', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人姓名', + 'description' => '经办人姓名', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'AdminIDCardNo', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人身份证号码', + 'description' => '经办人身份证号码', + 'type' => 'string', + 'required' => false, + 'example' => '511391********5123'."\n", + ], + ], + [ + 'name' => 'AdminIDCardExpDate', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人身份证有效期，格式示例2023-01-01~2033-01-01', + 'description' => '经办人身份证有效期，格式示例2023-01-01~2033-01-01', + 'type' => 'string', + 'required' => false, + 'example' => '2023-01-01~2033-01-01'."\n" + ."\n", + ], + ], + [ + 'name' => 'AdminPhoneNo', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人手机号码', + 'description' => '经办人手机号码', + 'type' => 'string', + 'required' => true, + 'example' => '137********', + ], + ], + [ + 'name' => 'CertifyCode', + 'in' => 'query', + 'schema' => [ + 'title' => '手机号验证码', + 'description' => '手机号验证码', + 'type' => 'string', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'AdminIDCardType', + 'in' => 'query', + 'schema' => [ + 'title' => '管理员身份证类型。identityCard:中国居民身份证;passport:护照;homeReturnPermit:港澳居民来往内地通行证;TaiwanCompatriotPermit:台湾居民来往大陆通行证;residencePermit:港澳台居民居住证";other:其他', + 'description' => '管理员身份证类型。identityCard:中国居民身份证;passport:护照;homeReturnPermit:港澳居民来往内地通行证;TaiwanCompatriotPermit:台湾居民来往大陆通行证;residencePermit:港澳台居民居住证";other:其他', + 'type' => 'string', + 'required' => false, + 'example' => 'identityCard', + ], + ], + [ + 'name' => 'OtherFiles', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '更多资料', + 'description' => '更多资料', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LicensePic' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '10000****', + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'QualificationNameNullError', + 'errorMessage' => 'Qualification name cannot be empty.', + ], + [ + 'errorCode' => 'BusinessLicensePicsNullError', + 'errorMessage' => 'Business license documents cannot be empty.', + ], + [ + 'errorCode' => 'OtherFileTypeError', + 'errorMessage' => 'Invalid file format for other documents.', + ], + [ + 'errorCode' => 'QualificationNameAlreadyExist', + 'errorMessage' => 'The qualification name already exists. Please modify and resubmit.', + ], + [ + 'errorCode' => 'QualificationNameNotMatchRegex', + 'errorMessage' => 'Qualification names must be in Chinese, English, or alphanumeric combinations. Symbols or pure numbers are not supported.', + ], + [ + 'errorCode' => 'AdminIdcardTypeError', + 'errorMessage' => 'Invalid administrator ID card type.', + ], + [ + 'errorCode' => 'BusinessLicensePicsFileError', + 'errorMessage' => 'Invalid business license file format.', + ], + [ + 'errorCode' => 'BusinessLicenseTypeError', + 'errorMessage' => 'Invalid business license type.', + ], + [ + 'errorCode' => 'LegalIdCardNoNullError', + 'errorMessage' => 'Legal person\'s ID number cannot be empty.', + ], + [ + 'errorCode' => 'LegalPersonIdcardTypeError', + 'errorMessage' => 'Invalid legal person ID card type.', + ], + [ + 'errorCode' => 'CompanyNameNullError', + 'errorMessage' => 'Company name cannot be empty.', + ], + [ + 'errorCode' => 'CompanyTypeError', + 'errorMessage' => 'Invalid company type.', + ], + [ + 'errorCode' => 'LegalIdCardNotMatchRegex', + 'errorMessage' => 'Invalid legal person ID number format.', + ], + [ + 'errorCode' => 'LegalPersonNameNullError', + 'errorMessage' => 'Legal person\'s name cannot be empty.', + ], + [ + 'errorCode' => 'OrganizationCodeNullError', + 'errorMessage' => 'Unified Social Credit Code cannot be empty.', + ], + [ + 'errorCode' => 'AdminIdcardFrontFaceFileError', + 'errorMessage' => 'Invalid format for administrator\'s ID card national emblem photo.', + ], + [ + 'errorCode' => 'AdminIdcardFrontFaceNullError', + 'errorMessage' => 'Administrator\'s ID card national emblem photo cannot be empty.', + ], + [ + 'errorCode' => 'AdminIdcardPicsFileError', + 'errorMessage' => 'Invalid format for administrator\'s ID card portrait photo.', + ], + [ + 'errorCode' => 'AdminIdcardPicsNullError', + 'errorMessage' => 'Administrator\'s ID card portrait photo cannot be empty.', + ], + [ + 'errorCode' => 'AdminNameNullError', + 'errorMessage' => 'Administrator\'s name cannot be empty.', + ], + [ + 'errorCode' => 'AdminIdcardExpdateNotMatchRegexError', + 'errorMessage' => 'Invalid administrator ID card expiration time format.', + ], + [ + 'errorCode' => 'AdminIdcardNoNullError', + 'errorMessage' => 'Administrator\'s ID number cannot be empty.', + ], + [ + 'errorCode' => 'AdminIdcardNotMatchRegex', + 'errorMessage' => 'Invalid administrator ID number format.', + ], + [ + 'errorCode' => 'BusinessLicenseDateNotMatchRegexError', + 'errorMessage' => 'Invalid business license expiration time format.', + ], + [ + 'errorCode' => 'LegalPersonIdcardEfftimeNotMatchRegexError', + 'errorMessage' => 'Invalid legal person ID card expiration time format.', + ], + [ + 'errorCode' => 'AdminDateNotValid', + 'errorMessage' => 'Current time is outside the administrator ID card validity period.', + ], + [ + 'errorCode' => 'BusinessLicenseDateNotValid', + 'errorMessage' => 'Current time is outside the business license validity period.', + ], + [ + 'errorCode' => 'BusinessLicenseOssFileNotUploadError', + 'errorMessage' => 'Business license file not uploaded.', + ], + [ + 'errorCode' => 'LegalDateNotValid', + 'errorMessage' => 'Current time is outside the legal person ID card validity period.', + ], + [ + 'errorCode' => 'LegalFrontOssFileNotUploadError', + 'errorMessage' => 'Legal person ID card national emblem photo not uploaded.', + ], + [ + 'errorCode' => 'AdminBackOssFileNotUploadError', + 'errorMessage' => 'Administrator ID card portrait photo not uploaded.', + ], + [ + 'errorCode' => 'AdminFrontOssFileNotUploadError', + 'errorMessage' => 'Administrator ID card national emblem photo not uploaded.', + ], + [ + 'errorCode' => 'CustNotExistError', + 'errorMessage' => 'Customer\'s cloud communication information is invalid.', + ], + [ + 'errorCode' => 'GrayCustAccessError', + 'errorMessage' => 'This customer is not authorized to use the OpenAPI. Please contact support for whitelisting.', + ], + [ + 'errorCode' => 'LegalBackOssFileNotUploadError', + 'errorMessage' => 'Legal person ID card portrait photo not uploaded.', + ], + [ + 'errorCode' => 'OtherOssFileNotUploadError', + 'errorMessage' => 'Other files not uploaded.', + ], + [ + 'errorCode' => 'CertifyCodeError', + 'errorMessage' => 'SMS verification code is incorrect.', + ], + [ + 'errorCode' => 'NotEnterpriseCertifyCustCheckError', + 'errorMessage' => 'Non-enterprise certified customers are not allowed to access.', + ], + [ + 'errorCode' => 'PhoneNoCertifyCodeNullError', + 'errorMessage' => 'Phone number and verification code cannot be empty.', + ], + [ + 'errorCode' => 'SameQualificationGroupError', + 'errorMessage' => 'A qualification with the same company and administrator information already exists.', + ], + [ + 'errorCode' => 'WorkOrderIdExpired', + 'errorMessage' => 'Qualification details have changed. Please re-query the qualification list and resubmit.', + ], + [ + 'errorCode' => 'CompanyVerificationFailedCompanyStateInvalid', + 'errorMessage' => 'Four Elements Verification Failed: Company is not in normal operation.', + ], + [ + 'errorCode' => 'CompanyVerificationFailedFourElementsError', + 'errorMessage' => 'Four Elements Verification Failed: Authentication Failed.', + ], + [ + 'errorCode' => 'CompanyVerificationFailedMismatch', + 'errorMessage' => 'Four Elements Verification Failed: Mismatch between Legal Representative and Company Information.', + ], + [ + 'errorCode' => 'CompanyVerificationFailedNoCompany', + 'errorMessage' => 'Four Elements Verification Failed: Company Not Found.', + ], + [ + 'errorCode' => 'CompanyVerificationFailedNoLegalPerson', + 'errorMessage' => 'Four Elements Verification Failed: Legal Representative Not Found.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"25D5AFDE-8EBC-132E-8909-1FDC071DA\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"10000****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteSmsQualification' => [ + 'summary' => '删除资质对客openAPI', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264874', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'QualificationGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '资质组ID', + 'description' => '资质组ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000****', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '工单ID', + 'description' => '工单ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2001****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'QualificationNotExist', + 'errorMessage' => 'Qualification does not exist.', + ], + [ + 'errorCode' => 'BindSignDeleteFailed', + 'errorMessage' => 'The qualification is bound to a signature and cannot be deleted temporarily.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"25D5AFDE-8EBC-132E-8909-1FDC071DA\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'RequiredPhoneCode' => [ + 'summary' => '验证手机验证码', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264879', + 'abilityTreeNodes' => [ + 'FEATUREdysms59DLHO', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PhoneNo', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '137****1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'string', + 'example' => '-', + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"-\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ValidPhoneCode' => [ + 'summary' => '发送手机验证码', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264877', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'PhoneNo', + 'in' => 'query', + 'schema' => [ + 'title' => '手机号', + 'description' => '手机号', + 'type' => 'string', + 'required' => true, + 'example' => '137****1234', + ], + ], + [ + 'name' => 'CertifyCode', + 'in' => 'query', + 'schema' => [ + 'title' => '验证码', + 'description' => '验证码', + 'type' => 'string', + 'required' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"90E63D28-E31D-1EB2-8939-A9486641****\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": true,\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateSmsAuthorizationLetter' => [ + 'summary' => '创建委托授权书', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264691', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AuthorizationLetterPic', + 'in' => 'query', + 'schema' => [ + 'title' => '上传oss的委托授权书图片标识', + 'description' => '上传oss的委托授权书图片标识', + 'type' => 'string', + 'required' => true, + 'example' => '1000088*****/1234qfac.png', + ], + ], + [ + 'name' => 'SignList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '委托授权签名列表，签名数量限制100个以内', + 'description' => '委托授权签名列表，签名数量限制100个以内', + 'type' => 'array', + 'items' => [ + 'title' => '签名内容，签名长度限2-12个字符，不支持包含“测试”“test”【】[] 、，。括号和空格等特殊字符', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'AuthorizationLetterExpDate', + 'in' => 'query', + 'schema' => [ + 'title' => '委托授权书有效期', + 'description' => '委托授权书有效期', + 'type' => 'string', + 'required' => true, + 'example' => '2023-01-01~2026-01-01', + ], + ], + [ + 'name' => 'Authorization', + 'in' => 'query', + 'schema' => [ + 'title' => '授权方，授权方命名长度不超过1000个字符，暂不支持包含除中点（·）、空格、中文括号【】、英文括号()外的任何符号或纯数字输入', + 'description' => '授权方，授权方命名长度不超过1000个字符，暂不支持包含除中点（·）、空格、中文括号【】、英文括号()外的任何符号或纯数字输入', + 'type' => 'string', + 'required' => true, + 'example' => '阿里云有限公司', + ], + ], + [ + 'name' => 'OrganizationCode', + 'in' => 'query', + 'schema' => [ + 'title' => '授权方社会统一信用代码，长度不超过150个字符', + 'description' => '授权方社会统一信用代码，长度不超过150个字符', + 'type' => 'string', + 'required' => true, + 'example' => '9****************A', + ], + ], + [ + 'name' => 'ProxyAuthorization', + 'in' => 'query', + 'schema' => [ + 'title' => '被授权方，被授权方命名长度不超过1000个字符，暂不支持包含除中点（·）、空格、中文括号【】、英文括号()外的任何符号或纯数字输入', + 'description' => '被授权方，被授权方命名长度不超过1000个字符，暂不支持包含除中点（·）、空格、中文括号【】、英文括号()外的任何符号或纯数字输入', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx公司', + ], + ], + [ + 'name' => 'AuthorizationLetterName', + 'in' => 'query', + 'schema' => [ + 'title' => '委托授权书命名非空，不超过100个字符，支持中文、英文或与数字组合进行命名，暂不支持任何符号或纯数字输入', + 'description' => '委托授权书命名非空，不超过100个字符，支持中文、英文或与数字组合进行命名，暂不支持任何符号或纯数字输入', + 'type' => 'string', + 'required' => true, + 'example' => 'xxx公司授权书', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '10000****', + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AuthorizationLetterNameRepeat', + 'errorMessage' => 'The authorization letter name is duplicated.', + ], + [ + 'errorCode' => 'AuthorizationLetterDateNotMatchRegex', + 'errorMessage' => 'The format of the authorization letter\'s effective and expiry date is incorrect.', + ], + [ + 'errorCode' => 'AuthorizationLetterDateNotValid', + 'errorMessage' => 'The current time is not within the validity period of the authorization letter.', + ], + [ + 'errorCode' => 'AuthorizationLetterNameNotMatchRegex', + 'errorMessage' => 'The authorization letter name cannot be empty and must consist of Chinese, English characters or a combination with numbers, symbols or purely numeric input are not supported.', + ], + [ + 'errorCode' => 'AuthorizationLetterNameOverLimit', + 'errorMessage' => 'The authorization letter name exceeds the 100-character length limit.', + ], + [ + 'errorCode' => 'AuthorizationNotMatchRegex', + 'errorMessage' => 'The authorizer name cannot be empty and currently does not support any symbols except middle dots, spaces, Chinese brackets, and English parentheses or purely numeric input.', + ], + [ + 'errorCode' => 'AuthorizationOssFileNotUploadError', + 'errorMessage' => 'The authorization letter file has not been uploaded.', + ], + [ + 'errorCode' => 'AuthorizationOverLimit', + 'errorMessage' => 'The authorizer exceeds the 1000-character length limit.', + ], + [ + 'errorCode' => 'ProxyAuthorizationOverLimit', + 'errorMessage' => 'The authorized party exceeds the 1000-character length limit.', + ], + [ + 'errorCode' => 'ProxyAuthorizationNotMatchRegex', + 'errorMessage' => 'The authorized party name currently does not support any symbols except middle dots, spaces, Chinese brackets, and English parentheses or purely numeric input.', + ], + [ + 'errorCode' => 'SignNumOverLimit', + 'errorMessage' => 'The signature exceeds the limit of 100 entries.', + ], + [ + 'errorCode' => 'SignNotMatchRegex', + 'errorMessage' => 'The signature length is limited to 2-12 characters and does not support some special characters.', + ], + [ + 'errorCode' => 'OrganizationCodeOverLimit', + 'errorMessage' => 'The organization code is limited to 150 characters.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"10000****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'QuerySmsAuthorizationLetter' => [ + 'summary' => '查询委托授权书', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264690', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'AuthorizationLetterIdList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '委托授权书id列表', + 'description' => '委托授权书id列表', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000*****', + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'title' => '签名名称（支持命中签名范围查询）', + 'description' => '签名名称（支持命中签名范围查询）', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'OrganizationCode', + 'in' => 'query', + 'schema' => [ + 'title' => '授权方社会统一信用代码', + 'description' => '授权方社会统一信用代码', + 'type' => 'string', + 'required' => false, + 'example' => '9****************A', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'title' => '授权书审核状态，INT:审核中，PASSED:审核通过', + 'description' => '授权书审核状态，INT:审核中，PASSED:审核通过', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'INT' => '', + 'PASSED' => '', + ], + 'example' => 'PASSED', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '授权书可用状态，VALID可用，INVALID不可用', + 'description' => '授权书可用状态，VALID可用，INVALID不可用', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'VALID' => '', + 'INVALID' => '', + ], + 'example' => 'VALID', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071D', + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Authorization' => [ + 'title' => '委托授权方', + 'description' => '委托授权方', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Status' => [ + 'title' => '委托授权书可用状态（可用VALID/不可用INVALID）', + 'description' => '委托授权书可用状态（可用VALID/不可用INVALID）', + 'type' => 'string', + 'example' => 'VALID', + ], + 'SignScope' => [ + 'title' => '委托授权签名范围', + 'description' => '委托授权签名范围', + 'type' => 'string', + 'example' => '示例值', + ], + 'State' => [ + 'title' => '委托授权书审核状态（初始化INT/审核通过PASSED）', + 'description' => '委托授权书审核状态（初始化INT/审核通过PASSED）', + 'type' => 'string', + 'example' => 'PASSED', + ], + 'AuthorizationLetterExpDate' => [ + 'title' => '委托授权书有效期', + 'description' => '委托授权书有效期', + 'type' => 'string', + 'example' => '2023-01-01~2026-01-01', + ], + 'AuthorizationLetterPic' => [ + 'title' => '委托授权书图片地址', + 'description' => '委托授权书图片地址', + 'type' => 'string', + 'example' => '1000045****/111.png', + ], + 'OrganizationCode' => [ + 'title' => '授权方统一社会信用代码', + 'description' => '授权方统一社会信用代码', + 'type' => 'string', + 'example' => '9****************A', + ], + 'ProxyAuthorization' => [ + 'title' => '被委托授权方', + 'description' => '被委托授权方', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'AuthorizationLetterId' => [ + 'title' => '委托授权书id', + 'description' => '委托授权书id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000******', + ], + 'AuthorizationLetterName' => [ + 'title' => '委托授权书命名', + 'description' => '委托授权书命名', + 'type' => 'string', + 'example' => '示例值示例值', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"25D5AFDE-8EBC-132E-8909-1FDC071D\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"Authorization\\": \\"菜鸟网络科技有限公司\\",\\n \\"Status\\": \\"VALID\\",\\n \\"SignScope\\": \\"菜鸟网络、菜鸟驿站、菜鸟裹裹\\",\\n \\"State\\": \\"PASSED\\",\\n \\"AuthorizationLetterExpDate\\": \\"2023-01-01~2026-01-01\\",\\n \\"AuthorizationLetterPic\\": \\"1000045****/111.png\\",\\n \\"OrganizationCode\\": \\"9****************A\\",\\n \\"ProxyAuthorization\\": \\"支付宝（中国）网络技术有限公司\\",\\n \\"AuthorizationLetterId\\": 0,\\n \\"AuthorizationLetterName\\": \\"菜鸟公司授权书\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateSmsSign' => [ + 'summary' => 'Create SMS Signature', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218492', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Signature name. Please adhere to the [Signature Specifications](https://help.aliyun.com/zh/sms/user-guide/signature-specifications-1?spm=a2c4g.11186623.0.0.4f9710fder2gR7#section-0p8-qn8-mmy).'."\n" + ."\n" + .'> - Signature names are case-insensitive; e.g., 【Aliyun Communication】 and 【aliyun communication】 are considered identical.'."\n" + .'> - If your verification code signature and general signature names are the same, the system defaults to using the general signature for sending SMS messages.', + 'type' => 'string', + 'required' => true, + 'example' => 'Aliyun', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'Explanation of the SMS signature scenario, with a maximum length of 200 characters.'."\n" + ."\n" + .'> The scenario explanation is one of the reference materials for signature review. Please provide a detailed description of the usage scenarios for your live services, along with links to verify these services such as website URLs with MIIT备案, app store display links, full names of public accounts or mini-programs, etc. For login scenarios, test account credentials are also required. A comprehensive application explanation enhances the efficiency of signature and template reviews. Refer to the **Application Scenario** column in the [Signature Source](https://help.aliyun.com/zh/sms/user-guide/signature-specifications-1?spm=a2c4g.11186623.0.i2#section-xup-k46-yi4) table for filling in SMS scenarios.', + 'type' => 'string', + 'required' => false, + 'example' => 'SMS signature for the login scenario using verification code.', + 'maxLength' => 500, + ], + ], + [ + 'name' => 'SignType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Signature type. Values:'."\n" + ."\n" + .'- **0**: Verification Code'."\n" + ."\n" + .'- **1**: General (Default)'."\n" + ."\n" + .'> It is recommended to use the default value: **General**.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'MoreData', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Additional information to supplement uploaded business proof documents or screenshots, which helps reviewers understand your business details.'."\n" + ."\n" + .'This parameter is optional; please fill it out based on your actual needs.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about files uploaded to OSS.'."\n" + .'For file upload operations, refer to [Upload Files via OSS](https://help.aliyun.com/zh/sms/upload-files-through-oss).', + 'type' => 'string', + 'required' => false, + 'example' => '10098689758*****/1234qwe.png', + ], + 'required' => false, + ], + ], + [ + 'name' => 'QualificationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Approved or under-review qualification ID.'."\n" + ."\n" + .'> - Before applying for an SMS signature, please first [Apply for Qualification](https://help.aliyun.com/zh/sms/user-guide/new-qualification?spm=a2c4g.11186623.0.0.718d187bbkpMRK).'."\n" + .'> - You can view the qualification ID on the [Qualification Management](https://dysms.console.aliyun.com/domestic/text/qualification) page.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '8563**', + ], + ], + [ + 'name' => 'ApplySceneContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'Application scenarios, instructions as follows:'."\n" + .'- For registered websites, enter the domain name with HTTP or HTTPS that has been registered with the MIIT.'."\n" + ."\n" + .'- For launched apps, provide a display link from the app store with HTTP or HTTPS, ensuring the app is online.'."\n" + ."\n" + .'- For public accounts or mini-programs, input the full name, ensuring they are online.'."\n" + ."\n" + .'- For e-commerce platform store names, applicable only to enterprise users, provide a display link with HTTP or HTTPS for the store.', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com/', + ], + ], + [ + 'name' => 'SignSource', + 'in' => 'query', + 'schema' => [ + 'description' => 'Signature source. Values:'."\n" + ."\n" + .'- **0**: Full name or abbreviation of an enterprise or institution.'."\n" + .'- **1**: Full name or abbreviation of a MIIT-registered website.'."\n" + .'- **2**: Full name or abbreviation of an App.'."\n" + .'- **3**: Full name or abbreviation of an official account or mini-program.'."\n" + .'- **4**: Full name or abbreviation of an e-commerce platform store.'."\n" + .'- **5**: Full name or abbreviation of a trademark.'."\n" + ."\n" + .'For detailed information on signature sources, refer to [Signature Source](https://help.aliyun.com/zh/sms/user-guide/signature-specifications-1?spm=a2c4g.11186623.0.0.4f9710fder2gR7#section-xup-k46-yi4).'."\n" + ."\n" + .'> This interface does not support applying for signatures with sources as **Test or Learning** and **Trial Use**. If you need to apply for signatures with these sources, please go to the [SMS Service Console](https://dysms.console.aliyun.com/domestic/text/sign/add/qualification).', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'enum' => [ + '0', + '1', + '2', + '3', + '4', + '5', + ], + ], + ], + [ + 'name' => 'ThirdParty', + 'in' => 'query', + 'schema' => [ + 'description' => 'Choose whether the applied signature is for self-use or third-party use.'."\n" + ."\n" + .'- false: Self-use (default)'."\n" + ."\n" + .'- true: Third-party use'."\n" + .'><notice>Please select self-use qualification ID when the signature is for self-use; choose third-party use qualification ID when it\'s for third-party use.></notice>', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'AuthorizationLetterId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'TrademarkId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'AppIcpRecordId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and issue localization.', + 'type' => 'string', + 'example' => 'CCA2BCFF-2BA7-427C-90EE-AC6994748607', + ], + 'Code' => [ + 'description' => 'Request status code.'."\n" + ."\n" + .'- OK indicates a successful request.'."\n" + .'- For other error codes, refer to the [Error Code List](~~101346~~).', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'Description of the status code.', + 'type' => 'string', + 'example' => 'successful', + ], + 'SignName' => [ + 'description' => 'Signature name.', + 'type' => 'string', + 'example' => 'Aliyun', + ], + 'OrderId' => [ + 'description' => 'Work order number.'."\n" + ."\n" + .'This parameter is used by auditors when querying the audit. You will need to provide this work order number if you require expedited review.', + 'type' => 'string', + 'example' => '2004415****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + [ + 'errorCode' => 'ParameterMismatch.ThirdParty', + 'errorMessage' => 'The type of signature, whether for personal use or for a third party, should be consistent with the qualifications.', + ], + [ + 'errorCode' => 'SignName.Exists', + 'errorMessage' => 'Sorry, this signature already exists and cannot be applied for again.', + ], + [ + 'errorCode' => 'InvalidQualification', + 'errorMessage' => 'The qualification should be approved.', + ], + [ + 'errorCode' => 'InvalidSignName', + 'errorMessage' => 'The signature cannot contain spaces, special '."\n" + .'symbols, or all numbers.', + ], + [ + 'errorCode' => 'InvalidApplySceneContent', + 'errorMessage' => 'For certain signature sources, the '."\n" + .'applySceneContent should be an HTTP or HTTPS link.', + ], + [ + 'errorCode' => 'MissApplySceneContent', + 'errorMessage' => 'In some signature sources, the applySceneContent is required.', + ], + [ + 'errorCode' => 'MissingSignName', + 'errorMessage' => 'The signature name cannot be empty.', + ], + [ + 'errorCode' => 'SmsAuthorizationLetterNotMatch', + 'errorMessage' => 'Please bind the available authorization letter whose the social credit code is same to the the social credit code of qualification.', + ], + [ + 'errorCode' => 'SmsAuthorizationLetterNotExist', + 'errorMessage' => 'Authorization does not belong to the customer.', + ], + [ + 'errorCode' => 'SmsSignNotAuthorized', + 'errorMessage' => 'the signature is not in the sign scope of the authorization letter.', + ], + [ + 'errorCode' => 'TrademarkNotExist', + 'errorMessage' => 'The trademark does not exist.', + ], + [ + 'errorCode' => 'AppIcpRecordNotExist', + 'errorMessage' => 'The APP-ICP record does not exist.', + ], + ], + 404 => [ + [ + 'errorCode' => 'QualificationNotFound', + 'errorMessage' => 'Qualification does not exist.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CCA2BCFF-2BA7-427C-90EE-AC6994748623\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"SignName\\": \\"阿里云\\",\\n \\"OrderId\\": \\"2004415****\\"\\n}","type":"json"}]', + 'title' => 'Apply for SMS Signature (New Interface)', + 'description' => '- For details about the announcement of changes to the new and original interfaces, see [Announcement on Updates to SMS Service Signature & Template Interfaces](https://help.aliyun.com/zh/sms/product-overview/announcement-on-sms-service-update-signature-template-interface).'."\n" + ."\n" + .'- Individual authenticated users can apply for one formal signature per natural day under the same Alibaba Cloud account, while enterprise authenticated users have no current restrictions. For details on the differences in rights between individual and enterprise users, please refer to [User Guide](https://help.aliyun.com/zh/sms/user-guide/usage-notes?spm).'."\n" + ."\n" + .'- Signature information applied through the interface will be synchronized in the SMS service console. For operations related to signatures in the console, see [SMS Signatures](https://help.aliyun.com/zh/sms/user-guide/create-signatures?spm).'."\n" + ."\n" + .'- After submitting the signature application, you can query the signature review status and details via the [GetSmsSign](https://help.aliyun.com/zh/sms/developer-reference/api-dysmsapi-2017-05-25-getsmssign?spm) interface. You can also [Configure Receipt Messages](https://help.aliyun.com/zh/sms/developer-reference/configure-delivery-receipts-1?spm) and obtain signature review status messages through SignSmsReport.', + ], + 'GetSmsSign' => [ + 'summary' => 'Query SMS Signature Details', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218493', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Signature name. Must be an SMS signature already applied for by this account.'."\n" + ."\n" + .'- Obtain from the return parameters after calling the [CreateSmsSign](https://help.aliyun.com/zh/sms/developer-reference/api-dysmsapi-2017-05-25-createsmssign?spm) API.'."\n" + .'- View the signature on the [Signature Management](https://dysms.console.aliyun.com/domestic/text/sign) page.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Aliyun', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and issue localization.', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'Code' => [ + 'description' => 'Request status code.'."\n" + ."\n" + .'- OK indicates a successful request.'."\n" + .'- For other error codes, see [API Error Codes](~~101346~~).', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'Description of the status code.', + 'type' => 'string', + 'example' => 'OK', + ], + 'SignName' => [ + 'description' => 'SMS signature name.', + 'type' => 'string', + 'example' => 'Aliyun', + ], + 'SignStatus' => [ + 'description' => 'Signature review status. Values:'."\n" + ."\n" + .'- **0**: Under review.'."\n" + .'- **1**: Approved.'."\n" + .'- **2**: Review failed, please check the Reason parameter for the failure cause.'."\n" + .'- **10**: Review canceled.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'CreateDate' => [ + 'description' => 'Creation date and time of the SMS signature.', + 'type' => 'string', + 'example' => '2024-06-03 10:02:34', + ], + 'OrderId' => [ + 'description' => 'Work order number.'."\n" + ."\n" + .'Used by reviewers when querying the review. You need to provide this work order number if you require expedited review.', + 'type' => 'string', + 'example' => '20044156924', + ], + 'QualificationId' => [ + 'description' => 'Credential ID, the credential ID associated when applying for the signature.', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2004393****', + ], + 'Remark' => [ + 'description' => 'Explanation of the SMS signature scenario, with a maximum length of 200 characters.', + 'type' => 'string', + 'example' => 'Send verification code text message during login.', + ], + 'AuditInfo' => [ + 'description' => 'Audit information.', + 'type' => 'object', + 'properties' => [ + 'RejectInfo' => [ + 'description' => 'Reasons for not passing the review.', + 'type' => 'string', + 'example' => 'reason for rejection.', + ], + 'AuditDate' => [ + 'description' => 'Audit date and time.', + 'type' => 'string', + 'example' => '2024-06-03 12:02:34'."\n", + ], + ], + ], + 'FileUrlList' => [ + 'description' => '更多资料信息，补充上传业务证明文件或业务截图文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Information of files uploaded to OSS.', + 'type' => 'string', + 'example' => '10098689758*****/1234qwe.png'."\n", + ], + ], + 'SignCode' => [ + 'description' => 'SMS signature code.', + 'type' => 'string', + 'example' => 'SIGN_100000077042023_17174665*****_ZM2kG', + ], + 'SignTag' => [ + 'description' => 'Signature tag indicating whether the signature is user-defined, system-provided, test, or trial. Values:'."\n" + ."\n" + .'- 2: User-defined signature'."\n" + .'- 3: System-provided signature'."\n" + .'- 4: Test signature'."\n" + .'- 5: Trial signature', + 'type' => 'string', + 'example' => '2', + ], + 'ApplyScene' => [ + 'description' => 'Content of application scenarios.', + 'type' => 'string', + 'example' => 'http://www.aliyun.com/'."\n", + ], + 'ThirdParty' => [ + 'description' => 'Signature usage indication—self-use or third-party use.'."\n" + ."\n" + .'- false: Self-use (default)'."\n" + ."\n" + .'- true: Third-party use', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SignUsage' => [ + 'description' => 'scenarios for using signatures.', + 'type' => 'string', + 'example' => 'App.', + ], + 'RegisterResult' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'AuthorizationLetterId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'AuthorizationLetterAuditPass' => [ + 'type' => 'boolean', + ], + 'SignIspRegisterDetailList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegisterStatus' => [ + 'type' => 'integer', + 'format' => 'int32', + ], + 'OperatorCode' => [ + 'type' => 'string', + ], + 'OperatorCompleteTime' => [ + 'type' => 'string', + ], + 'RegisterStatusReasons' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReasonCode' => [ + 'type' => 'string', + ], + 'ReasonDescList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + ], + 'TrademarkId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'AppIcpRecordId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + 404 => [ + [ + 'errorCode' => 'SignatureNotFound', + 'errorMessage' => 'The signature does not exist.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"SignName\\": \\"登录验证\\",\\n \\"SignStatus\\": 2,\\n \\"CreateDate\\": \\"2024-06-03 10:02:34\\",\\n \\"OrderId\\": \\"20044156924\\",\\n \\"QualificationId\\": 0,\\n \\"Remark\\": \\"登录场景验证码\\",\\n \\"AuditInfo\\": {\\n \\"RejectInfo\\": \\"通过资质信息，不能判断是否可以申请此签名。\\",\\n \\"AuditDate\\": \\"2024-06-03 12:02:34\\\\n\\"\\n },\\n \\"FileUrlList\\": [\\n \\"10098689758*****/1234qwe.png\\\\n\\"\\n ],\\n \\"SignCode\\": \\"SIGN_100000077042023_17174665*****_ZM2kG\\",\\n \\"SignTag\\": \\"2\\",\\n \\"ApplyScene\\": \\"http://www.aliyun.com/\\\\n\\",\\n \\"ThirdParty\\": false,\\n \\"SignUsage\\": \\"已注册商标名称。\\",\\n \\"RegisterResult\\": 1,\\n \\"AuthorizationLetterId\\": 0,\\n \\"AuthorizationLetterAuditPass\\": true,\\n \\"SignIspRegisterDetailList\\": [\\n {\\n \\"RegisterStatus\\": 0,\\n \\"OperatorCode\\": \\"telecom\\",\\n \\"OperatorCompleteTime\\": \\"2025-06-13 15:55:26\\",\\n \\"RegisterStatusReasons\\": [\\n {\\n \\"ReasonCode\\": \\"REGISTER_TIMEOUT\\",\\n \\"ReasonDescList\\": [\\n \\"报备超时。\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"TrademarkId\\": 0,\\n \\"AppIcpRecordId\\": 0\\n}","type":"json"}]', + 'title' => 'Query Signature Details (New Interface)', + 'description' => '- For details about the changes of this new interface and the original one, please refer to [Announcement on the Update of SMS Signature & Template Interfaces](https://help.aliyun.com/zh/sms/product-overview/announcement-on-sms-service-update-signature-template-interface).'."\n" + ."\n" + .'- Review Time: Generally, after submitting the signature, Alibaba Cloud expects to complete the review within 2 hours (Review Business Hours: Monday to Sunday 9:00~21:00, with legal holidays postponed). It is recommended to submit your application before 18:00.'."\n" + ."\n" + .'- If the signature fails the review, the reason for the failure will be returned. Please refer to [Handling Suggestions for Failed SMS Reviews](https://help.aliyun.com/zh/sms/user-guide/causes-of-application-failures-and-suggestions?spm), invoke the [UpdateSmsSign](https://help.aliyun.com/zh/sms/developer-reference/api-dysmsapi-2017-05-25-updatesmssign?spm) API, or modify the unapproved SMS signature on the [Signature Management](https://dysms.console.aliyun.com/domestic/text/sign) page.', + ], + 'QuerySmsSignList' => [ + 'summary' => 'Queries message signatures by page.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '118916', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'minLength' => 1, + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of signatures per page. Valid values: **1 to 50**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E47708****', + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'SmsSignList' => [ + 'description' => 'The queried message signatures.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SignName' => [ + 'description' => 'The name of the signature.'."\n", + 'type' => 'string', + 'example' => 'Aliyun', + ], + 'AuditStatus' => [ + 'description' => 'The approval status of the signature. Valid values:'."\n" + ."\n" + .'* **AUDIT_STATE_INIT**: The signature is pending approval.'."\n" + .'* **AUDIT_STATE_PASS**: The signature is approved.'."\n" + .'* **AUDIT_STATE_NOT_PASS**: The signature is rejected. You can view the reason in the Reason response parameter.'."\n" + .'* **AUDIT_STATE_CANCEL**: The approval is canceled.'."\n", + 'type' => 'string', + 'example' => 'AUDIT_STATE_NOT_PASS', + ], + 'CreateDate' => [ + 'description' => 'The time when the signature was created. Format: yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'example' => '2020-01-08 16:44:13', + ], + 'Reason' => [ + 'description' => 'The approval remarks.'."\n" + ."\n" + .'* If the value of AuditStatus is **AUDIT_STATE_PASS** or **AUDIT_STATE_INIT**, the value of Reason is No Approval Remarks.'."\n" + .'* If the value of AuditStatus is **AUDIT_STATE_NOT_PASS**, the reason why the signature is rejected is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RejectSubInfo' => [ + 'description' => 'The remarks about the rejection.'."\n", + 'type' => 'string', + 'example' => 'The document cannot verify the authenticity of the information. Please upload it again.', + ], + 'RejectDate' => [ + 'description' => 'The time when the signature was rejected. Format: yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'example' => '2020-01-08 19:02:13', + ], + 'RejectInfo' => [ + 'description' => 'The reason why the signature was rejected.'."\n", + 'type' => 'string', + 'example' => 'The document cannot verify the authenticity of the information. Please upload it again.', + ], + ], + ], + 'BusinessType' => [ + 'description' => 'The type of the signature scenario. The return value ends with "type". Valid values:'."\n" + ."\n" + .'* Verification code type'."\n" + .'* General-purpose type'."\n", + 'type' => 'string', + 'example' => 'Verification code type', + ], + 'OrderId' => [ + 'description' => 'The ticket ID.'."\n", + 'type' => 'string', + 'example' => '236****5', + ], + 'AuthorizationLetterId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'authorizationLetterAuditPass' => [ + 'type' => 'boolean', + ], + 'TrademarkId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + 'AppIcpRecordId' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => 'The total number of signatures.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'CurrentPage' => [ + 'description' => 'The page number. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of signatures per page. Valid values: **1 to 50**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\\\n\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"SmsSignList\\": [\\n {\\n \\"SignName\\": \\"阿里云\\",\\n \\"AuditStatus\\": \\"AUDIT_STATE_NOT_PASS\\",\\n \\"CreateDate\\": \\"2020-06-04 11:42:17\\",\\n \\"Reason\\": {\\n \\"RejectSubInfo\\": \\"文件不能证明信息真实性，请重新上传。\\",\\n \\"RejectDate\\": \\"2020-06-04 13:35:10\\",\\n \\"RejectInfo\\": \\"文件不能证明信息真实性，请重新上传。\\"\\n },\\n \\"BusinessType\\": \\"验证码类型\\",\\n \\"OrderId\\": \\"2005098****\\",\\n \\"AuthorizationLetterId\\": 0,\\n \\"authorizationLetterAuditPass\\": true,\\n \\"TrademarkId\\": 0,\\n \\"AppIcpRecordId\\": 0\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"<QuerySmsSignListResponse>\\n <RequestId>819BE656-D2E0-4858-8B21-B2E47708****</RequestId>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <SmsSignList>\\n <SignName>阿里云</SignName>\\n <AuditStatus>AUDIT_STATE_NOT_PASS</AuditStatus>\\n <CreateDate>2020-01-08 16:44:13</CreateDate>\\n <Reason>\\n <RejectSubInfo>文件不能证明信息真实性，请重新上传。</RejectSubInfo>\\n <RejectDate>2020-01-08 19:02:13</RejectDate>\\n <RejectInfo>文件不能证明信息真实性，请重新上传。</RejectInfo>\\n </Reason>\\n <BusinessType>验证码类型</BusinessType>\\n <OrderId>236****5</OrderId>\\n </SmsSignList>\\n</QuerySmsSignListResponse>","errorExample":""}]', + 'title' => 'QuerySmsSignList', + 'description' => 'You can call this operation to query the details of message signatures, including the name, creation time, and approval status of each signature. If a message template is rejected, the reason is returned. Modify the message signature based on the reason.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 10 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.'."\n", + ], + 'UpdateSmsSign' => [ + 'summary' => 'Update Text SMS Signature', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219280', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Signature not yet approved.', + 'type' => 'string', + 'required' => true, + 'example' => '阿里云验证码', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'Explanation of the SMS signature scenario, with a maximum length of 200 characters.'."\n" + ."\n" + .'> The scenario explanation is one of the reference information for signature review. Please provide a detailed description of the usage scenarios of the launched business, along with verifiable information such as website links, registered domain addresses, app store download links, full names of public accounts or mini-programs, etc. For login scenarios, test account credentials are also required. A well-informed application explanation will enhance the efficiency of signature and template reviews. Refer to the **Application Scenarios** column in the [Signature Source](https://help.aliyun.com/zh/sms/user-guide/signature-specifications-1?spm=a2c4g.11186623.0.i2#section-xup-k46-yi4) table for filling in SMS scenarios.', + 'type' => 'string', + 'required' => false, + 'example' => '登录场景申请验证码', + 'maxLength' => 500, + ], + ], + [ + 'name' => 'SignType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Signature type. It is recommended to use the default value.'."\n" + ."\n" + .'- **0**: Verification code'."\n" + .'- **1**: General (default)', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'MoreData', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Additional materials, such as uploading business proof documents or screenshots of business operations, to help reviewers understand your business details.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about files uploaded to OSS.'."\n" + .'For file upload operations, refer to [Upload Files via OSS](https://help.aliyun.com/zh/sms/upload-files-through-oss).', + 'type' => 'string', + 'required' => false, + 'example' => '10098689758*****/1234qwe.png'."\n", + ], + 'required' => false, + ], + ], + [ + 'name' => 'QualificationId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Approved or under-review qualification ID.'."\n" + ."\n" + .'> - Before applying for an SMS signature, please first [apply for qualifications](https://help.aliyun.com/zh/sms/user-guide/new-qualification?spm=a2c4g.11186623.0.0.718d187bbkpMRK).'."\n" + .'> - You can view the qualification ID on the [Qualification Management](https://dysms.console.aliyun.com/domestic/text/qualification) page.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '8563**', + ], + ], + [ + 'name' => 'ApplySceneContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'Application scenarios, instructions as follows:'."\n" + .'- For registered websites, please enter the domain name registered with MIIT, including HTTP or HTTPS.'."\n" + .'- For launched apps, provide the display link from the app store with HTTP or HTTPS, ensuring the app is online.'."\n" + .'- For public accounts or mini-programs, fill in the full name, ensuring they are online.'."\n" + .'- For e-commerce platform store names (for enterprise users only), provide the display link with HTTP or HTTPS.', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com/'."\n", + ], + ], + [ + 'name' => 'SignSource', + 'in' => 'query', + 'schema' => [ + 'description' => 'Source of the signature. Values:'."\n" + ."\n" + .'- **0**: Full name or abbreviation of enterprises and institutions.'."\n" + .'- **1**: Full name or abbreviation of MIIT-registered websites.'."\n" + .'- **2**: Full name or abbreviation of app applications.'."\n" + .'- **3**: Full name or abbreviation of public accounts or mini-programs.'."\n" + .'- **4**: Full name or abbreviation of e-commerce platform store names.'."\n" + .'- **5**: Full name or abbreviation of trademarks.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + 'enum' => [ + '0', + '1', + '2', + '3', + '4', + '5', + ], + ], + ], + [ + 'name' => 'ThirdParty', + 'in' => 'query', + 'schema' => [ + 'description' => 'Whether the signature is for self-use or others.'."\n" + ."\n" + .'- false: Self-use'."\n" + .'- true: Others'."\n" + .'><notice>When the signature is for self-use, select the self-use qualification ID; when it\'s for others, choose the others\' qualification ID.></notice>', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'AuthorizationLetterId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'TrademarkId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + [ + 'name' => 'AppIcpRecordId', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of this call request, uniquely generated by Alibaba Cloud, which can be used for troubleshooting and issue localization.', + 'type' => 'string', + 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', + ], + 'Code' => [ + 'description' => 'Request status code.'."\n" + ."\n" + .'* OK indicates a successful request.'."\n" + .'* For other error codes, refer to [Error Code List](~~101346~~).', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'Description of the status code.', + 'type' => 'string', + 'example' => 'OK', + ], + 'SignName' => [ + 'description' => 'The modified signature name.', + 'type' => 'string', + 'example' => '登录验证', + ], + 'OrderId' => [ + 'description' => 'Work order number.'."\n" + ."\n" + .'This parameter is used by auditors when querying audits. You need to provide this work order number for expedited review.', + 'type' => 'string', + 'example' => '2004417****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + [ + 'errorCode' => 'ParameterMismatch.ThirdParty', + 'errorMessage' => 'The type of signature, whether for personal use or for a third party, should be consistent with the qualifications.', + ], + [ + 'errorCode' => 'SignName.Exists', + 'errorMessage' => 'Sorry, this signature already exists and cannot be applied for again.', + ], + [ + 'errorCode' => 'InvalidQualification', + 'errorMessage' => 'The qualification should be approved.', + ], + [ + 'errorCode' => 'InvalidApplySceneContent', + 'errorMessage' => 'For certain signature sources, the '."\n" + .'applySceneContent should be an HTTP or HTTPS link.', + ], + [ + 'errorCode' => 'InvalidSignName', + 'errorMessage' => 'The signature cannot contain spaces, special '."\n" + .'symbols, or all numbers.', + ], + [ + 'errorCode' => 'MissApplySceneContent', + 'errorMessage' => 'In some signature sources, the applySceneContent is required.', + ], + [ + 'errorCode' => 'MissingSignName', + 'errorMessage' => 'The signature name cannot be empty.', + ], + [ + 'errorCode' => 'SmsAuthorizationLetterNotMatch', + 'errorMessage' => 'Please bind the available authorization letter whose the social credit code is same to the the social credit code of qualification.', + ], + [ + 'errorCode' => 'SmsAuthorizationLetterNotExist', + 'errorMessage' => 'Authorization does not belong to the customer.', + ], + [ + 'errorCode' => 'SmsSignNotAuthorized', + 'errorMessage' => 'the signature is not in the sign scope of the authorization letter.', + ], + [ + 'errorCode' => 'TrademarkNotExist', + 'errorMessage' => 'The trademark does not exist.', + ], + [ + 'errorCode' => 'AppIcpRecordNotExist', + 'errorMessage' => 'The APP-ICP record does not exist.', + ], + ], + 404 => [ + [ + 'errorCode' => 'QualificationNotFound', + 'errorMessage' => 'Qualification does not exist.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D1D\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"SignName\\": \\"登录验证\\",\\n \\"OrderId\\": \\"2004417****\\"\\n}","type":"json"}]', + 'title' => 'Update SMS Signature (New Interface)', + 'description' => '- For details about the changes of this new interface and the original one, please refer to [Announcement on the Update of SMS Signature & Template Interfaces](https://help.aliyun.com/zh/sms/product-overview/announcement-on-sms-service-update-signature-template-interface).'."\n" + .'- Only signatures that have not passed the review can be modified. Please refer to [Handling Suggestions for Failed SMS Reviews](https://help.aliyun.com/zh/sms/user-guide/causes-of-application-failures-and-suggestions?spm) and call this interface to modify and resubmit for review after modification.'."\n" + .'- Signature information applied through the interface will be synchronized in the SMS service console. For operations related to signatures in the console, please see [SMS Signatures](https://help.aliyun.com/zh/sms/user-guide/create-signatures?spm).', + ], + 'DeleteSmsSign' => [ + 'summary' => 'Deletes a signature.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102444', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The signature.'."\n" + ."\n" + .'> The signature must be submitted by the current Alibaba Cloud account, and has been approved.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Aliyun', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* If OK is returned, the request is successful.'."\n" + .'* Other values indicate that the request fails. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D****', + ], + 'SignName' => [ + 'description' => 'The signature.'."\n", + 'type' => 'string', + 'example' => 'Aliyun', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D****\\",\\n \\"SignName\\": \\"阿里云\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<DeleteSmsSignResponse>\\r\\n <Message>OK</Message>\\r\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8D****</RequestId>\\r\\n <SignName>阿里云</SignName>\\r\\n <Code>OK</Code>\\r\\n</DeleteSmsSignResponse>","errorExample":""}]', + 'title' => 'DeleteSmsSign', + 'description' => '* You cannot delete a signature that has not been approved.'."\n" + .'* After you delete a signature, you cannot recover it. Proceed with caution.'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the 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.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ChangeSignatureQualification' => [ + 'summary' => '更换签名的资质和授权书', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '268874', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SignatureName', + 'in' => 'query', + 'schema' => [ + 'title' => '签名', + 'description' => '签名', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'QualificationId', + 'in' => 'query', + 'schema' => [ + 'title' => '资质id', + 'description' => '资质id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1*****2', + ], + ], + [ + 'name' => 'AuthorizationLetterId', + 'in' => 'query', + 'schema' => [ + 'title' => '授权委托书id', + 'description' => '授权委托书id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000********1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '0A974B78-02BF-4C79-ADF3-90CFBA1B55B1', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'type' => 'object', + ], + 'ErrMessage' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + ], + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'QualificationNotExist', + 'errorMessage' => 'Can\'t query qualification information.', + ], + [ + 'errorCode' => 'SmsAuthorizationLetterNotExist', + 'errorMessage' => 'Authorization does not belong to the customer.', + ], + [ + 'errorCode' => 'SmsSignatureNotExist', + 'errorMessage' => 'Signature does not exist.', + ], + [ + 'errorCode' => 'SmsQualificationRegisterFailed', + 'errorMessage' => 'The registration of the current qualification fails. Please modify the qualification and re-bind the qualification before completing the signature registration process again.', + ], + [ + 'errorCode' => 'SmsQualificationNotPassed', + 'errorMessage' => 'The qualification has not been approved and cannot be bound to the signature.', + ], + [ + 'errorCode' => 'SmsPassedAuthorizationLetterNotMatch', + 'errorMessage' => 'Please bind audited authorization letter whose the social credit code is same to the the social credit code of qualification.', + ], + [ + 'errorCode' => 'QualificationNotComplete', + 'errorMessage' => 'The qualification elements are incomplete.', + ], + [ + 'errorCode' => 'SmsSignNotAuthorized', + 'errorMessage' => 'the signature is not in the sign scope of the authorization letter.', + ], + [ + 'errorCode' => 'SMS_STATUS_ILLEGAL', + 'errorMessage' => 'When replacing the qualification and power of attorney of the signature, the signature status must be approved.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"0A974B78-02BF-4C79-ADF3-90CFBA1B55B1\\",\\n \\"Data\\": {\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"ErrMessage\\": \\"OK\\",\\n \\"Success\\": true,\\n \\"ErrCode\\": \\"OK\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'AddSmsSign' => [ + 'summary' => 'Creates a signature.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102438', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the signature.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* The signature name is not case-sensitive. For example, \\[Alibaba Cloud Communication] and \\[alibaba cloud communication] are considered as the same name.'."\n" + ."\n" + .'* If your verification code signature and general-purpose signature have the same name, the system uses the general-purpose signature to send messages by default.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Aliyun', + ], + ], + [ + 'name' => 'SignSource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source of the signature. Valid values:'."\n" + ."\n" + .'* **0**: the full name or abbreviation of an enterprise or institution'."\n" + .'* **1**: the full name or abbreviation of a website that has obtained an ICP filing from the Ministry of Industry and Information Technology (MIIT) of China'."\n" + .'* **2**: the full name or abbreviation of an app'."\n" + .'* **3**: the full name or abbreviation of an official account or mini-program'."\n" + .'* **4**: the full name or abbreviation of an e-commerce store'."\n" + .'* **5**: the full name or abbreviation of a trademark'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the signature application. The description cannot exceed 200 characters in length. The description is one of the reference information for signature review. We recommend that you describe the use scenarios of your services in detail, and provide information that can verify the services, such as a website URL, a domain name with an ICP filing, an app download URL, an official account name, or a mini program name. For sign-in scenarios, you must also provide an account and password for tests. A detailed description can improve the review efficiency of signatures and templates.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'This is the abbreviation of our company.', + ], + ], + [ + 'name' => 'SignFileList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The signature files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of signature files.'."\n", + 'type' => 'object', + 'properties' => [ + 'FileContents' => [ + 'description' => 'The Base64-encoded string of the qualification document. An image cannot exceed 2 MB in size. In some scenarios, you must upload supporting documents to apply for signatures. For more information, see [SMS signature specifications](~~108076~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'R0lGODlhHAAmAKIHAKqqqsvLy0hISObm5vf394uL****', + ], + 'FileSuffix' => [ + 'description' => 'The format of the qualification document. You can upload multiple images. Images in JPG, PNG, GIF, or JPEG format are supported.'."\n" + ."\n" + .'In some scenarios, you must upload supporting documents to apply for signatures. For more information, see [SMS signature specifications](~~108076~~).'."\n" + ."\n" + .'> If you apply for a signature for other users or if the signature source is the name of an enterprise or public institution, you must upload a certificate and a letter of authorization. For more information, see [Certificate](~~108076~~) and [Letter of authorization](~~56741~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'jpg', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SignType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the signature. Valid values:'."\n" + ."\n" + .'* **0**: verification code'."\n" + .'* **1**: general-purpose'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'SignName' => [ + 'description' => 'The name of the signature.'."\n", + 'type' => 'string', + 'example' => 'Aliyun', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"SignName\\": \\"阿里云\\"\\n}","type":"json"}]', + 'title' => 'AddSmsSign', + 'description' => 'You can call the AddSmsSign operation or use the [Short Message Service (SMS) console](https://dysms.console.aliyun.com/dysms.htm#/overview) to create an SMS signature. The signature must comply with the [SMS signature specifications](~~108076~~). You can call the QuerySmsSign operation or use the SMS console to query the review status of the signature.'."\n" + ."\n" + .'For more information, see [Usage notes](~~55324~~).'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation only once per second. 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.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* You cannot cancel the review of a signature.'."\n" + ."\n" + .'* Individual users can create only one verification code signature, and can create only one general-purpose signature within a natural day. If you need to apply for multiple signatures, we recommend that you upgrade your account to an enterprise user.'."\n" + ."\n" + .'* If you need to use the same signature for messages sent to recipients both in and outside the Chinese mainland, the signature must be a general-purpose signature.'."\n" + ."\n" + .'* If you apply for a signature or message template, you must specify the signature scenario or template type. You must also provide the information of your services, such as a website URL, a domain name with an ICP filing, an application download URL, or the name of your WeChat official account or mini program. For sign-in scenarios, you must also provide an account and password for tests. A detailed description can improve the review efficiency of signatures and templates.'."\n" + ."\n" + .'* An SMS signature must undergo a thorough review process before it can be approved for use.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifySmsSign' => [ + 'summary' => 'Modifies a rejected signature and submit it for approval. Signatures that are pending approval or have been approved cannot be modified.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102449', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The signature.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Aliyun', + ], + ], + [ + 'name' => 'SignSource', + 'in' => 'query', + 'schema' => [ + 'description' => 'The source of the signature. Valid values:'."\n" + ."\n" + .'* **0**: full name or abbreviation of an enterprise or institution.'."\n" + .'* **1**: full name or abbreviation of a website with Ministry of Industry and Information Technology (MIIT) filing.'."\n" + .'* **2**: full name or abbreviation of an app.'."\n" + .'* **3**: full name or abbreviation of a WeChat official account or applet.'."\n" + .'* **4**: full name or abbreviation of an e-commerce store.'."\n" + .'* **5**: full name or abbreviation of a trademark.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'The scenario description of your released services. Provide the information of your services, such as a website URL, a domain name with an ICP filing, an app download URL, or the name of your WeChat official account or mini program. For sign-in scenarios, you must also provide an account and password for tests. A detailed description can improve the review efficiency of signatures and templates.'."\n" + ."\n" + .'> The description can be up to 200 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'This is the abbreviation of our company.', + ], + ], + [ + 'name' => 'SignFileList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of signature files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The signature files.'."\n", + 'type' => 'object', + 'properties' => [ + 'FileContents' => [ + 'description' => 'The base64-encoded string of the signed files. The size of the image cannot exceed 2 MB.'."\n" + ."\n" + .'In some scenarios, documents are required to prove your identity. For more information, see [Signature specifications](~~108076~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'R0lGODlhHAAmAKIHAKqqqsvLy0hISObm5vf394uLiwAA', + ], + 'FileSuffix' => [ + 'description' => 'The format of the documents. You can upload multiple images. JPG, PNG, GIF, and JPEG are supported.'."\n" + ."\n" + .'In some scenarios, documents are required to prove your identity. For more information, see [Signature specifications](~~108076~~).'."\n" + ."\n" + .'> If the signature is used for other purposes or the signature source is an enterprise or public institution, you must upload some documents and an authorization letter. For more information, see [Documents](~~108076~~) and [Letter of authorization](~~56741~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'jpg', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SignType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the signature. Valid values:'."\n" + ."\n" + .'* **0**: verification-code signature'."\n" + .'* **1**: general-purpose signature'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'SignName' => [ + 'description' => 'The signature.'."\n", + 'type' => 'string', + 'example' => 'Aliyun', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"SignName\\": \\"阿里云\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<ModifySmsSignResponse>\\r\\n <Message>OK</Message>\\r\\n <RequestId>44DF7A95-603F-4651-9298-BE1850BEB53F</RequestId>\\r\\n <Code>OK</Code>\\r\\n <SignName>阿里云</SignName>\\r\\n</ModifySmsSignResponse>","errorExample":""}]', + 'title' => 'ModifySmsSign', + 'description' => 'You can call the operation or use the [Alibaba Cloud SMS console](https://dysms.console.aliyun.com/dysms.htm#/overview) to modify an existing signature and submit the signature for approval. The signature must comply with the [signature specifications](~~108076~~).'."\n" + ."\n" + .'For more information, see [Usage notes](~~55324~~).'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'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.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* Signatures pending approval cannot be modified.'."\n" + ."\n" + .'* You cannot modify a signature after it is approved. If you no longer need the signature, you can delete it.'."\n" + ."\n" + .'* If you are an individual user, you cannot apply for a new signature on the same day that your signature is rejected or deleted. We recommend that you modify the rejected signature and submit it again.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QuerySmsSign' => [ + 'summary' => 'Queries the status of a signature.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102459', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The signature.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Aliyun', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CC89A90C-978F-46AC-B80D-54738371E7CA', + ], + 'SignStatus' => [ + 'description' => 'The status of the signature. Valid values:'."\n" + ."\n" + .'* **0**: The signature is pending approval.'."\n" + .'* **1**: The signature is approved.'."\n" + .'* **2**: The signature is rejected. The Reason parameter indicates the reason why the signature is rejected.'."\n" + .'* **10**: The signature is cancelled.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* If OK is returned, the request is successful.'."\n" + .'* Other values indicate that the request fails. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'CreateDate' => [ + 'description' => 'The date and time when the signature was created.'."\n", + 'type' => 'string', + 'example' => ' 2019-01-08 16:44:13', + ], + 'Reason' => [ + 'description' => 'The remarks of the review. Valid values:'."\n" + ."\n" + .'* If the signature is in the **Approved** or **Pending Approval** state, No Remarks is returned.'."\n" + .'* If the signature is in the **Not Approved** state, the reason why the signature is rejected is returned.'."\n", + 'type' => 'string', + 'example' => 'The document cannot verify the authenticity of the information. Please upload it again.', + ], + 'SignName' => [ + 'description' => 'The signature.'."\n", + 'type' => 'string', + 'example' => 'Aliyun', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"CC89A90C-978F-46AC-B80D-54738371E7CA\\",\\n \\"SignStatus\\": 1,\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"CreateDate\\": \\" 2019-01-08 16:44:13\\",\\n \\"Reason\\": \\"文件不能证明信息真实性，请重新上传\\",\\n \\"SignName\\": \\"阿里云\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<QuerySmsSignResponse>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>CC89A90C-978F-46AC-B80D-54738371E7CA</RequestId>\\r\\n\\t<SignStatus>1</SignStatus>\\r\\n\\t<CreateDate>2019-01-08 16:44:13</CreateDate>\\r\\n\\t<Code>OK</Code>\\r\\n\\t<SignName>阿里云</SignName>\\r\\n\\t<Reason>文件不能证明信息真实性，请重新上传</Reason>\\r\\n</QuerySmsSignResponse>","errorExample":""}]', + 'title' => 'QuerySmsSign', + 'description' => 'After you apply for an SMS signature, you can query its status by using the [Alibaba Cloud SMS console](https://dysms.console.aliyun.com/dysms.htm) or calling the operation. If the signature is rejected, you can modify the signature based on the reason why it is rejected.'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'You can call this API operation up to 500 times per second per account. If the number of the 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.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateSmsTrademark' => [ + 'summary' => '创建商标对客openAPI', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '289843', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'TrademarkPic', + 'in' => 'query', + 'schema' => [ + 'title' => '商标详情截图osskey', + 'description' => '商标详情截图osskey', + 'type' => 'string', + 'required' => true, + 'example' => '123456/test1719383196031.jpg', + ], + ], + [ + 'name' => 'TrademarkRegistrationNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '商标注册号', + 'description' => '商标注册号', + 'type' => 'string', + 'required' => true, + 'example' => '766905', + ], + ], + [ + 'name' => 'TrademarkName', + 'in' => 'query', + 'schema' => [ + 'title' => '商标名称', + 'description' => '商标名称', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'TrademarkApplicantName', + 'in' => 'query', + 'schema' => [ + 'title' => '申请人名称', + 'description' => '申请人名称', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'TrademarkEffExpDate', + 'in' => 'query', + 'schema' => [ + 'title' => '专用权生失效日期', + 'description' => '专用权生失效日期', + 'type' => 'string', + 'required' => true, + 'example' => '2010-12-14~2030-12-13', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '10000*******', + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'TrademarkOssFileNotUploadError', + 'errorMessage' => 'The trademark screenshot file is not uploaded.', + ], + [ + 'errorCode' => 'TrademarkLetterDateNotMatchRegex', + 'errorMessage' => 'The format of the trademark\'s validity period is incorrect.', + ], + [ + 'errorCode' => 'TrademarkNameNotMatchRegex', + 'errorMessage' => 'The trademark name cannot be empty.', + ], + [ + 'errorCode' => 'TrademarkNameOverLimit', + 'errorMessage' => 'The trademark name exceeds the length limit.', + ], + [ + 'errorCode' => 'TrademarkRegistrationNumberNotMatchRegex', + 'errorMessage' => 'The trademark registration number cannot be empty.', + ], + [ + 'errorCode' => 'TrademarkRegistrationNumberOverLimit', + 'errorMessage' => 'The trademark registration number exceeds the length limit.', + ], + [ + 'errorCode' => 'TrademarkApplicantNameNotMatchRegex', + 'errorMessage' => 'The trademark applicant cannot be empty.', + ], + [ + 'errorCode' => 'TrademarkApplicantNameOverLimit', + 'errorMessage' => 'The trademark applicant exceeds the length limit.', + ], + [ + 'errorCode' => 'TrademarkDateNotValid', + 'errorMessage' => 'The trademark\'s validity period is not within the valid range.', + ], + [ + 'errorCode' => 'TrademarkPicsFileError', + 'errorMessage' => 'The format of the trademark screenshot file is incorrect.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"10000*******\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'QuerySmsTrademark' => [ + 'summary' => '查询商标对客openAPI', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '289842', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'TrademarkIdList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '商标实体id列表', + 'description' => '商标实体id列表', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000***', + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '569E9DBD-23FF-1785-99AD-E4B23608C104', + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TrademarkPicUrl' => [ + 'title' => '商标截图url地址', + 'description' => '商标截图url地址', + 'type' => 'string', + 'example' => 'https://alicom-fc-media.oss-cn-zhangjiakou.aliyuncs.com/100000****50802/afde****-496d-46e4-899d-b43758****8_mhk9oz0p_176224****542.png?Expires=1762****6&OSSAccessKeyId=bypFN****73PsLI&Signature=BygI9X****h7%2FXmFIo****FB2c%3D', + ], + 'TrademarkRegistrationNumber' => [ + 'title' => '商标注册号', + 'description' => '商标注册号', + 'type' => 'string', + 'example' => '1234', + ], + 'TrademarkName' => [ + 'title' => '商标名称', + 'description' => '商标名称', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'TrademarkPic' => [ + 'title' => '商标截图Osskey（给签名传工单用）', + 'description' => '商标截图Osskey（给签名传工单用）', + 'type' => 'string', + 'example' => '100000*****802/afdebd46-****-46e4-899d-b4375826c898_mhk9oz0p_1762****31542.png', + ], + 'TrademarkEffExpDate' => [ + 'title' => '专用权生失效日期', + 'description' => '专用权生失效日期', + 'type' => 'string', + 'example' => '2025-11-01~2025-12-19', + ], + 'TrademarkId' => [ + 'title' => '商标材料id', + 'description' => '商标材料id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000*******', + ], + 'TrademarkApplicantName' => [ + 'title' => '申请人名称', + 'description' => '申请人名称', + 'type' => 'string', + 'example' => '示例值示例值', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"569E9DBD-23FF-1785-99AD-E4B23608C104\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"TrademarkPicUrl\\": \\"https://alicom-fc-media.oss-cn-zhangjiakou.aliyuncs.com/100000****50802/afde****-496d-46e4-899d-b43758****8_mhk9oz0p_176224****542.png?Expires=1762****6&OSSAccessKeyId=bypFN****73PsLI&Signature=BygI9X****h7%2FXmFIo****FB2c%3D\\",\\n \\"TrademarkRegistrationNumber\\": \\"1234\\",\\n \\"TrademarkName\\": \\"示例商标\\",\\n \\"TrademarkPic\\": \\"100000*****802/afdebd46-****-46e4-899d-b4375826c898_mhk9oz0p_1762****31542.png\\",\\n \\"TrademarkEffExpDate\\": \\"2025-11-01~2025-12-19\\",\\n \\"TrademarkId\\": 0,\\n \\"TrademarkApplicantName\\": \\"阿里云\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateSmsAppIcpRecord' => [ + 'summary' => '创建APP-ICP备案对客openAPI', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '289841', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppIcpRecordPic', + 'in' => 'query', + 'schema' => [ + 'title' => 'app-icp备案详情截图osskey', + 'description' => 'app-icp备案详情截图osskey', + 'type' => 'string', + 'required' => true, + 'example' => ' '."\n" + .'123456/test1719383196031.jpg'."\n", + ], + ], + [ + 'name' => 'AppServiceName', + 'in' => 'query', + 'schema' => [ + 'title' => 'app服务名称', + 'description' => 'app服务名称', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'AppPrincipalUnitName', + 'in' => 'query', + 'schema' => [ + 'title' => '主办单位名称', + 'description' => '主办单位名称', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值示例值', + ], + ], + [ + 'name' => 'AppIcpLicenseNumber', + 'in' => 'query', + 'schema' => [ + 'title' => 'ICP备案/许可证号', + 'description' => 'ICP备案/许可证号', + 'type' => 'string', + 'required' => true, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'AppApprovalDate', + 'in' => 'query', + 'schema' => [ + 'title' => '审核通过日期，示例2025-09-01', + 'description' => '审核通过日期，示例2025-09-01', + 'type' => 'string', + 'required' => true, + 'example' => '2025-05-22', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP应用商店链接', + 'description' => 'APP应用商店链接', + 'type' => 'string', + 'required' => true, + 'example' => 'https://alicom-ops.alibaba-inc.com/dyorder/audit-domain/rule_manage', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '10000*******', + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'AppIcpRecordOssFileNotUploadError', + 'errorMessage' => 'The APP-ICP record screenshot file is not uploaded.', + ], + [ + 'errorCode' => 'AppIcpRecordDateNotMatchRegex', + 'errorMessage' => 'The format of the APP-ICP record approval date is incorrect.', + ], + [ + 'errorCode' => 'AppPrincipalUnitNameNotMatchRegex', + 'errorMessage' => 'The principal unit name of the APP cannot be empty.', + ], + [ + 'errorCode' => 'AppPrincipalUnitNameOverLimit', + 'errorMessage' => 'The principal unit name of the APP exceeds the length limit.', + ], + [ + 'errorCode' => 'AppIcpLicenseNumberNotMatchRegex', + 'errorMessage' => 'The ICP record/license number cannot be empty.', + ], + [ + 'errorCode' => 'AppIcpLicenseNumberOverLimit', + 'errorMessage' => 'The ICP record/license number exceeds the length limit.', + ], + [ + 'errorCode' => 'AppDomainNotMatchRegex', + 'errorMessage' => 'The APP app store link cannot be empty and must start with http:// or https://.', + ], + [ + 'errorCode' => 'AppDomainOverLimit', + 'errorMessage' => 'The APP app store link exceeds the length limit.', + ], + [ + 'errorCode' => 'AppApprovalDateNotValid', + 'errorMessage' => 'The validity period of the APP-ICP record is not within the valid range.', + ], + [ + 'errorCode' => 'AppIcpRecordPicsFileError', + 'errorMessage' => 'The format of the APP-ICP record screenshot file is incorrect.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\\\n\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": \\"10000*******\\",\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'QuerySmsAppIcpRecord' => [ + 'summary' => '查询APP-ICP备案对客openAPI', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '289840', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'AppIcpRecordIdList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => 'app-icp备案实体id列表', + 'description' => 'app-icp备案实体id列表', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100000***', + ], + 'required' => true, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'C9955E63-8BFF-101D-80A1-E6998DFEFF1A', + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AppIcpRecordId' => [ + 'title' => 'app-icp备案材料id', + 'description' => 'app-icp备案材料id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '51', + ], + 'AppIcpRecordPic' => [ + 'title' => 'app-icp备案截图图片Osskey（给签名传工单用）', + 'description' => 'app-icp备案截图图片Osskey（给签名传工单用）', + 'type' => 'string', + 'example' => '10000025*****02/ac181696-****-49c6-90dc-50689267aa00_mhsjd8b8_17*****662348.jpeg', + ], + 'AppIcpRecordPicUrl' => [ + 'title' => 'app-icp备案截图url地址', + 'description' => 'app-icp备案截图url地址', + 'type' => 'string', + 'example' => 'https://alicom-fc-media.oss-cn-zhangjiakou.aliyuncs.com/100000****50802/afde****-496d-46e4-899d-b43758****8_mhk9oz0p_176224****542.png?Expires=1762****6&OSSAccessKeyId=bypFN****73PsLI&Signature=BygI9X****h7%2FXmFIo****FB2c%3D', + ], + 'AppPrincipalUnitName' => [ + 'title' => '主办单位名称', + 'description' => '主办单位名称', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'AppIcpLicenseNumber' => [ + 'title' => 'ICP备案/许可证号', + 'description' => 'ICP备案/许可证号', + 'type' => 'string', + 'example' => '123', + ], + 'Domain' => [ + 'title' => 'APP应用商店链接', + 'description' => 'APP应用商店链接', + 'type' => 'string', + 'example' => 'https://test', + ], + 'AppApprovalDate' => [ + 'title' => '审核通过日期，示例2025-09-01', + 'description' => '审核通过日期，示例2025-09-01', + 'type' => 'string', + 'example' => '2020-01-01', + ], + 'AppServiceName' => [ + 'title' => 'app服务名称', + 'description' => 'app服务名称', + 'type' => 'string', + 'example' => '示例值', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"C9955E63-8BFF-101D-80A1-E6998DFEFF1A\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": [\\n {\\n \\"AppIcpRecordId\\": 51,\\n \\"AppIcpRecordPic\\": \\"10000025*****02/ac181696-****-49c6-90dc-50689267aa00_mhsjd8b8_17*****662348.jpeg\\",\\n \\"AppIcpRecordPicUrl\\": \\"https://alicom-fc-media.oss-cn-zhangjiakou.aliyuncs.com/100000****50802/afde****-496d-46e4-899d-b43758****8_mhk9oz0p_176224****542.png?Expires=1762****6&OSSAccessKeyId=bypFN****73PsLI&Signature=BygI9X****h7%2FXmFIo****FB2c%3D\\",\\n \\"AppPrincipalUnitName\\": \\"阿里云\\",\\n \\"AppIcpLicenseNumber\\": \\"123\\",\\n \\"Domain\\": \\"https://apps.apple.com/cn/app/阿里云/id981011420\\",\\n \\"AppApprovalDate\\": \\"2020-01-01\\",\\n \\"AppServiceName\\": \\"测试\\"\\n }\\n ],\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateSmsTemplate' => [ + 'summary' => 'Create SMS Template', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218485', + 'abilityTreeNodes' => [ + 'FEATUREdysms2H0K7P', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Template name, up to 30 characters in length.', + 'type' => 'string', + 'required' => true, + 'example' => 'aliyunCode', + 'maxLength' => 30, + ], + ], + [ + 'name' => 'TemplateContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'Template content, up to 500 characters in length.'."\n" + ."\n" + .'Both the template content and variable content must comply with SMS specifications; otherwise, the template will fail the review. You can also view common template examples on the template application page. Using sample templates can enhance review efficiency and success rates. For variable specifications, see [TemplateContent Variable Parameter Filling Specifications](https://help.aliyun.com/zh/sms/templaterule-template-variable-parameter-filling-example).', + 'type' => 'string', + 'required' => true, + 'example' => 'You are applying for mobile registration. The verification code is: ${code}. It is valid for 5 minutes!'."\n" + ."\n", + 'maxLength' => 500, + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'Please describe the business scenario where you use SMS or provide an online link to the scenario, along with a complete example of the SMS (with variable contents filled), as complete information helps increase the template approval rate. Failure to follow guidelines or leaving this field blank may affect the approval of your template.', + 'type' => 'string', + 'required' => false, + 'example' => 'Request verification code SMS.'."\n" + ."\n", + 'maxLength' => 500, + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => 'SMS type. Values:'."\n" + ."\n" + .'- **0**: Verification code.'."\n" + .'- **1**: SMS notification.'."\n" + .'- **2**: Promotional message.'."\n" + .'- **3**: International/Hong Kong, Macao, and Taiwan messages.'."\n" + ."\n" + .'> Only enterprise-verified users can apply for promotional messages and international/Hong Kong, Macao, and Taiwan messages. For details on the differences between personal and enterprise user rights, please refer to [Usage Instructions](https://help.aliyun.com/zh/sms/user-guide/usage-notes?spm=a2c4g.11186623.0.0.67447f576NJnE8).', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + 'enum' => [ + '0', + '1', + '2', + '3', + ], + ], + ], + [ + 'name' => 'RelatedSignName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The signature name that the template needs to be associated with. The associated SMS signature must have passed the review.'."\n" + ."\n" + .'This parameter is mandatory when the TemplateType parameter is **0**, **1**, or **2**.'."\n" + ."\n" + .'<notice>Associating a signature can expedite the review process. Note that this associated signature is unrelated to the signature selected when sending SMS messages.</notice>', + 'type' => 'string', + 'required' => false, + 'example' => 'Aliyun', + ], + ], + [ + 'name' => 'TemplateRule', + 'in' => 'query', + 'schema' => [ + 'description' => 'Template variable rules.'."\n" + ."\n" + .'For filling in variable rules, refer to the [Sample Documentation](https://help.aliyun.com/zh/sms/templaterule-template-variable-parameter-filling-example).', + 'type' => 'string', + 'required' => false, + 'example' => '{"code":"characterWithNumber"}'."\n", + ], + ], + [ + 'name' => 'MoreData', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Additional materials you can upload, such as business proof documents or screenshots, to help reviewers understand your business details.'."\n" + ."\n" + .'This parameter is optional; please fill it in according to actual needs.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about files uploaded to OSS.'."\n" + .'For file upload operations, refer to [Upload Files via OSS](https://help.aliyun.com/zh/sms/upload-files-through-oss).', + 'type' => 'string', + 'required' => false, + 'example' => '10098689758*****/1234qwe.png', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ApplySceneContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'If there is an applicable scenario, you can fill it in.', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com/'."\n", + ], + ], + [ + 'name' => 'IntlType', + 'in' => 'query', + 'schema' => [ + 'description' => 'International/Hong Kong, Macao, and Taiwan template type. When the **TemplateType** parameter is **3**, this parameter is required for international/Hong Kong, Macao, and Taiwan templates, with values:'."\n" + .'- **0**: Verification code.'."\n" + .'- **1**: SMS notification.'."\n" + .'- **2**: Promotional message.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'TrafficDriving', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID generated by Alibaba Cloud for this request, which is a unique identifier that can be used for troubleshooting and issue定位.', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'Code' => [ + 'description' => 'Request status code.'."\n" + ."\n" + .'* OK indicates a successful request.'."\n" + .'* For other error codes, refer to the **Error Codes** section of this chapter or the product\'s [API Error Codes](~~101346~~).', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'Description of the status code.', + 'type' => 'string', + 'example' => 'successful', + ], + 'TemplateName' => [ + 'description' => 'SMS template name.', + 'type' => 'string', + 'example' => 'aliyunCode', + ], + 'TemplateCode' => [ + 'description' => 'SMS template code.'."\n" + ."\n" + .'After submitting the template application, you can use the SMS template code to query the template audit details via the [GetSmsTemplate](https://help.aliyun.com/zh/sms/developer-reference/api-dysmsapi-2017-05-25-getsmstemplate?) API. You can also [configure delivery receipts](https://help.aliyun.com/zh/sms/developer-reference/configure-delivery-receipts-1?spm), and obtain the template audit status messages through TemplateSmsReport.', + 'type' => 'string', + 'example' => 'SMS_10000****', + ], + 'OrderId' => [ + 'description' => 'Work order ID.'."\n" + ."\n" + .'This parameter is used by auditors when querying audits. If you need expedited review, you must provide this work order number.', + 'type' => 'string', + 'example' => '2005020****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + [ + 'errorCode' => 'AssocSignUnapproved', + 'errorMessage' => 'Associated signature must be approved.', + ], + [ + 'errorCode' => 'InvalidTemplateRule.Format', + 'errorMessage' => 'The parameter TemplateRule format must be JSON.', + ], + [ + 'errorCode' => 'InvalidMoreData', + 'errorMessage' => 'Specified parameter MoreData is not valid.', + ], + [ + 'errorCode' => 'TemplateVarLimitExceeded', + 'errorMessage' => 'The verification code template only supports one variable.', + ], + [ + 'errorCode' => 'InvalidTemplateContent.Format', + 'errorMessage' => 'Invalid template content format.', + ], + [ + 'errorCode' => 'InvalidTemplateRule', + 'errorMessage' => 'The template variable format is non-standard. Please refer to the variable format specifications in the help documentation.', + ], + [ + 'errorCode' => 'ServiceNotOpened', + 'errorMessage' => 'This product service is not opened.', + ], + ], + 404 => [ + [ + 'errorCode' => 'MissingTemplateName', + 'errorMessage' => 'The template name cannot be empty.', + ], + [ + 'errorCode' => 'SmsSignatureNotFound', + 'errorMessage' => 'The associated SMS signature does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE991\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"successful\\",\\n \\"TemplateName\\": \\"验证码模板\\",\\n \\"TemplateCode\\": \\"SMS_10000****\\",\\n \\"OrderId\\": \\"2005020****\\"\\n}","type":"json"}]', + 'title' => 'Apply for SMS Template (New Interface)', + 'description' => '- For details about the changes of this new interface compared to the original one, please refer to [Announcement on the Update of SMS Service Signature & Template Interfaces](https://help.aliyun.com/zh/sms/product-overview/announcement-on-sms-service-update-signature-template-interface).'."\n" + ."\n" + .'- It is recommended to apply for SMS templates via the API with at least a 30-second interval between each request.'."\n" + ."\n" + .'- The template information applied through the API will be synchronized in the SMS service console. For operations related to templates in the console, please refer to SMS Templates.'."\n" + ."\n" + .'- After submitting the template application, you can query the audit status and details using the GetSmsTemplate interface. You can also configure delivery receipts to obtain the audit status messages via TemplateSmsReport.'."\n" + ."\n" + .'- Domestic SMS templates are not interchangeable with international/Hong Kong, Macao, and Taiwan SMS templates. Please apply for templates based on your business scenario.'."\n" + ."\n" + .'- Only enterprise-verified users can apply for promotional messages and international/Hong Kong, Macao, and Taiwan messages. For differences in rights between personal and enterprise users, please refer to Usage Instructions.', + ], + 'GetSmsTemplate' => [ + 'summary' => 'Query Text SMS Template Details', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '217890', + 'abilityTreeNodes' => [ + 'FEATUREdysms2H0K7P', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'SMS template code.'."\n" + ."\n" + .'- Obtain the SMS template code from the return parameters of the [CreateSmsTemplate](https://help.aliyun.com/zh/sms/developer-reference/api-dysmsapi-2017-05-25-createsmstemplate?spm) API.'."\n" + .'- View the SMS template code on the [Template Management](https://dysms.console.aliyun.com/domestic/text/template) page.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SMS_20375****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request and can be used for troubleshooting and issue定位.', + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E47708****', + ], + 'Code' => [ + 'description' => 'Request status code.'."\n" + ."\n" + .'* OK indicates a successful request.'."\n" + .'* For other error codes, please refer to [API Error Codes](~~101346~~).', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'Description of the status code.', + 'type' => 'string', + 'example' => 'OK', + ], + 'TemplateName' => [ + 'description' => 'Name of the SMS template.', + 'type' => 'string', + 'example' => '验证码', + ], + 'TemplateCode' => [ + 'description' => 'SMS template code.', + 'type' => 'string', + 'example' => 'SMS_20375****', + ], + 'TemplateContent' => [ + 'description' => 'Content of the SMS template.', + 'type' => 'string', + 'example' => '您正在申请手机注册，验证码为：${code}，5分钟内有效！', + ], + 'TemplateType' => [ + 'description' => 'SMS type. Values:'."\n" + ."\n" + .'- **0**: Verification code.'."\n" + .'- **1**: SMS notification.'."\n" + .'- **2**: Promotional SMS.'."\n" + .'- **3**: International/Hong Kong, Macao, and Taiwan messages.'."\n" + ."\n" + .'> Only enterprise-certified users can apply for promotional SMS and international/Hong Kong, Macao, and Taiwan messages. For details on the differences between personal and enterprise user rights, please refer to [Usage Notes](https://help.aliyun.com/zh/sms/user-guide/usage-notes?spm=a2c4g.11186623.0.0.67447f576NJnE8).', + 'type' => 'string', + 'example' => '0', + ], + 'TemplateStatus' => [ + 'description' => 'Template review status. Return values:'."\n" + ."\n" + .'- **0**: Under review.'."\n" + .'- **1**: Approved.'."\n" + .'- **2**: Not approved, with reasons for failure returned. Please refer to [Handling Suggestions for Failed SMS Reviews](https://help.aliyun.com/zh/sms/user-guide/causes-of-application-failures-and-suggestions?spm=a2c4g.11186623.0.0.41fd339f3bPSCQ), invoke the [UpdateSmsTemplate](https://help.aliyun.com/zh/sms/developer-reference/api-dysmsapi-2017-05-25-updatesmstemplate?spm) API or modify the SMS template on the [Template Management](https://dysms.console.aliyun.com/domestic/text/template) page.'."\n" + .'- **10**: Review canceled.', + 'type' => 'string', + 'example' => '2', + ], + 'RelatedSignName' => [ + 'description' => 'The SMS signature associated with the template when applied.', + 'type' => 'string', + 'example' => '阿里云', + ], + 'TemplateTag' => [ + 'description' => 'Template identifier, indicating whether the template is user-defined or system-provided. Values:'."\n" + ."\n" + .'- **2**: User-defined template.'."\n" + ."\n" + .'- **3**: System-provided template.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'OrderId' => [ + 'description' => 'Work order number.'."\n" + ."\n" + .'This parameter is used by auditors when querying the audit. You need to provide this work order number when requesting expedited review.', + 'type' => 'string', + 'example' => '2003019****', + ], + 'VariableAttribute' => [ + 'description' => 'Template variable rules.'."\n" + ."\n" + .'For detailed rules of template variables, refer to the [Example Document](https://help.aliyun.com/zh/sms/templaterule-template-variable-parameter-filling-example).', + 'type' => 'string', + 'example' => '{"code":"characterWithNumber"}'."\n", + ], + 'Remark' => [ + 'description' => 'Explanation for the SMS template application, which is one of the reference information for template review.', + 'type' => 'string', + 'example' => '申请验证码模板', + ], + 'CreateDate' => [ + 'description' => 'The time when the SMS template was created.', + 'type' => 'string', + 'example' => '2024-06-03 10:02:34', + ], + 'AuditInfo' => [ + 'description' => 'Audit information.', + 'type' => 'object', + 'properties' => [ + 'RejectInfo' => [ + 'description' => 'Reasons for failed audit.', + 'type' => 'string', + 'example' => '模板内容中包含错别字。', + ], + 'AuditDate' => [ + 'description' => 'Audit date and time.', + 'type' => 'string', + 'example' => '2024-06-03 11:20:34'."\n", + ], + ], + ], + 'FileUrlList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FileUrl' => [ + 'description' => 'File information, compatible with signatures created by the [AddSmsSign](https://help.aliyun.com/zh/sms/developer-reference/api-dysmsapi-2017-05-25-addsmstemplate?spm) API.', + 'type' => 'array', + 'items' => [ + 'description' => 'File details.', + 'type' => 'string', + 'example' => '//alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/1800975045205261/data.jpg?Expires=1718202335&OSSAccessKeyId=bypFNb*****73PsLI&Signature=3dBy9k%2B0%2B8DnCsvzsHi68GHzRg0%3D', + ], + ], + ], + ], + 'MoreDataFileUrlList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'MoreDataFileUrl' => [ + 'description' => 'Additional documentation information, supplementing uploaded business proof files or operational screenshots file list.', + 'type' => 'array', + 'items' => [ + 'description' => 'File information on OSS.', + 'type' => 'string', + 'example' => '//alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/1800975045205261/test.jpg?Expires=1718202335&OSSAccessKeyId=bypFNb*****73PsLI&Signature=3dBy9k%2B0%2B8DnCsvzsHi68GHzRg0%3D', + ], + ], + ], + ], + 'IntlType' => [ + 'description' => 'International/Hong Kong, Macao, and Taiwan template type. When the **TemplateType** parameter is **3**, this parameter is required for international/Hong Kong, Macao, and Taiwan templates, with values:'."\n" + .'- **0**: Verification code.'."\n" + .'- **1**: SMS notification.'."\n" + .'- **2**: Promotional SMS.', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ApplyScene' => [ + 'description' => 'Application scenario content.', + 'type' => 'string', + 'example' => 'http://www.aliyun.com/'."\n", + ], + 'VendorAuditStatus' => [ + 'title' => ' 各运营商审核状态 key: MOBILE_VENDOR, TELECOM_VENDOR, UNICOM_VENDOR value: 运营商审核状态 0: 审核中 1:通过 2:不通过 15: 已失效'."\n" + .' ', + 'type' => 'object', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + 404 => [ + [ + 'errorCode' => 'TemplateNotFound', + 'errorMessage' => 'The template does not exist.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"TemplateName\\": \\"验证码\\",\\n \\"TemplateCode\\": \\"SMS_20375****\\",\\n \\"TemplateContent\\": \\"您正在申请手机注册，验证码为：${code}，5分钟内有效！\\",\\n \\"TemplateType\\": \\"0\\",\\n \\"TemplateStatus\\": \\"2\\",\\n \\"RelatedSignName\\": \\"阿里云\\",\\n \\"TemplateTag\\": 2,\\n \\"OrderId\\": \\"2003019****\\",\\n \\"VariableAttribute\\": \\"{\\\\\\"code\\\\\\":\\\\\\"characterWithNumber\\\\\\"}\\\\n\\",\\n \\"Remark\\": \\"申请验证码模板\\",\\n \\"CreateDate\\": \\"2024-06-03 10:02:34\\",\\n \\"AuditInfo\\": {\\n \\"RejectInfo\\": \\"模板内容中包含错别字。\\",\\n \\"AuditDate\\": \\"2024-06-03 11:20:34\\\\n\\"\\n },\\n \\"FileUrlList\\": {\\n \\"FileUrl\\": [\\n \\"//alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/1800975045205261/data.jpg?Expires=1718202335&OSSAccessKeyId=bypFNb*****73PsLI&Signature=3dBy9k%2B0%2B8DnCsvzsHi68GHzRg0%3D\\"\\n ]\\n },\\n \\"MoreDataFileUrlList\\": {\\n \\"MoreDataFileUrl\\": [\\n \\"//alicom-fc-media.cn-hangzhou.oss.aliyun-inc.com/1800975045205261/test.jpg?Expires=1718202335&OSSAccessKeyId=bypFNb*****73PsLI&Signature=3dBy9k%2B0%2B8DnCsvzsHi68GHzRg0%3D\\"\\n ]\\n },\\n \\"IntlType\\": 0,\\n \\"ApplyScene\\": \\"http://www.aliyun.com/\\\\n\\",\\n \\"VendorAuditStatus\\": {\\n \\"MOBILE_VENDOR\\": 0,\\n \\"TELCOM_VENDOR\\": 0,\\n \\"UNICOM_VENDOR\\": 0\\n }\\n}","type":"json"}]', + 'title' => 'Query SMS Template Audit Details (New Interface)', + 'description' => '- For details about the announcement of changes to the new and original interfaces, see [Announcement on Updates to SMS Service Signature & Template Interfaces](https://help.aliyun.com/zh/sms/product-overview/announcement-on-sms-service-update-signature-template-interface).'."\n" + .'- Review Time: Under normal circumstances, Alibaba Cloud expects to complete the review within 2 hours after template submission (review working hours: Monday to Sunday 9:00~21:00, with statutory holidays postponed). It is recommended to submit your application before 18:00.'."\n" + ."\n" + .'- If the template fails the review, the reason for the failure will be returned. Please refer to [Handling Suggestions for Failed SMS Reviews](https://help.aliyun.com/zh/sms/user-guide/causes-of-application-failures-and-suggestions?spm=a2c4g.11186623.0.0.41fd339f3bPSCQ), invoke the [ModifySmsTemplate](https://help.aliyun.com/zh/sms/developer-reference/api-dysmsapi-2017-05-25-modifysmstemplate?spm=a2c4g.11186623.0.0.5b1f6e8bQloFit) API or modify the SMS template on the [Template Management](https://dysms.console.aliyun.com/domestic/text/template) page.'."\n" + ."\n" + .'- The current QuerySmsTemplate interface queries the audit details of a single template by template code. The [QuerySmsTemplateList](https://help.aliyun.com/zh/sms/developer-reference/api-dysmsapi-2017-05-25-querysmstemplatelist?spm=a2c4g.11186623.0.0.24086e8bO8cFn4) interface can query the template details of all templates under your current account.', + ], + 'QuerySmsTemplateList' => [ + 'summary' => 'Queries message templates.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '118761', + 'abilityTreeNodes' => [ + 'FEATUREdysms2H0K7P', + ], + ], + 'parameters' => [ + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of templates per page. Valid values: **1 to 50**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E47708****', + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'SmsTemplateList' => [ + 'description' => 'The queried message templates.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TemplateCode' => [ + 'description' => 'The code of the message template.'."\n" + ."\n" + .'You can log on to the [Short Message Service (SMS) console](https://dysms.console.aliyun.com/dysms.htm), click **Go China** or **Go Globe** in the left-side navigation pane, and then view the template code on the **Templates** tab. You can also call the [AddSmsTemplate](~~121208~~) operation to obtain the template code.'."\n", + 'type' => 'string', + 'example' => 'SMS_1525***', + ], + 'TemplateName' => [ + 'description' => 'The name of the message template.'."\n", + 'type' => 'string', + 'example' => 'aliyun verification code', + ], + 'OuterTemplateType' => [ + 'description' => 'The type of the message template. We recommend that you specify this parameter. Valid values:'."\n" + ."\n" + .'* **0**: verification code'."\n" + .'* **1**: notification message'."\n" + .'* **2**: promotional message'."\n" + .'* **3**: message sent to countries or regions outside the Chinese mainland'."\n" + .'* **7**: digital message'."\n" + ."\n" + .'> The template type is the same as the value of the TemplateType parameter in the AddSmsTemplate and ModifySmsTemplate operations.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AuditStatus' => [ + 'description' => 'The approval status of the message template. Valid values:'."\n" + ."\n" + .'* **AUDIT_STATE_INIT**: The message template is pending approval.'."\n" + .'* **AUDIT_STATE_PASS**: The message template is approved.'."\n" + .'* **AUDIT_STATE_NOT_PASS**: The message template is rejected. You can view the reason in the Reason response parameter.'."\n" + .'* **AUDIT_STATE_CANCEL** or **AUDIT_SATE_CANCEL**: The approval is canceled.'."\n", + 'type' => 'string', + 'example' => 'AUDIT_STATE_PASS', + ], + 'TemplateContent' => [ + 'description' => 'The content of the message template.'."\n", + 'type' => 'string', + 'example' => '123456789', + ], + 'CreateDate' => [ + 'description' => 'The time when the message template was created. The time is in the yyyy-MM-dd HH:mm:ss format.'."\n", + 'type' => 'string', + 'example' => '2020-06-04 11:42:17', + ], + 'Reason' => [ + 'description' => 'The approval remarks.'."\n" + ."\n" + .'* If the value of AuditStatus is **AUDIT_STATE_PASS** or **AUDIT_STATE_INIT**, the value of Reason is No Approval Remarks.'."\n" + .'* If the value of AuditStatus is **AUDIT_STATE_NOT_PASS**, the reason why the message template is rejected is returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RejectDate' => [ + 'description' => 'The time when the message template was rejected. Format: yyyy-MM-dd HH:mm:ss.'."\n", + 'type' => 'string', + 'example' => '2020-06-04 16:01:17', + ], + 'RejectInfo' => [ + 'description' => 'The reason why the message template was rejected.'."\n", + 'type' => 'string', + 'example' => 'The document cannot verify the authenticity of the information. Please upload it again.', + ], + 'RejectSubInfo' => [ + 'description' => 'The remarks about the rejection.'."\n", + 'type' => 'string', + 'example' => 'The document cannot verify the authenticity of the information. Please upload it again.', + ], + ], + ], + 'OrderId' => [ + 'description' => 'The ticket ID.'."\n", + 'type' => 'string', + 'example' => '2361****', + ], + 'TemplateType' => [ + 'description' => 'The type of the message template. Valid values:'."\n" + ."\n" + .'* **0**: notification message'."\n" + .'* **1**: promotional message'."\n" + .'* **2**: verification code'."\n" + .'* **6**: message sent to countries or regions outside the Chinese mainland'."\n" + .'* **7**: digital message'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7', + ], + 'SignatureName' => [ + 'type' => 'string', + ], + 'TrafficDriving' => [ + 'type' => 'string', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => 'The total number of templates.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'CurrentPage' => [ + 'description' => 'The page number. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => 'The number of templates per page. Valid values: **1 to 50**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E47708****\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"SmsTemplateList\\": [\\n {\\n \\"TemplateCode\\": \\"SMS_1525***\\",\\n \\"TemplateName\\": \\"验证码模板\\",\\n \\"OuterTemplateType\\": 0,\\n \\"AuditStatus\\": \\"AUDIT_STATE_PASS\\",\\n \\"TemplateContent\\": \\"验证码为：${code}，您正在注册成为平台会员，感谢您的支持！\\",\\n \\"CreateDate\\": \\"2020-06-04 11:42:17\\",\\n \\"Reason\\": {\\n \\"RejectDate\\": \\"2020-06-04 16:01:17\\",\\n \\"RejectInfo\\": \\"变量不符合规范\\",\\n \\"RejectSubInfo\\": \\"变量属性选择错误。\\\\n请根据业务使用场景选择合适的变量属性。\\"\\n },\\n \\"OrderId\\": \\"2004983****\\",\\n \\"TemplateType\\": 2,\\n \\"SignatureName\\": \\"阿里云\\",\\n \\"TrafficDriving\\": \\"[{\\\\\\"trafficDrivingType\\\\\\":\\\\\\"DOMAIN\\\\\\",\\\\\\"trafficDrivingContent\\\\\\":\\\\\\"aliyun.com\\\\\\",\\\\\\"companyName\\\\\\":\\\\\\"阿里云计算有限公司\\\\\\",\\\\\\"organizationCode\\\\\\":\\\\\\"91330****73959654P\\\\\\",\\\\\\"icpNo\\\\\\":\\\\\\"浙B2-20****01-4\\\\\\",\\\\\\"icpPicOssKey\\\\\\":\\\\\\"db7784d8-cb0c-498f-****-295f1ad6d665_mf29l7nf.png\\\\\\",\\\\\\"companyDifferentFromSignQuaReason\\\\\\":\\\\\\"这是一段说明文字\\\\\\"},{\\\\\\"trafficDrivingType\\\\\\":\\\\\\"1_PHONE\\\\\\",\\\\\\"trafficDrivingContent\\\\\\":\\\\\\"1**86\\\\\\",\\\\\\"variableName\\\\\\":\\\\\\"my1Phone\\\\\\",\\\\\\"companyName\\\\\\":\\\\\\"阿里云计算有限公司\\\\\\",\\\\\\"organizationCode\\\\\\":\\\\\\"91330****73959654P\\\\\\",\\\\\\"companyDifferentFromSignQuaReason\\\\\\":\\\\\\"这是一段说明文字\\\\\\"}]\\"\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"CurrentPage\\": 1,\\n \\"PageSize\\": 10\\n}","errorExample":""},{"type":"xml","example":"<QuerySmsTemplateListResponse>\\n <RequestId>819BE656-D2E0-4858-8B21-B2E47708****</RequestId>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <SmsTemplateList>\\n <TemplateCode>SMS_1525***</TemplateCode>\\n <TemplateName>阿里云短信测试模板</TemplateName>\\n <TemplateType>7</TemplateType>\\n <AuditStatus>AUDIT_STATE_PASS</AuditStatus>\\n <TemplateContent>123456789</TemplateContent>\\n <CreateDate>2020-06-04 11:42:17</CreateDate>\\n <Reason>\\n <RejectDate>2020-06-04 16:01:17</RejectDate>\\n <RejectInfo>无审批备注</RejectInfo>\\n <RejectSubInfo>无审批备注</RejectSubInfo>\\n </Reason>\\n <OrderId>2361****</OrderId>\\n </SmsTemplateList>\\n</QuerySmsTemplateListResponse>","errorExample":""}]', + 'title' => 'QuerySmsTemplateList', + 'description' => 'You can call this operation to query the details of message templates, including the name, creation time, and approval status of each template. If a message template is rejected, the reason is returned. Modify the message template based on the reason.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 10 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.'."\n", + ], + 'UpdateSmsTemplate' => [ + 'summary' => 'Update Text SMS Template', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219284', + 'abilityTreeNodes' => [ + 'FEATUREdysms2H0K7P', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Template name, up to 30 characters in length.', + 'type' => 'string', + 'required' => true, + 'example' => '验证码', + 'maxLength' => 30, + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'Template Code of an unapproved template.', + 'type' => 'string', + 'required' => true, + 'example' => 'SMS_152550****', + ], + ], + [ + 'name' => 'TemplateContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'Template content, up to 500 characters in length.'."\n" + ."\n" + .'Both the template content and variable content must comply with SMS regulations; otherwise, the template will fail the review. You can also view common template examples on the template application page. Using sample templates can enhance review efficiency and success rates. Variable specifications can be found in [TemplateContent Parameter Variable Specifications](https://help.aliyun.com/zh/sms/templaterule-template-variable-parameter-filling-example?spm).', + 'type' => 'string', + 'required' => true, + 'example' => '您正在申请手机注册，验证码为：${code}，5分钟内有效！', + 'maxLength' => 500, + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'Explanation for the SMS template application, which serves as a reference for template review.', + 'type' => 'string', + 'required' => false, + 'example' => '登录场景使用验证码', + 'maxLength' => 500, + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => 'SMS type. Values:'."\n" + ."\n" + .'- **0**: Verification code.'."\n" + .'- **1**: SMS notification.'."\n" + .'- **2**: Promotional SMS.'."\n" + .'- **3**: International/Hong Kong, Macao, and Taiwan messages.'."\n" + ."\n" + .'> Only enterprise-certified users can apply for promotional SMS and international/Hong Kong, Macao, and Taiwan messages. Details on differences between personal and enterprise user rights are available in [Usage Guidelines](https://help.aliyun.com/zh/sms/user-guide/usage-notes?spm=a2c4g.11186623.0.0.67447f576NJnE8).', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + 'enum' => [ + '0', + '1', + '2', + '3', + ], + ], + ], + [ + 'name' => 'RelatedSignName', + 'in' => 'query', + 'schema' => [ + 'description' => 'SMS signature associated with the template during the application.', + 'type' => 'string', + 'required' => false, + 'example' => '阿里云', + ], + ], + [ + 'name' => 'TemplateRule', + 'in' => 'query', + 'schema' => [ + 'description' => 'Template variable rules.'."\n" + ."\n" + .'For guidance on filling variable rules, refer to the [Sample Documentation](https://help.aliyun.com/zh/sms/templaterule-template-variable-parameter-filling-example?spm).', + 'type' => 'string', + 'required' => false, + 'example' => '{"code":"characterWithNumber"}', + ], + ], + [ + 'name' => 'MoreData', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'Additional information, such as uploading business proof documents or screenshots, to help reviewers understand your business details. Optional and can be left unset.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about files uploaded to OSS.'."\n" + .'For file upload operations, see [Upload Files via OSS](https://help.aliyun.com/zh/sms/upload-files-through-oss).', + 'type' => 'string', + 'required' => false, + 'example' => '10098689758****/1234qwe.png', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ApplySceneContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'Application scenarios, instructions as follows:'."\n" + .'- For registered websites, please enter the MIIT-registered domain with HTTP or HTTPS.'."\n" + .'- For launched apps, provide the app store display link with HTTP or HTTPS, ensuring the app is online.'."\n" + .'- For public accounts or mini-programs, enter the full name of the public account or mini-program, ensuring they are online.'."\n" + .'- For e-commerce platform stores, applicable only to enterprise users, enter the display link of the e-commerce store with HTTP or HTTPS.', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com/'."\n", + ], + ], + [ + 'name' => 'IntlType', + 'in' => 'query', + 'schema' => [ + 'description' => 'International/Hong Kong, Macao, and Taiwan template type. When the **TemplateType** parameter is **3**, this parameter is required for international/Hong Kong, Macao, and Taiwan templates, with values:'."\n" + .'- **0**: Verification code.'."\n" + .'- **1**: SMS notification.'."\n" + .'- **2**: Promotional SMS.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'TrafficDriving', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request and can be used to troubleshoot and locate issues.', + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF', + ], + 'Code' => [ + 'description' => 'Request status code.'."\n" + ."\n" + .'* OK indicates a successful request.'."\n" + .'* For other error codes, refer to the **Error Codes** section of this chapter or the product\'s [API Error Codes](~~101346~~).', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'Description of the status code.', + 'type' => 'string', + 'example' => 'OK', + ], + 'TemplateName' => [ + 'description' => 'Name of the SMS template.', + 'type' => 'string', + 'example' => '验证码', + ], + 'TemplateCode' => [ + 'description' => 'Code of the SMS template.', + 'type' => 'string', + 'example' => 'SMS_152550****', + ], + 'OrderId' => [ + 'description' => 'Work order number.'."\n" + ."\n" + .'This parameter is used by auditors when querying audits. You need to provide this work order number when requesting expedited review.', + 'type' => 'string', + 'example' => '20041271****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + [ + 'errorCode' => 'AssocSignUnapproved', + 'errorMessage' => 'Associated signature must be approved.', + ], + [ + 'errorCode' => 'InvalidTemplateRule', + 'errorMessage' => 'The template variable format is non-standard. Please refer to the variable format specifications in the help documentation.', + ], + [ + 'errorCode' => 'InvalidTemplateRule.Format', + 'errorMessage' => 'The parameter TemplateRule format must be JSON.', + ], + [ + 'errorCode' => 'InvalidMoreData', + 'errorMessage' => 'Specified parameter MoreData is not valid.', + ], + [ + 'errorCode' => 'TemplateVarLimitExceeded', + 'errorMessage' => 'The verification code template only supports one variable.', + ], + [ + 'errorCode' => 'InvalidTemplateContent.Format', + 'errorMessage' => 'Invalid template content format.', + ], + [ + 'errorCode' => 'ServiceNotOpened', + 'errorMessage' => 'This product service is not opened.', + ], + ], + 404 => [ + [ + 'errorCode' => 'MissingTemplateName', + 'errorMessage' => 'The template name cannot be empty.', + ], + [ + 'errorCode' => 'SmsSignatureNotFound', + 'errorMessage' => 'The associated SMS signature does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AA0\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"TemplateName\\": \\"验证码\\",\\n \\"TemplateCode\\": \\"SMS_152550****\\",\\n \\"OrderId\\": \\"20041271****\\"\\n}","type":"json"}]', + 'title' => 'Update SMS Template (New Interface)', + 'description' => '- For details about the changes of this new interface compared to the original one, please refer to [Announcement on SMS Service Update: Signature & Template Interfaces](https://help.aliyun.com/zh/sms/product-overview/announcement-on-sms-service-update-signature-template-interface).'."\n" + .'- Only templates that have not passed the review can be modified. Please refer to [Handling Suggestions for Failed SMS Template Reviews](https://help.aliyun.com/zh/sms/user-guide/causes-of-application-failures-and-suggestions?spm=a2c4g.11186623.0.0.4bf5561ajcFtMQ) and call this interface to modify and resubmit for review.'."\n" + ."\n" + .'- Modifications made through the interface will be synchronized in the SMS service console. For related operations on templates in the console, see [SMS Templates](https://help.aliyun.com/zh/sms/user-guide/message-templates/?spm=a2c4g.11186623.0.0.35a947464Itaxp).'."\n" + ."\n" + .'### QPS Limit'."\n" + .'The single-user QPS limit for this interface is 1000 times/second. Exceeding this limit will result in API throttling, which may impact your business. Please make calls reasonably.', + ], + 'DeleteSmsTemplate' => [ + 'summary' => 'Deletes a message template.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102445', + 'abilityTreeNodes' => [ + 'FEATUREdysms2H0K7P', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the message template.'."\n" + ."\n" + .'You can log on to the [Alibaba Cloud SMS console](https://dysms.console.aliyun.com/dysms.htm) and obtain the message template code on the **Message Templates** tab. You can also obtain the message template code by calling the [AddSmsTemplate](~~121208~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SMS_152550****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CCA2BCFF-2BA7-427C-90EE-AC6994748607', + ], + 'TemplateCode' => [ + 'description' => 'The code of the message template.'."\n", + 'type' => 'string', + 'example' => 'SMS_20375****', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"CCA2BCFF-2BA7-427C-90EE-AC6994748607\\",\\n \\"TemplateCode\\": \\"SMS_152550****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<DeleteSmsTemplateResponse>\\r\\n\\t<TemplateCode>SMS_20375****</TemplateCode>\\r\\n\\t<Message>OK</Message>\\r\\n\\t<RequestId>CCA2BCFF-2BA7-427C-90EE-AC6994748607</RequestId>\\r\\n\\t<Code>OK</Code>\\r\\n</DeleteSmsTemplateResponse>","errorExample":""}]', + 'title' => 'DeleteSmsTemplate', + 'description' => '* Message templates pending approval can be withdrawn. You can delete a message template pending approval on the Message Templates tab in the [Alibaba Cloud SMS console](https://dysms.console.aliyun.com/dysms.htm#/overview).'."\n" + .'* Message templates that have been approved can be deleted, and cannot be modified. You can delete a message template pending approval on the Message Templates tab in the [Alibaba Cloud SMS console](https://dysms.console.aliyun.com/dysms.htm#/overview).'."\n" + .'* You cannot recover deleted message templates. Proceed with caution.'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'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.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddSmsTemplate' => [ + 'summary' => 'Creates a message template.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102439', + 'abilityTreeNodes' => [ + 'FEATUREdysms2H0K7P', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the message. Valid values:'."\n" + ."\n" + .'* **0**: verification code'."\n" + .'* **1**: notification'."\n" + .'* **2**: promotional message'."\n" + .'* **3**: message sent to countries or regions outside the Chinese mainland'."\n" + ."\n" + .'> Only enterprise users can send promotional messages, or send messages to countries or regions outside the Chinese mainland.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the template. The name can be up to 30 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Aliyun Test', + ], + ], + [ + 'name' => 'TemplateContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the template. The content can be up to 500 characters in length. For more information, see [Message template specifications](~~108253~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'You are applying for mobile registration. The verification code is: ${code}, valid for 5 minutes!', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the message template. It is one of the reference information for template review. The description cannot exceed 100 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Apply for a template to send verification codes.', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'TemplateCode' => [ + 'description' => 'The code of the message template.'."\n", + 'type' => 'string', + 'example' => 'SMS_15255****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'TemplateParameterCountIllegal', + 'errorMessage' => 'The verification code template only supports 1 verification code as a variable', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Dysmsapi::2017-05-25::CreateSmsTemplate', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"TemplateCode\\": \\"SMS_46817****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<AddSmsTemplateResponse>\\r\\n <TemplateCode>SMS_1525****</TemplateCode>\\r\\n <Message>OK</Message>\\r\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\r\\n <Code>OK</Code>\\r\\n</AddSmsTemplateResponse>","errorExample":""}]', + 'title' => 'AddSmsTemplate', + 'description' => 'You can call the operation or use the [Alibaba Cloud SMS console](https://dysms.console.aliyun.com/dysms.htm#/overview) to apply for a message template. The template must comply with the [message template specifications](~~108253~~). You can call the [QuerySmsTemplate](~~419289~~) operation or use the Alibaba Cloud SMS console to check whether the message template is approved.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* Message templates pending approval can be withdrawn. You can withdraw a message template pending approval on the Message Templates tab in the [Alibaba Cloud SMS console](https://dysms.console.aliyun.com/dysms.htm#/overview).'."\n" + ."\n" + .'* Message templates that have been approved can be deleted, and cannot be modified. You can delete a message template pending approval on the Message Templates tab in the [Alibaba Cloud SMS console](https://dysms.console.aliyun.com/dysms.htm#/overview).'."\n" + ."\n" + .'* If you call the AddSmsTemplate operation, you can apply for a maximum of 100 message templates in a calendar day. After you apply for a message template, we recommend that you wait for at least 30 seconds before you apply for another one. If you use the Alibaba Cloud SMS console, you can apply for an unlimited number of message templates.'."\n" + ."\n" + .'* Messages sent to the Chinese mainland and messages sent to countries or regions outside the Chinese mainland use separate message templates. Create message templates based on your needs.'."\n" + ."\n" + .'* If you apply for a signature or message template, you must specify the signature scenario or template type. You must also provide the information of your services, such as a website URL, a domain name with an ICP filing, an application download URL, or the name of your WeChat official account or mini program. For sign-in scenarios, you must also provide an account and password for tests. A detailed description can improve the review efficiency of signatures and templates.'."\n" + ."\n" + .'* A signature must undergo a thorough review process before it can be approved for use. For more information, see [Usage notes](~~55324~~).'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'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.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifySmsTemplate' => [ + 'summary' => 'Modifies the information of an unapproved message template and submits it for review again.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102450', + 'abilityTreeNodes' => [ + 'FEATUREdysms2H0K7P', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the message. Valid values:'."\n" + ."\n" + .'* **0**: verification code'."\n" + .'* **1**: text message'."\n" + .'* **2**: promotional message'."\n" + .'* **3**: message sent to countries or regions outside the Chinese mainland'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the template. The name must be 1 to 30 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'aliyun verification code', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the message template.'."\n" + ."\n" + .'You can log on to the [Short Message Service (SMS) console](https://dysms.console.aliyun.com/dysms.htm), click **Go China** or **Go Globe** in the left-side navigation pane, and then view the template code on the **Templates** tab. You can also call the [AddSmsTemplate](~~121208~~) operation to obtain the template code.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SMS_15255****', + ], + ], + [ + 'name' => 'TemplateContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'The content of the template. The content must be 1 to 500 characters in length.'."\n" + ."\n" + .'> When you modify a template, design the template content based on the review comments.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'You are applying for mobile registration. The verification code is: ${code}, valid for 5 minutes!', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the message template. It is one of the reference information for template review. The description cannot exceed 100 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Modify the parameters of the template.', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'TemplateCode' => [ + 'description' => 'The code of the message template.'."\n", + 'type' => 'string', + 'example' => 'SMS_15255****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'TemplateParameterCountIllegal', + 'errorMessage' => 'The verification code template only supports 1 verification code as a variable', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Dysmsapi::2017-05-25::UpdateSmsTemplate', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"TemplateCode\\": \\"SMS_15255****\\"\\n}","errorExample":""},{"type":"xml","example":"<?xml version=\'1.0\' encoding=\'UTF-8\'?>\\r\\n<ModifySmsTemplateResponse>\\r\\n <TemplateCode>SMS_15255****</TemplateCode>\\r\\n <Message>OK</Message>\\r\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\r\\n <Code>OK</Code>\\r\\n</ModifySmsTemplateResponse>","errorExample":""}]', + 'title' => 'ModifySmsTemplate', + 'description' => 'After you apply for a message template, if the template fails to pass the review, you can call this operation to modify the template and submit the template again. You can call this operation to modify only a template for a specific message type.'."\n" + ."\n" + .'The template content must comply with the [SMS template specifications](~~108253~~).'."\n" + ."\n" + .'For more information, see [Usage notes](~~55324~~).'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'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.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QuerySmsTemplate' => [ + 'summary' => 'Queries the approval status of a message template.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102460', + 'abilityTreeNodes' => [ + 'FEATUREdysms2H0K7P', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the message template.'."\n" + ."\n" + .'You can log on to the [Short Message Service (SMS) console](https://dysms.console.aliyun.com/dysms.htm), click **Go China** or **Go Globe** in the left-side navigation pane, and then view the template code on the **Templates** tab. You can also call the [AddSmsTemplate](~~121208~~) operation to obtain the template code.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SMS_1525***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateContent' => [ + 'description' => 'The content of the message template.'."\n", + 'type' => 'string', + 'example' => 'You are applying for mobile registration. The verification code is: ${code}, valid for 5 minutes!', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0A974B78-02BF-4C79-ADF3-90CFBA1B55B1', + ], + 'TemplateCode' => [ + 'description' => 'The code of the message template.'."\n", + 'type' => 'string', + 'example' => 'SMS_16703****', + ], + 'TemplateStatus' => [ + 'description' => 'The approval status of the message template. Valid values:'."\n" + ."\n" + .'* **0**: The message template is pending approval.'."\n" + .'* **1**: The message template is approved.'."\n" + .'* **AUDIT_STATE_NOT_PASS**: The message template is rejected. You can view the reason in the Reason response parameter.'."\n" + .'* **10**: The approval is canceled.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'TemplateType' => [ + 'description' => 'The type of the message. Valid values:'."\n" + ."\n" + .'* **0**: verification code'."\n" + .'* **1**: notification message'."\n" + .'* **2**: promotional message'."\n" + .'* **3**: message sent to countries or regions outside the Chinese mainland'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'TemplateName' => [ + 'description' => 'The name of the message template.'."\n", + 'type' => 'string', + 'example' => 'aliyun verification code', + ], + 'CreateDate' => [ + 'description' => 'The time when the message template was created.'."\n", + 'type' => 'string', + 'example' => '2019-06-04 11:42:17', + ], + 'Reason' => [ + 'description' => 'The approval remarks.'."\n" + ."\n" + .'* If the value of AuditStatus is **AUDIT_STATE_PASS** or **AUDIT_STATE_INIT**, the value of Reason is No Approval Remarks.'."\n" + .'* If the value of AuditStatus is **AUDIT_STATE_NOT_PASS**, the reason why the message template is rejected is returned.'."\n", + 'type' => 'string', + 'example' => 'The document cannot verify the authenticity of the information. Please upload it again.', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'Dysmsapi::2017-05-25::GetSmsTemplate', + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"TemplateContent\\": \\"亲爱的会员！阿里云短信服务祝您新年快乐！\\",\\n \\"RequestId\\": \\"0A974B78-02BF-4C79-ADF3-90CFBA1B55B1\\",\\n \\"TemplateCode\\": \\"SMS_1525****\\",\\n \\"TemplateStatus\\": 0,\\n \\"Code\\": \\"OK\\",\\n \\"TemplateType\\": 1,\\n \\"Message\\": \\"OK\\",\\n \\"TemplateName\\": \\"通知短信\\",\\n \\"CreateDate\\": \\"2024-06-03 10:02:34\\",\\n \\"Reason\\": \\"无审批备注\\"\\n}","errorExample":""},{"type":"xml","example":"<QuerySmsTemplateResponse>\\n<TemplateCode>SMS_16703****</TemplateCode>\\n<Message>OK</Message>\\n<RequestId>0A974B78-02BF-4C79-ADF3-90CFBA1B55B1</RequestId>\\n<TemplateContent>亲爱的会员！阿里云短信服务祝您新年快乐！</TemplateContent>\\n<TemplateName>阿里云短信测试模板</TemplateName>\\n<TemplateType>1</TemplateType>\\n<CreateDate>2019-06-04 11:42:17</CreateDate>\\n<Code>OK</Code>\\n<Reason>无审批备注</Reason>\\n<TemplateStatus>1</TemplateStatus>\\n</QuerySmsTemplateResponse>","errorExample":""}]', + 'title' => 'QuerySmsTemplate', + 'description' => 'After you create a message template, you can call this operation to query the approval status of the template. If a message template is rejected, the reason is returned. Modify the message template based on the reason.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 5,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.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SendSms' => [ + 'summary' => 'Sends a message. Before you call this operation, submit a message signature and message template, and make sure that the signature and template are approved.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '102468', + 'abilityTreeNodes' => [ + 'FEATUREdysmsKC679O', + ], + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumbers', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mobile numbers of the recipients. Format:'."\n" + ."\n" + .'* If you send messages to the Chinese mainland, specify mobile numbers that are prefixed with +, +86, 0086, or 86, or 11-digit mobile numbers without prefixes. Example: 1390000\\*\\*\\*\\*.'."\n" + .'* If you send messages to countries or regions outside the Chinese mainland, specify this parameter in the \\<Area code>\\<Mobile number> format. Example: 852000012\\*\\*\\*\\*.'."\n" + ."\n" + .'You can send messages to multiple mobile numbers, separate the mobile numbers with commas (,). You can specify up to 1,000 mobile numbers in each request. Compared with sending messages to a single mobile number, sending messages to multiple mobile numbers requires longer response time.'."\n" + ."\n" + .'> We recommend that you send one verification code message to a mobile number in each request.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The signature.'."\n" + ."\n" + .'You can log on to the [Short Message Service (SMS) console](https://dysms.console.aliyun.com/dysms.htm?spm=5176.12818093.categories-n-products.ddysms.3b2816d0xml2NA#/overview), click **Go China** or **Go Globe** in the left-side navigation pane, and then view the signature on the **Signatures** tab.'."\n" + ."\n" + .'> You must specify a signature that is created in the SMS console and approved by Alibaba Cloud. For more information about SMS signature specifications, see [SMS signature specifications](~~108076~~).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Aliyun', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the message template.'."\n" + ."\n" + .'You can log on to the [Short Message Service (SMS) console](https://dysms.console.aliyun.com/dysms.htm?spm=5176.12818093.categories-n-products.ddysms.3b2816d0xml2NA#/overview), click **Go China** or **Go Globe** in the left-side navigation pane, and then view the **template code** on the **Templates** tab.'."\n" + ."\n" + .'> You must specify a message template that is created in the SMS console and approved by Alibaba Cloud. If you send messages to countries or regions outside the Chinese mainland, use the corresponding message templates.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'SMS_15305****', + ], + ], + [ + 'name' => 'TemplateParam', + 'in' => 'query', + 'schema' => [ + 'description' => 'The value of the variable in the message template. You can specify multiple parameter values. Example:{"name":"Sam","number":"1390000\\*\\*\\*\\*"}.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If line breaks are required in JSON-formatted data, they must meet the relevant requirements that are specified in the standard JSON protocol.'."\n" + ."\n" + .'* For more information about template variables, see [SMS template specifications](~~108253~~).'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"code":"1111"}', + ], + ], + [ + 'name' => 'SmsUpExtendCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extension code of the upstream message. Upstream messages are messages sent to the communication service provider. Upstream messages are used to customize a service, complete an inquiry, or send a request. You are charged for sending upstream messages based on the billing standards of the service provider.'."\n" + ."\n" + .'> The extension code is automatically generated by the system when the signature is generated. You do not need to specify the extension code. You can ignore this parameter if you do not have special requirements.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '90999', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extension field.'."\n" + ."\n" + .'> You can ignore this parameter if you do not have special requirements.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abcdefgh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The HTTP status code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'BizId' => [ + 'description' => 'The ID of the delivery receipt.'."\n" + ."\n" + .'You can call the [QuerySendDetails](~~QuerySendDetails~~) operation to query the delivery status based on the receipt ID.'."\n", + 'type' => 'string', + 'example' => '9006197469364984****', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"BizId\\": \\"9006197469364984****\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\"\\n}","errorExample":""},{"type":"xml","example":"<SendSmsResponse>\\n <Message>OK</Message>\\n <RequestId>44DF7A95-603F-4651-9298-BE1850BEB53F</RequestId>\\n <BizId>336006646937050335^0</BizId>\\n <Code>OK</Code>\\n</SendSmsResponse>","errorExample":""}]', + 'title' => 'SendSms', + 'description' => '* This operation is mainly used to send a single message. In special scenarios, you can send multiple messages with the same content to a maximum of 1,000 mobile numbers. Note that group sending may be delayed.'."\n" + .'* To send messages with different signatures and template content to multiple mobile numbers in a single request, call the [SendBatchSms](~~102364~~) operation.'."\n" + .'* You are charged for using Alibaba Cloud Short Message Service (SMS) based on the amount of messages sent. For more information, see [Pricing](https://www.aliyun.com/price/product#/sms/detail).'."\n" + .'* If your verification code signature and general-purpose signature have the same name, the system uses the general-purpose signature to send messages by default.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + ], + 'SendBatchSms' => [ + 'summary' => 'Uses a single message template and multiple signatures to send messages to multiple recipients.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '102462', + 'abilityTreeNodes' => [ + 'FEATUREdysmsKC679O', + ], + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumberJson', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The mobile number of the recipient. Format:'."\n" + ."\n" + .'* Message delivery to the Chinese mainland: +/+86/0086/86 or an 11-digit mobile number without a prefix. Example: 1590000\\*\\*\\*\\*.'."\n" + .'* Message delivery to countries or regions outside the Chinese mainland: Dialing code + Mobile number. Example: 852000012\\*\\*\\*\\*.'."\n" + ."\n" + .'> We recommend that you call the SendSms operation to send verification codes.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '["1590000****","1350000****"]', + ], + ], + [ + 'name' => 'SignNameJson', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The signature.'."\n" + ."\n" + .'Log on to the Alibaba Cloud SMS console. In the left-side navigation pane, click **Go Globe** or **Go China**. You can view the signature in the **Signature** column on the **Signatures** tab.'."\n" + ."\n" + .'> The signatures must be approved and correspond to the mobile numbers in sequence.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '["Aliyun","Alibaba"]', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the message template.'."\n" + ."\n" + .'Log on to the Alibaba Cloud SMS console. In the left-side navigation pane, click **Go Globe** or **Go China**. You can view the message template in the **Template Code** column on the **Message Templates** tab.'."\n" + ."\n" + .'> The message templates must be created on the Go Globe page and approved.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'SMS_15255****', + ], + ], + [ + 'name' => 'TemplateParamJson', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The value of the variable in the message template.'."\n" + ."\n" + .'> If you need to add line breaks to the JSON template, make sure that the format is valid. In addition, the sequence of variable values must be the same as that of the mobile numbers and signatures.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"name":"TemplateParamJson"},{"name":"TemplateParamJson"}]', + ], + ], + [ + 'name' => 'SmsUpExtendCodeJson', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The extension code of the MO message. Format: JSON array.'."\n" + ."\n" + .'> The parameter is optional.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["90999","90998"]', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extension field of the external record. The value is a string that contains no more than 256 characters.'."\n" + ."\n" + .'> The parameter is optional.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abcdefg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* If OK is returned, the request is successful.'."\n" + .'* Other values indicate that the request fails. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'BizId' => [ + 'description' => 'The ID of the delivery receipt. You can use one of the following methods to query the delivery status of a message based on the ID.'."\n" + ."\n" + .'* Call the [QuerySendDetails](~~102352~~) operation.'."\n" + .'* Log on to the [Alibaba Cloud SMS console](https://dysms.console.aliyun.com/dysms.htm#/overview). In the left-side navigation pane, choose **Analytics** > **Delivery Report**.'."\n", + 'type' => 'string', + 'example' => '9006197469364984400', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D230E', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"BizId\\": \\"9006197469364984400\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D230E\\"\\n}","type":"json"}]', + 'title' => 'SendBatchSms', + 'description' => 'You can call the operation to send messages to a maximum of 100 recipients at a time.'."\n", + ], + 'QuerySendDetails' => [ + 'summary' => 'Queries the information about a message.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102455', + 'abilityTreeNodes' => [ + 'FEATUREdysmsWO2BNU', + ], + ], + 'parameters' => [ + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mobile numbers of the recipients. Format:'."\n" + ."\n" + .'* If you send messages in the Chinese mainland, specify an 11-digit mobile number, for example, 1390000\\*\\*\\*\\*.'."\n" + .'* If you send messages to countries or regions outside the Chinese mainland, specify this parameter in the \\<Area code>\\<Mobile number> format. Example: 8520000\\*\\*\\*\\*.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'BizId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the delivery receipt. The delivery receipt ID is the value of the BizId parameter that is returned when you call the SendSms or SendBatchSms operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '134523^435****', + ], + ], + [ + 'name' => 'SendDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The date when the message was sent. You can query messages that were sent within the last 30 days.'."\n" + ."\n" + .'Format: yyyyMMdd. Example: 20181225.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '20181228', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of items displayed per page.'."\n" + ."\n" + .'Valid values: 1 to 50.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the first page.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF', + ], + 'TotalCount' => [ + 'description' => 'The number of sent messages.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'SmsSendDetailDTOs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SmsSendDetailDTO' => [ + 'description' => 'The details of the message.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ErrCode' => [ + 'description' => 'The status code returned by the carrier.'."\n" + ."\n" + .'* If the message is delivered, "DELIVERED" is returned.'."\n" + .'* For information about the error codes that may be returned if the message is not delivered, see [error codes](~~101347~~).'."\n", + 'type' => 'string', + 'example' => 'DELIVERED', + ], + 'TemplateCode' => [ + 'description' => 'The ID of the message template.'."\n", + 'type' => 'string', + 'example' => 'SMS_12231****', + ], + 'OutId' => [ + 'description' => 'The extended field.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'ReceiveDate' => [ + 'description' => 'The date and time when the message was received.'."\n", + 'type' => 'string', + 'example' => '2019-01-08 16:44:13', + ], + 'SendDate' => [ + 'description' => 'The date and time when the message was sent.'."\n", + 'type' => 'string', + 'example' => '2019-01-08 16:44:10', + ], + 'PhoneNum' => [ + 'description' => 'The mobile numbers of the recipients.'."\n", + 'type' => 'string', + 'example' => '1390000****', + ], + 'Content' => [ + 'description' => 'The content of the message.'."\n", + 'type' => 'string', + 'example' => '【Aliyun】This is a test message.', + ], + 'SendStatus' => [ + 'description' => 'The delivery status of the message. Valid values:'."\n" + ."\n" + .'* **1**: The message has not received a delivery receipt yet.'."\n" + .'* **2**: The message failed to be delivered.'."\n" + .'* **3**: The message was delivered.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\",\\n \\"TotalCount\\": \\"1\\",\\n \\"SmsSendDetailDTOs\\": {\\n \\"SmsSendDetailDTO\\": [\\n {\\n \\"ErrCode\\": \\"DELIVERED\\",\\n \\"TemplateCode\\": \\"SMS_12231****\\",\\n \\"OutId\\": \\"123\\",\\n \\"ReceiveDate\\": \\"2025-06-01 16:44:13\\",\\n \\"SendDate\\": \\"2025-06-01 16:44:10\\",\\n \\"PhoneNum\\": \\"1390000****\\",\\n \\"Content\\": \\"【阿里云】验证码为：123，您正在登录，若非本人操作，请勿泄露\\",\\n \\"SendStatus\\": 3\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'QuerySendDetails', + ], + 'QuerySendStatistics' => [ + 'summary' => 'Queries message delivery details.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '118726', + 'abilityTreeNodes' => [ + 'FEATUREdysmsWO2BNU', + ], + ], + 'parameters' => [ + [ + 'name' => 'IsGlobe', + 'in' => 'query', + 'schema' => [ + 'description' => 'The site from where the message is sent. Valid values:'."\n" + ."\n" + .'* **1**: China site'."\n" + .'* **2**: international site'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '2', + 'minimum' => '1', + 'example' => '1', + 'maxLength' => 2, + 'minLength' => 1, + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Format: yyyyMMdd. Example: 20181225.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '20201002', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Format: yyyyMMdd. Example: 20181225.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '20201003', + ], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: **1**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + 'minLength' => 1, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries to return on each page. Valid values: **1 to 50**.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'maxLength' => 50, + 'minLength' => 1, + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the message template. Valid values: Valid values:'."\n" + ."\n" + .'* **0**: verification code'."\n" + .'* **1**: notification'."\n" + .'* **2**: promotional message (Enterprise users only)'."\n" + .'* **3**: international purpose (Enterprise users only)'."\n" + .'* **7**: digital message'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The signature.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Aliyun', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E47708****', + ], + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* If OK is returned, the request is successful.'."\n" + .'* Other values indicate that the request fails. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalSize' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TargetList' => [ + 'description' => 'The details of the data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The number of delivered messages.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'RespondedSuccessCount' => [ + 'description' => 'The number of messages with a delivery receipt that indicates a success.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '17', + ], + 'RespondedFailCount' => [ + 'description' => 'The number of messages with a delivery receipt that indicates a failure.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'NoRespondedCount' => [ + 'description' => 'The number of messages without a delivery receipt.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SendDate' => [ + 'description' => 'The date when the message is sent. Format: yyyyMMdd. Example: 20181225.'."\n", + 'type' => 'string', + 'example' => '20201010', + ], + ], + 'description' => 'The information about the configuration.'."\n", + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\\\n\\",\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"TotalSize\\": 20,\\n \\"TargetList\\": [\\n {\\n \\"TotalCount\\": 20,\\n \\"RespondedSuccessCount\\": 17,\\n \\"RespondedFailCount\\": 2,\\n \\"NoRespondedCount\\": 1,\\n \\"SendDate\\": \\"20201010\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QuerySendStatisticsResponse>\\n <RequestId>819BE656-D2E0-4858-8B21-B2E47708****</RequestId>\\n <Code>OK</Code>\\n <Message>OK</Message>\\n <Data>\\n <TotalSize>20</TotalSize>\\n <TargetList>\\n <TotalCount>20</TotalCount>\\n <RespondedSuccessCount>17</RespondedSuccessCount>\\n <RespondedFailCount>2</RespondedFailCount>\\n <NoRespondedCount>1</NoRespondedCount>\\n <SendDate>20201010</SendDate>\\n </TargetList>\\n </Data>\\n</QuerySendStatisticsResponse>","errorExample":""}]', + 'title' => 'QuerySendStatistics', + 'description' => 'You can call the operation to query message delivery details, including the number of delivered messages, the number of messages with delivery receipts, and the time that a message is sent. If a large number of messages are sent on the specified date, you can specify the number of items displayed on each page and the number of pages to view the details by page.'."\n" + ."\n" + .'### QPS limits'."\n" + ."\n" + .'You can call this operation up to 20 times per second per account. If the number of the 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.'."\n", + ], + 'CreateDigitalSignOrder' => [ + 'summary' => '数字短信签名操作订单', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'OrderType', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'UPDATE_DIGITALSMS_SIGN' => '', + 'DELETE_DIGITALSMS_SIGN' => '', + 'CREATE_DIGITALSMS_SIGN' => '', + ], + 'example' => 'CREATE_DIGITALSMS_SIGN', + ], + ], + [ + 'name' => 'Submitter', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '110000001750080', + ], + ], + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'QualificationId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '41', + ], + ], + [ + 'name' => 'QualificationVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '49', + ], + ], + [ + 'name' => 'OrderContext', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '', + ], + ], + [ + 'name' => 'SignIndustry', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'enumValueTitles' => [ + '', + '', + ], + 'example' => '0', + ], + ], + [ + 'name' => 'SignId', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'SignSource', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'enumValueTitles' => [ + '', + 2 => '', + 5 => '', + 7 => '', + ], + 'example' => '0', + ], + ], + [ + 'name' => 'ExtendMessage', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => '2D0133B9-6C0D-0BAE-8161-1EEF9E2D4069', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'example' => '{\'signId\': \'20067468291\', \'signCode\': \'SIGN_100000184736042_1744164758835_hpMd1\', \'signOrderId\': 22469795330, \'signName\': u\'\\u8d5b\\u745e\\u5a05\\u808c\\u80a4\\u7ba1\\u7406\'}', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"2D0133B9-6C0D-0BAE-8161-1EEF9E2D4069\\",\\n \\"Message\\": \\"示例值示例值\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'QueryDigitalSignByName' => [ + 'summary' => '获取数字短信签名通过签名name', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '', + 'type' => 'object', + 'example' => '', + ], + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '', + 'false' => '', + ], + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": false\\n}","type":"json"}]', + ], + 'CreateDigitalSmsTemplate' => [ + 'summary' => '创建数字短信模板', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102441', + 'abilityTreeNodes' => [ + 'FEATUREdysms0VSOON', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'TemplateContents', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'FileContents' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + 'FileSuffix' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'txt', + ], + 'FileName' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'file-1', + ], + 'FileSize' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1840901', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SignName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'TemplateCode' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'DIGITAL_SMS_0001', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"TemplateCode\\": \\"DIGITAL_SMS_0001\\"\\n}","type":"json"}]', + ], + 'GetOSSInfoForCardTemplate' => [ + 'summary' => 'Queries the OSS configuration information about card messages.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102447', + 'abilityTreeNodes' => [ + 'FEATUREdysms17QZIS', + ], + ], + 'parameters' => [], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The HTTP status code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Signature' => [ + 'description' => 'The signature.'."\n", + 'type' => 'string', + 'example' => 'Aliyun', + ], + 'Host' => [ + 'description' => 'The hostname.'."\n", + 'type' => 'string', + 'example' => ' https://alicom-cardsms-resources.oss-cn-zhangjiakou.aliyuncs.com', + ], + 'Policy' => [ + 'description' => 'The signature policy.'."\n", + 'type' => 'string', + 'example' => 'eyJxxx0=', + ], + 'ExpireTime' => [ + 'description' => 'The timeout period.'."\n", + 'type' => 'string', + 'example' => '1634209418', + ], + 'AliUid' => [ + 'description' => 'The ID of the Alibaba Cloud account.'."\n", + 'type' => 'string', + 'example' => '599333677478****', + ], + 'AccessKeyId' => [ + 'description' => 'The AccessKey ID.'."\n", + 'type' => 'string', + 'example' => 'LTAIxetqt1Dg****', + ], + 'StartPath' => [ + 'description' => 'The path of the policy.'."\n", + 'type' => 'string', + 'example' => '1631792777', + ], + 'Bucket' => [ + 'description' => 'The name of the OSS bucket.'."\n", + 'type' => 'string', + 'example' => 'alicom-cardsms-resources', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Signature\\": \\"阿里云\\",\\n \\"Host\\": \\"http://***.aliyuncs.com\\\\n\\",\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0yNlQwMzo0NDoyMy4xNTlaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCIxNDIwNjM0******************\\",\\n \\"ExpireTime\\": \\"1634209418\\",\\n \\"AliUid\\": \\"168**********184\\\\n\\",\\n \\"AccessKeyId\\": \\"LTAI************\\",\\n \\"StartPath\\": \\"168**********184\\",\\n \\"Bucket\\": \\"alicom-cardsms-resources\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetOSSInfoForCardTemplate', + 'description' => 'Resources such as images and videos used for card message templates can be uploaded to Object Storage Service (OSS) buckets for storage. For more information, see [Upload files to OSS](~~437303~~).'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 300 times per second per account. If the number of the 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.'."\n", + 'requestParamsDescription' => '### Description of equest parameters'."\n" + ."\n" + .'The GetOSSInfoForCardTemplate operation has no input parameters. You can directly call the operation to obtain the OSS configuration information.'."\n", + ], + 'GetMediaResourceId' => [ + 'summary' => 'Converts a resource uploaded to the specified Object Storage Service (OSS) bucket for unified management. Then, a resource ID is returned. You can manage the resource based on the ID.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102446', + 'abilityTreeNodes' => [ + 'FEATUREdysms17QZIS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource.'."\n" + ."\n" + .'* **1**: text.'."\n" + .'* **2**: image. A small image cannot exceed 100 KB in size, and a large image cannot exceed 2 MB in size. The image must be clear. Supported format: JPG, JPEG, and PNG.'."\n" + .'* **3**: audio.'."\n" + .'* **4**: video. Supported format: MP4.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If you set the ResourceType parameter to 2, the **img_rate** required is required. Valid values:'."\n" + ."\n" + .'* 1:1'."\n" + ."\n" + .'* 16:9'."\n" + ."\n" + .'* 3:1'."\n" + ."\n" + .'* 48:65'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000', + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'OssKey', + 'in' => 'query', + 'schema' => [ + 'description' => 'The address of the resource.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://alicom-fc-media/1947741454322274/alicom-fc-media/pic/202205191526575398603697152.png', + ], + ], + [ + 'name' => 'FileSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The size of the resource. Unit: bytes.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '12', + ], + ], + [ + 'name' => 'ExtendInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extended fields.'."\n" + ."\n" + .'> If you set the ResourceType parameter to **2**, this parameter is required.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{\\"img_rate\\":\\"oneToOne\\"}', + ], + ], + [ + 'name' => 'Memo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'remark', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* If OK is returned, the request is successful.'."\n" + .'* Other values indicate that the request fails. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F07CF237-F6E3-5F77-B91B-F9B7C5DE84AB', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => 'The resource ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'SMS_14571****', + ], + 'ResUrlDownload' => [ + 'description' => 'The download URL of the resource.'."\n", + 'type' => 'string', + 'example' => 'http://test-example.com/download.jpg', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"F07CF237-F6E3-5F77-B91B-F9B7C5DE84AB\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ResourceId\\": 0,\\n \\"ResUrlDownload\\": \\"http://test-example.com/download.jpg\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetMediaResourceId', + 'description' => '### QPS limit'."\n" + ."\n" + .'You can call this operation up to 300 times per second per account. If the number of the 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.'."\n", + ], + 'CreateCardSmsTemplate' => [ + 'summary' => 'Creates a card message template.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102440', + 'abilityTreeNodes' => [ + 'FEATUREdysms17QZIS', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the card message template.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Aliyun Image and Text Template', + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The content of the card message template.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* For information about fields such as Template, ExtendInfo, TemplateContent, TmpCard, and Action, see [Parameters of card message templates](~~434929~~).'."\n" + ."\n" + .'* Message template content varies based on the template type. For more information, see [Sample message templates](~~435361~~).'."\n", + 'type' => 'object', + 'required' => true, + 'docRequired' => true, + 'example' => '{'."\n" + .' "extendInfo":{'."\n" + .' "scene":"HMOVM",'."\n" + .' "purpose":"2",'."\n" + .' "userExt":{'."\n" + .' "outId":"1234554321"'."\n" + .' }'."\n" + .' },'."\n" + .' "templateContent":{'."\n" + .' "pages":['."\n" + .' {'."\n" + .'"tmpCards":['."\n" + .' {'."\n" + .' "type":"IMAGE",'."\n" + .' "srcType":1,'."\n" + .' "src":"28755",'."\n" + .' "actionType":"OPEN_APP",'."\n" + .' "action":{'."\n" + .' "target":"https://s.tb.cn/c.KxzZ",'."\n" + .' "merchantName":"test-template",'."\n" + .' "packageName":['."\n" + .' "com.taobao.taobao"],'."\n" + .' "floorUrl":"https://s.tb.cn/c.KxzZ"'."\n" + .' },'."\n" + .' "positionNumber":1'."\n" + .' },'."\n" + .' {'."\n" + .' "type":"TEXT",'."\n" + .' "content":"this is a test msg.",'."\n" + .' "isTextTitle":true,'."\n" + .' "positionNumber":2'."\n" + .' },'."\n" + .' {'."\n" + .' "type":"TEXT",'."\n" + .' "content":"Promotional information",'."\n" + .' "isTextTitle":false,'."\n" + .' "positionNumber":3'."\n" + .' },'."\n" + .' {'."\n" + .' "type":"BUTTON",'."\n" + .' "content":"Promotional information,",'."\n" + .' "actionType":"OPEN_BROWSER",'."\n" + .' "action":{'."\n" + .' "target":"https://www.aliyun.com",'."\n" + .' "merchantName":"Currently on the Alibaba Cloud official website."'."\n" + .'},'."\n" + .' "positionNumber":4'."\n" + .' }]'."\n" + .' }]'."\n" + .' },'."\n" + .' "cardSignName":"aliyun",'."\n" + .' "cardType":5'."\n" + .'}', + ], + ], + [ + 'name' => 'Memo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the message template.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'Image and Text Template', + ], + ], + [ + 'name' => 'Factorys', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mobile phone manufacturer. Valid values:'."\n" + ."\n" + .'* **HuaWei**: HUAWEI'."\n" + .'* **XiaoMi**: Xiaomi'."\n" + .'* **OPPO**: OPPO'."\n" + .'* **VIVO**: vivo'."\n" + .'* **MEIZU**: MEIZU'."\n" + ."\n" + .'> If this parameter is not specified, the system automatically specifies a supported mobile phone manufacturer.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'XiaoMi', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* If OK is returned, the request is successful.'."\n" + .'* Other values indicate that the request fails. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TemplateCode' => [ + 'description' => 'The code of the message template.'."\n" + ."\n" + .'You can view the template code in the **Template Code** column on the **Templates** tab of the **Go China** page in the [Alibaba Cloud SMS console](https://dysms.console.aliyun.com/dysms.htm?spm=5176.12818093.categories-n-products.ddysms.3b2816d0xml2NA#/overview).'."\n" + ."\n" + .'> Make sure that the message template has been approved.'."\n", + 'type' => 'string', + 'example' => 'CARD_SMS_60000****', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TemplateCode\\": \\"CARD_SMS_2****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateCardSmsTemplateResponse>\\n <Code>ok</Code>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\n <Success>true</Success>\\n <Data>\\n <TemplateCode>CARD_SMS_600000001</TemplateCode>\\n </Data>\\n</CreateCardSmsTemplateResponse>","errorExample":""}]', + 'title' => 'CreateCardSmsTemplate', + 'description' => '* The CreateCardSmsTemplate operation saves the card message template information, submits it to the mobile phone manufacturer for approval, and returns the message template ID.'."\n" + .'* If the type of the message template is not supported or events that are not supported by the mobile phone manufacturer are specified, the template is not submitted. For more information, see [Supported message templates](~~434611~~).'."\n" + .'* For information about sample card message templates, see [Sample card message templates](~~435361~~).'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 300 times per second per account. If the number of the 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.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryCardSmsTemplate' => [ + 'summary' => 'Queries the review status of a message template.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102452', + 'abilityTreeNodes' => [ + 'FEATUREdysms17QZIS', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the message template.'."\n" + ."\n" + .'You can view the template code in the **Template Code** column on the **Templates** tab of the **Go China** page in the Alibaba Cloud SMS console.'."\n" + ."\n" + .'> Make sure that the message template has been approved.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CARD_SMS_4139', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The HTTP status code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Templates' => [ + 'description' => 'The array of objects.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned template information.'."\n" + ."\n" + .'* tmpName: the name of the template.'."\n" + .'* tmpCode: the code of the template.'."\n" + .'* state: the review status of the template. Valid values: 0, 1, and 2. 0 indicates that the template is pending approval. 1 indicates that the template is approved. 2 indicates that the template is rejected.'."\n" + .'* tmpOps: the information about the mobile phone. The following information is returned: 1. state: the review status of the mobile phone. 2. vendorCode: the information about the mobile phone manufacturer. 3. remark: the comments on the mobile phone.'."\n", + 'type' => 'object', + 'example' => '', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Templates\\": [\\n {\\n \\"tmpName\\": \\"测试\\",\\n \\"tmpCode\\": \\"CARD_SMS_****\\",\\n \\"state\\": 1,\\n \\"tmpOps\\": [\\n {\\n \\"tmpOpId\\": \\"536363\\",\\n \\"vendorTmpId\\": \\"600302896\\",\\n \\"remark\\": \\"自动审核通过\\",\\n \\"supplierCode\\": \\"MW\\",\\n \\"state\\": 1,\\n \\"vendorName\\": \\"华为\\",\\n \\"vendorCode\\": \\"HUAWEI\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'QueryCardSmsTemplate', + 'description' => '### QPS limit'."\n" + ."\n" + .'You can call this operation up to 300 times per second per account. If the number of the 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.'."\n", + ], + 'CheckMobilesCardSupport' => [ + 'summary' => 'Queries whether some mobile phone numbers support card messages.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '125700', + 'abilityTreeNodes' => [ + 'FEATUREdysmsB35KN5', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the message template. You can view the template code in the **Template Code** column on the **Templates** tab of the **Go China** page in the Alibaba Cloud SMS console.'."\n" + ."\n" + .'> Make sure that the message template has been approved.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CARD_SMS_****', + ], + ], + [ + 'name' => 'Mobiles', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The list of mobile phone numbers that receive messages.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of mobile phone numbers that receive messages. A maximum of 10,000 mobile phone numbers can be queried per request.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '[{"#6#mobile":"1322587****"},{"#6#mobile":"1867845****"}]', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The HTTP status code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'queryResult' => [ + 'description' => 'The list of returned results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'mobile' => [ + 'description' => 'The mobile phone number.'."\n", + 'type' => 'string', + 'example' => '1390000****', + ], + 'support' => [ + 'description' => 'Indicates whether the mobile phone number supports card messages.'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"queryResult\\": [\\n {\\n \\"mobile\\": \\"1390000****\\",\\n \\"support\\": true\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'CheckMobilesCardSupport', + 'description' => '### QPS limit'."\n" + ."\n" + .'You can call this operation up to 2,000 times per second per account. If the number of the 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.'."\n", + ], + 'QueryMobilesCardSupport' => [ + 'summary' => 'Queries whether some mobile phone numbers support card messages.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '161447', + 'abilityTreeNodes' => [ + 'FEATUREdysmsB35KN5', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the message template. You can view the template code in the **Template Code** column on the **Templates** tab of the **Go China** page in the Alibaba Cloud SMS console.'."\n" + ."\n" + .'> Make sure that the message template has been approved.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CARD_SMS_0000', + ], + ], + [ + 'name' => 'Mobiles', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of mobile phone numbers.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of mobile phone numbers.'."\n", + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "mobile": "138****0000"'."\n" + .'}', + ], + 'required' => true, + ], + ], + [ + 'name' => 'EncryptType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'type' => 'string', + 'example' => 'NORMAL', + 'maxLength' => 100, + 'default' => 'NORMAL', + 'enum' => [ + 'SHA1', + 'NORMAL', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The array of objects.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The HTTP status code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '08C17DFE-2E10-54F4-BAFB-7180039CC217', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'QueryResult' => [ + 'description' => 'The list of returned results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Mobile' => [ + 'description' => 'The mobile phone number.'."\n", + 'type' => 'string', + 'example' => '1380000****', + ], + 'Support' => [ + 'description' => 'Indicates whether the mobile phone number supports card messages. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"08C17DFE-2E10-54F4-BAFB-7180039CC217\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"QueryResult\\": [\\n {\\n \\"Mobile\\": \\"1380000****\\",\\n \\"Support\\": true\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'QueryMobilesCardSupport', + ], + 'GetCardSmsLink' => [ + 'summary' => 'Queries the short URLs of a card messages template.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '125584', + 'abilityTreeNodes' => [ + 'FEATUREdysms17QZIS', + ], + ], + 'parameters' => [ + [ + 'name' => 'CardTemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the message template. You can view the template code in the **Template Code** column on the **Templates** tab of the **Go China** page in the Alibaba Cloud SMS console.'."\n" + ."\n" + .'> Make sure that the message template has been approved.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CARD_SMS_****', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extension field.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'BC20220608102511660860762****', + ], + ], + [ + 'name' => 'PhoneNumberJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mobile phone numbers of recipients, custom identifiers, or system identifiers.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* A maximum of 10,000 mobile phone numbers are supported.'."\n" + ."\n" + .'* You can enter custom identifier. Each identifier can be a maximum of 60 characters in length.'."\n" + ."\n" + .'* You can apply for a maximum of 10 OPPO templates at a time.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[\\"1390000****'."\n" + .'\\",\\"1370000****'."\n" + .'\\"]', + ], + ], + [ + 'name' => 'SignNameJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'The signature. You can view the template code in the **Signature** column on the **Signaturess** tab of the **Go China** page in the Alibaba Cloud SMS console.'."\n" + ."\n" + .'> The signatures must be approved and correspond to the mobile numbers in sequence.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[\\"aliyun\\", \\"aliyun2\\"]', + ], + ], + [ + 'name' => 'CardTemplateParamJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'The variables of the message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{},{}]', + ], + ], + [ + 'name' => 'CardCodeType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code type of the URLs.'."\n" + ."\n" + .'* **1**: group texting'."\n" + .'* **2**: personalization'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'CardLinkType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the short URLs.'."\n" + ."\n" + .'* 1: standard short code.'."\n" + .'* 2: custom short code.'."\n" + ."\n" + .'> If the **CardLinkType** is not specified, standard short codes are generated. If you need to generate custom short codes, contact Alibaba Cloud SMS technical support.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => 'The original domain name. You must submit domain names for approval in advance.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* If the **CardLinkType** parameter is set to **2**, the **Domain** parameter is required.'."\n" + ."\n" + .'* The **Domain** parameter cannot exceed 100 characters in length. If the parameter is not specified, a default domain name is used.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'xxx.com', + ], + ], + [ + 'name' => 'CustomShortCodeJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'The custom short code. It can contain 4 to 8 digits or letters.'."\n" + ."\n" + .'> If the CardLinkType parameter is set to 2, the CustomShortCodeJson parameter is required.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'abCde', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The HTTP status code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CC89A90C-978F-46AC-B80D-54738371E7CA', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'CardTmpState' => [ + 'description' => 'The review status of the card message template.'."\n" + ."\n" + .'* **0**: pending approval'."\n" + .'* **1**: approved'."\n" + .'* **2**: rejected'."\n" + ."\n" + .'> Unapproved card messages are rolled back.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NotMediaMobiles' => [ + 'description' => 'The mobile phone numbers that do not support card messages.'."\n", + 'type' => 'string', + 'example' => '1390000****', + ], + 'CardPhoneNumbers' => [ + 'description' => 'The mobile phone numbers that support card messages.'."\n", + 'type' => 'string', + 'example' => '[\\"1390000****\\",\\"1370000****\\"]', + ], + 'CardSmsLinks' => [ + 'description' => 'The short URLs.'."\n", + 'type' => 'string', + 'example' => '[\\"mw2m.cn/LAaGGa\\",\\"mw2m.cn/LAAaes\\"]', + ], + 'CardSignNames' => [ + 'description' => 'The signatures must correspond to the mobile numbers and short URLs in sequence.'."\n", + 'type' => 'string', + 'example' => '["aliyun","aliyun2"]', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"CC89A90C-978F-46AC-B80D-54738371E7CA\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"CardTmpState\\": 0,\\n \\"NotMediaMobiles\\": \\"1390000****\\",\\n \\"CardPhoneNumbers\\": \\"[\\\\\\\\\\\\\\"1390000****\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"1370000****\\\\\\\\\\\\\\"]\\",\\n \\"CardSmsLinks\\": \\"[\\\\\\\\\\\\\\"mw2m.cn/LAaGGa\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"mw2m.cn/LAAaes\\\\\\\\\\\\\\"]\\",\\n \\"CardSignNames\\": \\"[\\\\\\"阿里云\\\\\\",\\\\\\"阿里云2\\\\\\"]\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetCardSmsLink', + 'description' => '### QPS limit'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the 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.'."\n", + ], + 'GetCardSmsDetails' => [ + 'summary' => 'Query card sending details', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => 'For paginated viewing of sending records, specify the current page number of the sending records.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'For paginated viewing of sending records, specify the number of card SMS records to display per page.'."\n" + ."\n" + .'The value range is 1~50.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SendDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'Card SMS sending date, supports querying records from the last 30 days.'."\n" + ."\n" + .'Format: yyyyMMdd, for example, 20240112.', + 'type' => 'string', + 'required' => true, + 'example' => '20240112', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'Domestic phone number that received the SMS. Format: 11-digit phone number, for example, 1390000****.', + 'type' => 'string', + 'required' => true, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'BizCardId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Card SMS sending ID, which is the BizCardId field in the response when calling SendCardSms or SendBatchCardSms.', + 'type' => 'string', + 'required' => false, + 'example' => '123456^0', + ], + ], + [ + 'name' => 'BizSmsId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Text SMS sending ID, which is the BizSmsId field in the response when calling SendCardSms or SendBatchCardSms.', + 'type' => 'string', + 'required' => false, + 'example' => '1234576^0', + ], + ], + [ + 'name' => 'BizDigitId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Digital SMS sending ID, which is the BizDigitalId field in the response when calling SendCardSms or SendBatchCardSms.', + 'type' => 'string', + 'required' => false, + 'example' => '12346^0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Response information', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => 'Access denied detail; this field is returned only if the RAM check fails.', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'title' => '状态描述', + 'description' => 'Description of the status code.', + 'type' => 'string', + 'example' => 'OK'."\n", + ], + 'CardSendDetailDTO' => [ + 'title' => '卡片短信发送结果', + 'description' => 'Card SMS sending result', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总量', + 'description' => 'Total count', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageSize' => [ + 'title' => '页数', + 'description' => 'Page size', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'CurrentPage' => [ + 'title' => '页码', + 'description' => 'Current page number', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Records' => [ + 'description' => 'List of card SMS sending records', + 'type' => 'array', + 'items' => [ + 'description' => 'Card SMS sending record', + 'type' => 'object', + 'properties' => [ + 'TemplateCode' => [ + 'title' => '模板code', + 'description' => 'Template code', + 'type' => 'string', + 'example' => 'CARD_SMS_6***', + ], + 'RenderDate' => [ + 'title' => '渲染时间', + 'description' => 'Render date', + 'type' => 'string', + 'example' => '2024-09-27 12:13:39', + ], + 'ReceiveDate' => [ + 'title' => '接收时间', + 'description' => 'Receive date', + 'type' => 'string', + 'example' => '2024-09-27 11:26:35', + ], + 'RenderStatus' => [ + 'title' => '解析状态.。0：未解析；1：解析成功；3：未解析', + 'description' => 'Render status. 0: Not rendered; 1: Rendered successfully; 3: Not rendered', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ReceiveType' => [ + 'title' => '接收短信类型', + 'description' => 'Receive SMS type', + 'type' => 'string', + 'example' => 'CARD_SMS', + ], + 'SendStatus' => [ + 'title' => '发送状态 1：发送中；2：发送失败；3：发送成功；4：寻址失败', + 'description' => 'Sending status. 1: Sending; 2: Send failed; 3: Sent successfully; 4: Addressing failed', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'OutId' => [ + 'title' => '客户传输outId', + 'description' => 'Customer-transmitted outId', + 'type' => 'string', + 'example' => '12345678', + ], + 'PhoneNumber' => [ + 'title' => '接收短信手机号', + 'description' => 'Phone number that received the SMS', + 'type' => 'string', + 'example' => '156****9080', + ], + 'SmsContent' => [ + 'title' => '短信内容。只有文本短信有值', + 'description' => 'SMS content. Only applicable for text messages.', + 'type' => 'string', + 'example' => '您收到一条短信消息', + ], + 'SendDate' => [ + 'title' => '短信发送时间', + 'description' => 'Time when the SMS was sent', + 'type' => 'string', + 'example' => '2024-09-27 11:26:32', + ], + 'ErrCode' => [ + 'title' => '发送错误码', + 'description' => 'Error code for sending', + 'type' => 'string', + 'example' => 'Success', + ], + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => 'Request status code.'."\n" + .'* OK indicates a successful request.'."\n" + .'* For other error codes, see [API Error Codes](~~101346~~).', + 'type' => 'string', + 'example' => 'OK'."\n", + ], + 'Success' => [ + 'description' => 'Indicates whether the API call was successful. Values:'."\n" + .'- **true** - **false**', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorMessage' => 'Incorrect phone number format.', + 'errorCode' => 'InvalidParam.PhoneNumber', + ], + [ + 'errorMessage' => 'PageSize must be less than or equal to 50.', + 'errorCode' => 'InvalidParam.PageSize', + ], + [ + 'errorMessage' => 'Only the last 30 days can be queried.', + 'errorCode' => 'InvalidParam.SendDate', + ], + [ + 'errorMessage' => 'At most, only one parameter can be passed among bizCardId, bizSmsId, and bizDigitId.', + 'errorCode' => 'InvalidParameter', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"Message\\": \\"OK\\\\n\\",\\n \\"CardSendDetailDTO\\": {\\n \\"TotalCount\\": 10,\\n \\"PageSize\\": 10,\\n \\"CurrentPage\\": 1,\\n \\"Records\\": [\\n {\\n \\"TemplateCode\\": \\"CARD_SMS_6***\\",\\n \\"RenderDate\\": \\"2024-09-27 12:13:39\\",\\n \\"ReceiveDate\\": \\"2024-09-27 11:26:35\\",\\n \\"RenderStatus\\": 1,\\n \\"ReceiveType\\": \\"CARD_SMS\\",\\n \\"SendStatus\\": 3,\\n \\"OutId\\": \\"12345678\\",\\n \\"PhoneNumber\\": \\"156****9080\\",\\n \\"SmsContent\\": \\"您收到一条短信消息\\",\\n \\"SendDate\\": \\"2024-09-27 11:26:32\\",\\n \\"ErrCode\\": \\"Success\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"OK\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Query the card SMS sending records and status for a single phone number.', + 'translator' => 'machine', + ], + 'QueryCardSmsTemplateReport' => [ + 'summary' => 'Queries sent card messages.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '118232', + 'abilityTreeNodes' => [ + 'FEATUREdysms3V8ND3', + ], + ], + 'parameters' => [ + [ + 'name' => 'TemplateCodes', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The array of message templates.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The code of the message template. You can view the template code in the **Template Code** column on the **Templates** tab of the **Go China** page in the Alibaba Cloud SMS console.'."\n" + ."\n" + .'> Make sure that the message template has been approved.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CARD_SMS_391', + ], + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-10-10 00:00:01', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-10-11 00:00:01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The HTTP status code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'CC89A90C-978F-46AC-B80D-54738371E7CA', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'model' => [ + 'description' => 'The details of the data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the data returned.'."\n" + ."\n" + .'* tmpCode: the code of the template.'."\n" + .'* date: the date when the message is sent. The value is in the yyyy-MM-dd HH:mm:ss format.'."\n" + .'* rptSuccessCount: the number of messages with receipts returned.'."\n" + .'* exposeUv: the number of exposed messages.'."\n" + .'* exposePv: the number of times that messages are exposed.'."\n" + .'* clickUv: the number of messages clicked on.'."\n" + .'* clickPv: the number of time that messages are clicked on.'."\n", + 'type' => 'object', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"B71F06CA-7735-183A-B52E-234EF8AFE14B\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"model\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryCardSmsTemplateReportResponse>\\n <Code>ok</Code>\\n <RequestId>12343</RequestId>\\n <Success>true</Success>\\n <Data/>\\n</QueryCardSmsTemplateReportResponse>","errorExample":""}]', + 'title' => 'QueryCardSmsTemplateReport', + 'description' => '### QPS limit'."\n" + ."\n" + .'You can call this operation up to 300 times per second per account. If the number of the 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.'."\n", + ], + 'SendCardSms' => [ + 'summary' => 'Sends a card message.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '102463', + 'abilityTreeNodes' => [ + 'FEATUREdysmsB35KN5', + ], + ], + 'parameters' => [ + [ + 'name' => 'CardObjects', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => 'The objects of the message template.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'customUrl' => [ + 'description' => 'The URL to which the message is redirected if the message fails to be rendered.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'https://alibaba.com', + ], + 'dyncParams' => [ + 'description' => 'The variables. Special characters, such as $ and {}, do not need to be entered.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"param3\\":\\"three\\",\\"param1\\":\\"one\\",\\"param2\\":\\"two\\"}', + ], + 'mobile' => [ + 'description' => 'The mobile phone number.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1390000****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The signature. You can view the template code in the **Signature** column on the **Signaturess** tab of the **Go China** page in the Alibaba Cloud SMS console.'."\n" + ."\n" + .'> The signature must be approved.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'aliyun', + ], + ], + [ + 'name' => 'CardTemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the message template. You can view the template code in the **Template Code** column on the **Templates** tab of the **Go China** page in the Alibaba Cloud SMS console.'."\n" + ."\n" + .'> Make sure that the message template has been approved.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CARD_SMS_70', + ], + ], + [ + 'name' => 'SmsTemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the text message template that applies when the card message is rolled back. You can view the template code in the **Template Code** column on the **Templates** tab of the **Go China** page in the Alibaba Cloud SMS console.'."\n" + ."\n" + .'> Make sure that the message template has been approved. If you set the **FallbackType** parameter to **SMS**, this parameter is required.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'SIER_TEST_01', + ], + ], + [ + 'name' => 'SmsUpExtendCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extension code of the upstream message. Upstream messages are messages sent to the communication service provider. Upstream messages are used to customize a service, complete an inquiry, or send a request. You are charged for sending upstream messages based on the billing standards of the service provider.'."\n" + ."\n" + .'> If you do not need upstream messages, ignore this parameter.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FallbackType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The rollback type. Valid values:'."\n" + ."\n" + .'* **SMS**: text message'."\n" + .'* **DIGITALSMS**: digital message'."\n" + .'* **NONE**: none'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SMS', + ], + ], + [ + 'name' => 'DigitalTemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the digital message template that applies when the card message is rolled back. You can view the template code in the **Template Code** column on the **Templates** tab of the **Go China** page in the Alibaba Cloud SMS console.'."\n" + ."\n" + .'> Make sure that the message template has been approved.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SMS_003', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID that is reserved for the caller of the operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '38d76c9b-4a9a-4c89-afae-61fd8e0e****', + ], + ], + [ + 'name' => 'SmsTemplateParam', + 'in' => 'query', + 'schema' => [ + 'description' => 'The variables of the text message template.'."\n" + ."\n" + .'> If you need to add line breaks to the JSON template, make sure that the format is valid.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"uri\\":\\"Zg11tZ\\"}', + ], + ], + [ + 'name' => 'DigitalTemplateParam', + 'in' => 'query', + 'schema' => [ + 'description' => 'The variables of the digital message template.'."\n" + ."\n" + .'> If you need to add line breaks to the JSON template, make sure that the format is valid.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{\\"msg\\",\\"xxxd\\"}', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the text message template.'."\n" + ."\n" + .'Log on to the Alibaba Cloud SMS console. In the left-side navigation pane, click **Go Globe** or **Go China**. You can view the message template in the **Template Code** column on the **Message Templates** tab.'."\n" + ."\n" + .'> The message templates must be created on the Go Globe page and approved.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SMS_2322****', + ], + ], + [ + 'name' => 'TemplateParam', + 'in' => 'query', + 'schema' => [ + 'description' => 'The variables of the message template. Format: JSON.'."\n" + ."\n" + .'> If you need to add line breaks to the JSON template, make sure that the format is valid.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' \\"code\\": \\"1111\\"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* If OK is returned, the request is successful.'."\n" + .'* Other values indicate that the request fails. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D28D0', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'MediaMobiles' => [ + 'description' => 'The mobile phone number from which the card message is sent.'."\n", + 'type' => 'string', + 'example' => '1390000****', + ], + 'BizCardId' => [ + 'description' => 'The ID of the card message.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'BizDigitalId' => [ + 'description' => 'The ID of the digital message.'."\n", + 'type' => 'string', + 'example' => '232', + ], + 'CardTmpState' => [ + 'description' => 'The review status of the card message template.'."\n" + ."\n" + .'* **0**: pending approval'."\n" + .'* **1**: approved'."\n" + .'* **2**: rejected'."\n" + ."\n" + .'> Unapproved card messages are rolled back.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NotMediaMobiles' => [ + 'description' => 'The mobile phone number whose card message is rolled back.'."\n", + 'type' => 'string', + 'example' => '1390000****', + ], + 'BizSmsId' => [ + 'description' => 'The ID of the text message.'."\n", + 'type' => 'string', + 'example' => '524', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D28D0\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MediaMobiles\\": \\"1390000****\\",\\n \\"BizCardId\\": \\"123\\",\\n \\"BizDigitalId\\": \\"232\\",\\n \\"CardTmpState\\": 0,\\n \\"NotMediaMobiles\\": \\"1390000****\\",\\n \\"BizSmsId\\": \\"524\\"\\n }\\n}","type":"json"}]', + 'title' => 'SendCardSms', + 'description' => '* Make sure that the message template that you want to use has been approved. If the mobile phone number of a recipient does not support card messages, the SendCardSms operation allows the rollback feature to ensure successful delivery.'."\n" + .'* When you call the SendCardSms operation to send card messages, the operation checks whether the mobile phone numbers of the recipients support card messages. If the mobile phone numbers do not support card messages, you can specify whether to enable rollback. Otherwise, the card message cannot be delivered.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the 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.'."\n", + ], + 'SendBatchCardSms' => [ + 'summary' => 'Sends multiple card messages at a time.', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '125151', + 'abilityTreeNodes' => [ + 'FEATUREdysmsB35KN5', + ], + ], + 'parameters' => [ + [ + 'name' => 'CardTemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the message template. You can view the template code in the **Template Code** column on the **Templates** tab of the **Go China** page in the Alibaba Cloud SMS console.'."\n" + ."\n" + .'> Make sure that the message template has been approved.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CARD_SMS_3245', + ], + ], + [ + 'name' => 'SmsTemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the text message template that applies when the card message is rolled back. You can view the template code in the **Template Code** column on the **Templates** tab of the **Go China** page in the Alibaba Cloud SMS console.'."\n" + ."\n" + .'> Make sure that the message template has been approved.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'SMS_234251075', + ], + ], + [ + 'name' => 'FallbackType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The rollback type. Valid values:'."\n" + ."\n" + .'* **SMS**: text message'."\n" + .'* **DIGITALSMS**: digital message'."\n" + .'* **NONE**: none'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SMS', + ], + ], + [ + 'name' => 'DigitalTemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the digital message template that applies when the card message is rolled back. You can view the template code in the **Template Code** column on the **Templates** tab of the **Go China** page in the Alibaba Cloud SMS console.'."\n" + ."\n" + .'> Make sure that the message template has been approved.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'DIGITAL_SMS_234080176', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID that is reserved for the caller of the operation.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '16545681783595370', + ], + ], + [ + 'name' => 'PhoneNumberJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'The mobile numbers of the recipients.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[\\"1390000****\\",\\"1370000****\\"]"', + ], + ], + [ + 'name' => 'SignNameJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'The signature. You can view the template code in the **Signature** column on the **Signaturess** tab of the **Go China** page in the Alibaba Cloud SMS console.'."\n" + ."\n" + .'> The signatures must be approved and correspond to the mobile numbers in sequence.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '[\\"aliyun\\",\\"aliyuncode\\"]', + ], + ], + [ + 'name' => 'CardTemplateParamJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'The variables of the card message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"customurl\\":\\"http://www.alibaba.com\\",\\"dyncParams\\":\\"{\\\\\\"a\\\\\\":\\\\\\"hello\\\\\\",\\\\\\"b\\\\\\":\\\\\\"world\\\\\\"}\\"}]', + ], + ], + [ + 'name' => 'SmsTemplateParamJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'The variables of the text message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"a":1,"b":2},{"a":9,"b":8}]', + ], + ], + [ + 'name' => 'DigitalTemplateParamJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'The variables of the digital message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"a":1,"b":2},{"a":9,"b":8}]', + ], + ], + [ + 'name' => 'SmsUpExtendCodeJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'The extension code of the upstream message.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[\\"6\\",\\"6\\"]', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code of the message template.'."\n" + ."\n" + .'You can log on to the [Alibaba Cloud console](https://dysms.console.aliyun.com/dysms.htm?spm=5176.12818093.categories-n-products.ddysms.3b2816d0xml2NA#/overview), click **Go China** or **Go Globe** in the left-side navigation pane, and then view the **template code** on the **Templates** tab.'."\n" + ."\n" + .'> You must specify a message template that is created in the SMS console and approved by Alibaba Cloud. If you send messages to countries or regions outside the Chinese mainland, use the corresponding message templates.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SMS_20375****', + ], + ], + [ + 'name' => 'TemplateParamJson', + 'in' => 'query', + 'schema' => [ + 'description' => 'The value of the variable in the message template.'."\n" + ."\n" + .'> If you need to add line breaks to the JSON template, make sure that the format is valid. In addition, the sequence of variable values must be the same as that of the mobile numbers and signatures.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[{"name":"TemplateParamJson"},{"name":"TemplateParamJson"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The HTTP status code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* For more information about other response codes, see [API error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', + ], + 'Success' => [ + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'MediaMobiles' => [ + 'description' => 'The mobile phone number from which the card message is sent.'."\n", + 'type' => 'string', + 'example' => '1390000****', + ], + 'BizCardId' => [ + 'description' => 'The ID of the card message.'."\n", + 'type' => 'string', + 'example' => '123', + ], + 'BizDigitalId' => [ + 'description' => 'The ID of the digital message.'."\n", + 'type' => 'string', + 'example' => '3214', + ], + 'CardTmpState' => [ + 'description' => 'The review status of the card message template.'."\n" + ."\n" + .'* **0**: pending approval'."\n" + .'* **1**: approved'."\n" + .'* **2**: rejected'."\n" + ."\n" + .'> Unapproved card messages are rolled back.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NotMediaMobiles' => [ + 'description' => 'The mobile phone number whose card message is rolled back.'."\n", + 'type' => 'string', + 'example' => '1390000****', + ], + 'BizSmsId' => [ + 'description' => 'The ID of the text message.'."\n", + 'type' => 'string', + 'example' => '3256', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MediaMobiles\\": \\"1390000****\\",\\n \\"BizCardId\\": \\"123\\",\\n \\"BizDigitalId\\": \\"3214\\",\\n \\"CardTmpState\\": 0,\\n \\"NotMediaMobiles\\": \\"1390000****\\",\\n \\"BizSmsId\\": \\"3256\\"\\n }\\n}","type":"json"}]', + 'title' => 'SendBatchCardSms', + 'description' => 'You can call the operation to send multiple card messages to a maximum of mobile phone numbers at a time. Different signatures and rollback settings can be specified for the mobile phone numbers.'."\n" + ."\n" + .'### QPS limit'."\n" + ."\n" + .'You can call this operation up to 1,000 times per second per account. If the number of the 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.'."\n", + ], + 'GetQualificationOssInfo' => [ + 'summary' => '上传文件获取oss配置', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '264692', + 'abilityTreeNodes' => [ + 'FEATUREdysmsJ2BZAJ', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'title' => '业务，非空', + 'description' => '业务，非空', + 'type' => 'string', + 'required' => true, + 'example' => 'dysms', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => '', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA', + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'title' => '策略', + 'description' => '策略', + 'type' => 'string', + 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0wOVQxMTo1NTozOS4wMDFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0seyJidWNrZXQiOiJhbGljb20tZmMtbWVkaWEifSxbImVxIiwiJGtleSIsIjEwMDAwMDM1ODA4MjA2M1wv********', + ], + 'Expire' => [ + 'title' => '过期时间', + 'description' => '过期时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1741521339', + ], + 'StartPath' => [ + 'title' => '前缀', + 'description' => '前缀', + 'type' => 'string', + 'example' => '1000********001', + ], + 'AccessKeyId' => [ + 'title' => 'ak', + 'description' => 'ak', + 'type' => 'string', + 'example' => 'bypFNbG******', + ], + 'Signature' => [ + 'title' => '签名', + 'description' => '签名', + 'type' => 'string', + 'example' => 'QvNTGC9DSLTeByP+ZWW******', + ], + 'Host' => [ + 'title' => '域名', + 'description' => '域名', + 'type' => 'string', + 'example' => 'http://***.oss-cn-zhangjiakou.aliyuncs.com', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'OssBiztypeNotSupportError', + 'errorMessage' => 'Retrieving OSS configuration does not support this biz type.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"无\\",\\n \\"RequestId\\": \\"25D5AFDE-8EBC-132E-8909-1FDC071DA\\",\\n \\"Message\\": \\"OK\\",\\n \\"Data\\": {\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0wOVQxMTo1NTozOS4wMDFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0seyJidWNrZXQiOiJhbGljb20tZmMtbWVkaWEifSxbImVxIiwiJGtleSIsIjEwMDAwMDM1ODA4MjA2M1wv********\\",\\n \\"Expire\\": 1741521339,\\n \\"StartPath\\": \\"1000********001\\",\\n \\"AccessKeyId\\": \\"bypFNbG******\\",\\n \\"Signature\\": \\"QvNTGC9DSLTeByP+ZWW******\\",\\n \\"Host\\": \\"http://***.oss-cn-zhangjiakou.aliyuncs.com\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'GetOSSInfoForUploadFile' => [ + 'summary' => 'SMS File Upload, Get Authorization Info', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '218013', + 'abilityTreeNodes' => [ + 'FEATUREdysms2H0K7P', + 'FEATUREdysmsJ2BZAJ', + ], + ], + 'parameters' => [ + [ + 'name' => 'BizType', + 'in' => 'query', + 'schema' => [ + 'description' => 'Business type, default value is **fcMediaSms**.'."\n" + ."\n" + .'When creating signatures and templates, and uploading **additional materials**, this value is **fcMediaSms**.', + 'type' => 'string', + 'required' => false, + 'example' => 'fcMediaSms', + 'default' => 'fcMediaSms', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The ID of this call request, which is a unique identifier generated by Alibaba Cloud for the request, can be used for troubleshooting and issue定位.', + 'type' => 'string', + 'example' => 'A90E4451-FED7-49D2-87C8-00700EDCFD0D', + ], + 'Message' => [ + 'description' => 'Description of the status code.', + 'type' => 'string', + 'example' => 'OK', + ], + 'Model' => [ + 'description' => 'Return result.', + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'description' => 'Signature policy.', + 'type' => 'string', + 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyN***Ni0yNVQwNjozNzoyNS45NzBaI**iY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0sWyJzdGFydHMtd2l0***sIiRrZXkiLCIiXV19', + ], + 'StartPath' => [ + 'description' => 'Policy path.', + 'type' => 'string', + 'example' => '123456', + ], + 'AccessKeyId' => [ + 'description' => 'AccessKey ID used for signing.', + 'type' => 'string', + 'example' => 'LTAIxetqt1Dg****'."\n", + ], + 'Signature' => [ + 'description' => 'Signature information calculated based on **AccessKey Secret** and **Policy**. When calling the OSS API, OSS verifies this signature information to confirm the legitimacy of the Post request.', + 'type' => 'string', + 'example' => 'BXnwCWPrhVb*****aoZHZfli5KE=', + ], + 'Host' => [ + 'description' => 'Host address.', + 'type' => 'string', + 'example' => 'https://alicom-fc-media.oss-cn-zhangjiakou.aliyuncs.com', + ], + 'ExpireTime' => [ + 'description' => 'Expiration time.', + 'type' => 'string', + 'example' => '1719297445', + ], + ], + ], + 'Code' => [ + 'description' => 'Request status code.'."\n" + ."\n" + .'- OK return represents a successful request.'."\n" + .'- For other error codes, please refer to the [Error Code List](https://help.aliyun.com/document_detail/101346.htm).', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'Indicates success. Values:'."\n" + ."\n" + .'- **true**'."\n" + .'- **false**', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700EDCFD0D\\",\\n \\"Message\\": \\"OK\\",\\n \\"Model\\": {\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyN***Ni0yNVQwNjozNzoyNS45NzBaI**iY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0sWyJzdGFydHMtd2l0***sIiRrZXkiLCIiXV19\\",\\n \\"StartPath\\": \\"123456\\",\\n \\"AccessKeyId\\": \\"LTAI************\\\\n\\",\\n \\"Signature\\": \\"BXnwCWPrhVb*****aoZHZfli5KE=\\",\\n \\"Host\\": \\"https://alicom-fc-media.oss-cn-zhangjiakou.aliyuncs.com\\",\\n \\"ExpireTime\\": \\"1719297445\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Text SMS Obtain OSS Upload Information', + 'description' => '- When creating signatures or templates, you can upload materials such as login pages with links, backend page screenshots, software copyrights, supplementary agreements, etc. This helps the review personnel understand your business details. If there are multiple materials, they can be combined into one file, supporting png, jpg, jpeg, doc, docx, pdf formats.'."\n" + ."\n" + .'- For additional materials needed when creating signatures or templates, you can upload them to the OSS file system for storage. For file upload operations, refer to [OSS File Upload](https://help.aliyun.com/zh/sms/upload-files-through-oss).', + ], + 'GetSmsOcrOssInfo' => [ + 'summary' => '获取OCR的OSS信息', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '287263', + 'abilityTreeNodes' => [ + 'FEATUREdysms2H0K7P', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => 'OCR任务类型', + 'description' => 'OCR任务类型', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ICP_DOMAIN' => '', + ], + 'example' => '示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '25D5AFDE-xxxx-132E-8909-1FDC071DA', + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Model' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0wOVQxMTo1NTozOS4wMDFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0seyJidWNrZXQiOiJhbGljb20tZmMtbWVkaWEifSxbImVxIiwiJGtleSIsIjEwMDAwMDM1ODA4MjA2M1wv********', + ], + 'StartPath' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '1000********001', + ], + 'Bucket' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'AccessKeyId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'bypFNbG******', + ], + 'Signature' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'QvNTGC9DSLTeByP+ZWW******', + ], + 'Host' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'http://***.oss-cn-zhangjiakou.aliyuncs.com', + ], + 'ExpireTime' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '1741521339', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"25D5AFDE-xxxx-132E-8909-1FDC071DA\\",\\n \\"Message\\": \\"OK\\",\\n \\"Model\\": {\\n \\"Policy\\": \\"eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0wOVQxMTo1NTozOS4wMDFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0seyJidWNrZXQiOiJhbGljb20tZmMtbWVkaWEifSxbImVxIiwiJGtleSIsIjEwMDAwMDM1ODA4MjA2M1wv********\\",\\n \\"StartPath\\": \\"1000********001\\",\\n \\"Bucket\\": \\"示例值\\",\\n \\"AccessKeyId\\": \\"bypFNbG******\\",\\n \\"Signature\\": \\"QvNTGC9DSLTeByP+ZWW******\\",\\n \\"Host\\": \\"http://***.oss-cn-zhangjiakou.aliyuncs.com\\",\\n \\"ExpireTime\\": \\"1741521339\\"\\n },\\n \\"Code\\": \\"OK\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'SmsConversionIntl' => [ + 'summary' => 'Reports the status of an OTP message to Alibaba Cloud SMS.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '176603', + 'abilityTreeNodes' => [ + 'FEATUREdysmsWO2BNU', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'MessageId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the message.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1008030300****'."\n", + ], + ], + [ + 'name' => 'Delivered', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether customers replied to the OTP message. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'ConversionTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time when the OTP message was delivered. The value is a UNIX timestamp. Unit: milliseconds.'."\n" + ."\n" + .'* If you leave the parameter empty, the current timestamp is specified by default.'."\n" + .'* If you specify the parameter, the timestamp must be greater than the message sending time and less than the current timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1349055900000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D****'."\n", + ], + 'Code' => [ + 'description' => 'The response code. If OK is returned, the request is successful. For more information, see [Error codes](https://help.aliyun.com/document_detail/101346.html?spm=a2c4g.101345.0.0.74326ff2J5EZyt).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D****\\\\n\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'SmsConversionIntl', + 'description' => 'Metrics:'."\n" + ."\n" + .'* Requested OTP messages'."\n" + .'* Verified OTP messages'."\n" + ."\n" + .'An OTP conversion rate is calculated based on the following formula: OTP conversion rate = Number of verified OTP messages/Number of requested OTP messages.'."\n" + ."\n" + .'> If you call the SmsConversion operation to query OTP conversion rates, your business may be affected. We recommend that you perform the following operations: 1. Call the SmsConversion operation in an asynchronous manner by configuring queues or events. 2. Manually degrade your services or use a circuit breaker to automatically degrade services.'."\n", + ], + 'ConversionDataIntl' => [ + 'summary' => 'Sends conversion rate information to Alibaba Cloud SMS.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '176602', + 'abilityTreeNodes' => [ + 'FEATUREdysmsWO2BNU', + ], + ], + 'parameters' => [ + [ + 'name' => 'ReportTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The time point at which the conversion rate is monitored. The value is a UNIX timestamp. Unit: milliseconds.'."\n" + ."\n" + .'> If you do not specify this parameter, the current timestamp is used by default.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1349055900000', + ], + ], + [ + 'name' => 'ConversionRate', + 'in' => 'query', + 'schema' => [ + 'description' => 'The conversion rate.'."\n" + ."\n" + .'> The value of this parameter is a double, and ranges from 0 to 1.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0.53', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D****'."\n", + ], + 'Code' => [ + 'description' => 'The status code. If OK is returned, the request is successful. For more information, see [Error codes](https://help.aliyun.com/document_detail/101346.html?spm=a2c4g.101345.0.0.74326ff2J5EZyt).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + ], + 'description' => '', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\\\n\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => 'ConversionDataIntl', + ], + 'AddShortUrl' => [ + 'summary' => 'Creates a short URL.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102437', + 'abilityTreeNodes' => [ + 'FEATUREdysmsQAI8QG', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The source URL. The URL cannot exceed 1,000 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'https://www.****.com/product/sms', + ], + ], + [ + 'name' => 'ShortUrlName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The service name of the short URL. The name cannot exceed 13 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'The Alibaba Cloud Short Link service.', + ], + ], + [ + 'name' => 'EffectiveDays', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The validity period of the short URL. Unit: days. The maximum validity period is 90 days.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF', + ], + 'Data' => [ + 'description' => 'The details of the short URL.'."\n", + 'type' => 'object', + 'properties' => [ + 'SourceUrl' => [ + 'description' => 'The source URL.'."\n", + 'type' => 'string', + 'example' => 'https://www.****.com/product/sms', + ], + 'ExpireDate' => [ + 'description' => 'The time when the short URL expires.'."\n" + ."\n" + .'> The value of **ExpireDate** is on the hour.'."\n", + 'type' => 'string', + 'example' => '2021-09-19 00:00:00', + ], + 'ShortUrl' => [ + 'description' => 'The short URL.'."\n", + 'type' => 'string', + 'example' => 'http://****.cn/6y8uy7', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\",\\n \\"Data\\": {\\n \\"SourceUrl\\": \\"https://www.****.com/product/sms\\",\\n \\"ExpireDate\\": \\"2021-09-19 00:00:00\\",\\n \\"ShortUrl\\": \\"http://****.cn/6y8uy7\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<AddShortUrlResponse>\\n<Message>OK</Message>\\n<RequestId>819BE656-D2E0-4858-8B21-B2E477085AAF</RequestId>\\n<Data>\\n <SourceUrl>https://www.****.com/product/sms</SourceUrl>\\n <ShortUrl>http://****.cn/6y8uy7</ShortUrl>\\n <ExpireDate>2022-09-19 11:21:11</ExpireDate>\\n</Data>\\n<Code>OK</Code>\\n</AddShortUrlResponse>","errorExample":""}]', + 'title' => 'AddShortUrl', + 'description' => '* Before you call this operation, you must register the primary domain name of the source URL in the Short Message Service (SMS) console. After the domain name is registered, you can call this operation to create a short URL. For more information, see [Domain name registration](~~302325~~#title-mau-zdh-hd0).'."\n" + .'* You can create up to 3,000 short URLs within a natural day.'."\n" + .'* After a short URL is generated, a security review is required. Generally, the review takes 10 minutes to 2 hours to complete. Before the security review is passed, the short URL cannot be directly accessed.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteShortUrl' => [ + 'summary' => 'Deletes a short URL. After you delete a short URL, it cannot be changed to its original state.', + 'methods' => [ + 'post', + 'get', + 'delete', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102443', + 'abilityTreeNodes' => [ + 'FEATUREdysmsAF8QUN', + ], + ], + 'parameters' => [ + [ + 'name' => 'SourceUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The source address. The address can be up to 1,000 characters in length.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'https://www.****.com/product/sms', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* If OK is returned, the request is successful.'."\n" + .'* Other values indicate that the request fails. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteShortUrlResponse>\\n <Message>OK</Message>\\n <RequestId>819BE656-D2E0-4858-8B21-B2E477085AAF</RequestId>\\n <Code>OK</Code>\\n</DeleteShortUrlResponse>\\n","errorExample":""}]', + 'title' => 'DeleteShortUrl', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 100 times per second per account. If the number of the 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.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryShortUrl' => [ + 'summary' => 'Queries the status of a short URL.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102456', + 'abilityTreeNodes' => [ + 'FEATUREdysms2D1XSC', + ], + ], + 'parameters' => [ + [ + 'name' => 'ShortUrl', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The short URL. You can query the short URL by calling the [AddShortUrl](~~186774~~) operation.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'http://****.cn/6y8uy7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* If OK is returned, the request is successful.'."\n" + .'* Other values indicate that the request fails. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => 'The returned message.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF', + ], + 'Data' => [ + 'description' => 'The details of the short URL.'."\n", + 'type' => 'object', + 'properties' => [ + 'UniqueVisitorCount' => [ + 'description' => 'The UV.'."\n", + 'type' => 'string', + 'example' => '23', + ], + 'SourceUrl' => [ + 'description' => 'The source address.'."\n", + 'type' => 'string', + 'example' => 'https://www.****.com/product/sms', + ], + 'ShortUrlStatus' => [ + 'description' => 'The status of the short URL. Valid values:'."\n" + ."\n" + .'* **expired**'."\n" + .'* **effective**'."\n" + .'* **audit**'."\n" + .'* **reject**'."\n", + 'type' => 'string', + 'example' => 'expired', + ], + 'PageViewCount' => [ + 'description' => 'The PV.'."\n", + 'type' => 'string', + 'example' => '300', + ], + 'ExpireDate' => [ + 'description' => 'The time when the short URL expires.'."\n", + 'type' => 'string', + 'example' => '2019-01-22 11:21:11', + ], + 'ShortUrlName' => [ + 'description' => 'The service name of the short URL.'."\n", + 'type' => 'string', + 'example' => 'The Alibaba Cloud Short Link service.', + ], + 'CreateDate' => [ + 'description' => 'The time when the short URL was created.'."\n", + 'type' => 'string', + 'example' => '2019-01-08 16:44:13', + ], + 'ShortUrl' => [ + 'description' => 'The short URL.'."\n", + 'type' => 'string', + 'example' => 'http://****.cn/6y8uy7', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\",\\n \\"Data\\": {\\n \\"UniqueVisitorCount\\": \\"23\\",\\n \\"SourceUrl\\": \\"https://www.****.com/product/sms\\",\\n \\"ShortUrlStatus\\": \\"expired\\",\\n \\"PageViewCount\\": \\"300\\",\\n \\"ExpireDate\\": \\"2019-01-22 11:21:11\\",\\n \\"ShortUrlName\\": \\"阿里短链测试\\",\\n \\"CreateDate\\": \\"2019-01-08 16:44:13\\",\\n \\"ShortUrl\\": \\"http://****.cn/6y8uy7\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryShortUrlResponse>\\n<Message>OK</Message>\\n<RequestId>819BE656-D2E0-4858-8B21-B2E477085AAF</RequestId>\\n<Data>\\n <ShortUrlName>阿里短链测试</ShortUrlName>\\n <SourceUrl>https://www.****.com/product/sms</SourceUrl>\\n <ShortUrl>http://****.cn/6y8uy7</ShortUrl>\\n <ExpireDate>2022-09-19 11:21:11</ExpireDate>\\n <PageViewCount>300</PageViewCount>\\n <CreateDate>2019-01-08 16:44:13</CreateDate>\\n <ShortUrlStatus>expired</ShortUrlStatus>\\n <UniqueVisitorCount>23</UniqueVisitorCount>\\n</Data>\\n<Code>OK</Code>\\n</QueryShortUrlResponse>\\n","errorExample":""}]', + 'title' => 'QueryShortUrl', + 'description' => '### QPS limits'."\n" + ."\n" + .'You can call this operation up to 20 times per second per account. If the number of the 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.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTagResources' => [ + 'summary' => 'Queries the tags of a message template.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102448', + 'abilityTreeNodes' => [ + 'FEATUREdysmsGD2ZLS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Set the value to TEMPLATE.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TEMPLATE', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to **cn-hangzhou**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => 'The token used to query the next page.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '23432453245', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ProdCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the cloud service. Set the value to **dysms**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dysms', + 'default' => 'dysms', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tag list. Specify either the Tag or the ResourceId parameter. You can specify a maximum of 20 tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => 'The value of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The code of the message template. Specify either the Tag or the ResourceId parameter.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The code of the message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SMS_2342****', + ], + 'required' => false, + 'example' => 'SMS_23423423', + 'maxItems' => 51, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* If OK is returned, the request is successful.'."\n" + .'* Other values indicate that the request fails. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'NextToken' => [ + 'description' => 'The token used to query the next page.'."\n", + 'type' => 'string', + 'example' => '"23432453245"', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => 'The list of tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => 'The type of resource.'."\n", + 'type' => 'string', + 'example' => 'ALIYUN::DYSMS::TEMPLATE', + ], + 'TagValue' => [ + 'description' => 'The tag value.'."\n", + 'type' => 'string', + 'example' => 'TestValue', + ], + 'ResourceId' => [ + 'description' => 'The code of the message template.'."\n", + 'type' => 'string', + 'example' => 'SMS_23423****', + ], + 'TagKey' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'example' => 'TestKey', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"NextToken\\": \\"\\\\\\"23432453245\\\\\\"\\",\\n \\"RequestId\\": \\"A90E4451-FED7-49D2-87C8-00700A8C4D0D\\",\\n \\"TagResources\\": {\\n \\"TagResource\\": [\\n {\\n \\"ResourceType\\": \\"ALIYUN::DYSMS::TEMPLATE\\",\\n \\"TagValue\\": \\"TestValue\\",\\n \\"ResourceId\\": \\"SMS_23423****\\",\\n \\"TagKey\\": \\"TestKey\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListTagResourcesResponse>\\n <Code>OK</Code>\\n <NextToken>\\"23432453245\\"</NextToken>\\n <RequestId>A90E4451-FED7-49D2-87C8-00700A8C4D0D</RequestId>\\n <TagResources>\\n <ResourceType>ALIYUN::DYSMS::TEMPLATE</ResourceType>\\n <TagValue>TestValue</TagValue>\\n <ResourceId>SMS_23423****</ResourceId>\\n <TagKey>TestKey</TagKey>\\n </TagResources>\\n</ListTagResourcesResponse>","errorExample":""}]', + 'title' => 'ListTagResources', + 'description' => '### QPS limit'."\n" + ."\n" + .'You can call this operation up to 50 times per second per account. If the number of the 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.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TagResources' => [ + 'summary' => 'Attaches tags to a message template.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102472', + 'abilityTreeNodes' => [ + 'FEATUREdysmsGD2ZLS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Set the value to **TEMPLATE**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TEMPLATE', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID. Set the value to **cn-hangzhou**.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ProdCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the cloud service. Set the value to **dysms**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dysms', + 'default' => 'dysms', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The tag.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'The array of tag keys. Valid values of N: 1 to 20.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => 'The array of tag values. Valid values of N: 1 to 20.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The code of the message template.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The code of the message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SMS_2342****', + ], + 'required' => false, + 'example' => 'SMS_23423423', + 'maxItems' => 51, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The response code.'."\n" + ."\n" + .'* If OK is returned, the request is successful.'."\n" + .'* Other values indicate that the request fails. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'Indicates whether tags were attached. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\\\n\\"\\n}","type":"json"}]', + 'title' => 'TagResources', + 'description' => '### QPS limit'."\n" + ."\n" + .'You can call this operation up to 50 times per second per account. If the number of the 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.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UntagResources' => [ + 'summary' => 'Deletes tags from a message template.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '102473', + 'abilityTreeNodes' => [ + 'FEATUREdysmsGD2ZLS', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the resource. Set the value to TEMPLATE.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TEMPLATE', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region. Set the value to cn-hangzhou.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to delete all tags from the message template. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ProdCode', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the cloud service. Set the value to **dysms**.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dysms', + 'default' => 'dysms', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The array of tag keys. You can specify 1 to 20 tag keys.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The key of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'sampleTagKey', + ], + 'required' => false, + 'example' => 'TestKey', + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The array of message template codes. You can specify 1 to 20 message templates.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The code of the message template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SMS_2342****', + ], + 'required' => false, + 'example' => 'SMS_23423423', + 'maxItems' => 51, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The HTTP status code.'."\n" + ."\n" + .'* The value OK indicates that the request was successful.'."\n" + .'* Other values indicate that the request failed. For more information, see [Error codes](~~101346~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C****', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 200 => [ + [ + 'errorCode' => 'ForbiddenAction', + 'errorMessage' => 'Access to the account is denied. Please contact the administrator.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"OK\\",\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\\\n\\"\\n}","errorExample":""},{"type":"xml","example":"<UntagResourcesResponse>\\n<RequestId>A90E4451-FED7-49D2-87C8-00700A8C****</RequestId>\\n<Data>true</Data>\\n<Code>OK</Code>\\n</UntagResourcesResponse>","errorExample":""}]', + 'title' => 'UntagResources', + 'description' => '### QPS limit'."\n" + ."\n" + .'You can call this operation up to 50 times per second per account. If the number of the 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.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetSmsTemplateList' => [ + 'summary' => '查询模板列表详情（新接口）', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'title' => '签名', + 'description' => '签名', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'title' => '模板类型', + 'description' => '模板类型', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'enumValueTitles' => [ + '', + '', + '', + ], + 'example' => '0', + ], + ], + [ + 'name' => 'AuditStatus', + 'in' => 'query', + 'schema' => [ + 'title' => '模板审核状态', + 'description' => '模板审核状态', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'enumValueTitles' => [ + '', + '', + '', + ], + 'example' => '1', + ], + ], + [ + 'name' => 'UsableStateList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '模板状态', + 'description' => '模板状态', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'AVAILABLE' => '', + 'MISSING_SIGNATURE' => '', + 'MISSING_TRAFFIC_DRIVING' => '', + 'MISSING_TRAFFIC_DRIVING_ARCHIVE' => '', + 'UNAVAILABLE' => '', + 'MISSING_VARIABLE' => '', + ], + 'example' => 'MISSING_SIGNATURE', + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'title' => '模板名称', + 'description' => '模板名称', + 'type' => 'string', + 'required' => false, + 'example' => '示例值', + ], + ], + [ + 'name' => 'TemplateTag', + 'in' => 'query', + 'schema' => [ + 'title' => '模板标签', + 'description' => '模板标签', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'title' => '模板code', + 'description' => '模板code', + 'type' => 'string', + 'required' => false, + 'example' => 'SMS_1688168', + ], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'title' => '页码, 默认1', + 'description' => '页码, 默认1', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '每页数量，默认10', + 'description' => '每页数量，默认10', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'Message' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Data' => [ + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '78', + ], + 'Total' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '64', + ], + 'PageNo' => [ + 'title' => '', + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '97', + ], + 'List' => [ + 'title' => '', + 'description' => '', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateCode' => [ + 'title' => '模板code', + 'description' => '模板code', + 'type' => 'string', + 'example' => '示例值示例值示例值', + ], + 'GmtCreate' => [ + 'title' => '创建时间', + 'description' => '创建时间', + 'type' => 'string', + 'example' => '示例值', + ], + 'AuditStatus' => [ + 'title' => '模板审核状态', + 'description' => '模板审核状态', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '88', + ], + 'TemplateTag' => [ + 'title' => '模板标签', + 'description' => '模板标签', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '示例值', + ], + 'TagValue' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + ], + ], + 'example' => '', + ], + 'WorkOrderId' => [ + 'title' => '工单号', + 'description' => '工单号', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'UsableStateList' => [ + 'title' => '模板可用状态', + 'description' => '模板可用状态', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + 'example' => '', + ], + 'TemplateName' => [ + 'title' => '模板名称', + 'description' => '模板名称', + 'type' => 'string', + 'example' => '示例值', + ], + 'TemplateType' => [ + 'title' => '模板类型', + 'description' => '模板类型', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '43', + ], + 'SignName' => [ + 'title' => '签名', + 'description' => '签名', + 'type' => 'string', + 'example' => '示例值示例值', + ], + ], + ], + 'example' => '', + ], + ], + ], + 'Code' => [ + 'title' => '', + 'description' => '', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'title' => '', + 'description' => '', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"AccessDeniedDetail\\": \\"None\\",\\n \\"RequestId\\": \\"示例值\\",\\n \\"Message\\": \\"示例值示例值\\",\\n \\"Data\\": {\\n \\"PageSize\\": 78,\\n \\"Total\\": 64,\\n \\"PageNo\\": 97,\\n \\"List\\": [\\n {\\n \\"TemplateCode\\": \\"示例值示例值示例值\\",\\n \\"GmtCreate\\": \\"示例值\\",\\n \\"AuditStatus\\": 88,\\n \\"TemplateTag\\": [\\n {\\n \\"TagKey\\": \\"示例值\\",\\n \\"TagValue\\": \\"示例值示例值\\"\\n }\\n ],\\n \\"WorkOrderId\\": \\"示例值示例值\\",\\n \\"UsableStateList\\": [\\n \\"MISSING_SIGNATURE\\\\n\\"\\n ],\\n \\"TemplateName\\": \\"示例值\\",\\n \\"TemplateType\\": 43,\\n \\"SignName\\": \\"示例值示例值\\"\\n }\\n ]\\n },\\n \\"Code\\": \\"示例值示例值\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'dysmsapi.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2-pop', + 'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-pop', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-gov-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-nu16-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-edge-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fujian', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-haidian-cm12-c01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-bj-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-prod-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-2', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-3', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-test-306', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong-finance-pop', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote-nebula-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao-nebula', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et15-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et2-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-inner', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-internal-test-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-inner', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-st4-d01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-su18-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-yushanfang', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangbei', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangbei-na61-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou-na62-a01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-nebula-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'dysmsapi.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1-oxs', + 'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'rus-west-1-pop', + 'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + ], +]; diff --git a/data/en_us/dysmsapi/2018-05-01/api-docs.php b/data/en_us/dysmsapi/2018-05-01/api-docs.php new file mode 100644 index 0000000..44a33c1 --- /dev/null +++ b/data/en_us/dysmsapi/2018-05-01/api-docs.php @@ -0,0 +1,1193 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dysmsapi', + 'version' => '2018-05-01', + ], + 'directories' => [ + [ + 'id' => 349009, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'BatchSendMessageToGlobe', + 'SendMessageWithTemplate', + 'SendMessageToGlobe', + ], + ], + [ + 'id' => 349013, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'QueryMessage', + ], + ], + [ + 'id' => 349015, + 'title' => null, + 'type' => 'directory', + 'children' => [ + 'ConversionData', + 'SmsConversion', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'BatchSendMessageToGlobe' => [ + 'summary' => 'Sends a message to multiple recipients in countries or regions outside the Chinese mainland.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '13267', + 'abilityTreeNodes' => [ + 'FEATUREdysms1SWWZV', + ], + ], + 'parameters' => [ + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'title' => '接收方号码。号码格式为：国际区号+号码。'."\n" + ."\n" + .'电话代码详情，请参见电话代码。', + 'description' => 'The mobile phone number of the recipient. You must add the dialing code to the beginning of each mobile phone number.'."\n" + ."\n" + .'For more information, see [Dialing codes](~~158400~~).', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[\\"931520581****\\",\\"931530581****\\",\\"931540581****\\",\\"931550581****\\"]', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'title' => '发送方号码。支持SenderID的发送，只允许数字+字母，含有字母标识最长11位，纯数字标识支持15位。', + 'description' => 'The mobile phone number of the sender. You can specify the sender ID when you call the API operation. The sender ID can contain only digits and letters. If the sender ID contains letters, it can be a maximum of 11 characters in length. If the sender ID contains only digits, it can be a maximum of 15 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Alicloud321', + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'title' => '短信内容。', + 'description' => 'The content of the message.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[\\"message to 931520581****\\",\\"message to 931530581****\\",\\"message to 931540581****\\",\\"message to 931550581****\\"]', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '短信类型。取值：'."\n" + ."\n" + .'NOTIFY：通知短信。'."\n" + .'MKT：推广短信。', + 'description' => 'The type of the message. Valid values:'."\n" + ."\n" + .'* **NOTIFY**: notification'."\n" + .'* **MKT**: promotional message'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'NOTIFY', + 'enum' => [], + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务ID。长度不超过255个字符。可以在回执的TaskId获取。', + 'description' => 'The ID of the messaging campaign. It must be 1 to 255 characters in length. The ID is the value of the TaskId field in the delivery receipt of the message.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '123789****', + ], + ], + [ + 'name' => 'ValidityPeriod', + 'in' => 'query', + 'schema' => [ + 'title' => '短信有效时长', + 'description' => 'The validity period of the message. Unit: seconds.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '600', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '短信通道id', + 'description' => 'The ID of the delivery channel.', + 'type' => 'string', + 'required' => false, + 'example' => 'sms-djnfjn344', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ResponseCode' => [ + 'title' => '状态码。返回OK代表请求成功，其他错误码，请参见错误码列表。', + 'description' => 'The HTTP status code. If OK is returned, the request is successful. For more information, see [Error codes](~~180674~~).', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D28D3', + ], + 'FailedList' => [ + 'title' => '发送失败的号码列表。', + 'description' => 'The list of the mobile phone numbers that failed to receive the messages.'."\n", + 'type' => 'string', + 'example' => '["931520581****","931530581****"]', + ], + 'ResponseDescription' => [ + 'title' => '状态码描述。', + 'description' => 'The description of the status code.'."\n", + 'type' => 'string', + 'example' => 'The SMS Send Request was accepted', + ], + 'From' => [ + 'title' => '发送方标识，返回传入的SenderID。', + 'description' => 'The sender ID that was returned. The API operation returns the sender ID that you have specified in the request parameters.'."\n", + 'type' => 'string', + 'example' => 'Alicloud321', + ], + 'MessageIdList' => [ + 'title' => '发送成功的消息ID。', + 'description' => 'The ID of the sent message.'."\n", + 'type' => 'string', + 'example' => '["123****","124****"]', + ], + 'SuccessCount' => [ + 'title' => '成功发送条数。', + 'description' => 'The number of sent messages.'."\n", + 'type' => 'string', + 'example' => '2', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ResponseCode\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D28D3\\",\\n \\"FailedList\\": \\"[\\\\\\"931520581****\\\\\\",\\\\\\"931530581****\\\\\\"]\\",\\n \\"ResponseDescription\\": \\"The SMS Send Request was accepted\\",\\n \\"From\\": \\"Alicloud321\\",\\n \\"MessageIdList\\": \\"[\\\\\\"123****\\\\\\",\\\\\\"124****\\\\\\"]\\",\\n \\"SuccessCount\\": \\"2\\"\\n}","type":"json"}]', + 'title' => 'BatchSendMessageToGlobe', + 'description' => '## Usage notes'."\n" + ."\n" + .'* You cannot call the BatchSendMessageToGlobe operation to send messages to the Chinese mainland.'."\n" + .'* You can call the BatchSendMessageToGlobe operation to send notifications and promotional messages to a small number of mobile phone numbers at a time. To send messages to a large number of mobile phone numbers at a time, use the mass messaging feature of the SMS console.'."\n" + .'* To ensure that messages can be sent on time, call the [SendMessageToGlobe](~~406238~~) operation.'."\n" + .'* In each request, you can send messages to up to 1,000 mobile phone numbers.', + 'extraInfo' => "\n", + ], + 'SendMessageWithTemplate' => [ + 'summary' => 'Sends a message to the Chinese mainland by using a message template.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '13271', + 'abilityTreeNodes' => [ + 'FEATUREdysmsDXU0GD', + ], + ], + 'parameters' => [ + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'title' => '接收短信号码。号码格式为：国际区号+号码。', + 'description' => 'The mobile phone number to which the message is sent. You must add the country code to the beginning of the mobile phone number. Example: 861503871\\*\\*\\*\\*.'."\n" + ."\n" + .'For more information, see [Dialing codes](https://www.alibabacloud.com/help/en/sms/product-overview/dialing-codes?spm=a2c63.p38356.0.0.367279cbwQFoeM).', + 'type' => 'string', + 'required' => true, + 'example' => '861503871****', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'title' => '发送方标识，请传入短信签名名称。您可以登录短信服务控制台，选择发往中国大陆 > 短信签名，在短信签名列表查看签名名称。', + 'description' => 'The signature. To query the signature, log on to the [Short Message Service (SMS) console](https://sms-intl.console.aliyun.com/overview) and navigate to the **Signatures** tab of the **Go China** page.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Alicloud321', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'title' => '短信模板编码。您可以登录短信服务控制台，选择发往中国大陆 > 短信内容，在短信内容列表查看短信模板编码。', + 'description' => 'The code of the message template. To query the code, log on to the [SMS console](https://sms-intl.console.aliyun.com/overview) and navigate to the **Templates** tab of the **Go China** page.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'SMS_****', + ], + ], + [ + 'name' => 'TemplateParam', + 'in' => 'query', + 'schema' => [ + 'title' => '短信模板变量对应的实际值。如果模板中存在变量，该参数为必填项。', + 'description' => 'The value of the variable in the message template. If a variable exists in the template, the parameter is required.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"code":"1234","product":"ytx"}', + ], + ], + [ + 'name' => 'SmsUpExtendCode', + 'in' => 'query', + 'schema' => [ + 'title' => '上行短信扩展码。', + 'description' => 'The extension code of the MO message.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '90999', + ], + ], + [ + 'name' => 'ValidityPeriod', + 'in' => 'query', + 'schema' => [ + 'title' => '短信有效时长', + 'description' => 'The validity period of the message.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the channel.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '5739', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResponseCode' => [ + 'title' => '短信提交状态码。', + 'description' => 'The status code of the delivery request.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'NumberDetail' => [ + 'title' => '号码明细。', + 'description' => 'The details about the mobile phone number of the recipient.'."\n", + 'type' => 'object', + 'properties' => [ + 'Carrier' => [ + 'title' => '号码所属的运营商网络。', + 'description' => 'The carrier that owns the mobile phone number.'."\n", + 'type' => 'string', + 'example' => 'China Mobile', + ], + 'Region' => [ + 'title' => '号码所属地区。', + 'description' => 'The region to which the mobile phone number belongs.'."\n", + 'type' => 'string', + 'example' => 'Nanjing, Jiangsu', + ], + 'Country' => [ + 'title' => '号码所属国家。', + 'description' => 'The country to which the mobile phone number belongs.'."\n", + 'type' => 'string', + 'example' => 'China', + ], + ], + ], + 'ResponseDescription' => [ + 'title' => '短信提交状态的详细描述。', + 'description' => 'The description of the delivery request status.'."\n", + 'type' => 'string', + 'example' => 'The SMS Send Request was accepted', + ], + 'Segments' => [ + 'title' => '短信计费条数。', + 'description' => 'The number of messages that incurred fees.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'To' => [ + 'title' => '接收短信号码。号码格式为：国际区号+号码。', + 'description' => 'The mobile phone number to which the message was sent. The dialing code was added to the beginning of the mobile phone number. Example: 861503871\\*\\*\\*\\*.'."\n", + 'type' => 'string', + 'example' => '861503871****', + ], + 'MessageId' => [ + 'title' => '短信消息ID。由阿里云国际短信平台生成。', + 'description' => 'The ID of the message.'."\n", + 'type' => 'string', + 'example' => '1**************3', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D23D6', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResponseCode\\": \\"OK\\",\\n \\"NumberDetail\\": {\\n \\"Carrier\\": \\"China Mobile\\",\\n \\"Region\\": \\"Nanjing, Jiangsu\\",\\n \\"Country\\": \\"China\\"\\n },\\n \\"ResponseDescription\\": \\"The SMS Send Request was accepted\\",\\n \\"Segments\\": \\"1\\",\\n \\"To\\": \\"861503871****\\",\\n \\"MessageId\\": \\"1**************3\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D23D6\\"\\n}","errorExample":""},{"type":"xml","example":"<SendMessageWithTemplateResponse>\\n <ResponseCode>OK</ResponseCode>\\n <NumberDetail>\\n <Carrier>China Mobile</Carrier>\\n <Region>Nanjing, Jiangsu</Region>\\n <Country>China</Country>\\n </NumberDetail>\\n <ResponseDescription>The SMS Send Request was accepted</ResponseDescription>\\n <Segments>1</Segments>\\n <To>861503871****</To>\\n <MessageId>1**************3</MessageId>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8D23D6</RequestId>\\n</SendMessageWithTemplateResponse>","errorExample":""}]', + 'title' => 'SendMessageWithTemplate', + 'description' => '### Usage notes'."\n" + ."\n" + .'You can call the SendMessageWithTemplate operation to send messages only to the Chinese mainland.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SendMessageToGlobe' => [ + 'summary' => 'Sends a message to regions outside the Chinese mainland.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '13270', + 'abilityTreeNodes' => [ + 'FEATUREdysms1SWWZV', + ], + ], + 'parameters' => [ + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'title' => '接收方号码。号码格式为：国际区号+号码。', + 'description' => 'The mobile phone number to which the message is sent. You must add the dialing code to the beginning of the mobile phone number. Example: 8521245567\\*\\*\\*\\*.'."\n" + ."\n" + .'For more information, see [Dialing codes](https://www.alibabacloud.com/help/en/sms/product-overview/dialing-codes?spm=a2c63.p38356.0.0.48b940a1PFYRMz).'."\n" + ."\n" + .'> You cannot call the SendMessageToGlobe operation to send messages to the Chinese mainland.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8521245567****', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'title' => '发送方号码。支持SenderId的发送，只允许数字+字母，含有字母标识最长11位，纯数字标识支持15位。', + 'description' => 'The mobile phone number of the sender. You can also specify a sender ID. The sender ID can contain both letters and digits. If it does, the ID must be between 1 to 11 characters in length. If the sender ID contains only digits, it must be 1 to 15 characters in length.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Alicloud321', + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'title' => '短信的内容。', + 'description' => 'The content of the message.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Hello', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '短信类型。取值：'."\n" + .'OTP：验证码短信。'."\n" + .'NOTIFY：通知短信。'."\n" + .'MKT：推广短信。', + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务ID。长度不超过255个字符。可以从回执的TaskId字段获取。', + 'description' => 'The ID of the messaging campaign. It must be 1 to 255 characters in length. The ID is the value of the TaskId field in the delivery receipt of the message.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '123****789', + ], + ], + [ + 'name' => 'ValidityPeriod', + 'in' => 'query', + 'schema' => [ + 'title' => '短信有效时长', + 'description' => 'The validity period of the message. Unit: seconds.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '600', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the channel.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '3790', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResponseCode' => [ + 'title' => '短信提交状态码。', + 'description' => 'The status code of the delivery request.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'NumberDetail' => [ + 'title' => '号码明细。', + 'description' => 'The details about the mobile phone number of the recipient.'."\n", + 'type' => 'object', + 'properties' => [ + 'Carrier' => [ + 'title' => '号码所属的运营商网络。', + 'description' => 'The carrier that owns the mobile phone number.'."\n", + 'type' => 'string', + 'example' => 'CMI', + ], + 'Region' => [ + 'title' => '号码所属地区。', + 'description' => 'The region to which the mobile phone number belongs.'."\n", + 'type' => 'string', + 'example' => 'HongKong', + ], + 'Country' => [ + 'title' => '号码所属国家。', + 'description' => 'The country to which the mobile phone number belongs.'."\n", + 'type' => 'string', + 'example' => 'China', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'Segments' => [ + 'title' => '短信计费条数。', + 'description' => 'The number of messages that incurred fees.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'ResponseDescription' => [ + 'title' => '短信提交状态码描述。', + 'description' => 'The description of the delivery request status.'."\n", + 'type' => 'string', + 'example' => 'The SMS Send Request was accepted', + ], + 'From' => [ + 'title' => '发送方号码，返回传入的SenderId。', + 'description' => 'The sender ID returned.'."\n", + 'type' => 'string', + 'example' => 'Alicloud321', + ], + 'To' => [ + 'title' => '接收方号码。', + 'description' => 'The mobile phone number to which the message was sent.'."\n", + 'type' => 'string', + 'example' => '1380000****', + ], + 'MessageId' => [ + 'title' => '短信消息ID。由阿里云国际短信平台生成', + 'description' => 'The ID of the message.'."\n", + 'type' => 'string', + 'example' => '1008030300****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResponseCode\\": \\"OK\\",\\n \\"NumberDetail\\": {\\n \\"Carrier\\": \\"CMI\\",\\n \\"Region\\": \\"HongKong\\",\\n \\"Country\\": \\"China\\"\\n },\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8DE990\\",\\n \\"Segments\\": \\"1\\",\\n \\"ResponseDescription\\": \\"The SMS Send Request was accepted\\",\\n \\"From\\": \\"Alicloud321\\",\\n \\"To\\": \\"1380000****\\",\\n \\"MessageId\\": \\"1008030300****\\"\\n}","errorExample":""},{"type":"xml","example":"<SendMessageToGlobeResponse>\\n <ResponseCode>OK</ResponseCode>\\n <NumberDetail>\\n <Carrier>CMI</Carrier>\\n <Region>HongKong</Region>\\n <Country>Hongkong, China</Country>\\n </NumberDetail>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8DE990</RequestId>\\n <Segments>1</Segments>\\n <ResponseDescription>The SMS Send Request was accepted</ResponseDescription>\\n <From>Alicloud</From>\\n <To>\\"123\\"</To>\\n <MessageId>1008030300****</MessageId>\\n</SendMessageToGlobeResponse>","errorExample":""}]', + 'title' => 'SendMessageToGlobe', + 'description' => '### [](#)'."\n" + ."\n" + .'The SendMessageToGlobe API operation does not support message delivery to the Chinese mainland.'."\n" + ."\n" + .'### [](#qps-)QPS limit'."\n" + ."\n" + .'You can call this operation up to 2,000 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation.'."\n", + ], + 'QueryMessage' => [ + 'summary' => 'Queries the delivery report of a message.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13268', + 'abilityTreeNodes' => [ + 'FEATUREdysmsRZSVOZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'MessageId', + 'in' => 'query', + 'schema' => [ + 'title' => '短信消息ID。', + 'description' => 'The ID of the message.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1008030xxx3003', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '短信的发送状态。'."\n" + ."\n" + .'1：成功（Delivered）'."\n" + .'2：失败（Delivery Failed）'."\n" + .'3：发送中（Delivering）', + 'description' => 'The delivery status of the message.'."\n" + ."\n" + .'* 1: The message was sent.'."\n" + .'* 2: The message failed to be sent.'."\n" + .'* 3: The message is being sent.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'ErrorDescription' => [ + 'title' => '短信发送状态码的描述。', + 'description' => 'The description of the status code.'."\n", + 'type' => 'string', + 'example' => 'success', + ], + 'ResponseCode' => [ + 'title' => '短信提交状态码。', + 'description' => 'The status code of the delivery request.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'ReceiveDate' => [ + 'title' => '发送短信收到运营商回执的时间。', + 'description' => 'The time when the delivery receipt was received from the carrier.'."\n", + 'type' => 'string', + 'example' => 'Mon, 24 Dec 2018 16:58:22 +0800', + ], + 'NumberDetail' => [ + 'title' => '号码明细。', + 'description' => 'The details about the mobile phone number.'."\n", + 'type' => 'object', + 'properties' => [ + 'Carrier' => [ + 'title' => '号码所属的运营商网络。', + 'description' => 'The carrier that owns the mobile phone number.'."\n", + 'type' => 'string', + 'example' => 'CMI', + ], + 'Region' => [ + 'title' => '号码所属地区。', + 'description' => 'The region to which the mobile phone number belongs.'."\n", + 'type' => 'string', + 'example' => 'HongKong', + ], + 'Country' => [ + 'title' => '号码所属国家。', + 'description' => 'The country to which the mobile phone number belongs.'."\n", + 'type' => 'string', + 'example' => 'China', + ], + ], + ], + 'Message' => [ + 'title' => '短信内容。', + 'description' => 'The content of the message.'."\n", + 'type' => 'string', + 'example' => 'Hello!', + ], + 'ResponseDescription' => [ + 'title' => '短信提交状态的详细描述。', + 'description' => 'The description of the delivery request status.'."\n", + 'type' => 'string', + 'example' => 'The SMS Send Request was accepted', + ], + 'ErrorCode' => [ + 'title' => '短信发送状态码。', + 'description' => 'The status code of the message.'."\n", + 'type' => 'string', + 'example' => 'DELIVERED', + ], + 'SendDate' => [ + 'title' => '短信转发给运营商的时间。', + 'description' => 'The time when the message was sent to the carrier.'."\n", + 'type' => 'string', + 'example' => 'Mon, 24 Dec 2018 16:58:22 +0800', + ], + 'To' => [ + 'title' => '接收方号码。', + 'description' => 'The mobile phone number to which the message was sent.'."\n", + 'type' => 'string', + 'example' => '6581xxx810', + ], + 'MessageId' => [ + 'title' => '短信消息ID。', + 'description' => 'The ID of the message.'."\n", + 'type' => 'string', + 'example' => '1008030xxx3003', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D28D0', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Status\\": \\"1\\",\\n \\"ErrorDescription\\": \\"success\\",\\n \\"ResponseCode\\": \\"OK\\",\\n \\"ReceiveDate\\": \\"Mon, 24 Dec 2018 16:58:22 +0800\\",\\n \\"NumberDetail\\": {\\n \\"Carrier\\": \\"CMI\\",\\n \\"Region\\": \\"HongKong\\",\\n \\"Country\\": \\"China\\"\\n },\\n \\"Message\\": \\"Hello!\\",\\n \\"ResponseDescription\\": \\"The SMS Send Request was accepted\\",\\n \\"ErrorCode\\": \\"DELIVERED\\",\\n \\"SendDate\\": \\"Mon, 24 Dec 2018 16:58:22 +0800\\",\\n \\"To\\": \\"6581xxx810\\",\\n \\"MessageId\\": \\"1008030xxx3003\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D28D0\\"\\n}","errorExample":""},{"type":"xml","example":"<QueryMessageResponse>\\n <Status>1</Status>\\n <ErrorDescription>success</ErrorDescription>\\n <ResponseCode>OK</ResponseCode>\\n <ReceiveDate>Mon, 24 Dec 2018 16:58:22 +0800</ReceiveDate>\\n <NumberDetail>\\n <Carrier>CMI</Carrier>\\n <Region>HongKong</Region>\\n <Country>Hongkong, China</Country>\\n </NumberDetail>\\n <Message>Hello!</Message>\\n <ResponseDescription>The SMS Send Request was accepted</ResponseDescription>\\n <ErrorCode>DELIVERED</ErrorCode>\\n <SendDate>Mon, 24 Dec 2018 16:58:22 +0800</SendDate>\\n <To>6581xxx810</To>\\n <MessageId>1008030xxx3003</MessageId>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8D28D0</RequestId>\\n</QueryMessageResponse>","errorExample":""}]', + 'title' => 'QueryMessage', + 'description' => '### QPS limit'."\n" + ."\n" + .'You can call this operation up to 300 times per second. If the number of the calls per second exceeds a limit, throttling is triggered. As a result, your business may be affected. We recommend that you take note of the limits when you call this operation.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ConversionData' => [ + 'summary' => 'Reports the status of an OTP message to Alibaba Cloud SMS.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '31341', + 'abilityTreeNodes' => [ + 'FEATUREdysmsL8BKKM', + ], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ReportTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '转化率观测的时间点。必须是Unix时间戳，毫秒级别长整型。如果不指定该字段，默认当前的时间戳。', + 'description' => 'Timestamp of the conversion rate observation should be a Unix timestamp, a millisecond-level long integer.'."\n" + ."\n" + .'> If this field is not specified: the current timestamp is the default.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1349055900000', + ], + ], + [ + 'name' => 'ConversionRate', + 'in' => 'formData', + 'schema' => [ + 'title' => '转化率监控回报值。该参数取值为double类型 ，区间是[0,1]。', + 'description' => 'Conversion rate monitoring return value.'."\n" + ."\n" + .'> The value of this parameter is of type double, and the value is between \\[0,1].'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '0.53', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ResponseCode' => [ + 'title' => '状态码。返回OK代表请求成功，其他错误码，请参见错误码列表。', + 'description' => 'Status code. Returning OK means the request was successful. For other error codes, please refer to the [Error codes](~~180674~~) list.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'ResponseDescription' => [ + 'title' => '状态码描述。', + 'description' => 'The description of the status code.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResponseCode\\": \\"OK\\",\\n \\"ResponseDescription\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D****\\"\\n}","errorExample":""},{"type":"xml","example":"<ConversionDataResponse>\\n <ResponseCode>OK</ResponseCode>\\n <ResponseDescription>OK</ResponseDescription>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8D****</RequestId>\\n</ConversionDataResponse>","errorExample":""}]', + 'title' => 'ConversionData', + 'description' => 'Metrics:'."\n" + ."\n" + .'* Requested OTP messages'."\n" + .'* Verified OTP messages'."\n" + ."\n" + .'An OTP conversion rate is calculated based on the following formula: OTP conversion rate = Number of verified OTP messages/Number of requested OTP messages.'."\n", + ], + 'SmsConversion' => [ + 'summary' => 'Delivers one-time password (OTP) message statuses to Alibaba Cloud, which calculates and monitors OTP conversion rates.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '13273', + 'abilityTreeNodes' => [ + 'FEATUREdysmsL8BKKM', + ], + ], + 'parameters' => [ + [ + 'name' => 'MessageId', + 'in' => 'query', + 'schema' => [ + 'title' => '短信消息ID。', + 'description' => 'The ID of the OTP message.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1008030300****', + ], + ], + [ + 'name' => 'Delivered', + 'in' => 'query', + 'schema' => [ + 'title' => '如果您的用户确认接收到了您发送的消息，例如，回填了短信验证码，则设置为 true。否则，设置为 false。', + 'description' => 'Specifies whether customers replied to the OTP message. Valid values: true and false.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'ConversionTime', + 'in' => 'query', + 'schema' => [ + 'title' => '触达发送目标的时间戳。必须是Unix时间戳，毫秒级别长整型。'."\n" + ."\n" + .'如果不指定该字段：默认当前的时间戳。'."\n" + .'如果指定该字段：该时间戳必须大于发送时间并且小于当前时间戳。', + 'description' => 'The time when the OTP message was delivered. The value is a UNIX timestamp. Unit: milliseconds.'."\n" + ."\n" + .'* If you leave the parameter empty, the current timestamp is specified by default.'."\n" + .'* If you specify the parameter, the timestamp must be greater than the message sending time and less than the current timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1349055900000', + ], + ], + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'title' => '短信手机号', + 'description' => 'The mobile phone number of the recipient. You must add the dialing code to the beginning of the mobile phone number.'."\n" + ."\n" + .'For more information, see [Dialing codes](~~158400~~).', + 'type' => 'string', + 'required' => false, + 'example' => '8521245567****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ResponseCode' => [ + 'title' => '状态码。返回OK代表请求成功，其他错误码，请参见错误码列表。', + 'description' => 'The status code. If OK is returned, the request is successful. For more information, see [Error codes](~~180674~~).'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'ResponseDescription' => [ + 'title' => '状态码描述。', + 'description' => 'The description of the status code.'."\n", + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => 'The ID of the request.'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ResponseCode\\": \\"OK\\",\\n \\"ResponseDescription\\": \\"OK\\",\\n \\"RequestId\\": \\"F655A8D5-B967-440B-8683-DAD6FF8D****\\"\\n}","errorExample":""},{"type":"xml","example":"<SmsConversionResponse>\\n <ResponseCode>OK</ResponseCode>\\n <ResponseDescription>OK</ResponseDescription>\\n <RequestId>F655A8D5-B967-440B-8683-DAD6FF8D****</RequestId>\\n</SmsConversionResponse>","errorExample":""}]', + 'title' => 'SmsConversion', + 'description' => 'Metrics:'."\n" + ."\n" + .'* Requested OTP messages'."\n" + .'* Verified OTP messages'."\n" + ."\n" + .'An OTP conversion rate is calculated based on the following formula: OTP conversion rate = Number of verified OTP messages/Number of requested OTP messages.'."\n" + ."\n" + .'> If you call the SmsConversion operation to query OTP conversion rates, your business may be affected. We recommend that you perform the following operations:'."\n" + .'>* Call the SmsConversion operation in an asynchronous manner by configuring queues or events.'."\n" + .'>* Manually degrade your services or use a circuit breaker to automatically degrade services.', + ], + ], + 'endpoints' => [ + [ + 'regionId' => 'ap-southeast-1', + 'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'ap-southeast-5', + 'endpoint' => 'dysmsapi.ap-southeast-5.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'ap-northeast-2-pop', + 'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-finance-pop', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-gov-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-beijing-nu16-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-chengdu', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-edge-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-fujian', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-haidian-cm12-c01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-bj-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-finance', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-prod-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-2', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-internal-test-3', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou-test-306', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hongkong-finance-pop', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote-nebula-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-north-2-gov-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao-nebula', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et15-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-et2-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-finance-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-inner', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shanghai-internal-test-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-finance-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-inner', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-st4-d01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-shenzhen-su18-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-wuhan', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-yushanfang', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangbei', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangbei-na61-b01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou-na62-a01', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhengzhou-nebula-1', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'eu-central-1', + 'endpoint' => 'dysmsapi.eu-central-1.aliyuncs.com', + ], + [ + 'regionId' => 'eu-west-1-oxs', + 'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'rus-west-1-pop', + 'endpoint' => 'dysmsapi.ap-southeast-1.aliyuncs.com', + ], + [ + 'regionId' => 'cn-qingdao', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-zhangjiakou', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-huhehaote', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + [ + 'regionId' => 'cn-hangzhou', + 'endpoint' => 'dysmsapi.aliyuncs.com', + ], + ], +]; |