diff options
| author | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
|---|---|---|
| committer | Zhineng Li <[email protected]> | 2026-02-13 10:54:11 +0800 |
| commit | 7347bac4ab7e136157fc94777e6cf87ef9e08599 (patch) | |
| tree | 0dec367dac6e152161a6f7cc0dba6ebbef1f34a2 /data/zh_cn/dysmsapi | |
| download | acs-metadata-full-1.0.0+20260212.tar.gz acs-metadata-full-1.0.0+20260212.zip | |
first commitHEADv1.0.0+20260212main
Diffstat (limited to 'data/zh_cn/dysmsapi')
| -rw-r--r-- | data/zh_cn/dysmsapi/2017-05-25/api-docs.php | 12660 | ||||
| -rw-r--r-- | data/zh_cn/dysmsapi/2018-05-01/api-docs.php | 1201 |
2 files changed, 13861 insertions, 0 deletions
diff --git a/data/zh_cn/dysmsapi/2017-05-25/api-docs.php b/data/zh_cn/dysmsapi/2017-05-25/api-docs.php new file mode 100644 index 0000000..104b623 --- /dev/null +++ b/data/zh_cn/dysmsapi/2017-05-25/api-docs.php @@ -0,0 +1,12660 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dysmsapi', + 'version' => '2017-05-25', + ], + 'directories' => [ + [ + 'id' => 402523, + 'title' => '资质管理', + 'type' => 'directory', + 'children' => [ + 'SubmitSmsQualification', + 'QuerySmsQualificationRecord', + 'QuerySingleSmsQualification', + 'UpdateSmsQualification', + 'DeleteSmsQualification', + 'RequiredPhoneCode', + 'ValidPhoneCode', + ], + ], + [ + 'id' => 402531, + 'title' => '授权委托书', + 'type' => 'directory', + 'children' => [ + 'CreateSmsAuthorizationLetter', + 'QuerySmsAuthorizationLetter', + ], + ], + [ + 'id' => 402534, + 'title' => '签名管理', + 'type' => 'directory', + 'children' => [ + 'CreateSmsSign', + 'GetSmsSign', + 'QuerySmsSignList', + 'UpdateSmsSign', + 'DeleteSmsSign', + 'ChangeSignatureQualification', + 'AddSmsSign', + 'ModifySmsSign', + 'QuerySmsSign', + ], + ], + [ + 'id' => 402544, + 'title' => '商标+ICP备案', + 'type' => 'directory', + 'children' => [ + 'CreateSmsTrademark', + 'QuerySmsTrademark', + 'CreateSmsAppIcpRecord', + 'QuerySmsAppIcpRecord', + ], + ], + [ + 'id' => 402549, + 'title' => '模板管理', + 'type' => 'directory', + 'children' => [ + 'CreateSmsTemplate', + 'GetSmsTemplate', + 'QuerySmsTemplateList', + 'UpdateSmsTemplate', + 'DeleteSmsTemplate', + 'AddSmsTemplate', + 'ModifySmsTemplate', + 'QuerySmsTemplate', + ], + ], + [ + 'id' => 402558, + 'title' => '短信发送', + 'type' => 'directory', + 'children' => [ + 'SendSms', + 'SendBatchSms', + ], + ], + [ + 'id' => 402561, + 'title' => '发送查询', + 'type' => 'directory', + 'children' => [ + 'QuerySendDetails', + 'QuerySendStatistics', + ], + ], + [ + 'id' => 402564, + 'title' => '数字短信', + 'type' => 'directory', + 'children' => [ + 'CreateDigitalSignOrder', + 'QueryDigitalSignByName', + 'CreateDigitalSmsTemplate', + ], + ], + [ + 'id' => 402568, + 'title' => '卡片短信', + 'type' => 'directory', + 'children' => [ + 'GetOSSInfoForCardTemplate', + 'GetMediaResourceId', + 'CreateCardSmsTemplate', + 'QueryCardSmsTemplate', + 'CheckMobilesCardSupport', + 'QueryMobilesCardSupport', + 'GetCardSmsLink', + 'GetCardSmsDetails', + 'QueryCardSmsTemplateReport', + 'SendCardSms', + 'SendBatchCardSms', + ], + ], + [ + 'id' => 402580, + 'title' => '获取OSS上传信息', + 'type' => 'directory', + 'children' => [ + 'GetQualificationOssInfo', + 'GetOSSInfoForUploadFile', + 'GetSmsOcrOssInfo', + ], + ], + [ + 'id' => 402584, + 'title' => '国内发国际短信转化率', + 'type' => 'directory', + 'children' => [ + 'SmsConversionIntl', + 'ConversionDataIntl', + ], + ], + [ + 'id' => 402587, + 'title' => '短链管理', + 'type' => 'directory', + 'children' => [ + 'AddShortUrl', + 'DeleteShortUrl', + 'QueryShortUrl', + ], + ], + [ + 'id' => 402591, + 'title' => '标签管理', + 'type' => 'directory', + 'children' => [ + 'ListTagResources', + 'TagResources', + 'UntagResources', + ], + ], + [ + 'id' => 0, + 'title' => '其它', + 'type' => 'directory', + 'children' => [ + 'GetSmsTemplateList', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'SubmitSmsQualification' => [ + 'summary' => '根据工信部及运营商实名制发送短信的要求，国内短信需提供签名归属方的资质证件信息。请先申请短信资质，然后再申请签名和模板。', + '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' => '资质名称，用于管理、区分您申请的多个资质，不会出现在短信内容中。名称不可与已有资质名称重复，仅支持中文、英文或与数字组合，不支持任何符号或纯数字输入，长度不超过100字符。', + 'type' => 'string', + 'required' => true, + 'example' => '阿里云云通信有限公司资质李华', + ], + ], + [ + 'name' => 'UseBySelf', + 'in' => 'query', + 'schema' => [ + 'title' => '资质是自用还是他用，true：自用，false：他用', + 'description' => '资质申请用途，取值：'."\n" + ."\n" + .'- **true**：**自用**，签名所属主体与本账号实名认证的主体一致。'."\n" + .'- **false**：**他用**，签名所属主体与本账号实名认证的主体不一致。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'CompanyType', + 'in' => 'query', + 'schema' => [ + 'title' => '企业类型, COMPANY:公司;NON_PROFIT_ORGANIZATION:政府或者事业单位', + 'description' => '企业类型，取值：'."\n" + ."\n" + .'- COMPANY：企业。'."\n" + ."\n" + .'- NON_PROFIT_ORGANIZATION：政府机关或事业单位。', + 'type' => 'string', + 'required' => true, + 'example' => 'COMPANY', + ], + ], + [ + 'name' => 'BusinessLicensePics', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '企业营业证件信息，非大客户必填', + 'description' => '企业营业证件信息。资质用途`UseBySelf`选择`false`他用时，此参数必填。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '营业证件类型，businessLicense:营业执照;organizationCodeLicense:组织机构代码证;taxRegistrationLicense:税务登记证;socialCreditLicense:社会信用代码证书;newStyleBusinessLicense:三证合一;signLegalLicense:签名归属方的事业单位法人证书;otherLicense:其他类型执照证书', + 'description' => '营业证件类型。取值：'."\n" + ."\n" + .'- socialCreditLicense：社会信用代码证书。'."\n" + .'- businessLicense：企业营业执照。'."\n" + .'- signLegalLicense：事业单位法人证书。'."\n" + .'- otherLicense：其他。'."\n" + ."\n" + .'选择一种上传即可，证件上需含有：企业名称、统一社会信用代码、证件有效期。', + 'type' => 'string', + 'required' => false, + 'example' => 'businessLicense', + ], + 'LicensePic' => [ + 'title' => '营业证件图片标识的osskey', + 'description' => '营业证件图片，仅支持jpg、png、gif、jpeg格式的图片，图片不大于5MB。请填写上传到OSS的文件路径参数，待上传的文件命名不可包含中文和特殊字符，上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n" + ."\n\n" + .'><notice>'."\n" + ."\n" + .'证件的彩色原件无需盖章，若上传复印件/黑白照片，需要在复印件上加盖企业红章并拍照上传。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CompanyName', + 'in' => 'query', + 'schema' => [ + 'title' => '公司名称', + 'description' => '企业名称。符号仅支持中点`·`、中文`【】（）`、英文`()`及`空格`，不可含其他符号或纯数字，长度不超过150字符。', + 'type' => 'string', + 'required' => true, + 'example' => '阿里云云通信有限公司', + ], + ], + [ + 'name' => 'OrganizationCode', + 'in' => 'query', + 'schema' => [ + 'title' => '社会统一信用代码', + 'description' => '社会统一信用代码，长度不超过150字符。', + 'type' => 'string', + 'required' => true, + 'example' => '910X********0012', + ], + ], + [ + 'name' => 'BussinessLicenseExpDate', + 'in' => 'query', + 'schema' => [ + 'title' => '企业营业时间开始和结束字符串，格式示例2023-01-01~2033-01-01', + 'description' => '营业证件有效期。有效期格式：YYYY-MM-DD~YYYY-MM-DD。'."\n" + .'> 证照有效期为长期时，截止日期可填：2099-12-31。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-01-01~2033-01-01', + ], + ], + [ + 'name' => 'LegalPersonIdCardFrontSide', + 'in' => 'query', + 'schema' => [ + 'title' => '法人身份证照片国徽面', + 'description' => '法定代表人证件正面照片（身份证国徽面），仅支持jpg、png、gif、jpeg格式的图片，图片不大于5MB。请填写上传到OSS的文件路径参数，待上传的文件命名不可包含中文和特殊字符，上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n" + ."\n\n" + .'> 系统会使用您填写的法人姓名、证件号码进行校验；若校验不通过，则需要上传法定代表人身份证件照片。', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png', + ], + ], + [ + 'name' => 'LegalPersonIdCardBackSide', + 'in' => 'query', + 'schema' => [ + 'title' => '法人身份证照片人像面', + 'description' => '法定代表人证件反面照片（身份证人像面），仅支持jpg、png、gif、jpeg格式的图片，图片不大于5MB。请填写上传到OSS的文件路径参数，待上传的文件命名不可包含中文和特殊字符，上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n" + ."\n" + .'> 系统会使用您填写的法人姓名、证件号码进行校验；若校验不通过，则需要上传法定代表人身份证件照片。', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png', + ], + ], + [ + 'name' => 'LegalPersonName', + 'in' => 'query', + 'schema' => [ + 'title' => '法人姓名', + 'description' => '法定代表人姓名，长度不超过50字符。'."\n" + ."\n" + .'> - 若组织证件中无法定代表人信息，但存在负责人/首席代表等相关信息，请准备证件中对应负责人或首席代表的身份证件照片。'."\n" + .'> - 若组织证件中无法定代表人信息，且无任何负责人信息，请准备业务主要负责人的姓名、身份证件照片。', + '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' => '法定代表人证件有效期。有效期格式：YYYY-MM-DD~YYYY-MM-DD。'."\n" + .'> 证件有效期为长期时，截止日期可填：2099-12-31。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-01-01~2033-01-01', + ], + ], + [ + 'name' => 'LegalPersonIDCardType', + 'in' => 'query', + 'schema' => [ + 'title' => '法人身份证类型。identityCard:中国居民身份证;passport:护照;homeReturnPermit:港澳居民来往内地通行证;TaiwanCompatriotPermit:台湾居民来往大陆通行证;residencePermit:港澳台居民居住证";other:其他', + 'description' => '法定代表人证件类型。取值：'."\n" + ."\n" + .'- identityCard：身份证。'."\n" + .'- passport：护照。'."\n" + .'- homeReturnPermit：港澳居民来往内地通行证。'."\n" + .'- TaiwanCompatriotPermit：台湾居民来往大陆通行证。'."\n" + .'- residencePermit：港澳台居民居住证。'."\n" + .'- other：其他。', + 'type' => 'string', + 'required' => true, + 'example' => 'identityCard', + ], + ], + [ + 'name' => 'AdminIDCardPic', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人身份证照片人像面', + 'description' => '管理员证件反面照片（身份证人像面），仅支持jpg、png、gif、jpeg格式的图片，图片不大于5MB。请填写上传到OSS的文件路径参数，待上传的文件命名不可包含中文和特殊字符，上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n" + ."\n" + .'><notice>'."\n" + .'证件的彩色原件无需盖章，若上传复印件/黑白照片，需要在复印件上加盖企业红章并拍照上传。'."\n" + ."\n" + .'></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '123456/111.png', + ], + ], + [ + 'name' => 'AdminIDCardFrontFace', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人身份证照片国徽面', + 'description' => '管理员证件正面照片（身份证国徽面），仅支持jpg、png、gif、jpeg格式的图片，图片不大于5MB。请填写上传到OSS的文件路径参数，待上传的文件命名不可包含中文和特殊字符上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n" + ."\n" + .'><notice>'."\n" + .'证件的彩色原件无需盖章，若上传复印件/黑白照片，需要在复印件上加盖企业红章并拍照上传。'."\n" + ."\n" + .'></notice>', + 'type' => 'string', + 'required' => true, + 'example' => '123456/111.png', + ], + ], + [ + 'name' => 'AdminName', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人姓名', + 'description' => '管理员姓名，长度不超过50字符。**在当前的[短信签名实名制](~~2873145~~)要求下，同一个管理员若申请多个不同的企业资质会导致报备失败，请确认一管一企以提升报备成功率。**'."\n" + ."\n" + .'> 管理员（又称经办人）指登录阿里云账号并管理短信业务的人员，一般是贵方管理此阿里云账号下资质、签名和模板，并进行短信发送的相关运营人员，且此人手机号可接收验证码。管理员不一定是此阿里云账号的管理员，管理员可以与企业法人为同一人。', + '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' => '管理员证件类型。取值：'."\n" + ."\n" + .'- identityCard：身份证。'."\n" + .'- passport：护照。'."\n" + .'- homeReturnPermit：港澳居民来往内地通行证。'."\n" + .'- TaiwanCompatriotPermit：台湾居民来往大陆通行证。'."\n" + .'- residencePermit：港澳台居民居住证。'."\n" + .'- other：其他。', + 'type' => 'string', + 'required' => true, + 'example' => 'identityCard', + ], + ], + [ + 'name' => 'AdminIDCardExpDate', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人身份证有效期，格式示例2023-01-01~2033-01-01', + 'description' => '管理员证件有效期。有效期格式：YYYY-MM-DD~YYYY-MM-DD。'."\n" + .'> 证件有效期为长期时，截止日期可填：2099-12-31。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-01-01~2033-01-01', + ], + ], + [ + 'name' => 'AdminPhoneNo', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人手机号码', + 'description' => '管理员手机号码，格式：+/+86/0086/86 或无任何前缀的手机号码，例如1390000****。', + 'type' => 'string', + 'required' => true, + 'example' => '137****1234', + ], + ], + [ + 'name' => 'CertifyCode', + 'in' => 'query', + 'schema' => [ + 'title' => '手机号验证码', + 'description' => '手机号验证码。请调用[RequiredPhoneCode](~~RequiredPhoneCode~~)接口并传入**管理员手机号码**后，在此填入接收到的短信验证码。'."\n" + ."\n" + .'> 您可以使用[ValidPhoneCode](~~ValidPhoneCode~~)自行校验短信验证码是否准确后再传入。', + 'type' => 'string', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'OtherFiles', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '更多资料', + 'description' => '更多资料，如果您还有其他证明或备注材料、照片等，可在此上传。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LicensePic' => [ + 'title' => '', + 'description' => '更多资料文件，仅支持png、jpg、jpeg、doc、docx、pdf格式，文件不大于5MB。请填写上传到OSS的文件路径参数，待上传的文件命名不可包含中文和特殊字符，上传操作请参见通过[OSS上传文件](~~2833114~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'WhetherShare', + 'in' => 'query', + 'schema' => [ + 'title' => '是否同意与其他业务线共享', + 'description' => '资质授权，是否同意与其他云通信产品（如国内语音、国内号码隐私保护）的资质共享。仅当您申请**自用资质**，且资质信息**与当前阿里云账号认证企业信息一致**时可被共享、复用；其他情况无效。取值：'."\n" + ."\n" + .'- true：同意，您的资质信息可在其他云通信产品的“资质认证环节”调用，免除重复认证环节。'."\n" + .'- false：不同意。', + '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' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '资质ID。', + 'type' => 'string', + 'example' => '1000****', + ], + 'Code' => [ + 'title' => '', + 'description' => '请求状态码。'."\n" + ."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见本章节的错误码列表或产品[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + '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"}]', + 'title' => '申请短信资质', + 'description' => '- 在发起申请前，请您阅读[资质材料说明](~~2384377~~)并准备相关资质材料。'."\n" + .'- 目前仅**企业认证**用户可使用API申请短信资质。若您当前阿里云账号为个人认证，请通过短信服务[控制台](https://dysms.console.aliyun.com/domestic/text/qualification/add)申请资质，或[升级为企业认证](~~37178~~)。[查看我的帐户认证类型](https://myaccount.console.aliyun.com/cert-info)'."\n" + .'- 不支持批量申请短信资质，建议每次申请至少间隔5秒。', + 'requestParamsDescription' => '><notice>'."\n" + ."\n" + .'短信资质材料具体要求请参见[资质材料说明](~~2384377~~)，要求可能随工信部与运营商要求实时调整，请以审核实际结果为准。'."\n" + ."\n" + .'></notice>', + ], + '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' => '审核状态。取值：'."\n" + ."\n" + .'- INIT：审核中。'."\n" + .'- NOT_PASS：审核不通过。 '."\n" + .'- PASS：审核通过。'."\n" + .'- NOT_FINISH：资料待补充。'."\n" + .'- CANCEL：已撤回。', + 'type' => 'string', + 'required' => false, + 'example' => 'PASS', + ], + ], + [ + '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' => '资质申请用途，取值：'."\n" + ."\n" + .'- **true**：自用。'."\n" + .'- **false**：他用。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '当前页码。默认取值为 1。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '每页显示的数据条数。取值范围：**1~50**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID。', + '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' => '审核状态。取值：'."\n" + ."\n" + .'- INIT：审核中。'."\n" + .'- NOT_PASS：审核不通过。 '."\n" + .'- PASS：审核通过。'."\n" + .'- NOT_FINISH：资料待补充。'."\n" + .'- CANCEL：已撤回。', + 'type' => 'string', + 'example' => 'INIT', + ], + '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' => '资质申请用途，取值：'."\n" + ."\n" + .'- **true**：自用。'."\n" + .'- **false**：他用。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'example' => '', + ], + ], + ], + 'Code' => [ + 'title' => '', + 'description' => '请求状态码。'."\n" + ."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见本章节的错误码列表或产品[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + '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"}]', + 'title' => '查询资质列表', + 'description' => '- 支持全量查询或条件查询：'."\n" + .' - **全量查询**：查询您当前帐户下所有短信资质，无需传参。默认全量查询。'."\n" + .' - **条件查询**：支持根据资质名称、企业名称、法人姓名、审核状态、审核工单ID、资质用途进行查询，传入您希望筛选的参数即可。'."\n" + ."\n" + .'- 本接口用于查询资质及其审核信息，如果需要查询单个资质的具体信息（企业信息、法人信息、管理员信息），请调用[查询单个资质详情](~~QuerySingleSmsQualification~~)接口。'."\n" + ."\n" + .'- 受短信签名实名制报备要求影响，当前资质审核工单量增长快速，审核时间可能会延长，请耐心等待，预计2个工作日内完成（审核工作时间：周一至周日 9:00~21:00，法定节假日顺延）。特殊情况可能延长审核时间，请耐心等待。'."\n" + .'- 如果资质未通过审核，审核备注`AuditRemark`会返回审核失败的原因，请参考[审核失败的处理建议](~~2384377#a96cc318b94x1~~)，调用[修改短信资质](~~UpdateSmsQualification~~)接口或在控制台[资质管理](https://dysms.console.aliyun.com/domestic/text/qualification)页面修改资质信息后，重新发起审核。', + ], + '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，即您[申请资质](~~SubmitSmsQualification~~)返回的ID。您可以通过[查询资质列表](~~QuerySmsQualificationRecord~~)获取当前账号下的资质ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000****', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '工单id', + 'description' => '审核工单ID，您可以通过[查询资质列表](~~QuerySmsQualificationRecord~~)获取当前账号下的资质及其对应审核工单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2001****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + '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' => '管理员证件有效期。有效期格式：YYYY-MM-DD~YYYY-MM-DD。', + 'type' => 'string', + 'example' => '2023-01-01~2033-01-01', + ], + 'BusinessType' => [ + 'title' => '行业类型，在当前模式下是可以用产品线code来区分', + 'description' => '行业类型。', + 'type' => 'string', + 'example' => 'dysms', + ], + 'AdminIDCardFrontFace' => [ + 'title' => '经办人身份证国徽面，产品需求，要求身份证可以分正反面上传', + 'description' => '管理员证件正面（身份证国徽面）照片完整路径URL。', + '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' => '营业证件类型。取值：'."\n" + ."\n" + .'- socialCreditLicense：社会信用代码证书。'."\n" + .'- businessLicense：企业营业执照。'."\n" + .'- signLegalLicense：事业单位法人证书。'."\n" + .'- otherLicense：其他类型执照证书。', + 'type' => 'string', + 'example' => 'businessLicense', + ], + 'LicensePic' => [ + 'title' => '', + 'description' => '营业证件文件路径参数。', + 'type' => 'string', + 'example' => '123456/111.png', + ], + 'PicUrl' => [ + 'title' => '文件的完整路径', + 'description' => '营业证件文件完整路径URL。', + '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' => '法人证件有效期。有效期格式：YYYY-MM-DD~YYYY-MM-DD。', + 'type' => 'string', + 'example' => '2023-01-01~2033-01-01', + ], + 'AdminPhoneNo' => [ + 'title' => '经办人手机号码', + 'description' => '管理员手机号码。', + 'type' => 'string', + 'example' => '137*******', + ], + 'QualificationName' => [ + 'title' => '资质名称', + 'description' => '资质名称。', + 'type' => 'string', + 'example' => '阿里云云通信有限公司资质李华'."\n", + ], + 'AdminName' => [ + 'title' => '经办人姓名', + 'description' => '管理员姓名。', + 'type' => 'string', + 'example' => '李华', + ], + 'CompanyType' => [ + 'title' => '企业类型, COMPANY:公司，政府或者事业单位:NON_PROFIT_ORGANIZATION', + 'description' => '企业类型，取值：'."\n" + ."\n" + .'- COMPANY：企业。'."\n" + .'- NON_PROFIT_ORGANIZATION：政府机关或事业单位。', + 'type' => 'string', + 'example' => 'COMPANY', + ], + 'AdminIDCardType' => [ + 'title' => '管理员身份证类型', + 'description' => '管理员证件类型。取值：'."\n" + ."\n" + .'- identityCard：身份证。'."\n" + .'- passport：护照。'."\n" + .'- homeReturnPermit：港澳居民来往内地通行证。'."\n" + .'- TaiwanCompatriotPermit：台湾居民来往大陆通行证。'."\n" + .'- residencePermit：港澳台居民居住证。'."\n" + .'- other：其他。', + 'type' => 'string', + 'example' => 'identityCard', + ], + 'UseBySelf' => [ + 'title' => '是否自用', + 'description' => '资质申请用途，取值：'."\n" + ."\n" + .'- **true**：自用。'."\n" + .'- **false**：他用。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'EffTimeStr' => [ + 'title' => '', + 'description' => '营业证照有效期。有效期格式：YYYY-MM-DD~YYYY-MM-DD。', + 'type' => 'string', + 'example' => '2023-01-01~2033-01-01'."\n", + ], + 'QualificationGroupId' => [ + 'title' => '', + 'description' => '资质ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000****', + ], + 'WhetherShare' => [ + 'title' => '', + 'description' => '资质授权，是否同意与其他云通信产品（如国内语音、国内号码隐私保护）的资质共享。仅当您申请**自用资质**，且资质信息**与当前阿里云账号认证企业信息一致**时可被共享、复用；其他情况无效。取值：'."\n" + ."\n" + .'- true：同意，您的资质信息可在其他云通信产品的“资质认证环节”调用，免除重复认证环节。'."\n" + .'- false：不同意。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'false', + ], + 'WorkOrderId' => [ + 'title' => '乾坤袋工单ID', + 'description' => '审核工单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2001****', + ], + 'State' => [ + 'title' => '当前审核状态', + 'description' => '审核状态。取值：'."\n" + ."\n" + .'- INT：审核中。'."\n" + .'- FAILED：审核不通过。'."\n" + .'- PASSED：审核通过。'."\n" + .'- NOT_FINISH：资料待补充。'."\n" + .'- CANCELED：已撤回。'."\n" + ."\n" + .'> 本接口不会返回审核备注，如需要查询审核备注（`AuditRemark`）请使用[查询资质列表](~~QuerySmsQualificationRecord~~)。', + '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' => '更多资料文件完整路径URL。', + 'type' => 'string', + 'example' => 'https://******.aliyuncs.com/******', + ], + ], + ], + 'example' => '', + ], + 'LegalPersonIDCardType' => [ + 'title' => '法人身份证类型', + 'description' => '法人证件类型。取值：'."\n" + ."\n" + .'- identityCard：身份证。'."\n" + .'- passport：护照。'."\n" + .'- homeReturnPermit：港澳居民来往内地通行证。'."\n" + .'- TaiwanCompatriotPermit：台湾居民来往大陆通行证。'."\n" + .'- residencePermit：港澳台居民居住证。'."\n" + .'- other：其他。', + 'type' => 'string', + 'example' => 'identityCard', + ], + 'AdminIDCardPic' => [ + 'title' => '经办人身份证图片地址，正反面合一', + 'description' => '管理员证件反面（身份证人像面）图片完整路径URL。', + 'type' => 'string', + 'example' => 'https://******.aliyuncs.com/******', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见本章节的错误码列表或产品[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + '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"}]', + 'title' => '查询单个资质详情', + 'description' => '- 本接口查询单个资质的详情（企业信息、法人信息、管理员信息）。'."\n" + .'- 如果需要查询您当前账号下所有资质信息，或需要查询审核详情，请调用[查询资质列表](~~QuerySmsQualificationRecord~~)。'."\n" + .'- 受短信签名实名制报备要求影响，当前资质审核工单量增长快速，审核时间可能会延长，请耐心等待，预计2个工作日内完成（审核工作时间：周一至周日 9:00~21:00，法定节假日顺延）。特殊情况可能延长审核时间，请耐心等待。', + ], + 'UpdateSmsQualification' => [ + 'summary' => '如果您需要更新短信资质信息，可通过本接口提交修改请求，提交后将重新进入审核流程。', + '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，即您[申请短信资质](~~SubmitSmsQualification~~)返回的ID。您可以通过[查询资质列表](~~QuerySmsQualificationRecord~~)获取当前账号下的资质ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000****', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '工单ID', + 'description' => '审核工单ID。您可以通过[查询资质列表](~~QuerySmsQualificationRecord~~)获取当前账号下的资质及其对应审核工单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' => '营业证件类型。取值：'."\n" + ."\n" + .'- socialCreditLicense：社会信用代码证书。'."\n" + .'- businessLicense：企业营业执照。'."\n" + .'- signLegalLicense：事业单位法人证书。'."\n" + .'- otherLicense：其他。'."\n" + ."\n" + .'选择一种上传即可，证件上需含有：企业名称、统一社会信用代码、证件有效期。', + 'type' => 'string', + 'required' => false, + 'example' => 'businessLicense', + ], + 'LicensePic' => [ + 'title' => '证件图片标识的osskey', + 'description' => '营业证件图片，仅支持jpg、png、gif、jpeg格式的图片，图片不大于5MB。请填写上传到OSS的文件路径参数，待上传的文件命名不可包含中文和特殊字符，上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n" + ."\n" + .'><notice>'."\n" + .'证件的彩色原件无需盖章，若上传复印件/黑白照片，需要在复印件上加盖企业红章并拍照上传。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CompanyName', + 'in' => 'query', + 'schema' => [ + 'title' => '公司名称', + 'description' => '企业名称。符号仅支持中点`·`、中文`【】（）`、英文`()`及`空格`，不可含其他符号或纯数字，长度不超过150字符。', + 'type' => 'string', + 'required' => false, + 'example' => '阿里云云通信有限公司', + ], + ], + [ + 'name' => 'BussinessLicenseExpDate', + 'in' => 'query', + 'schema' => [ + 'title' => '企业营业时间开始和结束字符串，格式示例2023-01-01~2033-01-01', + 'description' => '营业证件有效期。有效期格式：YYYY-MM-DD~YYYY-MM-DD。'."\n" + .'> 证照有效期为长期时，截止日期可填：2099-12-31。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-01-01~2033-01-01', + ], + ], + [ + 'name' => 'LegalPersonIdCardFrontSide', + 'in' => 'query', + 'schema' => [ + 'title' => '法人身份照片证国徽面', + 'description' => '法定代表人证件正面照片（身份证国徽面），仅支持jpg、png、gif、jpeg格式的图片，图片不大于5MB。请填写上传到OSS的文件路径参数，待上传的文件命名不可包含中文和特殊字符，上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n" + .'> 系统会使用您填写的法人姓名、证件号码进行校验；若校验不通过，则需要上传法定代表人身份证件照片。', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png'."\n", + ], + ], + [ + 'name' => 'LegalPersonIdCardBackSide', + 'in' => 'query', + 'schema' => [ + 'title' => '法人身份证照片人像面', + 'description' => '法定代表人证件反面照片（身份证人像面），仅支持jpg、png、gif、jpeg格式的图片，图片不大于5MB。请填写上传到OSS的文件路径参数，待上传的文件命名不可包含中文和特殊字符，上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n" + .'> 系统会使用您填写的法人姓名、证件号码进行校验；若校验不通过，则需要上传法定代表人身份证件照片。', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png'."\n", + ], + ], + [ + 'name' => 'LegalPersonName', + 'in' => 'query', + 'schema' => [ + 'title' => '法人姓名', + 'description' => '法定代表人姓名。'."\n" + ."\n" + .'> - 若组织证件中无法定代表人信息，但存在负责人/首席代表等相关信息，请准备证件中对应负责人或首席代表的身份证件照片。'."\n" + .'> - 若组织证件中无法定代表人信息，且无任何负责人信息，请准备业务主要负责人的姓名、身份证件照片。', + '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' => '法人证件有效期。有效期格式：YYYY-MM-DD~YYYY-MM-DD。'."\n" + .'> 证件有效期为长期时，截止日期可填：2099-12-31。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-01-01~2033-01-01', + ], + ], + [ + 'name' => 'LegalPersonIDCardType', + 'in' => 'query', + 'schema' => [ + 'title' => '法人身份证类型。identityCard:中国居民身份证;passport:护照;homeReturnPermit:港澳居民来往内地通行证;TaiwanCompatriotPermit:台湾居民来往大陆通行证;residencePermit:港澳台居民居住证";other:其他', + 'description' => '法人证件类型。取值：'."\n" + ."\n" + .'- identityCard：身份证。'."\n" + .'- passport：护照。'."\n" + .'- homeReturnPermit：港澳居民来往内地通行证。'."\n" + .'- TaiwanCompatriotPermit：台湾居民来往大陆通行证。'."\n" + .'- residencePermit：港澳台居民居住证。'."\n" + .'- other：其他。', + 'type' => 'string', + 'required' => false, + 'example' => 'identityCard', + ], + ], + [ + 'name' => 'AdminIDCardPic', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人身份证照片人像面', + 'description' => '管理员证件反面照片（身份证人像面），仅支持jpg、png、gif、jpeg格式的图片，图片不大于5MB。请填写上传到OSS的文件路径参数，待上传的文件命名不可包含中文和特殊字符，上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n" + ."\n" + .'><notice>'."\n" + .' 证件的彩色原件无需盖章，若上传复印件/黑白照片，需要在复印件上加盖企业红章并拍照上传。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png'."\n", + ], + ], + [ + 'name' => 'AdminIDCardFrontFace', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人身份证照片国徽面', + 'description' => '管理员证件正面照片（身份证国徽面），仅支持jpg、png、gif、jpeg格式的图片，图片不大于5MB。请填写上传到OSS的文件路径参数，待上传的文件命名不可包含中文和特殊字符，上传操作请参见通过[OSS上传文件](~~2833114~~)。'."\n" + ."\n" + .'><notice>'."\n" + .'证件的彩色原件无需盖章，若上传复印件/黑白照片，需要在复印件上加盖企业红章并拍照上传。'."\n" + .'></notice>', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png'."\n", + ], + ], + [ + 'name' => 'AdminName', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人姓名', + 'description' => '管理员姓名。'."\n" + ."\n" + .'> 管理员（又称经办人）指登录阿里云账号并管理短信业务的人员，一般是贵方管理此阿里云账号下资质、签名和模板，并进行短信发送的相关运营人员，且此人手机号可接收验证码。管理员不一定是此阿里云账号的管理员，管理员可以与企业法人为同一人。', + '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' => '管理员证件有效期。有效期格式：YYYY-MM-DD~YYYY-MM-DD。'."\n" + .'> 证件有效期为长期时，截止日期可填：2099-12-31。', + 'type' => 'string', + 'required' => false, + 'example' => '2023-01-01~2033-01-01'."\n" + ."\n", + ], + ], + [ + 'name' => 'AdminPhoneNo', + 'in' => 'query', + 'schema' => [ + 'title' => '经办人手机号码', + 'description' => '管理员手机号码，格式：+/+86/0086/86 或无任何前缀的手机号码，例如1390000****。', + 'type' => 'string', + 'required' => true, + 'example' => '137********', + ], + ], + [ + 'name' => 'CertifyCode', + 'in' => 'query', + 'schema' => [ + 'title' => '手机号验证码', + 'description' => '手机号验证码。请调用[RequiredPhoneCode](~~RequiredPhoneCode~~)接口并传入**管理员手机号码**后，在此填入接收到的短信验证码。'."\n" + ."\n" + .'> 您可以使用[ValidPhoneCode](~~ValidPhoneCode~~)自行校验短信验证码是否准确后再传入。', + 'type' => 'string', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'AdminIDCardType', + 'in' => 'query', + 'schema' => [ + 'title' => '管理员身份证类型。identityCard:中国居民身份证;passport:护照;homeReturnPermit:港澳居民来往内地通行证;TaiwanCompatriotPermit:台湾居民来往大陆通行证;residencePermit:港澳台居民居住证";other:其他', + 'description' => '管理员证件类型。取值：'."\n" + ."\n" + .'- identityCard：身份证。'."\n" + .'- passport：护照。'."\n" + .'- homeReturnPermit：港澳居民来往内地通行证。'."\n" + .'- TaiwanCompatriotPermit：台湾居民来往大陆通行证。'."\n" + .'- residencePermit：港澳台居民居住证。'."\n" + .'- 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' => '更多资料文件，仅支持png、jpg、jpeg、doc、docx、pdf格式，文件不大于5MB。请填写上传到OSS的文件路径参数，待上传的文件命名不可包含中文和特殊字符，上传操作请参见通过[OSS上传文件](~~2833114~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '123456/111.png'."\n", + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '资质ID。', + 'type' => 'string', + 'example' => '10000****', + ], + 'Code' => [ + 'title' => '', + 'description' => '请求状态码。'."\n" + ."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见本章节的错误码列表或产品[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', + '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"}]', + 'title' => '修改短信资质', + 'description' => '- 审核中的资质不支持修改，请等待审核流程结束或在短信服务控制台[撤回申请](https://dysms.console.aliyun.com/domestic/text/qualification)后再修改。'."\n" + .'- 修改后的短信资质**需要重新审核**（包括已审核通过的资质），请根据[资质材料说明](~~2384377~~)上传符合规范的材料。'."\n" + .'- **不支持修改**资质命名、申请用途、统一社会信用代码。'."\n" + .'- 不支持批量修改短信资质，建议每次修改至少间隔5秒。', + 'requestParamsDescription' => '><notice>'."\n" + ."\n" + .'短信资质材料具体要求请参见[资质材料说明](~~2384377~~)，要求可能随工信部与运营商要求实时调整，请以审核实际结果为准。'."\n" + ."\n" + .'></notice>', + ], + 'DeleteSmsQualification' => [ + 'summary' => '若您不再使用某个短信资质或因其他原因需要删除时，调用此接口或在短信服务控制台删除短信资质。', + '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，即您[申请资质](~~SubmitSmsQualification~~)返回的ID。您可以通过调用[查询资质列表](~~QuerySmsQualificationRecord~~)接口，或通过控制台国内消息[资质管理](https://dysms.console.aliyun.com/domestic/text/qualification)页面获取当前账号下的资质ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000****', + ], + ], + [ + 'name' => 'OrderId', + 'in' => 'query', + 'schema' => [ + 'title' => '工单ID', + 'description' => '审核工单ID。您可以通过调用[查询资质列表](~~QuerySmsQualificationRecord~~)接口，或通过控制台国内消息[资质管理](https://dysms.console.aliyun.com/domestic/text/qualification)页面获取当前账号下的资质及其对应审核工单ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '2001****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '是否删除成功。取值：'."\n" + ."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'Code' => [ + 'title' => '', + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 请参见本章节的错误码列表或产品[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + '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"}]', + 'title' => '删除短信资质', + 'description' => '><warning>资质删除后不能恢复，也无法在后续申请签名时选用，请谨慎操作。></warning>'."\n" + .'- 审核中的资质不支持修改或删除，您可以在短信服务[控制台](https://dysms.console.aliyun.com/domestic/text/qualification)撤回申请后操作。'."\n" + .'- 审核通过的资质若已被签名绑定则不支持删除。'."\n" + .'- 审核不通过的资质可通过[修改资质信息](~~UpdateSmsQualification~~)后直接重新发起审核。', + ], + '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' => '接收验证码的管理员手机号。'."\n" + .'- 调用本接口**发送验证码的账号和提交资质的账号必须是同一个**，否则调用失败。'."\n" + .'- 号码格式：+/+86/0086/86 或无任何前缀的手机号码，例如 1390000****。', + 'type' => 'string', + 'required' => true, + 'example' => '137****1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****', + ], + 'Message' => [ + 'title' => '', + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '本数据无返回，可忽略。', + 'type' => 'string', + 'example' => '-', + ], + 'Code' => [ + 'title' => '', + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', + '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"}]', + 'title' => '获取手机验证码', + 'description' => '- 接收到手机验证码后，请传入[申请短信资质](~~SubmitSmsQualification~~)/[修改短信资质](~~UpdateSmsQualification~~)接口的`CertifyCode`参数中。'."\n" + .'- 您可以通过[ValidPhoneCode](~~ValidPhoneCode~~)接口校验短信验证码是否准确。'."\n" + .'- 本接口获取短信验证码有[流控限制](~~44335#section-0wh-xn6-0t7~~)，请勿频繁操作：针对同一个号码最多支持1条/分钟，5条/小时，10条/天。', + ], + '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' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '90E63D28-E31D-1EB2-8939-A9486641****'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '是否验证成功。取值：'."\n" + ."\n" + .'- **true**：验证成功。'."\n" + .'- **false**：验证失败。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'Code' => [ + 'title' => '', + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见本章节的错误码列表或产品[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- true：调用成功。'."\n" + .'- false：调用失败。', + '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"}]', + 'title' => '验证手机验证码', + 'description' => '- 请先调用[获取手机验证码](~~RequiredPhoneCode~~)接口，阿里云将发送短信验证码至您填写的手机号码。'."\n" + .'- 本接口不影响短信资质申请流程，仅供验证短信验证码使用。实际申请时，请在[申请短信资质](~~SubmitSmsQualification~~)接口中的`CertifyCode`参数传入验证码。', + ], + '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' => '委托授权书的fileKey。'."\n" + ."\n" + .'1. 上传到OSS的授权委托书文件信息。请下载[授权委托书模板](https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20250414/bvpcmo/%E6%8E%88%E6%9D%83%E5%A7%94%E6%89%98%E4%B9%A6%E6%A8%A1%E7%89%88.doc)后，根据[规范](~~56741~~)完成填写并盖章后上传。文件上传要求：'."\n" + .'- 待上传的文件命名不可包含中文和特殊字符。'."\n" + .'- 仅支持jpg、png、gif、jpeg格式的图片，图片不大于5MB。'."\n" + ."\n" + .'2. fileKey的获取方式如下：[通过OSS上传文件](~~2833114~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '123456/test1719383196031.jpg', + ], + ], + [ + 'name' => 'SignList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '委托授权签名列表，签名数量限制100个以内', + 'description' => '委托授权签名列表，签名数量不超过100个。'."\n" + ."\n" + .'> 建议您在授权书内将可能需要用到的签名一次性全部授权，避免后续申请签名时不在授权书签名范围内，导致审核不通过且需重新补充委托授权书。', + 'type' => 'array', + 'items' => [ + 'title' => '签名内容，签名长度限2-12个字符，不支持包含“测试”“test”【】[] 、，。括号和空格等特殊字符', + 'description' => '短信签名名称，请遵守[签名规范](~~108076~~)。长度限2~12字符，不支持包含“测试”、“test”等字样；不支持添加【】、()、[]等符号；不支持`、，。空格`等特殊字符。', + 'type' => 'string', + 'required' => false, + 'example' => '菜鸟网络', + ], + 'required' => true, + 'example' => '', + ], + ], + [ + 'name' => 'AuthorizationLetterExpDate', + 'in' => 'query', + 'schema' => [ + 'title' => '委托授权书有效期', + 'description' => '授权委托书有效期。有效期格式：`YYYY-MM-DD~YYYY-MM-DD`。'."\n" + ."\n" + .'> 有效期限建议为1~3年。请设定一个合理的时间周期，避免有效期过长或过短。', + 'type' => 'string', + 'required' => true, + 'example' => '2023-01-01~2026-01-01', + ], + ], + [ + 'name' => 'Authorization', + 'in' => 'query', + 'schema' => [ + 'title' => '授权方，授权方命名长度不超过1000个字符，暂不支持包含除中点（·）、空格、中文括号【】、英文括号()外的任何符号或纯数字输入', + 'description' => '委托授权方，即签名归属方。符号仅支持中点`·`、中文`【】（）`、英文`()`及空格，不可含其他符号或纯数字，长度不超过150字符。', + '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' => '被委托授权方，即签名申请方。符号仅支持中点`·`、中文`【】（）`、英文`()`及空格，不可含其他符号或纯数字，长度不超过150字符。', + 'type' => 'string', + 'required' => true, + 'example' => '支付宝（中国）网络技术有限公司', + ], + ], + [ + 'name' => 'AuthorizationLetterName', + 'in' => 'query', + 'schema' => [ + 'title' => '委托授权书命名非空，不超过100个字符，支持中文、英文或与数字组合进行命名，暂不支持任何符号或纯数字输入', + 'description' => '授权委托书命名。命名不可与您其他授权书重复，仅支持中文、英文或与数字组合，不可含符号或纯数字，长度不超过100字符。', + 'type' => 'string', + 'required' => true, + 'example' => '菜鸟公司授权书', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '委托授权书ID。', + 'type' => 'string', + 'example' => '10000****', + ], + 'Code' => [ + 'title' => '', + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见本章节的错误码列表或产品[API 错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + '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"}]', + 'title' => '创建授权委托书', + 'description' => '- 请您在使用前阅读[授权书规范](~~56741~~)，下载[授权委托书模板](https://help-static-aliyun-doc.aliyuncs.com/file-manage-files/zh-CN/20250414/bvpcmo/%E6%8E%88%E6%9D%83%E5%A7%94%E6%89%98%E4%B9%A6%E6%A8%A1%E7%89%88.doc)后，根据规范完成填写并盖章后上传。'."\n" + .'- 您创建的授权委托书可在后续申请短信资质/申请短信签名时使用，如果您的资质/签名涉及他用，则必须创建授权委托书并提交。'."\n" + .'- 创建授权委托书后，您可以通过[QuerySmsAuthorizationLetter](~~QuerySmsAuthorizationLetter~~)查询已创建的授权书详情；通过接口创建的授权书信息会同步在短信服务控制台。', + ], + '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' => '委托授权书ID。', + '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' => '委托授权方社会统一信用代码，长度不超过150个字符。', + 'type' => 'string', + 'required' => false, + 'example' => '9****************A', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'title' => '授权书审核状态，INT:审核中，PASSED:审核通过', + 'description' => '委托授权书审核状态，与签名审核状态相关，取值：'."\n" + .'- **INT**：待审核。委托授权书已创建，当您提交签名申请后进入审核流程。'."\n" + .'- **PASSED**：审核通过。当您的委托授权签名范围中有签名审核通过时，委托授权书状态变为PASSED。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'INT' => '待审核', + 'PASSED' => '审核通过', + ], + 'example' => 'PASSED', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => '授权书可用状态，VALID可用，INVALID不可用', + 'description' => '委托授权书可用状态，与授权书有效期相关，取值：'."\n" + ."\n" + .'- **VALID**：可用，授权书处于有效期内。'."\n" + .'- **INVALID**：不可用，授权书已过期。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'VALID' => '可用', + 'INVALID' => '不可用', + ], + 'example' => 'VALID', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + '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' => '委托授权书可用状态，与授权书有效期相关，取值：'."\n" + ."\n" + .'- **VALID**：可用，授权书处于有效期内。'."\n" + .'- **INVALID**：不可用，授权书已过期。', + 'type' => 'string', + 'example' => 'VALID', + ], + 'SignScope' => [ + 'title' => '委托授权签名范围', + 'description' => '委托授权签名范围。若有多个签名，签名之间使用顿号`、`分隔。', + 'type' => 'string', + 'example' => '菜鸟网络、菜鸟驿站、菜鸟裹裹', + ], + 'State' => [ + 'title' => '委托授权书审核状态（初始化INT/审核通过PASSED）', + 'description' => '委托授权书状态，与签名审核状态相关，取值：'."\n" + .'- **INT**：待审核。委托授权书已创建，当您提交签名申请后进入审核流程。'."\n" + .'- **PASSED**：审核通过。当您的委托授权签名范围中有签名审核通过时，委托授权书状态变为PASSED。', + 'type' => 'string', + 'example' => 'PASSED', + ], + 'AuthorizationLetterExpDate' => [ + 'title' => '委托授权书有效期', + 'description' => '委托授权书有效期。有效期格式：YYYY-MM-DD~YYYY-MM-DD。', + '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' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见本章节的错误码列表或产品[API 错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + '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"}]', + 'title' => '查询授权委托书', + 'description' => '- 支持全量查询或条件查询：'."\n" + .' - **全量查询**：查询您当前帐户下所有授权委托书信息，无需传参。默认全量查询。'."\n" + .' - **条件查询**：支持根据授权委托书ID、签名名称、授权委托书审核状态进行查询，传入您希望筛选的参数即可。'."\n" + ."\n" + .'- 审核时间：受短信签名实名制报备要求影响，当前资质审核工单量增长快速，审核时间可能会延长，请耐心等待，预计2个工作日内完成。短信签名及模板预计在审核提交后的2小时内完成审核，涉及政府企业相关，一般2个工作日内审核完成。如遇升级核验、审核任务较多、非工作时间，审核时间可能会延长，请耐心等待（审核工作时间：周一至周日 9:00~21:00，法定节假日顺延）。', + ], + 'CreateSmsSign' => [ + 'summary' => '短信签名作为短信发送方的一种标识，发送短信前，您需要先申请签名和模板，系统会将已审核通过的短信签名添加到短信内容的开头，并与短信内容一起发送给接收方。', + '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' => '签名名称，签名名称请遵守[签名规范](~~108076#section-0p8-qn8-mmy~~)：'."\n" + ."\n" + .'- 长度限2~12字符，不支持包含“测试”、“test”等字样。'."\n" + ."\n" + .'- 不支持添加【】、()、[]等符号；不支持、，。空格等特殊字符。'."\n" + ."\n" + .'> - 签名名称区分大小写字母，如【Aliyun通信】和【aliyun通信】视为两个不同的签名。'."\n" + .'> - 当您的验证码签名和通用签名名称相同时，系统默认使用通用签名发送短信。', + 'type' => 'string', + 'required' => true, + 'example' => '阿里云验证码', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '短信签名场景说明，是签名审核的参考信息之一，长度不超过200个字符。'."\n" + .'> - 您可以提供已上线业务的使用场景，并提供实际业务的网站链接、应用市场下载链接等。'."\n" + .'> - 您可以提供短信完整示例，体现您的业务场景。'."\n" + .'> - 您可以提供变量的传参内容，详细描述业务使用场景和选择这个变量属性的原因。'."\n" + .'> - 若签名涉及政企机关单位，请备注政企机关单位的固定电话。'."\n" + ."\n" + .'信息完善的申请说明会提高签名、模板的审核效率。如未按规范进行填写或不填写，可能会影响您签名审核的通过。', + 'type' => 'string', + 'required' => false, + 'example' => '登录场景使用验证码', + 'maxLength' => 500, + ], + ], + [ + 'name' => 'SignType', + 'in' => 'query', + 'schema' => [ + 'description' => '签名类型。取值：'."\n" + ."\n" + .'- **0**：验证码。'."\n" + ."\n" + .'- **1**：通用（默认值）。'."\n" + ."\n" + .'建议使用默认值：**通用**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'MoreData', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '更多资料。补充上传业务证明文件或业务截图，有助于审核人员了解您的业务详情。请参见[签名申请材料](~~108076#section-xup-k46-yi4~~)，上传相关材料。', + 'type' => 'array', + 'items' => [ + 'description' => '上传到OSS的文件信息。文件上传操作，请参见[OSS上传文件](~~2833114~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '10098689758*****/123qwe.png', + ], + 'required' => false, + ], + ], + [ + 'name' => 'QualificationId', + 'in' => 'query', + 'schema' => [ + 'description' => '已审核通过的资质ID。'."\n" + ."\n" + .'> - 在申请短信签名前，请先[申请资质](~~2539801~~)。'."\n" + .'> - 您可在[资质管理](https://dysms.console.aliyun.com/domestic/text/qualification)页面查看资质ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '8563**', + ], + ], + [ + 'name' => 'ApplySceneContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'App应用商店链接。若签名来源为“已上线APP”，即`SignSource`取值为2时，请填写http://或https://开头的应用商店链接，并确保App已经上线。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com/', + ], + ], + [ + 'name' => 'SignSource', + 'in' => 'query', + 'schema' => [ + 'description' => '签名来源。取值：'."\n" + ."\n" + .'- **0**：企事业单位的全称或简称。**（优先推荐）**'."\n" + .'- **5**：商标名的全称或简称。'."\n" + .'- **2**：App应用的全称或简称。**（不推荐）**'."\n" + ."\n" + .'签名来源的详细说明请参见[签名来源](~~108076#section-fow-bfu-wo9~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'enumValueTitles' => [], + 'example' => '0', + 'enum' => [ + '0', + '1', + '2', + '3', + '4', + '5', + ], + ], + ], + [ + 'name' => 'ThirdParty', + 'in' => 'query', + 'schema' => [ + 'description' => '签名用途。取值：'."\n" + ."\n" + .'- false：自用（默认值，签名为本账号实名认证的企业、网站、产品名等）。'."\n" + ."\n" + .'- true：他用（签名为非本账号实名认证的企业、网站、产品名等）。'."\n" + .'><notice>签名为自用时，请选择自用资质ID；签名为他用时，请选择他用资质ID。></notice>', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'AuthorizationLetterId', + 'in' => 'query', + 'schema' => [ + 'description' => '委托授权书ID，当签名为他用时，委托授权书ID不可为空，否则签名审核不通过。委托授权书的社会统一信用代码必须与签名绑定的资质信息中社会统一信用代码字段保持一致，否则创建签名失败。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000********1234', + ], + ], + [ + 'name' => 'TrademarkId', + 'in' => 'query', + 'schema' => [ + 'description' => '商标实体id。'."\n" + .'> - 当SignSource=5时，需要传商标实体id。'."\n" + .'> - 商标实体id可以通过调用[创建商标实体](~~CreateSmsTrademark~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000009081***', + ], + ], + [ + 'name' => 'AppIcpRecordId', + 'in' => 'query', + 'schema' => [ + 'description' => 'APP-ICP备案实体id。'."\n" + .'> - 当SignSource=2时，需要传备案实体id。'."\n" + .'> - 备案实体id可以通过调用[创建ICP备案实体](~~CreateSmsAppIcpRecord~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000****029', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'CCA2BCFF-2BA7-427C-90EE-AC6994748623', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'SignName' => [ + 'description' => '签名名称。', + 'type' => 'string', + 'example' => '阿里云', + ], + 'OrderId' => [ + 'description' => '工单号。'."\n" + ."\n" + .'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。', + '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' => '申请短信签名（新接口）', + 'description' => '- 新接口和原接口变更的公告详情请参见[关于短信服务更新签名&模板接口的公告](~~2806975~~)。'."\n" + ."\n" + .'- 个人认证用户，同一个阿里云账号一个自然日支持申请一个正式签名；企业认证用户目前无限制。个人用户与企业用户权益区别详情请参见[使用须知](~~55324~~)。'."\n" + ."\n" + .'- 请阅读[签名规范](~~108076~~)，了解短信签名审核规范的具体内容。'."\n" + .'- 通过接口申请的签名信息会同步在短信服务控制台。控制台相关操作，请参见[短信签名](~~108073~~)。'."\n" + ."\n" + .'- 提交签名申请后，您可以通过[GetSmsSign](~~2807429~~)接口查询签名审核状态和详情。也可以[配置回执消息](~~101508~~)，通过[SignSmsReport](~~120998~~)获取签名的审核状态消息。', + ], + 'GetSmsSign' => [ + 'summary' => '申请签名后，通过此接口查询签名审核详情', + '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' => '签名名称。必须是本账号已申请的短信签名。'."\n" + ."\n" + .'- 调用[CreateSmsSign](~~2807427~~)接口后在返回参数中获取。'."\n" + .'- 在[签名管理](https://dysms.console.aliyun.com/domestic/text/sign)页面查看签名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '阿里云', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'SignName' => [ + 'description' => '短信签名名称。', + 'type' => 'string', + 'example' => '登录验证', + ], + 'SignStatus' => [ + 'description' => '签名审核状态。取值：'."\n" + ."\n" + .'- **0**：审核中。'."\n" + .'- **1**：审核通过。'."\n" + .'- **2**：审核失败，请在返回参数`AuditInfo.RejectInfo`中查看审核失败原因。'."\n" + .'- **10**：取消审核。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'CreateDate' => [ + 'description' => '短信签名的创建日期和时间。', + 'type' => 'string', + 'example' => '2024-06-03 10:02:34', + ], + 'OrderId' => [ + 'description' => '工单号。'."\n" + ."\n" + .'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。', + 'type' => 'string', + 'example' => '20044156924', + ], + 'QualificationId' => [ + 'description' => '资质ID。申请签名时关联的资质ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2004393****', + ], + 'Remark' => [ + 'description' => '短信签名场景说明，长度不超过200个字符。', + 'type' => 'string', + 'example' => '登录场景验证码', + ], + 'AuditInfo' => [ + 'description' => '审核信息。', + 'type' => 'object', + 'properties' => [ + 'RejectInfo' => [ + 'description' => '审批未通过的原因。', + 'type' => 'string', + 'example' => '通过资质信息，不能判断是否可以申请此签名。', + ], + 'AuditDate' => [ + 'description' => '审核时间。', + 'type' => 'string', + 'example' => '2024-06-03 12:02:34'."\n", + ], + ], + ], + 'FileUrlList' => [ + 'description' => '更多资料信息，补充上传业务证明文件或业务截图文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '上传到OSS上的文件信息。', + 'type' => 'string', + 'example' => '10098689758*****/1234qwe.png'."\n", + ], + ], + 'SignCode' => [ + 'description' => '短信签名Code。', + 'type' => 'string', + 'example' => 'SIGN_100000077042023_17174665*****_ZM2kG', + ], + 'SignTag' => [ + 'description' => '签名标识。取值：'."\n" + ."\n" + .'- 2：用户自定义创建签名。'."\n" + .'- 3：系统赠送签名。'."\n" + .'- 4：测试签名。'."\n" + .'- 5：试用签名。', + 'type' => 'string', + 'example' => '2', + ], + 'ApplyScene' => [ + 'description' => '应用场景内容。', + 'type' => 'string', + 'example' => 'http://www.aliyun.com/'."\n", + ], + 'ThirdParty' => [ + 'description' => '签名为自用或他用。'."\n" + ."\n" + .'- false：自用（默认值）。'."\n" + ."\n" + .'- true：他用。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'SignUsage' => [ + 'description' => '签名使用场景。', + 'type' => 'string', + 'example' => '已注册商标名称。', + ], + 'RegisterResult' => [ + 'description' => '**已废弃，请使用`SignIspRegisterDetailList`查看各运营商实名报备结果。**'."\n" + ."\n" + .'签名实名制报备结果。取值：'."\n" + .'- 0：报备失败。'."\n" + .'- 1：报备成功。'."\n" + .'- 2：报备失效。'."\n" + .'- -1：无状态。'."\n" + ."\n" + .'建议您单击查看[更多签名实名制报备内容及建议操作](~~2873145~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'AuthorizationLetterId' => [ + 'description' => '委托授权书ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000********1234', + ], + 'AuthorizationLetterAuditPass' => [ + 'description' => '委托授权书审核状态。取值：'."\n" + .'- true：审核通过。'."\n" + .'- false：审核未通过（包含审核通过外的其他所有状态）。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'SignIspRegisterDetailList' => [ + 'description' => '运营商报备状态列表。获取此参数返回数据需要[更新SDK](https://api.aliyun.com/api-tools/sdk/Dysmsapi?version=2017-05-25&language=java-tea&tab=primer-doc)至4.1.2版本或以上。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RegisterStatus' => [ + 'description' => '报备状态。取值：'."\n" + ."\n" + .'- **0**：报备失败，原因可能为资质信息与工信注册信息不一致或运营商侧无法支持等。建议您登录[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/sign)查看具体失败原因，并依据提示进行操作；'."\n" + .'- **1**：已报备待验证，当前至少有一个子端口号运营商已返回报备通过，建议您少量多次向不同运营商手机号发送验证码、通知短信进行验证；'."\n" + .'- **2**：报备失效，签名超过 6 个月无发送记录时，报备结果失效。如您需要重新启用该签名，请在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/sign)重新发起报备；'."\n" + .'- **3**：报备成功，当前至少有一个子端口号运营商已返回报备通过，经验证短信发送成功率符合预期，建议您持续关注发送成功率；'."\n" + .'- **-1**：报备中，当前尚未收到运营商反馈的报备结果，建议您等待签名报备状态变更为“已报备待验证”后再批量发送，当前可少量多次尝试使用该签名发送，观察短信发送效果；'."\n" + .'- **-2**：未报备，原因可能为当前签名未关联实名资质或关联资质信息不全，建议您修改当前资质或编辑签名绑定其他资质以重新发起报备。'."\n" + ."\n" + .'建议您单击查看[更多签名实名制报备内容及建议操作](~~2873145~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'OperatorCode' => [ + 'description' => '运营商类型。取值：'."\n" + .'- **mobile**：中国移动；'."\n" + .'- **unicom**：中国联通；'."\n" + .'- **telecom**：中国电信。', + 'type' => 'string', + 'example' => 'telecom', + ], + 'OperatorCompleteTime' => [ + 'description' => '运营商反馈时间，格式为yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'example' => '2025-06-13 15:55:26', + ], + 'RegisterStatusReasons' => [ + 'description' => '报备状态原因列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReasonCode' => [ + 'description' => '报备状态原因码。取值：'."\n" + .'- **UNBINDING_QUA**：签名未关联资质；'."\n" + .'- **BINDING_INCOMPLETE_QUA**：关联资质信息不全；'."\n" + .'- **NON_REGISTER**：未发起报备；'."\n" + .'- **REGISTERING**：签名报备中；'."\n" + .'- **DETECTING**：未发起探测或探测中；'."\n" + .'- **DETECT_SUCCESS**：报备成功；'."\n" + .'- **QUALIFICATION_ERROR**：资质原因；'."\n" + .'- **SIGNATURE_ERROR**：签名原因；'."\n" + .'- **SIGNATURE_QUALIFICATION_ERROR**：签名与资质关系不符；'."\n" + .'- **ONE_CODE_MULTIPLE_SIGN**：扩展码原因；'."\n" + .'- **OTHERS_ERROR**：其他原因；'."\n" + .'- **REGISTER_TIMEOUT**：报备超时；'."\n" + .'- **NO_SEND_RECORD**：签名超过6个月无发送记录；'."\n" + .'- **EXT_CODE_RECYCLE**：扩展码收回。'."\n" + .'- **SUBPORT_RECYCLE**：子端口被运营商治理。', + 'type' => 'string', + 'example' => 'REGISTER_TIMEOUT', + ], + 'ReasonDescList' => [ + 'description' => '原因说明列表。可能返回0个或者多个原因说明，返回原因码不一定会返回原因说明。', + 'type' => 'array', + 'items' => [ + 'description' => '原因说明。', + 'type' => 'string', + 'example' => '报备超时。', + ], + ], + ], + ], + ], + ], + ], + ], + 'TrademarkId' => [ + 'description' => '商标实体id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000009081***', + ], + 'AppIcpRecordId' => [ + 'description' => 'APP-ICP备案实体id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000009***123', + ], + ], + ], + ], + ], + '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' => '查询签名详情（新接口）', + 'description' => '- 仅可查询**首次创建**的签名资料或者**最新审核通过**的资料。'."\n" + ."\n" + .'- 新接口和原接口变更的公告详情请参见[关于短信服务更新签名&模板接口的公告](~~2806975~~)。'."\n" + ."\n" + .'- 审核时间：一般情况下，签名提交后，阿里云预计在 2 个小时内审核完成（审核工作时间：周一至周日 9:00~21:00，法定节假日顺延）。'."\n" + ."\n" + .'- 如果签名未通过审核，会返回审核失败的原因，请参考[短信审核失败的处理建议](~~65990~~)，调用[UpdateSmsSign](~~2807428~~)接口或在[签名管理](https://dysms.console.aliyun.com/domestic/text/sign)页面修改未审核通过的短信签名。'."\n" + ."\n" + .'- [QuerySmsSignList](~~QuerySmsSignList~~)接口可以查询您账号下的所有签名，包括签名审核状态、签名类型、签名名称等。'."\n" + ."\n" + .'- 本接口的单用户QPS限制为150次/秒。超过限制，API调用将会被限流，这可能会影响您的业务，请合理调用。', + ], + 'QuerySmsSignList' => [ + 'summary' => '可以通过此接口可以查询您账号下的所有签名，方便您查看签名详情，包括签名审核状态、签名类型、签名名称等。', + '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' => '当前页码，默认取值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'minLength' => 1, + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的签名个数。默认取值为**10**，取值范围：**1~50**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'."\n", + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + .' '."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'SmsSignList' => [ + 'description' => '结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '结果列表。', + 'type' => 'object', + 'properties' => [ + 'SignName' => [ + 'description' => '签名名称。', + 'type' => 'string', + 'example' => '阿里云', + ], + 'AuditStatus' => [ + 'description' => '签名审批状态。取值：'."\n" + ."\n" + .'- **AUDIT_STATE_INIT**：审核中。'."\n" + ."\n" + .'- **AUDIT_STATE_PASS**：审核通过。'."\n" + ."\n" + .'- **AUDIT_STATE_NOT_PASS**：审核未通过，请在返回参数Reason中查看审核未通过原因。'."\n" + ."\n" + .'- **AUDIT_STATE_CANCEL**：取消审核。', + 'type' => 'string', + 'example' => 'AUDIT_STATE_NOT_PASS', + ], + 'CreateDate' => [ + 'description' => '短信签名的创建日期和时间，格式为yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'example' => '2020-06-04 11:42:17', + ], + 'Reason' => [ + 'description' => '审核备注。'."\n" + ."\n" + .'- 如果审核状态为**审核通过**或**审核中**，参数Reason显示为“无审核备注”。'."\n" + ."\n" + .'- 如果审核状态为**审核未通过**，参数Reason显示审核的具体原因。', + 'type' => 'object', + 'properties' => [ + 'RejectSubInfo' => [ + 'description' => '审批未通过的备注信息。', + 'type' => 'string', + 'example' => '文件不能证明信息真实性，请重新上传。', + ], + 'RejectDate' => [ + 'description' => '审批未通过的时间，格式为yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'example' => '2020-06-04 13:35:10', + ], + 'RejectInfo' => [ + 'description' => '审批未通过的原因。', + 'type' => 'string', + 'example' => '文件不能证明信息真实性，请重新上传。', + ], + ], + ], + 'BusinessType' => [ + 'description' => '签名场景类型。取值：'."\n" + ."\n" + .'- 验证码类型。'."\n" + ."\n" + .'- 通用类型。', + 'type' => 'string', + 'example' => '验证码类型', + ], + 'OrderId' => [ + 'description' => '工单号。'."\n" + ."\n" + .'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。', + 'type' => 'string', + 'example' => '2005098****', + ], + 'AuthorizationLetterId' => [ + 'description' => '委托授权书ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000********1234', + ], + 'authorizationLetterAuditPass' => [ + 'description' => '委托授权书审核状态。取值：'."\n" + .'- true：审核通过。'."\n" + .'- false：审核未通过（包含审核通过外的其他所有状态）。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => 'true', + 'false' => 'false', + ], + 'example' => 'true', + ], + 'TrademarkId' => [ + 'description' => '商标实体id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000009081***', + ], + 'AppIcpRecordId' => [ + 'description' => 'APP-ICP备案实体id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000001***123', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '签名总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'CurrentPage' => [ + 'description' => '当前页码。默认取值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的签名个数。默认取值为**10**，取值范围：**1~50**。', + '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' => '查询签名列表详情', + 'description' => '本接口可以查询您当前账号下**首次创建**的签名资料或者**最新审核通过**的签名详情。如果您需要查询应用场景内容、申请时上传的文件资料信息等更多内容，可以调用[GetSmsSign](~~GetSmsSign~~)接口通过签名名称查询单个签名审核详情。', + ], + 'UpdateSmsSign' => [ + 'summary' => '修改未通过审核和已经审核通过的签名，修改完成后自动提交审核，签名进入待审核状态。', + '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' => '未审核通过的短信签名。您可在控制台[国内消息>签名管理](https://dysms.console.aliyun.com/domestic/text/sign)页签进行查看未通过审核得短信签名。也可通过[QuerySmsSignList](~~QuerySmsSignList~~)接口查看未通过审核的短信签名。', + 'type' => 'string', + 'required' => true, + 'example' => '阿里云验证码', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '短信签名场景说明，是签名审核的参考信息之一，长度不超过200个字符。'."\n" + .'> - 您可以提供已上线业务的使用场景，并提供实际业务的网站链接、应用市场下载链接等。'."\n" + .'> - 您可以提供短信完整示例，体现您的业务场景。'."\n" + .'> - 您可以提供变量的传参内容，详细描述业务使用场景和选择这个变量属性的原因。'."\n" + .'> - 若签名涉及政企机关单位，请备注政企机关单位的固定电话。'."\n" + ."\n" + .'信息完善的申请说明会提高签名、模板的审核效率。如未按规范进行填写或不填写，可能会影响您签名审核的通过。', + 'type' => 'string', + 'required' => false, + 'example' => '登录场景申请验证码', + 'maxLength' => 500, + ], + ], + [ + 'name' => 'SignType', + 'in' => 'query', + 'schema' => [ + 'description' => '签名类型。取值：'."\n" + ."\n" + .'- **0**：验证码。'."\n" + .'- **1**：通用（默认值）。'."\n" + ."\n" + .'建议使用默认值：**通用**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'MoreData', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '更多资料。补充上传业务证明文件或业务截图，有助于审核人员了解您的业务详情。请参见[签名申请材料](~~108076#section-xup-k46-yi4~~)，上传相关材料。', + 'type' => 'array', + 'items' => [ + 'description' => '上传到OSS的文件信息。待上传的**文件命名不可包含中文及特殊字符**。文件上传操作请参见[通过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' => '已审核通过的资质ID。'."\n" + ."\n" + .'> - 在申请短信签名前，请先[申请资质](https://help.aliyun.com/zh/sms/user-guide/new-qualification?spm=a2c4g.11186623.0.0.718d187bbkpMRK)。'."\n" + .'> - 您可在[资质管理](https://dysms.console.aliyun.com/domestic/text/qualification)页面查看资质ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '8563**', + ], + ], + [ + 'name' => 'ApplySceneContent', + 'in' => 'query', + 'schema' => [ + 'description' => 'App应用商店链接，若签名来源为“已上线APP”，即`SignSource`取值为2时，请填写http://或https://开头的应用商店链接，并确保App已经上线。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com/'."\n", + ], + ], + [ + 'name' => 'SignSource', + 'in' => 'query', + 'schema' => [ + 'description' => '签名来源。取值：'."\n" + ."\n" + .'- **0**：企事业单位的全称或简称。**（优先推荐）**'."\n" + .'- **5**：商标名的全称或简称。'."\n" + .'- **2**：App应用的全称或简称。**（不推荐）**'."\n" + ."\n" + .'签名来源的详细说明请参见[签名来源](~~108076#section-fow-bfu-wo9~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'enumValueTitles' => [], + 'example' => '2', + 'enum' => [ + '0', + '1', + '2', + '3', + '4', + '5', + ], + ], + ], + [ + 'name' => 'ThirdParty', + 'in' => 'query', + 'schema' => [ + 'description' => '签名用途。取值：'."\n" + ."\n" + .'- false：自用（默认值，签名为本账号实名认证的企业、网站、产品名等）。'."\n" + ."\n" + .'- true：他用（签名为非本账号实名认证的企业、网站、产品名等）。'."\n" + .'><notice>签名为自用时，请选择自用资质ID；签名为他用时，请选择他用资质ID。></notice>', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'AuthorizationLetterId', + 'in' => 'query', + 'schema' => [ + 'description' => '委托授权书ID，当签名为他用时，委托授权书ID不可为空，否则签名审核不通过。委托授权书的社会统一信用代码必须与签名绑定的资质信息中社会统一信用代码字段保持一致，否则创建签名失败。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000********1234', + ], + ], + [ + 'name' => 'TrademarkId', + 'in' => 'query', + 'schema' => [ + 'description' => '商标实体id。'."\n" + .'> - 当SignSource=5时，需要传商标实体id。'."\n" + .'> - 商标实体id可以通过调用[创建商标实体](~~CreateSmsTrademark~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000009081***', + ], + ], + [ + 'name' => 'AppIcpRecordId', + 'in' => 'query', + 'schema' => [ + 'description' => 'APP-ICP备案实体id。'."\n" + .'> - 当SignSource=2时，需要传备案实体id。'."\n" + .'> - 备案实体id可以通过调用[创建ICP备案实体](~~CreateSmsAppIcpRecord~~)接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100001***1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D1D', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'* OK：代表请求成功。'."\n" + .'* 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'SignName' => [ + 'description' => '已修改的签名名称。', + 'type' => 'string', + 'example' => '登录验证', + ], + 'OrderId' => [ + 'description' => '工单号。'."\n" + ."\n" + .'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。', + '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' => '修改短信签名（新接口）', + 'description' => '- 新接口和原接口变更的公告详情请参见[关于短信服务更新签名&模板接口的公告](~~2806975~~)。'."\n" + .'- 支持修改**未通过审核**和**已经审核通过**的签名，请参考[短信审核失败的处理建议](~~65990~~)，调用此接口修改后重新提交审核。'."\n" + .'- **未通过审核**的签名如需编辑名称，该接口不支持，您可以访问控制台页面进行修改。[短信服务签名控制台入口](https://dysms.console.aliyun.com/domestic/text/sign)。'."\n" + .'- 通过接口申请的签名信息会同步在短信服务控制台，在控制台对签名的相关操作，请参见[短信签名](~~108073~~)。', + ], + 'DeleteSmsSign' => [ + 'summary' => '如果您不再使用某个短信签名，需要删除签名时，调用此接口或在短信服务控制台删除短信签名。', + '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' => '短信签名。支持删除已撤回、审核失败或审核通过的签名，审核中的短信签名不支持删除。'."\n" + ."\n" + .'您可以通过[QuerySmsSignList](~~419282~~)接口查询当前账号已申请的签名或在短信控制台[签名管理](https://dysms.console.aliyun.com/domestic/text/sign)页查看签名列表'."\n" + .'><notice>删除短信签名后不可恢复，且后续不可再使用该签名发送短信，请谨慎操作。></notice>', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '阿里云', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D****', + ], + 'SignName' => [ + 'description' => '已删除的签名名称。', + 'type' => 'string', + 'example' => '阿里云', + ], + ], + ], + ], + ], + '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' => '删除短信签名', + 'description' => '- 支持删除已撤回、审核失败或审核通过的签名，审核中的短信签名不支持删除。'."\n" + .'- 删除短信签名后不可恢复，且后续不可再使用该签名发送短信，请谨慎操作。'."\n" + .'- 通过接口删除签名的操作会在短信服务控制台同步，在控制台对模板的相关操作，请参见[短信签名](~~108073~~)。', + '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，即您申请资质返回的ID。您可以通过控制台国内消息[资质管理](https://dysms.console.aliyun.com/domestic/text/qualification)页面获取当前账号下的资质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' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '0A974B78-02BF-4C79-ADF3-90CFBA1B55B1', + ], + 'Data' => [ + 'description' => '返回数据结构。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '本数据无返回，可忽略。', + 'type' => 'object', + ], + 'ErrMessage' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '调用接口是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ErrCode' => [ + 'description' => '请求状态码。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见本章节的错误码列表或产品[API 错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + '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"}]', + 'title' => '更换签名的资质和授权书（待下线）', + ], + 'AddSmsSign' => [ + 'summary' => '该接口已下线。', + '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' => '签名名称，签名名称请遵守[签名规范](~~108076#section-0p8-qn8-mmy~~)。'."\n" + ."\n" + .'> - 签名名称不区分大小写字母，如【Aliyun通信】和【aliyun通信】视为名称相同。'."\n" + .'> - 当您的验证码签名和通用签名名称相同时，系统默认使用通用签名发送短信。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '阿里云', + ], + ], + [ + 'name' => 'SignSource', + 'in' => 'query', + 'schema' => [ + 'description' => '签名来源。取值：'."\n" + ."\n" + .'- **0**：企事业单位的全称或简称。'."\n" + .'- **1**：工信部备案网站的全称或简称。'."\n" + .'- **2**：App应用的全称或简称。'."\n" + .'- **3**：公众号或小程序的全称或简称。'."\n" + .'- **4**：电商平台店铺名的全称或简称。'."\n" + .'- **5**：商标名的全称或简称。'."\n" + ."\n" + .'签名来源的详细说明请参见[签名来源](https://help.aliyun.com/zh/sms/user-guide/signature-specifications-1?spm=a2c4g.11186623.0.0.4f9710fder2gR7#section-xup-k46-yi4)。'."\n" + ."\n" + .'>此接口不支持申请签名来源是**测试或学习**和**线上试用**的签名，如果您需要申请这两种签名来源的签名，请前往[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/sign/add/qualification)申请。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '短信签名场景说明，长度不超过200个字符。'."\n" + ."\n" + .'签名审核的参考信息，完善申请说明有助于审核人员理解您的业务场景，提高审核效率。填写指导：'."\n" + ."\n" + .'- 您可以提供已上线业务的使用场景。'."\n" + ."\n" + .'- 您可以提供真实场景的短信示例，体现您的业务场景。'."\n" + ."\n" + .'- 您可以提供变量的传参内容，详细描述业务使用场景和选择这个变量属性的原因。'."\n" + ."\n" + .'- 您可以提供实际业务的网站链接、已备案的域名地址、应用市场下载链接等。'."\n" + ."\n" + .'- 登录场景，您可以提供测试账号和密码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '当前的短信签名应用于双11大促推广营销', + ], + ], + [ + 'name' => 'SignFileList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '签名文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '签名数据。', + 'type' => 'object', + 'properties' => [ + 'FileContents' => [ + 'description' => '签名的资质证明文件经base64编码后的字符串。图片不超过2 MB。个别场景下，申请签名需要上传证明文件。'."\n" + ."\n" + .'详细规范，请参见[上传文件规范](~~463316~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'R0lGODlhHAAmAKIHAKqqqsvLy0hISObm5vf394uL****', + ], + 'FileSuffix' => [ + 'description' => '签名的证明文件格式，支持上传多张图片。当前支持JPG、PNG、GIF或JPEG格式的图片。个别场景下，申请签名需要上传证明文件。'."\n" + ."\n" + .'> 如果签名用途为他用或个人认证用户的自用签名来源为企事业单位名时，还需上传证明文件和委托授权书，详情请参见[证明文件](~~108076~~)和[授权委托书](~~56741~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'jpg', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SignType', + 'in' => 'query', + 'schema' => [ + 'description' => '签名类型。'."\n" + ."\n" + .'- **0**：验证码'."\n" + .'- **1**：通用', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'SignName' => [ + 'description' => '签名名称。', + 'type' => 'string', + 'example' => '阿里云', + ], + ], + ], + ], + ], + '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' => '申请短信签名（已下线）', + 'description' => '- 根据工信部规定与运营商[相关要求](~~2806975~~)，阿里云进行了签名相关API的功能改造，为提升您签名的审核效率和审核通过率，请您使用新接口[CreateSmsSign-申请短信签名](~~2807427~~)。'."\n" + ."\n" + .'- 个人用户同一个阿里云账号一个自然日支持申请一个签名；企业用户申请次数无限制。个人用户与企业用户权益区别详情请参见[使用须知](~~55324~~)。'."\n" + ."\n" + .'- 通过接口申请的签名信息会同步在短信服务控制台，在控制台对签名的相关操作，请参见[短信签名](~~108073~~)。'."\n" + ."\n" + .'- 提交签名申请后，您可以通过[QuerySmsSign](~~419283~~)接口查询签名审核状态和详情。也可以[配置回执消息](~~101508~~)，通过[SignSmsReport](~~120998~~)获取签名的审核状态消息。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为1次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifySmsSign' => [ + 'summary' => '该接口已下线。', + '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' => '签名名称。'."\n" + ."\n" + .'> 审核通过的签名支持修改，但不支持修改签名名称，修改后的签名需要重新通过审核后才能使用。签名审核未完成前，原签名也不能正常使用。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '阿里云', + ], + ], + [ + 'name' => 'SignSource', + 'in' => 'query', + 'schema' => [ + 'description' => '签名来源。取值：'."\n" + ."\n" + .'- **0**：企事业单位的全称或简称。'."\n" + .'- **1**：工信部备案网站的全称或简称。'."\n" + .'- **2**：App应用的全称或简称。'."\n" + .'- **3**：公众号或小程序的全称或简称。'."\n" + .'- **4**：电商平台店铺名的全称或简称。'."\n" + .'- **5**：商标名的全称或简称。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '短信签名申请说明，长度不超过200个字符。'."\n" + ."\n" + .'签名审核的参考信息，完善申请说明有助于审核人员理解您的业务场景，提高审核效率。填写指导：'."\n" + ."\n" + .'- 您可以提供已上线业务的使用场景。'."\n" + .'- 您可以提供真实场景的短信示例，体现您的业务场景。'."\n" + .'- 您可以提供变量的传参内容，详细描述业务使用场景和选择这个变量属性的原因。'."\n" + .'- 您可以提供实际业务的网站链接、已备案的域名地址、应用市场下载链接等。'."\n" + .'- 登录场景，您可以提供测试账号和密码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '当前的短信签名应用于双11大促推广营销', + ], + ], + [ + 'name' => 'SignFileList', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '签名文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '签名文件列表。', + 'type' => 'object', + 'properties' => [ + 'FileContents' => [ + 'description' => '签名的纸质证明文件经base64编码后的字符串。图片不超过2 MB。'."\n" + ."\n" + .'个别场景下，申请签名需要上传证明文件。详细说明，请参见[短信签名规范](~~108076~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'R0lGODlhHAAmAKIHAKqqqsvLy0hISObm5vf394uLiwAA', + ], + 'FileSuffix' => [ + 'description' => '签名的证明文件格式，支持上传多张图片。当前支持JPG、PNG、GIF或JPEG格式的图片。'."\n" + ."\n" + .'个别场景下，申请签名需要上传证明文件。详细说明，请参见[短信签名规范](~~108076~~)。'."\n" + .'> 如果签名用途为他用或个人认证用户的自用签名来源为企事业单位名时，还需上传证明文件和委托授权书，详情请参见[证明文件](~~108076~~)和[授权委托书](~~56741~~)。', + 'type' => 'string', + 'required' => true, + 'example' => 'jpg', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 10, + ], + ], + [ + 'name' => 'SignType', + 'in' => 'query', + 'schema' => [ + 'description' => '签名类型。取值：'."\n" + ."\n" + .'- **0**：验证码'."\n" + ."\n" + .'- **1**：通用', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'SignName' => [ + 'description' => '签名名称。', + 'type' => 'string', + 'example' => '阿里云', + ], + ], + ], + ], + ], + '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' => '修改短信签名（已下线）', + 'description' => '- 根据工信部规定与运营商[相关要求](~~2806975~~)，阿里云进行了签名相关API的功能改造。为提升您签名的审核效率和审核通过率，请您使用新接口[UpdateSmsSign-修改短信签名](~~2807428~~)。'."\n" + ."\n" + .'- 仅支持修改未通过审核的签名，请参考[短信审核失败的处理建议](~~65990~~)，调用此接口修改后自动提交审核，签名进入待审核状态。'."\n" + ."\n" + .'- 通过接口修改签名的操作会在短信服务控制台同步，在控制台对签名的相关操作，请参见[短信签名](~~108073~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QuerySmsSign' => [ + 'summary' => '查询签名审核状态。', + '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' => '签名名称。必须是本账号已申请的短信签名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '阿里云', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CC89A90C-978F-46AC-B80D-54738371E7CA', + ], + 'SignStatus' => [ + 'description' => '签名审核状态。取值：'."\n" + ."\n" + .'- **0**：审核中。'."\n" + .'- **1**：审核通过。'."\n" + .'- **2**：审核失败，请在返回参数Reason中查看审核失败原因。'."\n" + .'- **10**：取消审核。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'CreateDate' => [ + 'description' => '短信签名的创建日期和时间。', + 'type' => 'string', + 'example' => ' 2019-01-08 16:44:13', + ], + 'Reason' => [ + 'description' => '审核备注。'."\n" + ."\n" + .'- 如果审核状态为**审核通过**或**审核中**，参数Reason显示为“无审核备注”。'."\n" + .'- 如果审核状态为**审核未通过**，参数Reason显示审核的具体原因。', + 'type' => 'string', + 'example' => '文件不能证明信息真实性，请重新上传', + ], + 'SignName' => [ + 'description' => '短信签名。', + 'type' => 'string', + 'example' => '阿里云', + ], + ], + ], + ], + ], + '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' => '查询签名审核状态（待下线）', + 'description' => '- 根据工信部规定与运营商[相关要求](~~2806975~~)，阿里云进行了签名相关API的功能改造。请您使用新接口[GetSmsSign-查询签名详情](~~2807429~~)，新接口查询结果返回参数中将比原有接口返回更多的签名详情信息。'."\n" + ."\n" + .'- 审核时间：一般情况下，签名提交后，阿里云预计在2个小时内审核完成（审核工作时间：周一至周日9:00~21:00，法定节假日顺延），建议您尽量在18:00前提交申请。'."\n" + ."\n" + .'- 如果签名未通过审核，会返回审核失败的原因，请参考[短信审核失败的处理建议](~~65990~~)，调用[ModifySmsTemplate](~~419287~~)接口或在[签名管理](https://dysms.console.aliyun.com/domestic/text)页面修改短信签名。'."\n" + ."\n" + .'- 当前接口是通过签名名称查询单个签名的审核详情。[QuerySmsSignList](~~419288~~)接口可以查询您当前账号下所有签名的签名详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateSmsTrademark' => [ + 'summary' => '创建商标实体。使用场景是签名来源=商标时，需要上传商标信息。', + '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' => '商标详情截图fileKey。'."\n" + ."\n" + .'1. 商标查询方法：'."\n" + .'- 登录中国商标网点击“商标网上查询”商标详情截图。'."\n" + .'- 接受使用说明，填入“申请/注册号”查询。'."\n" + .'- 点击“申请/注册号”查询详情。'."\n" + ."\n" + .'2. 上传到OSS的商标文件信息。文件上传要求：'."\n" + .'- 待上传的文件命名不可包含中文和特殊字符。'."\n" + .'- 仅支持jpg、png、gif、jpeg格式的图片，图片不大于5MB。'."\n" + .'- 截图中包含完整的网址;'."\n" + .'- 商标图片清晰，和“签名名称”完全一致；'."\n" + .'- “申请人名称”需和签名关联的企事业单位名称完全一致；'."\n" + .'- 商标状态为注册商标。'."\n" + ."\n" + .'3. fileKey的获取方式如下：[通过OSS上传文件](~~2833114~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '123456/test1719383196031.jpg', + ], + ], + [ + 'name' => 'TrademarkRegistrationNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '商标注册号', + 'description' => '商标注册号，长度在15个字符内', + 'type' => 'string', + 'required' => true, + 'example' => '766905', + ], + ], + [ + 'name' => 'TrademarkName', + 'in' => 'query', + 'schema' => [ + 'title' => '商标名称', + 'description' => '商标名称，长度在15个字符内', + 'type' => 'string', + 'required' => true, + 'example' => '阿里云', + ], + ], + [ + 'name' => 'TrademarkApplicantName', + 'in' => 'query', + 'schema' => [ + 'title' => '申请人名称', + 'description' => '申请人名称，长度在50个字符内', + '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', + 'example' => '无', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'Message' => [ + 'title' => '', + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => '商标id', + 'type' => 'string', + 'example' => '10000*******', + ], + 'Code' => [ + 'title' => '', + 'description' => '请求状态码。'."\n" + ."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见本章节的错误码列表或产品[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', + '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"}]', + 'title' => '创建商标实体', + 'description' => '商标应在国家知识产权局商标局-中国商标网中可查，且商标所有方与企业名称一致。', + ], + 'QuerySmsTrademark' => [ + 'summary' => '查询商标实体详情信息。', + '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' => '商标实体id', + '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' => '请求ID。', + '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' => '商标截图OSS返回的图片fileKey', + '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' => '请求状态码。'."\n" + ."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + '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"}]', + 'title' => '查询商标实体', + 'description' => '传入商标id列表，返回商标详情。'."\n" + ."\n" + .'如查签名接口（QuerySmsSignList/GetSmsSign）会查出商标id，然后使用此接口进一步查询详情。', + ], + 'CreateSmsAppIcpRecord' => [ + 'summary' => '创建APP-ICP备案实体。使用场景是签名来源=APP时，需要上传ICP备案信息。', + '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备案详情截图fileKey。'."\n" + ."\n" + .'1. ICP备案查询方法：'."\n" + .'前往 [工信部服务平台](https://beian.miit.gov.cn/#/Integrated/recordQuery) 查询ICP备案 ，并进入详情页。'."\n" + ."\n" + .'2. 上传到OSS的ICP 备案文件信息。文件上传要求：'."\n" + ."\n" + .'- 待上传的文件命名不可包含中文和特殊字符。'."\n" + .'- 仅支持jpg、png、gif、jpeg格式的图片，图片不大于5MB。'."\n" + .'- 截图中包含完整的网址。'."\n" + .'- 搜索备案类型选择“APP”。'."\n" + .'- “主办单位名称”需和签名关联资质的企事业单位名称完全一致。'."\n" + .'- 有完整清晰的ICP备案/许可证号。'."\n" + .'- “服务名称”需和“签名名称”完全一致。'."\n" + ."\n" + .'3. fileKey的获取方式如下：[通过OSS上传文件](~~2833114~~)。', + 'type' => 'string', + 'required' => true, + 'example' => ' '."\n" + .'123456/test1719383196031.jpg'."\n", + ], + ], + [ + 'name' => 'AppServiceName', + 'in' => 'query', + 'schema' => [ + 'title' => 'app服务名称', + 'description' => 'ICP备案：服务名称，长度在15个字符内', + 'type' => 'string', + 'required' => true, + 'example' => '阿里云', + ], + ], + [ + 'name' => 'AppPrincipalUnitName', + 'in' => 'query', + 'schema' => [ + 'title' => '主办单位名称', + 'description' => 'ICP备案：主办单位名称，长度在50个字符内', + 'type' => 'string', + 'required' => true, + 'example' => '阿里云计算有限公司', + ], + ], + [ + 'name' => 'AppIcpLicenseNumber', + 'in' => 'query', + 'schema' => [ + 'title' => 'ICP备案/许可证号', + 'description' => 'ICP备案/许可证号，长度在15个字符内', + 'type' => 'string', + 'required' => true, + 'example' => '浙B2-20080101', + ], + ], + [ + 'name' => 'AppApprovalDate', + 'in' => 'query', + 'schema' => [ + 'title' => '审核通过日期，示例2025-09-01', + 'description' => 'ICP备案审核通过日期', + 'type' => 'string', + 'required' => true, + 'example' => '2025-05-22', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'title' => 'APP应用商店链接', + 'description' => 'APP应用商店链接。'."\n" + ."\n" + .'> '."\n" + .'> - 必须以http://或https://开头。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://apps.apple.com/cn/app/阿里云/id981011420', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'."\n", + ], + 'Message' => [ + 'title' => '', + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => 'APP-ICP备案实体ID。', + 'type' => 'string', + 'example' => '10000*******', + ], + 'Code' => [ + 'title' => '', + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', + '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"}]', + 'title' => '创建ICP备案实体', + 'description' => '签名来源选择已上线APP，则需要上传ICP备案截图。', + ], + 'QuerySmsAppIcpRecord' => [ + 'summary' => '查询ICP备案详情信息。', + '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' => 'ICP备案实体id列表', + 'type' => 'array', + 'items' => [ + 'description' => 'ICP备案实体id', + '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' => '请求ID。', + 'type' => 'string', + 'example' => 'C9955E63-8BFF-101D-80A1-E6998DFEFF1A', + ], + 'Message' => [ + 'title' => '', + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => 'APP-ICP备案实体详情列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'APP-ICP备案实体详情。', + '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备案截图OSS返回的图片fileKey', + '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://apps.apple.com/cn/app/阿里云/id981011420', + ], + 'AppApprovalDate' => [ + 'title' => '审核通过日期，示例2025-09-01', + 'description' => '审核通过日期', + 'type' => 'string', + 'example' => '2020-01-01', + ], + 'AppServiceName' => [ + 'title' => 'app服务名称', + 'description' => 'APP服务名称', + 'type' => 'string', + 'example' => '测试', + ], + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](https://help.aliyun.com/document_detail/101346.htm)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', + '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"}]', + 'title' => '查询ICP备案实体', + 'description' => '传入ICP备案id列表，返回ICP备案详情。'."\n" + ."\n" + .'如查签名接口（QuerySmsSignList/GetSmsSign）会查出ICP备案id，然后使用此接口进一步查询详情。', + ], + 'CreateSmsTemplate' => [ + 'summary' => '短信模板即接收方收到短信的详细内容，包括变量和模板内容。您可以根据业务需要，申请验证码、通知短信或推广短信，模板审核通过后才可以发送短信。', + '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' => '模板名称，长度不超过30个字符。', + 'type' => 'string', + 'required' => true, + 'example' => '验证码', + 'maxLength' => 30, + ], + ], + [ + 'name' => 'TemplateContent', + 'in' => 'query', + 'schema' => [ + 'description' => '模板内容，长度不超过500个字符。'."\n" + ."\n" + .'模板内容和变量内容必须符合[短信模板规范](~~463161~~)，否则模板会审核失败。您也可以在[申请模板](https://dysms.console.aliyun.com/domestic/text/template/add)页面，查看常用模板示例。使用示例模板可提高审核效率和成功率。变量规范请参见[TemplateContent参数变量规范](~~2806243~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '您正在申请手机注册，验证码为：${code}，5分钟内有效！'."\n", + 'maxLength' => 500, + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '请描述您使用短信的业务场景或提供业务场景的线上链接，并提供短信完整示例（填入变量内容），信息完整有助于提高模板审核通过率。如未按规范进行填写或不填写，可能会影响您模板审核的通过。', + 'type' => 'string', + 'required' => false, + 'example' => '申请验证码短信', + 'maxLength' => 500, + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => '短信类型。取值：'."\n" + ."\n" + .'- **0**：验证码。'."\n" + .'- **1**：短信通知。'."\n" + .'- **2**：推广短信。'."\n" + .'- **3**：国际/港澳台消息。'."\n" + ."\n" + .'> 仅支持企业认证用户申请推广短信和国际/港澳台消息。个人用户与企业用户权益区别详情请参见[使用须知](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' => '模板需要关联的签名名称。关联的短信签名必须为审核通过的签名。'."\n" + ."\n" + .'<notice>'."\n" + ."\n" + .'- 当TemplateType参数为**0**、**1**、**2**时，此参数必填。'."\n" + ."\n" + .'- 关联签名可以提升审核效率，此处关联的签名和短信发送时选择的签名无关。</notice>', + 'type' => 'string', + 'required' => false, + 'example' => '验证码签名', + ], + ], + [ + 'name' => 'TemplateRule', + 'in' => 'query', + 'schema' => [ + 'description' => '模板变量规则。变量规则的填写，请参见[示例文档](~~2806243~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"code":"characterWithNumber2"}'."\n", + ], + ], + [ + 'name' => 'MoreData', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '更多资料，您可以补充上传业务证明文件或业务截图，有助于审核人员了解您的业务详情。如果您申请的短信模板为推广短信（即TemplateType为2），请上传用户授权证明材料，具体说明请参见[用户授权证明材料上传规范](~~312341~~)。', + 'type' => 'array', + 'items' => [ + 'description' => '上传到OSS的文件信息。文件上传操作，请参见[OSS上传文件](~~2833114~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '10098689758*****/1234qwe.png', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ApplySceneContent', + 'in' => 'query', + 'schema' => [ + 'description' => '业务场景。'."\n" + .' - 模板关联的短信签名使用场景如果为“已上线APP”，`ApplySceneContent`必须为以`http://`开头或`https://`开头的App链接。'."\n" + .' - 模板关联的短信签名使用场景如果为“已注册商标名”、“企事业单位名称”，`ApplySceneContent`必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com/'."\n", + ], + ], + [ + 'name' => 'IntlType', + 'in' => 'query', + 'schema' => [ + 'description' => '国际/港澳台模板类型。当**TemplateType**参数为**3**时，国际/港澳台模板需要设置此参数，取值：'."\n" + .'- **0**：短信通知。'."\n" + .'- **1**：推广短信。'."\n" + .'- **2**：验证码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'TrafficDriving', + 'in' => 'query', + 'schema' => [ + 'description' => '><warning>'."\n" + .'为管控短信内容安全，短信内容中包含“号码、链接”等引流信息，存在被运营商拦截导致发送失败的风险。建议尽可能在短信模板中避免包含相关信息，以降低短信发送失败风险。></warning>'."\n" + ."\n" + .'引流信息列表JSON字符串。'."\n" + .'><notice>JSON格式，传入前请转为字符串。></notice>'."\n" + ."\n" + .'### 1. 字段说明：'."\n" + ."\n" + .'{'."\n" + .' "trafficDrivingType":"引流类型",'."\n" + .' "trafficDrivingContent":"引流内容",'."\n" + .' "variableName":"变量名称",'."\n" + .' "companyName":企事业单位名称,'."\n" + .' "organizationCode":统一社会信用代码,'."\n" + .' "icpNo":ICP备案/许可证号,'."\n" + .' "icpPicOssKey":ICP备案截图OssKey,'."\n" + .' "companyDifferentFromSignQuaReason":企事业单位名称与签名资质不同原因'."\n" + .'}'."\n" + ."\n" + .'### 2. 注意事项：'."\n" + ."\n" + .'- 如果非变量则variableName不传。'."\n" + ."\n" + .'- 企事业单位名称与签名关联资质的企事业单位名称不同，则传入companyDifferentFromSignQuaReason。'."\n" + ."\n" + .'- 如果trfficDrivingType=DOMAIN，则传入所有参数。'."\n" + ."\n" + .'- 如果trafficDrivingType为其他，则传入trafficDrivingType、trafficDrivingContent、variableName（按需）、companyName、organizationCode、companyDifferentFromSignQuaReason（按需）'."\n" + ."\n" + .'### 3. trafficDrivingType引流类型枚举值：'."\n" + .'><warning>因监管要求，不支持手机号码。></warning>'."\n" + .'- DOMAIN：域名类型链接。'."\n" + .'- FIXED_PHONE：固定电话。'."\n" + .'- 400_PHONE：400开头电话。'."\n" + .'- 800_PHONE：800开头电话。'."\n" + .'- 95_PHONE：95开头电话。'."\n" + .'- 96_PHONE：96开头电话。'."\n" + .'- 1_PHONE：1开头，3~5位电话。'."\n" + .'- OTHER_PHONE：其他号码。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"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":"这是一段说明文字"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID。是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE991', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'* OK：代表请求成功。'."\n" + .'* 其他错误码，请参见本章节的**错误码**列表或产品[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'successful', + ], + 'TemplateName' => [ + 'description' => '短信模板名称。', + 'type' => 'string', + 'example' => '验证码模板', + ], + 'TemplateCode' => [ + 'description' => '短信模板Code。'."\n" + ."\n" + .'提交模板申请后，您可以使用短信模板Code，通过[GetSmsTemplate](~~2807433~~)接口查询模板审核详情。也可以[配置回执消息](~~101508~~)，通过[TemplateSmsReport](~~120999~~)获取模板的审核状态消息。', + 'type' => 'string', + 'example' => 'SMS_10000****', + ], + 'OrderId' => [ + 'description' => '工单号。'."\n" + ."\n" + .'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。', + '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' => '申请短信模板（新接口）', + 'description' => '- 新接口和原接口变更的公告详情请参见[关于短信服务更新签名&模板接口的公告](~~2806975~~)。'."\n" + ."\n" + .'- 通过接口申请短信模板，建议每次申请至少间隔30秒。'."\n" + ."\n" + .'- 通过接口申请的模板信息会同步在短信服务控制台，在控制台对模板的相关操作，请参见[短信模板](~~108085~~)。'."\n" + ."\n" + .'- 提交模板申请后，您可以通过[GetSmsTemplate](~~2807433~~)接口查询模板审核状态和详情。也可以[配置回执消息](~~101508~~)，通过[TemplateSmsReport](~~120999~~)获取模板的审核状态消息。'."\n" + ."\n" + .'- 国内短信模板与国际/港澳台短信模板不通用（不能混用），请根据业务使用场景申请模板。'."\n" + ."\n" + .'- 仅支持企业认证用户申请推广短信和国际/港澳台消息，个人用户与企业用户权益区别详情请参见[使用须知](~~55324~~)。', + ], + 'GetSmsTemplate' => [ + 'summary' => '申请模板后，通过此接口查询模板审核详情，可查看模板审核状态。', + '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' => '短信模板Code。'."\n" + ."\n" + .'- 在[CreateSmsTemplate](~~2807431~~)接口的返回参数中获取短信模板Code。'."\n" + .'- 在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面查看短信模板Code。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SMS_20375****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'* OK：代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'TemplateName' => [ + 'description' => '短信模板名称。', + 'type' => 'string', + 'example' => '验证码', + ], + 'TemplateCode' => [ + 'description' => '短信模板Code。', + 'type' => 'string', + 'example' => 'SMS_20375****', + ], + 'TemplateContent' => [ + 'description' => '短信模板内容。', + 'type' => 'string', + 'example' => '您正在申请手机注册，验证码为：${code}，5分钟内有效！', + ], + 'TemplateType' => [ + 'description' => '短信类型。取值：'."\n" + ."\n" + .'- **0**：验证码。'."\n" + .'- **1**：短信通知。'."\n" + .'- **2**：推广短信。'."\n" + .'- **3**：国际/港澳台消息。'."\n" + ."\n" + .'> 仅支持企业认证用户申请推广短信和国际/港澳台消息。个人用户与企业用户权益区别详情请参见[使用须知](https://help.aliyun.com/zh/sms/user-guide/usage-notes?spm=a2c4g.11186623.0.0.67447f576NJnE8)。', + 'type' => 'string', + 'example' => '0', + ], + 'TemplateStatus' => [ + 'description' => '模板审核状态。返回值：'."\n" + ."\n" + .'- **0**：审核中。'."\n" + .'- **1**：通过审核。'."\n" + .'- **2**：未通过审核，会返回审核失败的原因，请参考[短信审核失败的处理建议](https://help.aliyun.com/zh/sms/user-guide/causes-of-application-failures-and-suggestions?spm=a2c4g.11186623.0.0.41fd339f3bPSCQ)，调用[UpdateSmsTemplate](https://help.aliyun.com/zh/sms/developer-reference/api-dysmsapi-2017-05-25-updatesmstemplate?spm)接口或在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面修改短信模板。'."\n" + .'- **10**：取消审核。', + 'type' => 'string', + 'example' => '2', + ], + 'RelatedSignName' => [ + 'description' => '申请模板时，关联的短信签名。', + 'type' => 'string', + 'example' => '阿里云', + ], + 'TemplateTag' => [ + 'description' => '模板标识。取值：'."\n" + ."\n" + .'- 2：用户自定义创建模板。'."\n" + ."\n" + .'- 3：系统赠送模板。'."\n" + ."\n" + .'- 4：测试模板。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'OrderId' => [ + 'description' => '工单号。'."\n" + ."\n" + .'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。', + 'type' => 'string', + 'example' => '2003019****', + ], + 'VariableAttribute' => [ + 'description' => '模板变量规则。'."\n" + ."\n" + .'模板变量规则详情，请参见[示例文档](https://help.aliyun.com/zh/sms/templaterule-template-variable-parameter-filling-example)。', + 'type' => 'string', + 'example' => '{"code":"characterWithNumber"}'."\n", + ], + 'Remark' => [ + 'description' => '短信模板申请说明，是模板审核的参考信息之一。', + 'type' => 'string', + 'example' => '申请验证码模板', + ], + 'CreateDate' => [ + 'description' => '创建短信模板的时间。', + 'type' => 'string', + 'example' => '2024-06-03 10:02:34', + ], + 'AuditInfo' => [ + 'description' => '审核信息。', + 'type' => 'object', + 'properties' => [ + 'RejectInfo' => [ + 'description' => '审核未通过的原因。', + 'type' => 'string', + 'example' => '模板内容中包含错别字。', + ], + 'AuditDate' => [ + 'description' => '审核时间。', + 'type' => 'string', + 'example' => '2024-06-03 11:20:34'."\n", + ], + ], + ], + 'FileUrlList' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'FileUrl' => [ + 'description' => '文件资料信息。兼容旧接口创建的信息。', + 'type' => 'array', + 'items' => [ + 'description' => '文件信息。', + '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' => '更多资料信息，补充上传业务证明文件或业务截图文件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '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' => '国际/港澳台模板类型。当**TemplateType**参数返回值为**3**时，此参数取值：'."\n" + .'- **0**：短信通知。'."\n" + .'- **1**：推广短信。'."\n" + .'- **2**：验证码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ApplyScene' => [ + 'description' => '应用场景内容。', + 'type' => 'string', + 'example' => 'http://www.aliyun.com/'."\n", + ], + 'VendorAuditStatus' => [ + 'title' => ' 各运营商审核状态 key: MOBILE_VENDOR, TELECOM_VENDOR, UNICOM_VENDOR value: 运营商审核状态 0: 审核中 1:通过 2:不通过 15: 已失效'."\n" + .' ', + 'description' => '各运营商审核状态，仅数字短信会返回该参数。'."\n" + ."\n\n" + .'key代表运营商。取值：'."\n" + ."\n" + .'- MOBILE_VENDOR：中国移动。'."\n" + ."\n" + .'- TELECOM_VENDOR：中国电信。'."\n" + ."\n" + .'- UNICOM_VENDOR：中国联通。'."\n" + ."\n" + .' value代表审核状态。取值： '."\n" + ."\n" + .'- 0：审核中。'."\n" + ."\n" + .'- 1：通过。'."\n" + ."\n" + .' - 2：不通过。'."\n" + ."\n" + .' - 15：已失效。', + 'type' => 'object', + 'example' => '{'."\n" + .' "MOBILE_VENDOR": 0,'."\n" + .' "TELCOM_VENDOR": 0,'."\n" + .' "UNICOM_VENDOR": 0'."\n" + .' }', + ], + ], + ], + ], + ], + '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' => '查询模板审核详情（新接口）', + 'description' => '- 新接口和原接口变更的公告详情请参见[关于短信服务更新签名&模板接口的公告](~~2806975~~)。'."\n" + .'- 审核时间：一般情况下，模板提交后，阿里云预计在2个小时内审核完成（审核工作时间：周一至周日9:00~21:00，法定节假日顺延）。'."\n" + ."\n" + .'- 如果模板未通过审核，会返回审核失败的原因，请参考[短信审核失败的处理建议](~~65990~~)，调用[UpdateSmsTemplate](~~UpdateSmsTemplate~~)接口或在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面修改短信模板。'."\n" + ."\n" + .'- 当前接口是通过模板Code查询单个模板的审核详情。[QuerySmsTemplateList](~~419288~~)接口可以查询您当前账号下所有模板的模板详情。', + ], + 'QuerySmsTemplateList' => [ + 'summary' => '可以通过此接口查询您账号下的所有模板，方便您查看模板详情，包括模板审核状态、模板类型、模板内容等。', + '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' => '当前页码。默认取值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的模板个数。取值范围：**1~50**，默认取值为**10**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E47708****', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'SmsTemplateList' => [ + 'description' => '结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '单个模板详情。', + 'type' => 'object', + 'properties' => [ + 'TemplateCode' => [ + 'description' => '短信模板Code。', + 'type' => 'string', + 'example' => 'SMS_1525***', + ], + 'TemplateName' => [ + 'description' => '短信模板名称。', + 'type' => 'string', + 'example' => '验证码模板', + ], + 'OuterTemplateType' => [ + 'description' => '模板类型（对外使用）。返回值：'."\n" + ."\n" + .'- **0**：验证码短信。'."\n" + .'- **1**：通知短信。'."\n" + .'- **2**：推广短信。'."\n" + .'- **3**：国际/港澳台短信。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'AuditStatus' => [ + 'description' => '模板审核状态。返回值：'."\n" + ."\n" + .'- **AUDIT_STATE_INIT**：审核中。'."\n" + .'- **AUDIT_STATE_PASS**：通过审核。'."\n" + .'- **AUDIT_STATE_NOT_PASS**：未通过审核，请在返回参数Reason中查看审核未通过原因。'."\n" + .'- **AUDIT_SATE_CANCEL**：取消审核。', + 'type' => 'string', + 'example' => 'AUDIT_STATE_PASS', + ], + 'TemplateContent' => [ + 'description' => '模板内容。', + 'type' => 'string', + 'example' => '验证码为：${code}，您正在注册成为平台会员，感谢您的支持！', + ], + 'CreateDate' => [ + 'description' => '创建模板的时间，格式为yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'example' => '2020-06-04 11:42:17', + ], + 'Reason' => [ + 'description' => '审核返回值。', + 'type' => 'object', + 'properties' => [ + 'RejectDate' => [ + 'description' => '审核未通过的时间，格式为yyyy-MM-dd HH:mm:ss。', + 'type' => 'string', + 'example' => '2020-06-04 16:01:17', + ], + 'RejectInfo' => [ + 'description' => '审核未通过的原因。', + 'type' => 'string', + 'example' => '变量不符合规范', + ], + 'RejectSubInfo' => [ + 'description' => '审核未通过的详细说明。', + 'type' => 'string', + 'example' => '变量属性选择错误。'."\n" + .'请根据业务使用场景选择合适的变量属性。', + ], + ], + ], + 'OrderId' => [ + 'description' => '工单号。'."\n" + ."\n" + .'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。', + 'type' => 'string', + 'example' => '2004983****', + ], + 'TemplateType' => [ + 'description' => '模板类型。返回值：'."\n" + ."\n" + .'- **0**：短信通知。'."\n" + .'- **1**：推广短信。'."\n" + .'- **2**：验证码短信。'."\n" + .'- **6**：国际/港澳台短信。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'SignatureName' => [ + 'description' => '关联签名名称。', + 'type' => 'string', + 'example' => '阿里云', + ], + 'TrafficDriving' => [ + 'description' => '引流信息列表JSON字符串。'."\n" + .'><notice>JSON格式，传入前请转为字符串。></notice>'."\n" + ."\n" + .'### 1. 字段说明：'."\n" + ."\n" + .'{'."\n" + .' "trafficDrivingType":"引流类型",'."\n" + .' "trafficDrivingContent":"引流内容",'."\n" + .' "variableName":"变量名称",'."\n" + .' "companyName":企事业单位名称,'."\n" + .' "organizationCode":统一社会信用代码,'."\n" + .' "icpNo":ICP备案/许可证号,'."\n" + .' "icpPicOssKey":ICP备案截图OssKey,'."\n" + .' "companyDifferentFromSignQuaReason":企事业单位名称与签名资质不同原因'."\n" + .'}'."\n" + ."\n" + .'### 2. 注意事项：'."\n" + ."\n" + .'- 如果非变量则variableName不传。'."\n" + ."\n" + .'- 企事业单位名称与签名关联资质的企事业单位名称不同，则传入companyDifferentFromSignQuaReason。'."\n" + ."\n" + .'- 如果trfficDrivingType=DOMAIN，则传入所有参数。'."\n" + ."\n" + .'- 如果trafficDrivingType为其他，则传入trafficDrivingType、trafficDrivingContent、variableName（按需）、companyName、organizationCode、companyDifferentFromSignQuaReason（按需）'."\n" + ."\n" + .'### 3. trafficDrivingType引流类型枚举值：'."\n" + ."\n" + .'- DOMAIN：域名类型链接。'."\n" + .'- FIXED_PHONE：固定电话。'."\n" + .'- 400_PHONE：400开头电话。'."\n" + .'- 800_PHONE：800开头电话。'."\n" + .'- 95_PHONE：95开头电话。'."\n" + .'- 96_PHONE：96开头电话。'."\n" + .'- 1_PHONE：1开头，3~5位电话。'."\n" + .'- OTHER_PHONE：其他号码。', + 'type' => 'string', + 'example' => '[{"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":"这是一段说明文字"}]', + ], + ], + ], + ], + 'TotalCount' => [ + 'description' => '本次查询到的模板总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100', + ], + 'CurrentPage' => [ + 'description' => '当前页码。默认取值为**1**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页显示的模板个数。取值范围：**1~50**。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + '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' => '查询模板列表详情', + 'description' => '- 本接口用于查询您当前账号下所有模板的模板详情。如果您需要查询模板变量内容、申请时上传的文件资料信息等更多内容，可以调用[GetSmsTemplate](~~GetSmsTemplate~~)接口通过模板Code查询单个模板审核详情。'."\n" + .'- 您也可登录短信服务控制台[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页查看您当前账号下所有模板的模板详情。', + ], + 'UpdateSmsTemplate' => [ + 'summary' => '修改未通过审核的模板，调用本接口修改后将自动提交审核。', + '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' => '模板名称，长度不超过30个字符。您可在控制台[国内消息>模板管理](https://dysms.console.aliyun.com/domestic/text/template)页签查看未通过审核的模板名称。也可通过[QuerySmsTemplateList](~~QuerySmsTemplateList~~)接口查看未通过审核的短信模板名称。', + 'type' => 'string', + 'required' => true, + 'example' => '验证码模板', + 'maxLength' => 30, + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '未通过审核的模板Code。您可在控制台[国内消息>模板管理](https://dysms.console.aliyun.com/domestic/text/template)页签查看未通过审核的模板Code。也可通过[QuerySmsTemplateList](~~QuerySmsTemplateList~~)接口查看未通过审核的模板Code。', + 'type' => 'string', + 'required' => true, + 'example' => 'SMS_152550****', + ], + ], + [ + 'name' => 'TemplateContent', + 'in' => 'query', + 'schema' => [ + 'description' => '模板内容，长度不超过500个字符。'."\n" + ."\n" + .'模板内容和变量内容必须符合[短信模板规范](~~463161~~)，否则模板会审核失败。您也可以在[申请模板](https://dysms.console.aliyun.com/domestic/text/template/add)页面，查看常用模板示例。使用示例模板可提高审核效率和成功率。变量规范请参见[TemplateContent参数变量规范](~~2806243~~)。', + 'type' => 'string', + 'required' => true, + 'example' => '您正在申请手机注册，验证码为：${code}，5分钟内有效！', + 'maxLength' => 500, + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '请描述您使用短信的业务场景或提供业务场景的线上链接，并提供短信完整示例（填入变量内容），信息完整有助于提高模板审核通过率。如未按规范进行填写或不填写，可能会影响您模板审核的通过。', + 'type' => 'string', + 'required' => false, + 'example' => '登录场景使用验证码', + 'maxLength' => 500, + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => '短信类型。取值：'."\n" + ."\n" + .'- **0**：验证码。'."\n" + .'- **1**：短信通知。'."\n" + .'- **2**：推广短信。'."\n" + .'- **3**：国际/港澳台消息。'."\n" + ."\n" + .'> 仅支持企业认证用户申请推广短信和国际/港澳台消息。个人用户与企业用户权益区别详情请参见[使用须知](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' => '模板申请时关联的短信签名。', + 'type' => 'string', + 'required' => false, + 'example' => '阿里云', + ], + ], + [ + 'name' => 'TemplateRule', + 'in' => 'query', + 'schema' => [ + 'description' => '模板变量规则。变量规则填写请参见[示例文档](~~2806243~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"code":"characterWithNumber"}', + ], + ], + [ + 'name' => 'MoreData', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '更多资料，您可以补充上传业务证明文件或业务截图，有助于审核人员了解您的业务详情。如果您申请的短信模板为推广短信（即TemplateType为2），请上传用户授权证明材料，具体说明请参见[用户授权证明材料上传规范](~~312341~~)。', + 'type' => 'array', + 'items' => [ + 'description' => '上传到OSS的文件信息。文件上传操作，请参见[OSS上传文件](~~2833114~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '10098689758****/1234qwe.png', + ], + 'required' => false, + ], + ], + [ + 'name' => 'ApplySceneContent', + 'in' => 'query', + 'schema' => [ + 'description' => '业务场景。'."\n" + .' - 模板关联的短信签名使用场景如果为“已上线APP”，`ApplySceneContent`必须为以`http://`开头或`https://`开头的App链接。'."\n" + .' - 模板关联的短信签名使用场景如果为“已注册商标名”、“企事业单位名称”，`ApplySceneContent`必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com/'."\n", + ], + ], + [ + 'name' => 'IntlType', + 'in' => 'query', + 'schema' => [ + 'description' => '国际/港澳台模板类型。当**TemplateType**参数为**3**时，国际/港澳台模板需要设置此参数，取值：'."\n" + .'- **0**：短信通知。'."\n" + .'- **1**：推广短信。'."\n" + .'- **2**：验证码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'TrafficDriving', + 'in' => 'query', + 'schema' => [ + 'description' => '><warning>'."\n" + .'为管控短信内容安全，短信内容中包含“号码、链接”等引流信息，存在被运营商拦截导致发送失败的风险。建议尽可能在短信模板中避免包含相关信息，以降低短信发送失败风险。></warning>'."\n" + ."\n" + .'引流信息列表JSON字符串。'."\n" + .'><notice>JSON格式，传入前请转为字符串。></notice>'."\n" + ."\n" + .'### 1. 字段说明：'."\n" + ."\n" + .'{'."\n" + .' "trafficDrivingType":"引流类型",'."\n" + .' "trafficDrivingContent":"引流内容",'."\n" + .' "variableName":"变量名称",'."\n" + .' "companyName":企事业单位名称,'."\n" + .' "organizationCode":统一社会信用代码,'."\n" + .' "icpNo":ICP备案/许可证号,'."\n" + .' "icpPicOssKey":ICP备案截图OssKey,'."\n" + .' "companyDifferentFromSignQuaReason":企事业单位名称与签名资质不同原因'."\n" + .'}'."\n" + ."\n" + .'### 2. 注意事项：'."\n" + ."\n" + .'- 如果非变量则variableName不传。'."\n" + ."\n" + .'- 企事业单位名称与签名关联资质的企事业单位名称不同，则传入companyDifferentFromSignQuaReason。'."\n" + ."\n" + .'- 如果trfficDrivingType=DOMAIN，则传入所有参数。'."\n" + ."\n" + .'- 如果trafficDrivingType为其他，则传入trafficDrivingType、trafficDrivingContent、variableName（按需）、companyName、organizationCode、companyDifferentFromSignQuaReason（按需）'."\n" + ."\n" + .'### 3. trafficDrivingType引流类型枚举值：'."\n" + .'><warning>因监管要求，不支持手机号码。></warning>'."\n" + ."\n" + .'- DOMAIN：域名类型链接。'."\n" + .'- FIXED_PHONE：固定电话。'."\n" + .'- 400_PHONE：400开头电话。'."\n" + .'- 800_PHONE：800开头电话。'."\n" + .'- 95_PHONE：95开头电话。'."\n" + .'- 96_PHONE：96开头电话。'."\n" + .'- 1_PHONE：1开头，3~5位电话。'."\n" + .'- OTHER_PHONE：其他号码。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"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":"这是一段说明文字"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E477085AA0', + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'* OK：代表请求成功。'."\n" + .'* 其他错误码，请参见本章节的**错误码**列表或产品[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'TemplateName' => [ + 'description' => '短信模板名称。', + 'type' => 'string', + 'example' => '验证码', + ], + 'TemplateCode' => [ + 'description' => '短信模板Code。'."\n" + ."\n" + .'提交模板修改后，您可以使用短信模板Code，通过[GetSmsTemplate](~~GetSmsTemplate~~)接口查询模板审核详情。也可以[配置回执消息](https://help.aliyun.com/zh/sms/developer-reference/configure-delivery-receipts-1)，通过[TemplateSmsReport](~~120999~~)获取模板的审核状态消息。', + 'type' => 'string', + 'example' => 'SMS_152550****', + ], + 'OrderId' => [ + 'description' => '工单号。'."\n" + ."\n" + .'审核人员查询审核时会用到此参数。您需要审核加急时需要提供此工单号。', + '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' => '修改短信模板（新接口）', + 'description' => '- 新接口和原接口变更的公告详情请参见[关于短信服务更新签名&模板接口的公告](~~2806975~~)。'."\n" + .'- 仅支持修改未通过审核的模板，请参考[短信审核失败的处理建议](~~65990~~)，调用此接口修改后重新提交审核。'."\n" + ."\n" + .'- 通过接口修改模板的操作会在短信服务控制台同步，在控制台对模板的相关操作，请参见[短信模板](~~108085~~)。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'DeleteSmsTemplate' => [ + 'summary' => '如果您不再使用某个短信模板，需要删除模板时，调用此接口或在短信服务控制台删除短信模板。', + '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' => '短信模板Code。支持删除已撤回、审核失败或审核通过的模板，审核中的短信模板不支持删除。'."\n" + ."\n" + .'- 您可通过[QuerySmsTemplateList](~~419288~~)接口获取短信模板Code。'."\n" + ."\n" + .'- 或在短信控制台[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面获取短信模板Code。'."\n" + .'><notice>删除短信模板后不可恢复，且后续不可再使用该模板发送短信，请谨慎操作。></notice>', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SMS_152550****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'CCA2BCFF-2BA7-427C-90EE-AC6994748607', + ], + 'TemplateCode' => [ + 'description' => '已删除的模板Code。', + 'type' => 'string', + 'example' => 'SMS_152550****', + ], + ], + ], + ], + ], + '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' => '删除短信模板', + 'description' => '- 支持删除已撤回、审核失败或审核通过的模板，审核中的短信模板不支持删除。'."\n" + .'- 删除短信模板后不可恢复，且后续不可再使用该模板发送短信，请谨慎操作。'."\n" + .'- 通过接口删除模板的操作会在短信服务控制台同步，在控制台对模板的相关操作，请参见[短信模板](~~108085~~)。'."\n" + ."\n\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'AddSmsTemplate' => [ + 'summary' => '该接口已下线。', + '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' => '短信类型。取值：'."\n" + ."\n" + .'- **0**：验证码。'."\n" + .'- **1**：短信通知。'."\n" + .'- **2**：推广短信。'."\n" + .'- **3**：国际/港澳台消息。'."\n" + ."\n" + .'> 仅支持企业认证用户申请推广短信和国际/港澳台消息。个人用户与企业用户权益区别详情请参见[使用须知](~~55324~~)。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称，长度不超过30个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '验证码', + ], + ], + [ + 'name' => 'TemplateContent', + 'in' => 'query', + 'schema' => [ + 'description' => '模板内容，长度不超过500个字符。'."\n" + ."\n" + .'模板内容和变量内容必须符合[短信模板规范](~~463161~~)，否则模板会审核失败。您也可以在[申请模板](https://dysms.console.aliyun.com/domestic/text/template/add)页面，查看常用模板示例。使用示例模板可提高审核效率和成功率。变量规范请参见[TemplateContent参数变量规范](~~2806243~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '您正在申请手机注册，验证码为：${code}，5分钟内有效！', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '短信模板申请说明，长度不超过100个字符。'."\n" + ."\n" + .'模板审核的参考信息，完善申请说明有助于审核人员理解您的业务场景，提高审核效率。填写指导：'."\n" + ."\n" + .'- 您可以提供已上线业务的使用场景。'."\n" + .'- 您可以提供真实场景的短信示例，体现您的业务场景。'."\n" + .'- 您可以提供变量的传参内容，详细描述业务使用场景和选择这个变量属性的原因。'."\n" + .'- 您可以提供实际业务的网站链接、已备案的域名地址、应用市场下载链接等。'."\n" + .'- 登录场景，您可以提供测试账号和密码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '申请验证码短信', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'TemplateCode' => [ + 'description' => '短信模板Code。'."\n" + ."\n" + .'提交模板申请后，您可以使用短信模板Code，通过[QuerySmsTemplate](~~419289~~)接口查询模板审核详情。也可以[配置回执消息](~~101508~~)，通过[TemplateSmsReport](~~120999~~)获取模板的审核状态消息。', + 'type' => 'string', + 'example' => 'SMS_46817****', + ], + ], + ], + ], + ], + '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' => '申请短信模板（已下线）', + 'description' => '- 根据工信部规定与运营商[相关要求](~~2806975~~)，阿里云进行了模板相关API的功能改造。为提升您模板的审核效率和审核通过率，请您使用新接口[CreateSmsTemplate-申请短信模板](~~2807431~~)。'."\n" + ."\n" + .'- 通过接口申请短信模板，一个自然日最多可以提交100次短信模板申请。建议每次申请至少间隔30秒。通过[控制台](https://dysms.console.aliyun.com/domestic/text/template)申请短信模板，提交次数无限制。'."\n" + ."\n" + .'- 通过接口申请的模板信息会同步在短信服务控制台，在控制台对模板的相关操作，请参见[短信模板](~~108085~~)。'."\n" + ."\n" + .'- 提交模板申请后，您可以通过[QuerySmsTemplate](~~419289~~)接口查询模板审核状态和详情。也可以[配置回执消息](~~101508~~)，通过[TemplateSmsReport](~~120999~~)获取模板的审核状态消息。'."\n" + ."\n" + .'- 国内短信模板与国际/港澳台短信模板不通用（不能混用），请根据业务使用场景申请模板。'."\n" + ."\n" + .'- 仅支持企业认证用户申请推广短信和国际/港澳台消息，个人用户与企业用户权益区别详情请参见[使用须知](~~55324~~)。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ModifySmsTemplate' => [ + 'summary' => '该接口已下线。', + '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' => '短信类型。取值：'."\n" + ."\n" + .'- **0**：验证码。'."\n" + .'- **1**：短信通知。'."\n" + .'- **2**：推广短信。'."\n" + .'- **3**：国际/港澳台消息。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'TemplateName', + 'in' => 'query', + 'schema' => [ + 'description' => '模板名称，长度限制为1~30个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '验证码模板', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '未通过审核的短信模板Code。'."\n" + ."\n" + .'- 通过[QuerySmsTemplateList](~~419288~~)接口获取未通过审核的短信模板Code。'."\n" + .'- 在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面查看未通过审核的短信模板Code。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SMS_15255****', + ], + ], + [ + 'name' => 'TemplateContent', + 'in' => 'query', + 'schema' => [ + 'description' => '模板内容，长度不超过500个字符。'."\n" + ."\n" + .'模板内容和变量内容必须符合[短信模板规范](~~463161~~)，否则模板会审核失败。您也可以在[申请模板](https://dysms.console.aliyun.com/domestic/text/template/add)页面，查看常用模板示例。使用示例模板可提高审核效率和成功率。变量规范请参见[TemplateContent参数变量规范](~~2806243~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '您正在申请手机注册，验证码为：${code}，5分钟内有效！', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'query', + 'schema' => [ + 'description' => '短信模板申请说明，长度不超过100个字符。'."\n" + ."\n" + .'模板审核的参考信息，完善申请说明有助于审核人员理解您的业务场景，提高审核效率。填写指导：'."\n" + ."\n" + .'- 您可以提供已上线业务的使用场景。'."\n" + .'- 您可以提供真实场景的短信示例，体现您的业务场景。'."\n" + .'- 您可以提供变量的传参内容，详细描述业务使用场景和选择这个变量属性的原因。'."\n" + .'- 您可以提供实际业务的网站链接、已备案的域名地址、应用市场下载链接等。'."\n" + .'- 登录场景，您可以提供测试账号和密码。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '手机注册登录', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'TemplateCode' => [ + 'description' => '已修改的模板Code。', + 'type' => 'string', + 'example' => 'SMS_15255****', + ], + ], + ], + ], + ], + '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' => '修改短信模板（已下线）', + 'description' => '- 根据工信部规定与运营商[相关要求](~~2806975~~)，阿里云进行了模板相关API的功能改造。为提升您模板的审核效率和审核通过率，请您使用新接口[UpdateSmsTemplate-修改短信模板](~~2807432~~)。'."\n" + ."\n" + .'- 仅支持修改未通过审核的模板，请参考[短信审核失败的处理建议](~~65990~~)，调用此接口修改后重新提交审核。'."\n" + ."\n" + .'- 通过接口修改模板的操作会在短信服务控制台同步，在控制台对模板的相关操作，请参见[短信模板](~~108085~~)。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QuerySmsTemplate' => [ + 'summary' => '该接口已下线。', + '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' => '短信模板CODE。'."\n" + .'- 在[AddSmsTemplate](~~121208~~)接口的返回参数中获取短信模板Code。'."\n" + .'- 在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面查看短信模板Code。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SMS_1525****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'TemplateContent' => [ + 'description' => '短信模板内容。', + 'type' => 'string', + 'example' => '亲爱的会员！阿里云短信服务祝您新年快乐！', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0A974B78-02BF-4C79-ADF3-90CFBA1B55B1', + ], + 'TemplateCode' => [ + 'description' => '短信模板Code。', + 'type' => 'string', + 'example' => 'SMS_1525****', + ], + 'TemplateStatus' => [ + 'description' => '模板审核状态。返回值：'."\n" + ."\n" + .'- **0**：审核中。'."\n" + .'- **1**：通过审核。'."\n" + .'- **2**：未通过审核，会返回审核失败的原因，请参考[短信审核失败的处理建议](~~65990~~)，调用[ModifySmsTemplate](~~419287~~)接口或在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面修改短信模板。'."\n" + .'- **10**：取消审核。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'TemplateType' => [ + 'description' => '短信类型。返回值：'."\n" + ."\n" + .'- **0**：验证码。'."\n" + .'- **1**：短信通知。'."\n" + .'- **2**：推广短信。'."\n" + .'- **3**：国际/港澳台消息。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'TemplateName' => [ + 'description' => '短信模板名称。', + 'type' => 'string', + 'example' => '通知短信', + ], + 'CreateDate' => [ + 'description' => '创建短信模板的时间。', + 'type' => 'string', + 'example' => '2024-06-03 10:02:34', + ], + 'Reason' => [ + 'description' => '模板审核备注。'."\n" + ."\n" + .'- 如果审核状态为**通过审核**或**审核中**，Reason返回“无审批备注”。'."\n" + .'- 如果审核状态为**未通过审核**，Reason返回未审核通过的具体原因。', + 'type' => 'string', + 'example' => '无审批备注', + ], + ], + ], + ], + ], + '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' => '查询模板审核状态（已下线）', + 'description' => '- 根据工信部规定与运营商[相关要求](~~2806975~~)，阿里云进行了模板相关API的功能改造。请您使用新接口[GetSmsTemplate-查询模板审核详情](~~2807433~~)，新接口查询结果返回参数中将比原有接口返回更多的模板详情信息。'."\n" + ."\n" + .'- 审核时间：一般情况下，模板提交后，阿里云预计在2个小时内审核完成（审核工作时间：周一至周日9:00~21:00，法定节假日顺延），建议您尽量在18:00前提交申请。'."\n" + ."\n" + .'- 如果模板未通过审核，会返回审核失败的原因，请参考[短信审核失败的处理建议](~~65990~~)，调用[ModifySmsTemplate](~~419287~~)接口或在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面修改短信模板。'."\n" + ."\n" + .'- QuerySmsTemplate当前接口是通过模板Code查询单个模板的审核详情。[QuerySmsTemplateList](~~419288~~)接口可以查询您当前账号下所有模板的模板详情。', + ], + 'SendSms' => [ + 'summary' => '向指定的手机号码发送短信。', + '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' => '接收短信的手机号码。手机号码格式：'."\n" + ."\n" + .'* 国内短信：+/+86/0086/86或无任何前缀的手机号码，例如1390000\\*\\*\\*\\*。'."\n" + .'* 国际/港澳台消息：国际区号+号码，例如852000012\\*\\*\\*\\*。'."\n" + .'* 接收测试短信的手机号：必须先在[控制台](https://dysms.console.aliyun.com/quickstart)绑定测试手机号后才可以发送。'."\n" + ."\n" + .'>支持向不同的手机号码发送短信，手机号码之间以半角逗号（,）分隔。上限为1000个手机号码。批量发送相对于单条发送，及时性稍有延迟。验证码类型的短信，建议单条发送。', + 'type' => 'string', + 'required' => true, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'description' => '短信签名名称。'."\n" + ."\n" + .'您可以通过[QuerySmsSignList](~~419282~~)接口查询当前账号已申请的签名或在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/sign)查看签名列表，必须使用**审核通过**的签名发送短信。'."\n" + ."\n" + .'> - 1、如果验证码签名和通用签名相同时，默认使用通用签名发送短信。'."\n" + .'> - 2、系统会根据您选择的签名执行短信发送任务。', + 'type' => 'string', + 'required' => true, + 'example' => '阿里云', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '短信模板Code。'."\n" + ."\n" + .'您可以通过[QuerySmsTemplateList](~~419288~~)接口查询当前账号已申请的模板或在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/template)查看模板列表，必须使用已**审核通过**的模板Code发送短信。', + 'type' => 'string', + 'required' => true, + 'example' => 'SMS_15305****', + ], + ], + [ + 'name' => 'TemplateParam', + 'in' => 'query', + 'schema' => [ + 'description' => '短信模板变量对应的实际值，请传入**JSON字符串**。当您选择的模板内容含有变量时，此参数必填。参数个数应与模板内变量个数一致。'."\n" + ."\n" + .'> - 如果JSON中需要带换行符，请参照标准的JSON协议处理。'."\n" + .'> - 模板变量规范，请参见[短信模板规范](~~463161~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '{"name":"张三","number":"1390000****"}', + ], + ], + [ + 'name' => 'SmsUpExtendCode', + 'in' => 'query', + 'schema' => [ + 'description' => '上行短信扩展码。上行短信指发送给通信服务提供商的短信，用于定制某种服务、完成查询，或是办理某种业务等，需要收费，按运营商普通短信资费进行扣费。'."\n" + .'> 扩展码是生成签名时系统自动默认生成的，不支持自行传入。无特殊需要可忽略此字段。', + 'type' => 'string', + 'required' => false, + 'example' => '90999', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => '外部流水扩展字段。'."\n" + ."\n" + .'> 无特殊需要可忽略此字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'abcdefgh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'BizId' => [ + 'description' => '发送回执ID。'."\n" + ."\n" + .'可根据发送回执ID在接口[QuerySendDetails](~~QuerySendDetails~~)中查询具体的发送状态。', + 'type' => 'string', + 'example' => '9006197469364984****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '发送短信', + 'description' => '本接口主要用于向单个手机号发送短信，也支持向多个手机号（单次最多支持 1000 个手机号）发送相同签名、相同模板变量的短信，群发存在一定延迟。如果您需要向多个手机号发送不同签名、不同模板变量的短信，请使用[SendBatchSms](~~419274~~)接口（单次最多支持100个手机号）。'."\n" + ."\n" + .'### 注意事项'."\n" + .'- 国内短信服务超时时间建议设置为≥1S；发生超时失败的情况时，建议查看回执状态后再判断是否重试。超时和重试的相关设置，请参见[超时机制](~~262079~~)、[重试机制](~~262080~~)。'."\n" + .'- 国内短信、国际短信及多媒体短信目前均不支持幂等的能力，请您做好幂等控制，防止因多次重试而导致的重复操作问题。'."\n" + .'- 发送短信为计费接口，国内短信按照运营商回执状态计费，调用 SendSms 提交成功但运营商回执失败时不计费。计费详情请参见[计费概述](~~44340~~)。'."\n" + ."\n" + .'### QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 5000/秒。超过限制，API 调用将会被限流，请合理使用。', + 'requestParamsDescription' => '## 请求示例'."\n" + .'- 服务地址URL：dysmsapi.aliyuncs.com（中国站）'."\n" + .'- 请求风格：RPC'."\n" + .'- 请求方式：POST/GET （推荐使用POST）'."\n" + .'- 公共请求头：[V3版本请求体公共请求头](~~2593177#sectiondiv-726-v1i-gel~~)'."\n" + .'- 请求参数：见上方请求参数表格'."\n" + ."\n" + .'### SDK示例'."\n" + .'如果您需要了解如何使用SDK，请参见[首次调用API](~~2841024~~)。'."\n" + .'```Java'."\n" + .'// 构造请求对象'."\n" + .'SendSmsRequest sendSmsRequest = new SendSmsRequest()'."\n" + .' .setPhoneNumbers("1390000****")'."\n" + .' .setSignName("阿里云")'."\n" + .' .setTemplateCode("SMS_15305****")'."\n" + .' // TemplateParam为序列化后的JSON字符串。其中\\"表示转义后的双引号。'."\n" + .' .setTemplateParam("{\\"name\\":\\"张三\\",\\"number\\":\\"1390000****\\"}"); '."\n" + ."\n" + .'// 发送API请求'."\n" + .'SendSmsResponse sendSmsResponse = client.sendSms(sendSmsRequest);'."\n" + .'```'."\n" + .'您可以访问[OpenAPI门户](https://api.aliyun.com/api/Dysmsapi/2017-05-25/SendSms?tab=DEMO&lang=JAVA)，查看各语言SDK请求完整示例。'."\n" + ."\n" + .'### 自签名请求示例'."\n" + .'推荐您通过SDK调用API，SDK已经封装了签名等机制。'."\n" + .'```HTTP'."\n" + .'POST /?PhoneNumbers=123****4567&SignName=阿里云短信测试&TemplateCode=SMS_154950909&TemplateParam={"code":"1234"} HTTP/1.1'."\n" + .'Host: dysmsapi.aliyuncs.com'."\n" + .'Authorization: ACS3-HMAC-SHA256 Credential=YourAccessKeyId,SignedHeaders=host;x-acs-action;x-acs-content-sha256;x-acs-date;x-acs-signature-nonce;x-acs-version,Signature=06563a9e1b43f5dfe96b81********ceab24a1d853912eee15083a6f0f3283c0'."\n" + .'x-acs-action: SendSms'."\n" + .'x-acs-version: 2017-05-25'."\n" + .'x-acs-signature-nonce: d410180a5abf7f********74aca91fc0'."\n" + .'x-acs-date: 2024-12-02T06:53:09Z'."\n" + .'x-acs-content-sha256: e3b0c44298fc1c149afb********b92427ae41e4649b934ca495991b7852b855'."\n" + .'```'."\n" + .'自定义封装API调用签名机制，请参见[V3版本签名机制示例](~~2593177#79cbd5a0c1gif~~)。', + ], + 'SendBatchSms' => [ + 'summary' => '调用此接口可以给不同的手机号码，发送不同签名、同一个模板（可以是不同模板变量）的短信。', + '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' => '接收短信的手机号码。手机号码格式：'."\n" + ."\n" + .'* 国内短信：+/+86/0086/86或无任何前缀的手机号码，例如1590000\\*\\*\\*\\*。'."\n" + .'* 国际/港澳台消息：国际区号+号码，例如852000012\\*\\*\\*\\*。'."\n" + ."\n" + .'> 验证码类型短信，建议使用[SendSms](~~419273~~)接口单条发送。', + 'type' => 'string', + 'required' => true, + 'example' => '["1590000****","1350000****"]', + ], + ], + [ + 'name' => 'SignNameJson', + 'in' => 'formData', + 'schema' => [ + 'description' => '短信签名名称，签名数量需与手机号码数量一致。'."\n" + ."\n" + .'您可以通过[QuerySmsSignList](~~419282~~)接口查询当前账号已申请的签名或在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/sign)查看已审核通过的签名，必须使用审核通过的签名发送短信。'."\n" + ."\n" + .'> '."\n" + .'> - 系统会根据您选择的签名执行短信发送任务。', + 'type' => 'string', + 'required' => true, + 'example' => '["阿里云","阿里巴巴"]', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '短信模板Code。国内短信模板和国际短信模板不可以混用。'."\n" + ."\n" + .'您可以通过[QuerySmsTemplateList](~~419288~~)接口查询当前账号已申请的模板或在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/template)查看模板列表，必须使用已审核通过的模板Code发送短信。', + 'type' => 'string', + 'required' => true, + 'example' => 'SMS_15255****', + ], + ], + [ + 'name' => 'TemplateParamJson', + 'in' => 'formData', + 'schema' => [ + 'description' => '短信模板变量对应的实际值。当您选择的模板内含有变量时，此参数必填。'."\n" + ."\n" + .'> - 模板变量值的个数必须与手机号码、签名的个数相同、内容一一对应，表示向指定手机号码中发对应签名的短信，且短信模板中的变量参数替换为对应的值。'."\n" + .'> - 如果JSON中需要带换行符，请参照标准的JSON协议处理。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"name":"TemplateParamJson"},{"name":"TemplateParamJson"}]', + ], + ], + [ + 'name' => 'SmsUpExtendCodeJson', + 'in' => 'formData', + 'schema' => [ + 'description' => '上行短信扩展码，JSON数组格式。'."\n" + ."\n" + .'> 无特殊需要可忽略此字段。', + 'type' => 'string', + 'required' => false, + 'example' => '["90999","90998"]', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => '外部流水扩展字段，长度小于256的字符串。'."\n" + ."\n" + .'> 无特殊需要可忽略此字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'abcdefg', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '是否调用接口成功的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'BizId' => [ + 'description' => '发送回执ID。'."\n" + ."\n" + .'- 根据该ID在接口[QuerySendDetails](~~102352~~)中查询具体的发送状态。'."\n" + .'- 登录[短信服务控制台](https://dysms.console.aliyun.com/dysms.htm#/overview)，在**业务统计**-**发送记录查询**页面查看发送详情。', + 'type' => 'string', + 'example' => '9006197469364984400', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D230E', + ], + ], + ], + ], + ], + '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' => '批量发送短信', + 'description' => '### 基本信息'."\n" + .'- 本接口主要用于向多个手机号发送短信，支持发送不同签名、同一模板、不同模板变量的短信，单次调用最多支持 100 个手机号。'."\n" + .'- [服务接入点](~~419270~~) (Endpoint)：全局接入点域名为`dysmsapi.aliyuncs.com`。请参见[服务接入点](~~419270~~) ，根据您的使用地域，选择对应的接入点地址。'."\n" + .'### 快速调用'."\n" + .'- 推荐您通过 SDK 调用 API。 如果您需要了解如何使用 ，请参见[首次调用API](~~2841024~~)。'."\n" + .'- 如果您需要使用控制台发送短信，请参见[群发短信](~~108266~~)。'."\n" + .'- 如果您需要自定义封装API调用，请参见[V3版本请求体&签名机制](~~2593177~~)'."\n" + .'### 注意事项'."\n" + .'- 国内短信服务超时时间建议设置为≥1S；发生超时失败的情况时，建议查看回执状态后再判断是否重试。超时和重试的相关设置，请参见[超时机制](~~262079~~)、[重试机制](~~262080~~)。'."\n" + .'- 国内短信、国际短信及多媒体短信目前均不支持幂等的能力，请您做好幂等控制，防止因多次重试而导致的重复操作问题。'."\n" + .'- 发送短信为计费接口，国内短信按照运营商回执状态计费，调用SendBatchSms提交成功但运营商回执失败的短信不计费，计费详情请参见[计费概述](~~44340~~)。'."\n" + .'### QPS 限制'."\n" + .'本接口的单用户 QPS 限制为 5000/秒。超过限制，API 调用将会被限流，请合理使用。', + ], + 'QuerySendDetails' => [ + 'summary' => '查询单个号码的短信发送记录和发送状态等信息。', + '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' => '需要查询的手机号码。格式：'."\n" + ."\n" + .'* 国内短信：11位手机号码，例如1390000\\*\\*\\*\\*。'."\n" + .'* 国际/港澳台消息：国际区号+号码，例如8520000\\*\\*\\*\\*。'."\n" + ."\n" + .'> 只能传入一个手机号码。', + 'type' => 'string', + 'required' => true, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'BizId', + 'in' => 'query', + 'schema' => [ + 'description' => '发送回执ID。即发送流水号，调用[SendSms](~~419273~~)或[SendBatchSms](~~419274~~)发送短信时，返回值中的BizId字段。'."\n" + ."\n" + .'> 只能传入一个Bizid的值，无法传入多个Bizid。', + 'type' => 'string', + 'required' => false, + 'example' => '134523^435****', + ], + ], + [ + 'name' => 'SendDate', + 'in' => 'query', + 'schema' => [ + 'description' => '短信发送日期，支持查询最近30天的记录。'."\n" + ."\n" + .'格式：**yyyyMMdd**，例如20250601。', + 'type' => 'string', + 'required' => true, + 'example' => '20250601', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的短信记录数量，供分页查看发送记录使用。'."\n" + ."\n" + .'取值范围为1~50。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '发送记录的当前页码，供分页查看发送记录使用。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF', + ], + 'TotalCount' => [ + 'description' => '短信发送总条数。', + 'type' => 'string', + 'example' => '1', + ], + 'SmsSendDetailDTOs' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'SmsSendDetailDTO' => [ + 'description' => '短信发送明细。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ErrCode' => [ + 'description' => '运营商短信状态码。'."\n" + ."\n" + .'- 短信发送成功：DELIVERED。'."\n" + .'- 短信发送失败：失败错误码请参见[错误码](~~101347~~)。', + 'type' => 'string', + 'example' => 'DELIVERED', + ], + 'TemplateCode' => [ + 'description' => '短信模板Code。'."\n" + ."\n" + .'> 若选择`[测试专用]阿里云通信`和`[测试专用]阿里云通信测试模板`发送的测试短信，本接口将不会返回TemplateCode字段。', + 'type' => 'string', + 'example' => 'SMS_12231****', + ], + 'OutId' => [ + 'description' => '外部流水扩展字段。'."\n" + ."\n" + .'> 若发送短信时未传入OutId，本接口将不会返回OutId字段。', + 'type' => 'string', + 'example' => '123', + ], + 'ReceiveDate' => [ + 'description' => '短信接收日期和时间。', + 'type' => 'string', + 'example' => '2025-06-01 16:44:13', + ], + 'SendDate' => [ + 'description' => '短信发送日期和时间。', + 'type' => 'string', + 'example' => '2025-06-01 16:44:10', + ], + 'PhoneNum' => [ + 'description' => '接收短信的手机号码。', + 'type' => 'string', + 'example' => '1390000****', + ], + 'Content' => [ + 'description' => '短信内容。', + 'type' => 'string', + 'example' => '【阿里云】验证码为：123，您正在登录，若非本人操作，请勿泄露', + ], + 'SendStatus' => [ + 'description' => '短信发送状态，包括：'."\n" + ."\n" + .'- **1**：等待回执。'."\n" + .'- **2**：发送失败。'."\n" + .'- **3**：发送成功。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询短信发送详情', + 'description' => '- 本接口主要用于查询指定日期下，向某个手机号码发送短信的记录详情。您也可以传入发送流水号（BizId），查询该号码的指定发送记录。'."\n" + ."\n" + .'- 本接口仅支持查询单个手机号码发送详情。如果需要批量查看短信发送详情，您可以使用[QuerySendStatistics](~~419276~~)接口，查询短信发送统计详情；或登录[控制台发送记录查询](https://dysms.console.aliyun.com/record)页面，查询发送详情。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为5000/秒。超过限制，API调用将会被限流，请合理使用。', + 'requestParamsDescription' => '您可以访问[OpenAPI](https://api.aliyun.com/api/Dysmsapi/2017-05-25/QuerySendDetails?tab=DEMO&lang=JAVA)门户，查看各语言SDK请求示例。', + ], + 'QuerySendStatistics' => [ + 'summary' => '查询短信发送统计详情，包括短信发送时间、短信发送成功条数、接收回执条数等。', + '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' => '短信发送范围。取值：'."\n" + ."\n" + .'- **1**：国内短信发送记录。'."\n" + ."\n" + .'- **2**：国际/港澳台短信发送记录。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '2', + 'minimum' => '1', + 'example' => '1', + 'maxLength' => 2, + 'minLength' => 1, + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '开始日期，格式为yyyyMMdd。', + 'type' => 'string', + 'required' => true, + 'example' => '20201002', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '结束日期，格式为yyyyMMdd。', + 'type' => 'string', + 'required' => true, + 'example' => '20201003', + ], + ], + [ + 'name' => 'PageIndex', + 'in' => 'query', + 'schema' => [ + 'description' => '当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + 'minLength' => 1, + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示的条数。取值范围：**1~50**。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'maximum' => '50', + 'minimum' => '1', + 'example' => '10', + 'maxLength' => 50, + 'minLength' => 1, + ], + ], + [ + 'name' => 'TemplateType', + 'in' => 'query', + 'schema' => [ + 'description' => '模板类型。取值：'."\n" + ."\n" + .'- **0**：验证码。'."\n" + ."\n" + .'- **1**：通知短信。'."\n" + ."\n" + .'- **2**：推广短信。（仅支持企业客户）'."\n" + ."\n" + .'- **3**：国际/港澳台消息。（仅支持企业客户）'."\n" + ."\n" + .'- **7**：数字短信。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'description' => '签名名称。', + 'type' => 'string', + 'required' => false, + 'example' => '阿里云平台', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990'."\n", + ], + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'TotalSize' => [ + 'description' => '返回数据的总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'TargetList' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => '发送成功的短信条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'RespondedSuccessCount' => [ + 'description' => '接收到回执成功的短信条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '17', + ], + 'RespondedFailCount' => [ + 'description' => '接收到回执失败的短信条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'NoRespondedCount' => [ + 'description' => '未收到回执的短信条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SendDate' => [ + 'description' => '短信发送日期，格式为yyyyMMdd。', + 'type' => 'string', + 'example' => '20201010', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询短信发送量统计', + 'description' => '- 如果选择的时间范围较长的话，可以分页查看。指定每页显示的短信详情数量和查看的页数，即可分页查看发送记录。'."\n" + ."\n" + .'- 您可以登录[短信服务控制台](https://dysms.console.aliyun.com/dysms.htm#/overview)，在**业务统计**-**发送记录**页面查询发送详情。', + ], + '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' => '签名名称 创建/更新/删除当前字段必填。'."\n" + ."\n" + .'1. 仅支持纯中文、中英文、中文+数字、英文+数字组合输入，字符长度限制2~16字符以内'."\n" + ."\n" + .'2. 输入限制规则'."\n" + .'- 禁止任何特殊字符输入，包括但不限于 “$、&、%、#、@、!、^、*、(、)、_、+、-、=、{、}、[、]、|、;、:、\'、"、<、>、,、.、/、?、~、`” 等特殊符号'."\n" + .'- 不支持纯英文字母输入'."\n" + .'- 不接受纯数字输入严格禁止输入空格，无论是单个空格还是多个连续空格'."\n" + .'- 不允许输入emoji', + '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' => '资质信息，在这个结构中，在【创建】时必填，【更新】时需要变更资质信息则必填'."\n" + .'- qualificationCompanyName 企业名称。符号仅支持中点·、中文【】（）、英文()及空格，不可含其他符号或纯数字，长度不超过 150 字符'."\n" + .'- qualificationOrganizationCode 企业社会信用代码（18位） 仅支持统一社会信用，18位数字或大小写英文字母组成的代码'."\n" + .'- qualificationAdminName 经办人姓名（中文） 法定代表人姓名。'."\n" + .'- qualificationAdminIDCard 经办人身份证号（18位）当前只支持身份证，数据校验格式为身份证格式（数字+字母 18位）'."\n" + .'- qualificationLegalPersonName 法人姓名 经办人姓名。'."\n" + .'- qualificationLegalPersonIDCard 身份证号（18位） 当前只支持身份证，数据校验格式为身份证格式（数字+字母 18位）', + 'type' => 'object', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '{'."\n" + .' "qualificationCompanyName": "阿里阿巴",'."\n" + .' "qualificationOrganizationCode": "91330106MA2A0XABCD",'."\n" + .' "qualificationLegalPersonName": "张三",'."\n" + .' "qualificationLegalPersonIDCard": "110105199001011234",'."\n" + .' "qualificationAdminName": "李四",'."\n" + .' "qualificationAdminIDCard": "1101051990010100000"'."\n" + .'}', + ], + ], + [ + 'name' => 'SignIndustry', + 'in' => 'query', + 'schema' => [ + 'description' => '行业类型'."\n" + .'- 0：通用（GENERAL）；1：电商零售（ECOMMERCE）。'."\n" + .'- 新增/更新签名时，当前字段必填；删除时非必填。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'enumValueTitles' => [ + '通用（GENERAL）', + '电商零售（ECOMMERCE）', + ], + 'example' => '0', + ], + ], + [ + 'name' => 'SignId', + 'in' => 'query', + 'schema' => [ + 'description' => '非必填 签名ID-系统内唯一签名标识', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '80', + ], + ], + [ + 'name' => 'SignSource', + 'in' => 'query', + 'schema' => [ + 'description' => '签名来源 '."\n" + .'- 新增/更新签名时，当前字段必填；删除时非必填。'."\n" + .'- 0：企事业单位；2：App应用；5：商标名；7：电商/旗舰店。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'enumValueTitles' => [ + '企事业单位', + 2 => 'App应用', + 5 => '商标名', + 7 => '电商/旗舰店', + ], + 'example' => '0', + ], + ], + [ + 'name' => 'ExtendMessage', + 'in' => 'query', + 'schema' => [ + 'description' => '非必填', + 'type' => 'string', + 'required' => false, + 'example' => '示例值示例值', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '2D0133B9-6C0D-0BAE-8161-1EEF9E2D4069', + ], + 'Message' => [ + 'description' => '是否调用接口成功的描述。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Data' => [ + 'description' => '接口返回参数body'."\n" + .'- signName 签名名称 创建的签名名称'."\n" + .'- signOrderId 签名OrderId 关联的签名订单唯一标识'."\n" + .'- signCode 签名编码 签名在系统中的唯一数字ID'."\n" + .'- signId 签名ID 签名在系统中的唯一数字ID', + 'type' => 'object', + 'example' => '{\'signId\': \'20067468291\', \'signCode\': \'SIGN_100000184736042_1744164758835_hpMd1\', \'signOrderId\': 22469795330, \'signName\': u\'\\u8d5b\\u745e\\u5a05\\u808c\\u80a4\\u7ba1\\u7406\'}', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + '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"}]', + 'title' => '数字短信签名管理', + 'description' => '创建/编辑/删除 签名接口', + 'requestParamsDescription' => '资质信息，在这个结构中，在【创建】时必填，【更新】时需要变更资质信息则必填'."\n" + .'json示例：'."\n" + .'`{'."\n" + .' "qualificationCompanyName": "阿里阿巴",'."\n" + .' "qualificationOrganizationCode": "91330106MA2A0XABCD",'."\n" + .' "qualificationLegalPersonName": "张三",'."\n" + .' "qualificationLegalPersonIDCard": "110105199001011234",'."\n" + .' "qualificationAdminName": "李四",'."\n" + .' "qualificationAdminIDCard": "1101051990010100000"'."\n" + .'}`'."\n" + .'- qualificationCompanyName 企业名称。符号仅支持中点·、中文【】（）、英文()及空格，不可含其他符号或纯数字，长度不超过 150 字符'."\n" + .'- qualificationOrganizationCode 企业社会信用代码（18位） 仅支持统一社会信用，18位数字或大小写英文字母组成的代码'."\n" + .'- qualificationAdminName 经办人姓名（中文） 法定代表人姓名。'."\n" + .'- qualificationAdminIDCard 经办人身份证号（18位）当前只支持身份证，数据校验格式为身份证格式（数字+字母 18位）'."\n" + .'- qualificationLegalPersonName 法人姓名 经办人姓名。'."\n" + .'- qualificationLegalPersonIDCard 身份证号（18位） 当前只支持身份证，数据校验格式为身份证格式（数字+字母 18位）', + 'extraInfo' => '提交签名申请后，您可以通过 GetSmsSign 接口查询签名报备状态和详情。也可以[配置回执消息](https://dysmsnext.console.aliyun.com/general/audit)'."\n" + .'核心处理逻辑：'."\n" + ."\n" + .'1. 删除签名：通过接口删除签名的操作会在短信服务控制台同步，页面将移除该签名记录；若任意一家运营商存在‘报备中’状态，不支持删除，请等待结果返回后再试。'."\n" + .'2. 关联模板失效：自动查询此签名关联的所有短信模板，并将这些模板的状态批量变更为“已失效”。'."\n" + .'3. 标记原因：在关联模板的状态变更记录中，会附加失效原因：“模板关联的签名被删除”。'."\n" + ."\n" + .'● 使用限制与说明：'."\n" + ."\n" + .'1. 权限：仅签名所属的阿里云账号可对其进行删除操作。'."\n" + .'2. 不可逆：签名删除后不可恢复，如需使用需重新提交申请。'."\n" + .'3. 发送影响：签名删除且关联模板失效后，所有基于这些模板的'."\n" + ."\n" + .'短信发送请求将会失败。请在操作前务必确认影响范围。', + ], + 'QueryDigitalSignByName' => [ + 'summary' => '根据签名名称查询签名详细信息', + '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' => '必填 签名名称'."\n" + .'必须是本账号已申请的数字短信签名。', + 'type' => 'string', + 'required' => false, + 'example' => '阿里云数字商城', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '- gmtModified 最后修改时间 '."\n" + .'- creator 创建者 创建者ID'."\n" + .'- signName 短信签名名称 '."\n" + .'- qualificationId 资质ID 接口或控制台创建的资质ID'."\n" + .'- signIndustry 行业类型 行业类型。0：通用（GENERAL）；1：电商零售（ECOMMERCE）。'."\n" + .'- signVersion 签名版本 若有版本迭代会更新数字，当前为1'."\n" + .'- telecomRegisterStatus 电信报备状态 0, "报备失败" 3, "报备成功" -1, "报备中" -2, "未报备"'."\n" + .'- signCode 签名code 短信签名 Code。'."\n" + .'- gmtCreate 创建时间 '."\n" + .'- signId 签名ID 系统内唯一签名标识'."\n" + .'- mobileRegisterStatus 移动报备状态 '."\n" + .'- SignSource 签名来源 2 签名来源。取值：'."\n" + .'0：企事业单位的全称或简称。'."\n" + .'2：App 应用的全称或简称。'."\n" + .'5：商标名的全称或简称。'."\n" + .'7：电商、旗舰店（仅接口可创建此类型）'."\n" + .'- mobileAvailableStatus 移动可用性 0, "不可用"/1, "可用" 创建模板或发送数字短信时请尽可能选择‘可用’签名。'."\n" + .'- unicomRegisterStatus 联通报备状态 0, "报备失败"/3, "报备成功"/-1, "报备中"/-2, "未报备"'."\n" + .'- unicomAvailableStatus 联通可用性 0, "不可用"/1, "可用" 创建模板或发送数字短信时请尽可能选择‘可用’签名。'."\n" + .'- telecomAvailableStatus 电信可用性 0, "不可用"/1, "可用" 创建模板或发送数字短信时请尽可能选择‘可用’签名。', + 'type' => 'object', + 'example' => ' "Data": {'."\n" + .' "gmtModified": 1770005896000,'."\n" + .' "creator": "UID:1498275912899720",'."\n" + .' "signName": "驳回理由",'."\n" + .' "qualificationId": 2757722,'."\n" + .' "qualificationVersion": 1768974751432,'."\n" + .' "signIndustry": 0,'."\n" + .' "registerStatueReason": {},'."\n" + .' "signVersion": 1,'."\n" + .' "remark": "",'."\n" + .' "telecomRegisterStatus": -1,'."\n" + .' "signCode": "DIGSIGN_100000168688001_1769050485148_pYZu1",'."\n" + .' "gmtCreate": 1769050485000,'."\n" + .' "signId": 22784769,'."\n" + .' "mobileRegisterStatus": -1,'."\n" + .' "signSource": 0,'."\n" + .' "mobileAvailableStatus": 0,'."\n" + .' "attachmentList": [],'."\n" + .' "unicomRegisterStatus": 3,'."\n" + .' "unicomAvailableStatus": 1,'."\n" + .' "signType": 1,'."\n" + .' "telecomAvailableStatus": 0,'."\n" + .' "extendMessage": "{}"'."\n" + .' },', + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + .'OK代表成功，其他为错误码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => 'ture:成功'."\n" + .'false:失败', + '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"}]', + 'title' => '数字短信签名查询', + 'description' => '查询范围：仅支持查询当前阿里云账号下已申请的数字短信签名。', + ], + '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' => '模板名称,不要超过20字符', + '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' => '文件二进制数组转base64，转的时候指定编码格式为UTF-8', + 'type' => 'string', + 'required' => false, + 'example' => '字符', + ], + 'FileSuffix' => [ + 'description' => '文件后缀名，文字内容转成txt，图片支持gif、jpg、png格式，音频支持mp3格式，视频支持mp4格式，目前只支持上传一个视频文件', + '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' => '请求状态码。返回OK代表请求成功。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '附加信息。取值说明如下：请求正常，返回success。请求异常，返回具体异常错误码。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'TemplateCode' => [ + 'description' => '模板code', + '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"}]', + 'title' => '数字短信模板创建', + 'description' => '数字短信-创建模板接口', + ], + 'GetOSSInfoForCardTemplate' => [ + 'summary' => '获取卡片短信所属OSS资源配置信息，此配置信息将用于后续OSS文件上传操作。', + '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' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', + ], + 'Success' => [ + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Signature' => [ + 'description' => '短信签名。', + 'type' => 'string', + 'example' => '阿里云', + ], + 'Host' => [ + 'description' => '访问地址。', + 'type' => 'string', + 'example' => 'http://***.aliyuncs.com'."\n", + ], + 'Policy' => [ + 'description' => '签名策略。', + 'type' => 'string', + 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0yNlQwMzo0NDoyMy4xNTlaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0sWyJzdGFydHMtd2l0aCIsIiRrZXkiLCIxNDIwNjM0******************', + ], + 'ExpireTime' => [ + 'description' => '超时时间戳。单位：秒。', + 'type' => 'string', + 'example' => '1634209418', + ], + 'AliUid' => [ + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '168**********184'."\n", + ], + 'AccessKeyId' => [ + 'description' => '签名使用的AccessKey ID。', + 'type' => 'string', + 'example' => 'LTAI************', + ], + 'StartPath' => [ + 'description' => '策略路径。', + 'type' => 'string', + 'example' => '168**********184', + ], + 'Bucket' => [ + 'description' => 'OSS文件保存桶名称。', + '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' => '获取OSS上传信息', + 'description' => '- 您在调用卡片短信相关API接口前，首先需要开通卡片短信功能，目前卡片短信在内部邀约阶段，请联系您的阿里云商务经理申请开通或联系[阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html)。'."\n" + ."\n" + .'- 卡片短信模板中使用的图片、视频等素材资源可上传到OSS文件系统保存。文件上传操作，请参见[OSS文件上传](~~437303~~)。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为300次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '### 请求参数说明'."\n" + .'GetOSSInfoForCardTemplate接口没有入参，直接调用接口即可获取OSS上传信息。', + ], + 'GetMediaResourceId' => [ + 'summary' => '将用户上传到卡片短信OSS存储的图片、视频转换成（生成）资源数据统一管理，并返回资源ID，用户可以对返回的资源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' => '资源类型。'."\n" + ."\n" + .'- **1**：文本'."\n" + .'- **2**：图片。小图片限制在100 KB以内，大图片限制在2 MB以内，图片要求清晰；图片格式支持JPG、JPEG、PNG。'."\n" + .'- **3**：音频'."\n" + .'- **4**：视频。视频格式支持MP4。'."\n" + .'> '."\n" + .'> - 资源类型为图片时**img_rate**必填。'."\n" + .'> - 1:1比例：oneToOne'."\n" + .'> - 16:9比例：sixteenToNine'."\n" + .'> - 3:1比例：threeToOne'."\n" + .'> - 48:65比例：fortyEightToSixtyFiv', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'maximum' => '10000', + 'minimum' => '0', + 'example' => '1', + ], + ], + [ + 'name' => 'OssKey', + 'in' => 'query', + 'schema' => [ + 'description' => '获取的资源地址。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'oss://alicom-fc-media/1947741454322274/alicom-fc-media/pic/202205191526575398603697152.png', + ], + ], + [ + 'name' => 'FileSize', + 'in' => 'query', + 'schema' => [ + 'description' => '文件大小，单位：Byte。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '12', + ], + ], + [ + 'name' => 'ExtendInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '扩展字段。'."\n" + ."\n" + .'> 资源类型为**图片**时必填。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '{\\"img_rate\\":\\"oneToOne\\"}', + ], + ], + [ + 'name' => 'Memo', + 'in' => 'query', + 'schema' => [ + 'description' => '上传资源的描述。', + 'type' => 'string', + 'required' => false, + 'example' => '图片信息', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F07CF237-F6E3-5F77-B91B-F9B7C5DE84AB', + ], + 'Success' => [ + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ResUrlDownload' => [ + 'description' => '资源下载地址。', + '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' => '获取媒体资源ID', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为300次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CreateCardSmsTemplate' => [ + 'summary' => '创建卡片短信模板。', + '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' => '卡片短信模板名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '阿里云图文类模板', + ], + ], + [ + 'name' => 'Template', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '卡片短信的模板内容。'."\n" + ."\n" + .'> - Template、ExtendInfo、TemplateContent、TmpCard、Action等字段说明，请参见[卡片短信模板参数字段说明](~~434929~~)。'."\n" + .'> - 不同类型的卡片短信模板的内容结构不同，详情请参见[卡片短信模板示例](~~435361~~)。', + '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":"测试-图文模板",'."\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":"测试- BENZ AMG 2020 试驾邀请",'."\n" + .' "isTextTitle":true,'."\n" + .' "positionNumber":2'."\n" + .' },'."\n" + .' {'."\n" + .' "type":"TEXT",'."\n" + .' "content":"测试-梅赛德斯-奔驰，创新激情永不灭。作为汽车 XXXX",'."\n" + .' "isTextTitle":false,'."\n" + .' "positionNumber":3'."\n" + .' },'."\n" + .' {'."\n" + .' "type":"BUTTON",'."\n" + .' "content":"预约试驾",'."\n" + .' "actionType":"OPEN_BROWSER",'."\n" + .' "action":{'."\n" + .' "target":"https://www.mercedes-benz.com.cn",'."\n" + .' "merchantName":"测试-正在跳转梅赛德斯-奔驰"'."\n" + .'},'."\n" + .' "positionNumber":4'."\n" + .' }]'."\n" + .' }]'."\n" + .' },'."\n" + .' "cardSignName":"阿里云",'."\n" + .' "cardType":5'."\n" + .'}', + ], + ], + [ + 'name' => 'Memo', + 'in' => 'query', + 'schema' => [ + 'description' => '对上传模板的描述。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '图文类模板', + ], + ], + [ + 'name' => 'Factorys', + 'in' => 'query', + 'schema' => [ + 'description' => '模板提交的厂商。厂商类型取值：'."\n" + ."\n" + .'- **HuaWei**：表示华为厂商。'."\n" + .'- **XiaoMi**：表示小米厂商。'."\n" + .'- **OPPO**：表示OPPO厂商。'."\n" + .'- **VIVO**：表示VIVO厂商。'."\n" + .'- **MEIZU**：表示魅族厂商。'."\n" + .'- **HONOR**：表示荣耀厂商。'."\n" + ."\n" + .'> 该参数不填时，系统自动匹配模板支持的手机厂商。', + 'type' => 'string', + 'required' => false, + 'example' => '["HuaWei","XiaoMi"] ', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '数据对象。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'Success' => [ + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回对象。', + 'type' => 'object', + 'properties' => [ + 'TemplateCode' => [ + 'description' => '卡片短信模板Code。您可以在控制台**卡片短信**[模板管理](https://dysms.console.aliyun.com/domestic/card)页面查看**模板Code**。'."\n" + ."\n" + .'>必须是已添加、并通过审核的卡片短信模板。', + 'type' => 'string', + 'example' => 'CARD_SMS_2****', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建卡片短信模板', + 'description' => '- 目前卡片短信在内部邀约阶段，请联系您的阿里云商务经理申请开通或联系[阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html?spm=a2c4g.11186623.0.0.213273d4Xe6UEu#section-81n-72q-ybm)。'."\n" + ."\n" + .'- 保存卡片短信模板信息，提交手机厂商审核，并返回模板Code。'."\n" + .'- 使用CreateCardSmsTemplate创建卡片短信模板，若模板中包含厂商不支持的模板类型或事件时，将不向对应厂商提交审核。更多信息，请参见[厂商支持的模板说明](~~434611~~)。'."\n" + .'- 更多卡片短信模板的示例，请参见[卡片短信模板示例](~~435361~~)。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为300次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryCardSmsTemplate' => [ + 'summary' => '查询卡片短信模板审核状态，返回手机厂商审核相关信息。', + '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' => '卡片短信模板Code。取值：'."\n" + ."\n" + .'- 调用[创建卡片短信模板](~~CreateCardSmsTemplate~~)接口后，返回参数**TemplateCode**即为新创建的卡片短信模板Code。'."\n" + ."\n" + .'- 您也可登录控制台[国内卡片短信](https://dysms.console.aliyun.com/domestic/card)页面，在**模板管理**页签查看卡片短信模板Code。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CARD_SMS_2****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Templates' => [ + 'description' => '返回模板列表。'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '返回的模板信息，具体信息以实际返回值为准。'."\n" + .'- tmpName：模板名称。'."\n" + .'- tmpCode：模板Code。'."\n" + .'- state：模板审核状态。0：审核中，1：审核通过。2：审核未通过'."\n" + .'- tmpOps：手机厂商审核列表。（state：手机厂商审核状态。vendorCode：手机厂商信息。remark：手机厂商审核意见。）', + 'type' => 'object', + 'example' => ' {'."\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" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询卡片短信模板状态', + 'description' => '- 未开通卡片短信业务的阿里云账号无法调用此API。'."\n" + .'- 目前卡片短信在内部邀约阶段，请联系您的阿里云商务经理申请开通或[联系阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html)。'."\n" + .'- 您也可登录控制台[国内卡片短信](https://dysms.console.aliyun.com/domestic/card)页面，在模板管理页签内查询卡片短信模板的审核状态。'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为300次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'CheckMobilesCardSupport' => [ + 'summary' => '检查手机号码是否支持卡片短信。', + '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' => '卡片短信模板Code。'."\n" + .'登录短信服务控制台[国内卡片短信](https://dysms.console.aliyun.com/domestic/card)页面，在**模板管理**页签查看卡片短信模板列表。'."\n" + ."\n" + .'>必须是已添加、并通过审核的卡片短信模板。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CARD_SMS_****', + ], + ], + [ + 'name' => 'Mobiles', + 'in' => 'query', + 'style' => 'flat', + 'schema' => [ + 'description' => '待查询的手机号列表。', + 'type' => 'array', + 'items' => [ + 'description' => '待查询的手机号，且该参数的填写格式必须为{"#6#mobile":"1380000****"}，否则会报手机号格式错误。一次请求最多支持查询10000个号码。', + 'type' => 'object', + 'required' => false, + 'example' => '{"#6#mobile":"1322587****"}', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'queryResult' => [ + 'description' => '查询结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '查询数据。', + 'type' => 'object', + 'properties' => [ + 'mobile' => [ + 'description' => '手机号码。', + 'type' => 'string', + 'example' => '1390000****', + ], + 'support' => [ + 'description' => '是否支持卡片短信能力。取值：'."\n" + ."\n" + .'- **true**：支持卡片短信。'."\n" + ."\n" + .'- **false**：不支持卡片短信。', + '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\\": \\"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' => '检查手机号是否支持卡片短信（旧接口）', + 'description' => '- 未开通卡片短信业务的阿里云账号无法调用此API。'."\n" + .'- 目前卡片短信在内部邀约阶段，请联系您的阿里云商务经理申请开通或[联系阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html)。'."\n" + .'- 推荐使用新接口[QueryMobilesCardSupport](~~QueryMobilesCardSupport~~)查询手机号是否支持卡片短信。'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为2000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => '完整请求参数示例：'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "Mobiles": ['."\n" + .' {'."\n" + .' "#6#mobile": "137******00"'."\n" + .' },'."\n" + .' {'."\n" + .' "#6#mobile": "130******00"'."\n" + .' }'."\n" + .' ],'."\n" + .' "TemplateCode": "CARD_SMS_6***9"'."\n" + .'}'."\n" + .'```', + ], + 'QueryMobilesCardSupport' => [ + 'summary' => '查询手机号是否支持卡片短信。', + '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' => '卡片短信模板Code。请在控制台选择**国内消息**>[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面查看。'."\n" + ."\n" + .'>必须是已添加、并通过审核的卡片短信模板。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CARD_SMS_2****', + ], + ], + [ + 'name' => 'Mobiles', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '手机号列表。', + 'type' => 'array', + 'items' => [ + 'description' => '待查询的手机号。一次请求最多支持查询10000个号码。', + 'type' => 'object', + 'required' => false, + 'example' => '{'."\n" + .' "mobile": "138****0000"'."\n" + .'}', + ], + 'required' => true, + ], + ], + [ + 'name' => 'EncryptType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '手机号码加密方式。取值：'."\n" + .'- SHA1：SHA1加密方式。'."\n" + .'- NORMAL：不加密，明文传输。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'NORMAL', + 'maxLength' => 100, + 'default' => 'NORMAL', + 'enum' => [ + 'SHA1', + 'NORMAL', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回值根对象。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '阿里云为该请求生成的唯一标识符。', + 'type' => 'string', + 'example' => '08C17DFE-2E10-54F4-BAFB-7180039CC217', + ], + 'Success' => [ + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'QueryResult' => [ + 'description' => '查询值。', + 'type' => 'array', + 'items' => [ + 'description' => '查询值。', + 'type' => 'object', + 'properties' => [ + 'Mobile' => [ + 'description' => '查询的手机号码。', + 'type' => 'string', + 'example' => '1380000****', + ], + 'Support' => [ + 'description' => '是否支持卡片短信。取值：'."\n" + ."\n" + .'- **true**：支持。'."\n" + .'- **false**：不支持。', + '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' => '查询手机号是否支持卡片短信（新接口）', + 'description' => '- 未开通卡片短信业务的阿里云账号无法调用此API。'."\n" + .'- 目前卡片短信在内部邀约阶段，请联系您的阿里云商务经理申请开通或[联系阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html)。', + ], + 'GetCardSmsLink' => [ + 'summary' => '获取卡片短信短链。', + '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' => '卡片短信模板Code。请在控制台[卡片短信>模板管理](https://dysms.console.aliyun.com/domestic/card)页面选择已通过审核的卡片短信模板Code。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CARD_SMS_****', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => '外部流水扩展字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'BC20220608102511660860762****', + ], + ], + [ + 'name' => 'PhoneNumberJson', + 'in' => 'query', + 'schema' => [ + 'description' => '手机号码、用户ID或系统内部标识。'."\n" + ."\n" + .'> - 最多支持1万个手机号码。'."\n" + .'> - 用户也可自定义标识，长度不超过60个字符。'."\n" + .'> - OPPO厂商的模板一次最多申请10个。', + 'type' => 'string', + 'required' => false, + 'example' => '[\\"1390000****'."\n" + .'\\",\\"1370000****'."\n" + .'\\"]', + ], + ], + [ + 'name' => 'SignNameJson', + 'in' => 'query', + 'schema' => [ + 'description' => '短信签名名称。'."\n" + .'请在控制台[国内消息>签名管理](https://dysms.console.aliyun.com/domestic/text/sign)页签下**签名名称**一列查看。也可通过[QuerySmsSignList](https://help.aliyun.com/zh/sms/developer-reference/api-dysmsapi-2017-05-25-querysmssignlist?spm=a2c4g.11186623.help-menu-search-44282.d_0)接口查看的短信签名名称。'."\n" + ."\n" + .'>必须是已添加、并通过审核的短信签名；且短信签名的个数必须与手机号码的个数相同、内容一一对应。', + 'type' => 'string', + 'required' => true, + 'example' => '[\\"阿里云\\", \\"阿里云2\\"]', + ], + ], + [ + 'name' => 'CardTemplateParamJson', + 'in' => 'query', + 'schema' => [ + 'description' => '卡片短信动参。', + 'type' => 'string', + 'required' => false, + 'example' => ' [{\\"customUrl\\":\\"https://alibaba.com\\",\\"dyncParams\\": \\"{\\\\\\"动参key\\\\\\":\\\\\\"动参value\\\\\\"}\\"},{\\"customUrl\\":\\"https://alibaba.com\\",\\"dyncParams\\": \\"{\\\\\\"动参key\\\\\\":\\\\\\"动参value\\\\\\"}\\"}]', + ], + ], + [ + 'name' => 'CardCodeType', + 'in' => 'query', + 'schema' => [ + 'description' => '卡片短信短链编码类型。取值：'."\n" + .'- 1：群发。'."\n" + .'- 2：个性化。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'CardLinkType', + 'in' => 'query', + 'schema' => [ + 'description' => '卡片短信短链类型。取值：'."\n" + .'- 1：标准生成短码。'."\n" + .'- 2：自定义生成短码。'."\n" + ."\n" + .'> **CardLinkType**不填时，默认为标准生成短码。如需生成自定义短码，请联系阿里运营人员进行报备。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Domain', + 'in' => 'query', + 'schema' => [ + 'description' => '发送账号分配的短链域名，需要提前报备。'."\n" + ."\n" + .'> - 当**CardLinkType**为**2**时，**Domain**参数必填。'."\n" + .'> - 当**Domain**参数不填时，则使用系统默认域名。长度不超过100个字符。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx.com', + ], + ], + [ + 'name' => 'CustomShortCodeJson', + 'in' => 'query', + 'schema' => [ + 'description' => '客户自定义短码。长度为4~8位的数字或字母。'."\n" + ."\n" + .'> 当生成类型为自定义生成短码时必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'abCde', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + .'- OK：代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。'."\n", + 'type' => 'string', + 'example' => 'CC89A90C-978F-46AC-B80D-54738371E7CA', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'CardTmpState' => [ + 'description' => '卡片短信模板审核状态。取值：'."\n" + .'- **0**：审核中。'."\n" + .'- **1**：审核通过。'."\n" + .'- **2**：审核不通过。'."\n" + ."\n" + .'> 未审核通过的短信走回落流程。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NotMediaMobiles' => [ + 'description' => '不支持卡片短信的手机号。', + 'type' => 'string', + 'example' => '1390000****', + ], + 'CardPhoneNumbers' => [ + 'description' => '支持卡片短信的手机号码。', + 'type' => 'string', + 'example' => '[\\"1390000****\\",\\"1370000****\\"]', + ], + 'CardSmsLinks' => [ + 'description' => '卡片短信短链。', + 'type' => 'string', + 'example' => '[\\"mw2m.cn/LAaGGa\\",\\"mw2m.cn/LAAaes\\"]', + ], + 'CardSignNames' => [ + 'description' => '用于申请卡片短信短链的短信签名，在发送时签名、接收号码、卡片短信短链要一一对应。', + 'type' => 'string', + 'example' => '["阿里云","阿里云2"]', + ], + ], + ], + ], + ], + ], + ], + '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' => '获取卡片短信短链', + 'description' => '- 目前卡片短信在内部邀约阶段，请联系您的阿里云商务经理申请开通或联系[阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html?spm=a2c4g.11186623.0.0.213273d4Xe6UEu#section-81n-72q-ybm)。'."\n" + ."\n" + .'### QPS限制'."\n" + .'- 本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'GetCardSmsDetails' => [ + 'summary' => '查询单个号码的卡片短信发送记录和发送状态等信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查看发送记录，指定发送记录的当前页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查看发送记录，指定每页显示的卡片短信记录数量。'."\n" + ."\n" + .'取值范围为1~50。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SendDate', + 'in' => 'query', + 'schema' => [ + 'description' => '卡片短信发送日期，支持查询最近30天的记录。'."\n" + ."\n" + .'格式为yyyyMMdd，例如20240112。', + 'type' => 'string', + 'required' => true, + 'example' => '20240112', + ], + ], + [ + 'name' => 'PhoneNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '接收短信的国内手机号码。格式：11位手机号码，例如1390000****。', + 'type' => 'string', + 'required' => true, + 'example' => '1390000****', + ], + ], + [ + 'name' => 'BizCardId', + 'in' => 'query', + 'schema' => [ + 'description' => '卡片短信发送ID。通过[SendCardSms](~~434120~~)接口或[SendBatchCardSms](~~434119~~)接口发送卡片短信时，获取返回值中的BizCardId字段。', + 'type' => 'string', + 'required' => false, + 'example' => '123456^0', + ], + ], + [ + 'name' => 'BizSmsId', + 'in' => 'query', + 'schema' => [ + 'description' => '文本短信发送ID，调用[SendCardSms](~~434120~~)接口或[SendBatchCardSms](~~434119~~)接口发送卡片短信时，获取返回值中的BizSmsId字段。', + 'type' => 'string', + 'required' => false, + 'example' => '1234576^0', + ], + ], + [ + 'name' => 'BizDigitId', + 'in' => 'query', + 'schema' => [ + 'description' => '数字短信发送ID，调用[SendCardSms](~~434120~~)接口或[SendBatchCardSms](~~434119~~)接口发送卡片短信时，获取返回值中的BizDigitalId字段。', + 'type' => 'string', + 'required' => false, + 'example' => '12346^0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息；只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '无', + ], + 'Message' => [ + 'title' => '状态描述', + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK'."\n", + ], + 'CardSendDetailDTO' => [ + 'title' => '卡片短信发送结果', + 'description' => '卡片短信发送结果。', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'title' => '总量', + 'description' => '总量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'PageSize' => [ + 'title' => '页数', + 'description' => '页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'CurrentPage' => [ + 'title' => '页码', + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Records' => [ + 'description' => '卡片短信发送记录列表。', + 'type' => 'array', + 'items' => [ + 'description' => '卡片短信发送记录。', + 'type' => 'object', + 'properties' => [ + 'TemplateCode' => [ + 'title' => '模板code', + 'description' => '模板code。', + 'type' => 'string', + 'example' => 'CARD_SMS_6***', + ], + 'RenderDate' => [ + 'title' => '渲染时间', + 'description' => '渲染时间。', + 'type' => 'string', + 'example' => '2024-09-27 12:13:39', + ], + 'ReceiveDate' => [ + 'title' => '接收时间', + 'description' => '接收时间。', + 'type' => 'string', + 'example' => '2024-09-27 11:26:35', + ], + 'RenderStatus' => [ + 'title' => '解析状态.。0：未解析；1：解析成功；3：未解析', + 'description' => '解析状态。取值：'."\n" + ."\n" + .'- 0：未解析；'."\n" + .'- 1：解析成功；'."\n" + .'- 3：未解析。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ReceiveType' => [ + 'title' => '接收短信类型', + 'description' => '接收短信类型。', + 'type' => 'string', + 'example' => 'CARD_SMS', + ], + 'SendStatus' => [ + 'title' => '发送状态 1：发送中；2：发送失败；3：发送成功；4：寻址失败', + 'description' => '发送状态。取值：'."\n" + ."\n" + .'- 1：发送中；'."\n" + .'- 2：发送失败；'."\n" + .'- 3：发送成功；'."\n" + .'- 4：寻址失败', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'OutId' => [ + 'title' => '客户传输outId', + 'description' => '客户传输outId。', + 'type' => 'string', + 'example' => '12345678', + ], + 'PhoneNumber' => [ + 'title' => '接收短信手机号', + 'description' => '接收短信手机号。', + 'type' => 'string', + 'example' => '156****9080', + ], + 'SmsContent' => [ + 'title' => '短信内容。只有文本短信有值', + 'description' => '短信内容。只有文本短信有值。', + 'type' => 'string', + 'example' => '您收到一条短信消息', + ], + 'SendDate' => [ + 'title' => '短信发送时间', + 'description' => '短信发送时间。', + 'type' => 'string', + 'example' => '2024-09-27 11:26:32', + ], + 'ErrCode' => [ + 'title' => '发送错误码', + 'description' => '发送错误码。', + 'type' => 'string', + 'example' => 'Success', + ], + ], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '状态码', + 'description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK'."\n", + ], + 'Success' => [ + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **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' => '查询单个号码的卡片短信发送记录和发送状态等信息', + ], + 'QueryCardSmsTemplateReport' => [ + 'summary' => '查询卡片短信指定模板的解析数据，解析数据包括短信解析回执成功数、消息曝光次数和消息点击数等。', + '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' => '卡片短信对象。', + 'type' => 'array', + 'items' => [ + 'description' => '卡片短信模板Code。请在控制台**国内消息**页面中的**模板管理**页签下**模板CODE**一列查看。'."\n" + ."\n" + .'>必须是已添加、并通过审核的卡片短信模板。', + 'type' => 'string', + 'required' => false, + 'example' => 'CARD_SMS_391', + ], + 'required' => true, + 'docRequired' => true, + ], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间，格式为yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-10-10 00:00:01', + ], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间，格式为yyyy-MM-dd HH:mm:ss', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '2020-10-11 00:00:01', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '数据对象。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + ."\n" + .'- 其他错误码请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B71F06CA-7735-183A-B52E-234EF8AFE14B', + ], + 'Success' => [ + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'model' => [ + 'description' => '返回数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据明细。'."\n" + .'- tmpCode：模板Code。'."\n" + .'- date：数据日期。格式为yyyy-MM-dd HH:mm:ss'."\n" + .'- rptSuccessCount：短信解析回执成功数。'."\n" + .'- exposeUv：消息曝光数。'."\n" + .'- exposePv：消息曝光次数。'."\n" + .'- clickUv：消息点击数。'."\n" + .'- clickPv：消息点击次数。'."\n" + .'- facPvUvList：厂商信息列表。', + 'type' => 'object', + ], + 'enumValueTitles' => [], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询卡片短信指定模板的解析数据', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为300次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'SendCardSms' => [ + 'summary' => '发送卡片短信。', + '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' => '卡片短信对象。', + 'type' => 'array', + 'items' => [ + 'description' => '卡片短信对象。', + 'type' => 'object', + 'properties' => [ + 'customUrl' => [ + 'description' => '渲染失败后跳转链接。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://alibaba.com', + ], + 'dyncParams' => [ + 'description' => '动态参数。动参变量不需要${}', + 'type' => 'string', + 'required' => false, + 'example' => '{"param3":"李四3","param1":"李四","param2":"李四2"}', + ], + 'mobile' => [ + 'description' => '接收卡片短信的手机号码。', + 'type' => 'string', + 'required' => false, + 'example' => '1390000****', + ], + ], + 'required' => false, + ], + 'required' => true, + 'docRequired' => true, + 'example' => 'SendCardSms', + ], + ], + [ + 'name' => 'SignName', + 'in' => 'query', + 'schema' => [ + 'description' => '短信签名名称。您可以通过[QuerySmsSignList](~~419282~~)接口查询当前账号已申请的签名或在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/sign)查看签名列表。'."\n" + .'>必须是通过审核的短信签名。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '阿里云', + ], + ], + [ + 'name' => 'CardTemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '卡片短信模板Code。请在控制台**卡片短信**[模板管理](https://dysms.console.aliyun.com/domestic/card)页面选择已通过审核的卡片短信模板Code。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CARD_SMS_70', + ], + ], + [ + 'name' => 'SmsTemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '回落文本短信的模板Code。**FallbackType**选择**SMS**回落文本短信时，此参数必填。'."\n" + ."\n" + .'您可以通过[QuerySmsTemplateList](~~419288~~)接口查询当前账号已申请的模板或在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/template)查看模板列表。'."\n" + .'>必须是已添加、并通过审核的短信模板。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'SMS_48068****', + ], + ], + [ + 'name' => 'SmsUpExtendCode', + 'in' => 'query', + 'schema' => [ + 'description' => '上行短信扩展码。上行短信，指发送给通信服务提供商的短信，用于定制某种服务、完成查询，或是办理某种业务等，需要收费的，按运营商普通短信资费进行扣费。'."\n" + .'>无上述需求的用户请忽略此字段。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'FallbackType', + 'in' => 'query', + 'schema' => [ + 'description' => '回落类型。取值：'."\n" + .'- **SMS**：不支持卡片短信的号码，回落文本短信。'."\n" + .'- **DIGITALSMS**：不支持卡片短信的号码，回落数字短信。'."\n" + .'- **NONE**：不需要回落。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SMS', + ], + ], + [ + 'name' => 'DigitalTemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '回落数字短信的模板Code。**FallbackType**选择**DIGITALSMS**回落数字短信时，此参数必填。'."\n" + ."\n" + .'您可在控制台**数字短信**[模板管理](https://dysms.console.aliyun.com/domestic/digit)页面查看数字短信模板列表。'."\n" + ."\n" + .'>必须是已添加、并通过审核的数字短信模板。', + 'type' => 'string', + 'required' => false, + 'example' => 'DIGITAL_SMS_31359****', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => '预留给调用方使用的ID。', + 'type' => 'string', + 'required' => false, + 'example' => '38d76c9b-4a9a-4c89-afae-61fd8e0e****', + ], + ], + [ + 'name' => 'SmsTemplateParam', + 'in' => 'query', + 'schema' => [ + 'description' => '回落文本短信的模板变量对应的实际值。**SmsTemplateCode**回落的文本短信模板内含有变量时，此参数必填。'."\n" + ."\n" + .'>如果JSON中需要带换行符，请参照标准的JSON协议处理。', + 'type' => 'string', + 'required' => false, + 'example' => '{"jifen":"积分"}', + ], + ], + [ + 'name' => 'DigitalTemplateParam', + 'in' => 'query', + 'schema' => [ + 'description' => '回落数字短信的模板变量对应的实际值。**DigitalTemplateCode**回落的数字短信模板内含有变量时，此参数必填。'."\n" + ."\n" + .'>如果JSON中需要带换行符，请参照标准的JSON协议处理。', + 'type' => 'string', + 'required' => false, + 'example' => '{"msg","xxxd"}', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义发送内容模板CODE。'."\n" + ."\n" + .'自定义内容会按照选定的文本短信模板+卡片解析链接的形式下发到终端，您可以登录[短信服务控制台](https://dysms.console.aliyun.com/overview)，选择**国内消息**或**国际/港澳台短信**，在**模板管理**页签下查看**模板CODE**。'."\n" + ."\n" + .'> - 必须是已添加、并通过审核的模板CODE；且发送国际/港澳台消息时，请使用国际/港澳台短信模版。'."\n" + .'> - 例如：选择的文本短信模板内容为：您有一条消息待查收；卡片解析链接为：`1*.cn/2**d`。最终下发内容：`您有一条消息待查收1*.cn/2**d`。请在下发前做好测试和字数控制。', + 'type' => 'string', + 'required' => false, + 'example' => 'SMS_2322****', + ], + ], + [ + 'name' => 'TemplateParam', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义发送内容模板变量对应的实际值。**TemplateCode**填入包含变量的短信模板时，此参数必填。'."\n" + ."\n" + .'>如果JSON中需要带换行符，请参照标准的JSON协议处理。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "code": "1111"'."\n" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D28D0', + ], + 'Success' => [ + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'MediaMobiles' => [ + 'description' => '接收卡片短信的手机号。', + 'type' => 'string', + 'example' => '1390000****', + ], + 'BizCardId' => [ + 'description' => '卡片短信发送ID。', + 'type' => 'string', + 'example' => '123', + ], + 'BizDigitalId' => [ + 'description' => '数字短信发送ID。', + 'type' => 'string', + 'example' => '232', + ], + 'CardTmpState' => [ + 'description' => '卡片短信模板审核状态。取值：'."\n" + .'- **0**：审核中。'."\n" + .'- **1**：审核通过。'."\n" + .'- **2**：审核不通过。'."\n" + .'> 审核不通过的短信可通过**FallbackType**字段设置回落流程。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NotMediaMobiles' => [ + 'description' => '回落的手机号。', + 'type' => 'string', + 'example' => '1390000****', + ], + 'BizSmsId' => [ + 'description' => '文本短信发送ID。', + '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' => '发送卡片短信', + 'description' => '- 发送卡片短信为计费接口，卡片短信发送失败或渲染失败时不计费，详情请参见[多媒体短信定价](~~437951~~)。'."\n" + .'- 目前卡片短信在内部邀约阶段，请联系您的阿里云商务经理申请开通或联系[阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html?spm=a2c4g.11186623.0.0.213219fcSn2Ykj#section-81n-72q-ybm)。'."\n" + .'- 卡片短信超时时间建议设置为≥3S；发生超时失败的情况时，建议查看回执状态后再判断是否重试。同时建议您在调用此接口时，不要开启SDK重试逻辑，否则可能会造成多次发送的情况。超时和重试的相关设置，请参见[超时机制](~~262079~~)、[重试机制](~~262080~~)。'."\n" + .'- 国内短信、国际短信及多媒体短信目前均不支持幂等的能力，请您做好幂等控制，防止因多次重试而导致的重复操作问题。'."\n" + .'- 发送卡片短信前需添加卡片短信模板且模板审核通过。本接口在发送短信时，会校验号码是否支持卡片短信。如果该手机号不支持发送卡片短信，可在接口中设置是否接受数字短信和文本短信的回落，提升发送的触达率。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'SendBatchCardSms' => [ + 'summary' => '批量发送卡片短信。', + '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' => '卡片短信模板Code。请在控制台**卡片短信**[模板管理](https://dysms.console.aliyun.com/domestic/card)页面选择**已通过审核**的卡片短信模板Code。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CARD_SMS_3**5', + ], + ], + [ + 'name' => 'SmsTemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '回落文本短信的模板Code。**FallbackType**选择**SMS**回落文本短信时，此参数必填。'."\n" + ."\n" + .'您可以通过[QuerySmsTemplateList](~~419288~~)接口查询当前账号已申请的模板或在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/template)查看模板列表。'."\n" + .'>必须是已添加、并通过审核的短信模板。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'SMS_23425****', + ], + ], + [ + 'name' => 'FallbackType', + 'in' => 'query', + 'schema' => [ + 'description' => '回落类型。取值：'."\n" + .'- **SMS**：不支持卡片短信的号码，回落文本短信。'."\n" + .'- **DIGITALSMS**：不支持卡片短信的号码，回落数字短信。'."\n" + .'- **NONE**：不需要回落。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SMS', + ], + ], + [ + 'name' => 'DigitalTemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '回落数字短信的模板Code。**FallbackType**选择**DIGITALSMS**回落数字短信时，此参数必填。'."\n" + ."\n" + .'您可在控制台**国内数字短信**[模板管理](https://dysms.console.aliyun.com/domestic/digit)页面查看数字短信模板列表。'."\n" + .'>必须是已添加、并通过审核的数字短信模板。', + 'type' => 'string', + 'required' => false, + 'example' => 'DIGITAL_SMS_23408****', + ], + ], + [ + 'name' => 'OutId', + 'in' => 'query', + 'schema' => [ + 'description' => '预留给调用方使用的ID。', + 'type' => 'string', + 'required' => false, + 'example' => '16545681783595370', + ], + ], + [ + 'name' => 'PhoneNumberJson', + 'in' => 'query', + 'schema' => [ + 'description' => '接收短信的手机号码。', + 'type' => 'string', + 'required' => true, + 'example' => '["1390000****","1370000****"]', + ], + ], + [ + 'name' => 'SignNameJson', + 'in' => 'query', + 'schema' => [ + 'description' => '短信签名名称。'."\n" + .'您可以通过[QuerySmsSignList](~~419282~~)接口查询当前账号已申请的签名或在[短信服务控制台](https://dysms.console.aliyun.com/domestic/text/sign)查看签名列表。'."\n" + .'>必须是已添加、并通过审核的短信签名；且短信签名的个数必须与手机号码的个数相同、内容一一对应。', + 'type' => 'string', + 'required' => true, + 'example' => '["阿里云","阿里巴巴"]', + ], + ], + [ + 'name' => 'CardTemplateParamJson', + 'in' => 'query', + 'schema' => [ + 'description' => '卡片短信模板参数对应的实际值。**CardTemplateCode**卡片短信模板内含有变量时，此参数必填。'."\n" + ."\n" + .'>如果JSON中需要带换行符，请参照标准的JSON协议处理。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"customurl":"http://www.alibaba.com","dyncParams":"{"a":"hello","b":"world"}"}]', + ], + ], + [ + 'name' => 'SmsTemplateParamJson', + 'in' => 'query', + 'schema' => [ + 'description' => '文本短信模板参数对应的实际值。**SmsTemplateCode**回落的文本短信模板内含有变量时，此参数必填。'."\n" + ."\n" + .'>如果JSON中需要带换行符，请参照标准的JSON协议处理。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"a":1,"b":2},{"a":9,"b":8}]', + ], + ], + [ + 'name' => 'DigitalTemplateParamJson', + 'in' => 'query', + 'schema' => [ + 'description' => '数字短信模板参数对应的实际值。**DigitalTemplateCode**回落的数字短信模板内含有变量时，此参数必填。'."\n" + .'>如果JSON中需要带换行符，请参照标准的JSON协议处理。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"a":1,"b":2},{"a":9,"b":8}]', + ], + ], + [ + 'name' => 'SmsUpExtendCodeJson', + 'in' => 'query', + 'schema' => [ + 'description' => '上行短信扩展码。', + 'type' => 'string', + 'required' => false, + 'example' => '[\\"6\\",\\"6\\"]', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义发送内容模板CODE。'."\n" + ."\n" + .'自定义内容会按照选定的文本短信模板+卡片解析链接的形式下发到终端，您可以登录[短信服务控制台](https://dysms.console.aliyun.com/overview)，选择**国内消息**或**国际/港澳台短信**，在**模板管理**页面查看**模板CODE**。'."\n" + ."\n" + .'> - 必须是已添加、并通过审核的短信模板；且发送国际/港澳台消息时，请使用国际/港澳台短信模板。'."\n" + .'> - 例如：选择的文本短信模板内容为：您有一条消息待查收；卡片解析链接为：`1*.cn/2**d`。最终下发内容：`您有一条消息待查收1*.cn/2**d`。请在下发前做好测试和字数控制。', + 'type' => 'string', + 'required' => false, + 'example' => 'SMS_20375****', + ], + ], + [ + 'name' => 'TemplateParamJson', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义发送内容模板变量对应的实际值。**TemplateCode**填入包含变量的短信模板时，此参数必填。'."\n" + ."\n" + .'> - 如果JSON中需要带换行符，请参照标准的JSON协议处理；'."\n" + .'> - 模板变量值的个数必须与手机号码、签名的个数相同、内容一一对应，表示向指定手机号码中发对应签名的短信，且短信模板中的变量参数替换为对应的值。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"name":"TemplateParamJson"},{"name":"TemplateParamJson"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + .'* 返回OK代表请求成功。'."\n" + .'* 其他错误码，请参见[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', + ], + 'Success' => [ + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回数据。'."\n", + 'type' => 'object', + 'properties' => [ + 'MediaMobiles' => [ + 'description' => '接收卡片短信的手机号。', + 'type' => 'string', + 'example' => '1390000****', + ], + 'BizCardId' => [ + 'description' => '卡片短信发送ID。', + 'type' => 'string', + 'example' => '123', + ], + 'BizDigitalId' => [ + 'description' => '数字短信发送ID。', + 'type' => 'string', + 'example' => '3214', + ], + 'CardTmpState' => [ + 'description' => '卡片短信模板审核状态。取值：'."\n" + .'- **0**：审核中。'."\n" + .'- **1**：审核通过。'."\n" + .'- **2**：审核不通过。'."\n" + .'> 审核不通过的短信可通过**FallbackType**字段设置回落流程。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NotMediaMobiles' => [ + 'description' => '回落的手机号。', + 'type' => 'string', + 'example' => '1390000****', + ], + 'BizSmsId' => [ + 'description' => '文本短信发送ID。', + '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' => '批量发送卡片短信', + 'description' => '- 发送卡片短信为计费接口，卡片短信发送失败或渲染失败时不计费，详情请参见[多媒体短信定价](~~437951~~)。'."\n" + .'- 目前卡片短信在内部邀约阶段，请联系您的阿里云商务经理申请开通或联系[阿里云售前咨询](https://help.aliyun.com/document_detail/464625.html?spm=a2c4g.11186623.0.0.213219fcSn2Ykj#section-81n-72q-ybm)。'."\n" + .'- 卡片短信超时时间建议设置为≥3S；发生超时失败的情况时，建议查看回执状态后再判断是否重试。同时建议您在调用此接口时，不要开启SDK重试逻辑，否则可能会造成多次发送的情况。超时和重试的相关设置，请参见[超时机制](~~262079~~)、[重试机制](~~262080~~)。'."\n" + .'- 国内短信、国际短信及多媒体短信目前均不支持幂等的能力，请您做好幂等控制，防止因多次重试而导致的重复操作问题。'."\n" + .'- 发送卡片短信前需添加卡片短信模板且模板审核通过。本接口在发送短信时，会校验号码是否支持卡片短信。如果该手机号不支持发送卡片短信，可在接口中设置是否接受数字短信和文本短信的回落，提升发送的触达率。'."\n" + .'- 批量发送卡片短信，每个号码可以使用不同的签名，不同的回落。在一次请求中，最多可以向100个手机号码分别发送卡片短信。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为1000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + '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' => '业务类型。申请资质或创建授权委托书文件时请填写**dysms**。', + 'type' => 'string', + 'required' => true, + 'example' => 'dysms', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => '无', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '25D5AFDE-8EBC-132E-8909-1FDC071DA', + ], + 'Message' => [ + 'title' => '', + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'title' => '', + 'description' => 'OSS配置信息。', + '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' => '签名使用的 AccessKey ID。', + 'type' => 'string', + 'example' => 'bypFNbG******', + ], + 'Signature' => [ + 'title' => '签名', + 'description' => '根据AccessKey Secret和Policy计算出的签名信息。调用OSS API时，OSS验证该签名信息，从而确认请求的合法性。', + 'type' => 'string', + 'example' => 'QvNTGC9DSLTeByP+ZWW******', + ], + 'Host' => [ + 'title' => '域名', + 'description' => 'Host 地址。', + 'type' => 'string', + 'example' => 'http://***.oss-cn-zhangjiakou.aliyuncs.com', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', + '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"}]', + 'title' => '获取资质材料/授权书OSS配置信息', + 'description' => '- 您在申请资质/签名时，若用途为他用或涉及第三方，需要提供[授权委托书](~~56741~~)。'."\n" + .'- 请使用本接口获取OSS资源配置信息后，通过OSS上传相关资质材料。具体操作，可参见[通过OSS上传文件](~~2833114~~)。'."\n" + .'- 待上传的文件命名不支持包含中文和特殊符号。', + ], + 'GetOSSInfoForUploadFile' => [ + 'summary' => '获取OSS资源配置信息，此配置信息将用于后续OSS文件上传操作。', + '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' => '业务类型，默认值为**fcMediaSms**。'."\n" + ."\n" + .'创建签名、创建模板时，上传**更多资料**场景，该值为**fcMediaSms**。', + 'type' => 'string', + 'required' => false, + 'example' => 'fcMediaSms', + 'default' => 'fcMediaSms', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A90E4451-FED7-49D2-87C8-00700EDCFD0D', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Model' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'description' => '签名策略。', + 'type' => 'string', + 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyN***Ni0yNVQwNjozNzoyNS45NzBaI**iY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0sWyJzdGFydHMtd2l0***sIiRrZXkiLCIiXV19', + ], + 'StartPath' => [ + 'description' => '策略路径。', + 'type' => 'string', + 'example' => '123456', + ], + 'AccessKeyId' => [ + 'description' => '签名使用的AccessKey ID。', + 'type' => 'string', + 'example' => 'LTAI************'."\n", + ], + 'Signature' => [ + 'description' => '根据**AccessKey Secret**和**Policy**计算出的签名信息。调用OSS API时，OSS验证该签名信息，从而确认Post请求的合法性。', + 'type' => 'string', + 'example' => 'BXnwCWPrhVb*****aoZHZfli5KE=', + ], + 'Host' => [ + 'description' => 'Host地址。', + 'type' => 'string', + 'example' => 'https://alicom-fc-media.oss-cn-zhangjiakou.aliyuncs.com', + ], + 'ExpireTime' => [ + 'description' => '到期时间。', + 'type' => 'string', + 'example' => '1719297445', + ], + ], + ], + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](https://help.aliyun.com/document_detail/101346.htm)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'description' => '接口调用是否成功。取值：'."\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' => '获取签名/模板材料OSS配置信息', + 'description' => '- 您在创建签名或模板时，可上传带有链接的登录页面、后台页面截图、软著、协议补充等资料。有助于审核人员了解您的业务详情。如果是多个资料，可拼成一个文件，支持png、jpg、jpeg、doc、docx、pdf格式。'."\n" + ."\n" + .'- 创建签名或模板所需的更多资料，可上传到OSS文件系统保存。文件上传操作，请参见[OSS上传文件](~~2833114~~)。', + ], + '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任务类型。可选值：'."\n" + .'- ICP_DOMAIN（域名类型链接ICP备案截图）', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'ICP_DOMAIN' => '域名类型链接ICP备案截图', + ], + 'example' => 'ICP_DOMAIN', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'AccessDeniedDetail' => [ + 'description' => '访问被拒绝详细信息，只有 RAM 校验失败才会返回此字段。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '25D5AFDE-xxxx-132E-8909-1FDC071DA', + ], + 'Message' => [ + 'title' => '', + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Model' => [ + 'title' => '', + 'description' => 'OSS配置信息。', + 'type' => 'object', + 'properties' => [ + 'Policy' => [ + 'title' => '', + 'description' => '签名策略。', + 'type' => 'string', + 'example' => 'eyJleHBpcmF0aW9uIjoiMjAyNS0wMy0wOVQxMTo1NTozOS4wMDFaIiwiY29uZGl0aW9ucyI6W1siY29udGVudC1sZW5ndGgtcmFuZ2UiLDAsMTA0ODU3NjAwMF0seyJidWNrZXQiOiJhbGljb20tZmMtbWVkaWEifSxbImVxIiwiJGtleSIsIjEwMDAwMDM1ODA4MjA2M1wv********', + ], + 'StartPath' => [ + 'title' => '', + 'description' => '策略路径。', + 'type' => 'string', + 'example' => '1000********001', + ], + 'Bucket' => [ + 'title' => '', + 'description' => 'bucket名称。', + 'type' => 'string', + 'example' => '示例值', + ], + 'AccessKeyId' => [ + 'title' => '', + 'description' => '签名使用的 AccessKey ID。', + 'type' => 'string', + 'example' => 'bypFNbG******', + ], + 'Signature' => [ + 'title' => '', + 'description' => '根据 AccessKey Secret 和 Policy 计算出的签名信息。调用 OSS API 时，OSS 验证该签名信息，从而确认请求的合法性。', + 'type' => 'string', + 'example' => 'QvNTGC9DSLTeByP+ZWW******', + ], + 'Host' => [ + 'title' => '', + 'description' => 'Host 地址。', + 'type' => 'string', + 'example' => 'http://***.oss-cn-zhangjiakou.aliyuncs.com', + ], + 'ExpireTime' => [ + 'title' => '', + 'description' => '过期时间戳，单位：秒。', + 'type' => 'string', + 'example' => '1741521339', + ], + ], + 'example' => '', + ], + 'Code' => [ + 'title' => '', + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回 OK 代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见 [API 错误码](https://help.aliyun.com/zh/sms/developer-reference/api-error-codes)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Success' => [ + 'title' => '', + 'description' => '调用接口是否成功。取值：'."\n" + ."\n" + .'- true：调用成功。'."\n" + ."\n" + .'- false：调用失败。', + '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"}]', + 'title' => '获取OCR图片识别OSS信息', + ], + 'SmsConversionIntl' => [ + 'summary' => '将每一条消息ID(MessageId) 对应短信的接收情况反馈给阿里云国际短信平台。', + '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' => '消息ID。', + 'type' => 'string', + 'required' => true, + 'example' => '1008030300****'."\n", + ], + ], + [ + 'name' => 'Delivered', + 'in' => 'query', + 'schema' => [ + 'description' => '如果您的用户回复了您发送的消息，则设置为 true。否则，设置为 false。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'ConversionTime', + 'in' => 'query', + 'schema' => [ + 'description' => '触达发送目标的时间戳。必须是Unix时间戳，毫秒级别长整型。'."\n" + ."\n" + .'- 如果不指定该字段：默认当前的时间戳。'."\n" + ."\n" + .'- 如果指定该字段：该时间戳必须大于发送时间并且小于当前时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1349055900000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '接口返回参数。', + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D****'."\n", + ], + 'Code' => [ + 'description' => '状态码。返回OK代表请求成功，其他错误码，请参见[错误码列表](https://help.aliyun.com/document_detail/101346.html?spm=a2c4g.101345.0.0.74326ff2J5EZyt)。', + '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' => '国内发国际短信转化反馈', + 'description' => '指标说明：'."\n" + ."\n" + .'- OTP发送量：验证码发送量。'."\n" + ."\n" + .'- OTP转化量：验证码转换量。（用户成功获取验证码，并进行回传）'."\n" + ."\n" + .'转化率=OTP转化量/OTP发送量。'."\n" + ."\n" + .'> 转化率反馈功能会对业务系统有一定的侵入性，为了防止调用转化率API的抖动影响业务逻辑，请考虑： - 使用异步模式（例如：队列或事件驱动）调用API。 - 添加可降级的方案保护业务逻辑（例如：手动降级开工或者使用断路器自动降级）。', + ], + 'ConversionDataIntl' => [ + 'summary' => '将短信转化率统计数据反馈给阿里云短信平台。', + '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' => '转化率观测的时间点。必须是Unix时间戳，毫秒级别长整型。'."\n" + ."\n" + .'>如果不指定该字段：默认当前的时间戳。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1349055900000', + ], + ], + [ + 'name' => 'ConversionRate', + 'in' => 'query', + 'schema' => [ + 'description' => '转化率监控回报值。'."\n" + .'>该参数取值为double类型 ，区间是\\[0,1]。', + 'type' => 'string', + 'required' => true, + 'example' => '0.53', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF'."\n", + ], + 'Code' => [ + 'description' => '状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + ."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Message\\": \\"OK\\",\\n \\"RequestId\\": \\"819BE656-D2E0-4858-8B21-B2E477085AAF\\\\n\\",\\n \\"Code\\": \\"OK\\"\\n}","type":"json"}]', + 'title' => '国内发国际转化率数据接入API', + 'description' => '指标说明：转化率=OTP 转化量/OTP 发送量。'."\n" + .'- OTP发送量：验证码发送量。'."\n" + .'- OTP转化量：验证码转换量。（用户成功获取验证码，并进行回传）'."\n" + .'>转化率反馈功能会对业务系统有一定的侵入性，为了防止调用转化率 API 的抖动影响业务逻辑，请考虑： '."\n" + .'>- 使用异步模式（例如：队列或事件驱动）调用 API。 '."\n" + .'>- 添加可降级的方案保护业务逻辑（例如：手动降级开工或者使用断路器自动降级）。', + ], + 'AddShortUrl' => [ + 'summary' => '创建短链。', + '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' => '原始链接地址。不超过1000个字符。'."\n" + .'><notice>短信服务暂时不支持使用此接口。></notice>', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'https://www.****.com/product/sms', + ], + ], + [ + 'name' => 'ShortUrlName', + 'in' => 'formData', + 'schema' => [ + 'description' => '短链服务名称。不超过13个字符。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '阿里短链测试', + ], + ], + [ + 'name' => 'EffectiveDays', + 'in' => 'formData', + 'schema' => [ + 'description' => '短链服务使用有效期。单位为天，有效期最长为90天。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF', + ], + 'Data' => [ + 'description' => '短链详情。', + 'type' => 'object', + 'properties' => [ + 'SourceUrl' => [ + 'description' => '原始链接地址。', + 'type' => 'string', + 'example' => 'https://www.****.com/product/sms', + ], + 'ExpireDate' => [ + 'description' => '短链服务使用失效时间。'."\n" + ."\n" + .'> **ExpireDate**值为整点时间。', + 'type' => 'string', + 'example' => '2021-09-19 00:00:00', + ], + 'ShortUrl' => [ + 'description' => '生成的短链服务地址。', + 'type' => 'string', + 'example' => 'http://****.cn/6y8uy7', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建短链', + 'description' => '><notice>短信服务暂时不支持使用此接口。></notice>'."\n" + ."\n" + .'- 一个自然日最多可以创建3000个短链。'."\n" + .'- 短链接生成后，需要进行安全审核，审核时长一般为10分钟~2小时，安全审核通过之前，短链接无法直接访问。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteShortUrl' => [ + 'summary' => '删除短链，删除后短链将无法使用，无法还原为原链。', + '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' => '原始链接地址。不超过1000个字符。'."\n" + .'><notice>短信服务暂时不支持使用此接口。></notice>', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'https://www.****.com/product/sms', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF', + ], + ], + ], + ], + ], + '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' => '删除短链', + 'description' => '><notice>短信服务暂时不支持使用此接口。></notice>'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为100次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryShortUrl' => [ + 'summary' => '查询短链状态，可判断短链是否可用。', + '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' => '生成的短链服务地址。可通过[AddShortUrl](~~186774~~)接口获取。'."\n" + .'><notice>短信服务暂时不支持使用此接口。></notice>', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'http://****.cn/6y8uy7', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Message' => [ + 'description' => '状态码的描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF', + ], + 'Data' => [ + 'description' => '短链详情。', + 'type' => 'object', + 'properties' => [ + 'UniqueVisitorCount' => [ + 'description' => '短链使用的UV数据。', + 'type' => 'string', + 'example' => '23', + ], + 'SourceUrl' => [ + 'description' => '原始链接地址。', + 'type' => 'string', + 'example' => 'https://www.****.com/product/sms', + ], + 'ShortUrlStatus' => [ + 'description' => '短链状态。取值：'."\n" + ."\n" + .'- **expired**：失效。'."\n" + .'- **effective**：有效。'."\n" + .'- **audit**：审核中。'."\n" + .'- **reject**：审核拒绝。', + 'type' => 'string', + 'example' => 'expired', + ], + 'PageViewCount' => [ + 'description' => '短链使用的PV数据。', + 'type' => 'string', + 'example' => '300', + ], + 'ExpireDate' => [ + 'description' => '短链失效时间。', + 'type' => 'string', + 'example' => '2019-01-22 11:21:11', + ], + 'ShortUrlName' => [ + 'description' => '短链服务名称。', + 'type' => 'string', + 'example' => '阿里短链测试', + ], + 'CreateDate' => [ + 'description' => '短链创建时间。', + 'type' => 'string', + 'example' => '2019-01-08 16:44:13', + ], + 'ShortUrl' => [ + 'description' => '生成的短链服务地址。', + 'type' => 'string', + 'example' => 'http://****.cn/6y8uy7', + ], + ], + ], + ], + ], + ], + ], + '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' => '短链状态查询', + 'description' => '><notice>短信服务暂时不支持使用此接口。></notice>'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为20次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListTagResources' => [ + 'summary' => '标签是您为模板添加的标记，每个标签都由一对键值对（Key-Value）组成。您可以查询标签键值对绑定的模板Code，也可以查询某个模板已绑定的所有标签。', + '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' => '资源类型，默认填写TEMPLATE。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TEMPLATE', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认取值：**cn-hangzhou**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'description' => '查询下一页标签的Token。', + 'type' => 'string', + 'required' => false, + 'example' => '23432453245', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页显示条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'ProdCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品名。默认取值：**dysms**。', + 'type' => 'string', + 'required' => false, + 'example' => 'dysms', + 'default' => 'dysms', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。标签列表和**ResourceId**(短信模板Code)不能同时为空。最多可输入20个标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '短信模板Code。短信模板Code和标签列表**Tag**不能同时为空。', + 'type' => 'array', + 'items' => [ + 'description' => '短信模板Code。', + 'type' => 'string', + 'required' => false, + 'example' => 'SMS_2342****', + ], + 'required' => false, + 'example' => 'SMS_23423423', + 'maxItems' => 51, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。'."\n" + ."\n" + .'- 返回OK代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'NextToken' => [ + 'description' => '查询下一页标签的Token。', + 'type' => 'string', + 'example' => '"23432453245"', + ], + 'RequestId' => [ + 'description' => '本次调用请求的ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => 'A90E4451-FED7-49D2-87C8-00700A8C4D0D', + ], + 'TagResources' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'TagResource' => [ + 'description' => '标签资源。', + 'type' => 'array', + 'items' => [ + 'description' => '标签资源。', + 'type' => 'object', + 'properties' => [ + 'ResourceType' => [ + 'description' => '资源类型。', + 'type' => 'string', + 'example' => 'ALIYUN::DYSMS::TEMPLATE', + ], + 'TagValue' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'TestValue', + ], + 'ResourceId' => [ + 'description' => '短信模板Code。', + 'type' => 'string', + 'example' => 'SMS_23423****', + ], + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'TestKey', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询模板标签', + 'description' => '您可登录短信服务控制台[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面筛选标签键值对已绑定的短信模板，或单击操作列**详情**按钮查看当前模板已绑定的标签。'."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'TagResources' => [ + 'summary' => '标签可以标记资源，允许企业或个人将同类型的模板进行资源归类，便于搜索和资源聚合。调用本接口对短信模板进行标签绑定。', + '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' => '资源类型，默认取值：**TEMPLATE**。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TEMPLATE', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID，默认取值：**cn-hangzhou**。更多地域ID请参见[服务接入点](~~419270~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ProdCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品名。默认取值：**dysms**。', + 'type' => 'string', + 'required' => false, + 'example' => 'dysms', + 'default' => 'dysms', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签。单次添加的标签数量不超过20。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '短信模板Code。数量不能超过20条。', + 'type' => 'array', + 'items' => [ + 'description' => '短信模板Code。'."\n" + ."\n" + .'>- 在[CreateSmsTemplate](~~CreateSmsTemplate~~)接口的返回参数中获取短信模板Code。'."\n" + .'>- 在[国内消息>模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面查看短信模板Code。', + 'type' => 'string', + 'required' => false, + 'example' => 'SMS_2342****', + ], + 'required' => false, + 'example' => 'SMS_23423423', + 'maxItems' => 51, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '添加标签的执行结果。取值：'."\n" + ."\n" + .'- **true**：成功。'."\n" + .'- **false**：失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF'."\n", + ], + ], + ], + ], + ], + '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' => '添加模板标签', + 'description' => '- 每个模板最多可以绑定20个标签。'."\n" + .'- 同一个模板的标签键（Key）必须唯一，一个模板如果设置了同Key不同Value的两个标签，新值将覆盖旧值。'."\n" + .'- 此功能仅适用于中国站短信服务的国内文本短信。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UntagResources' => [ + 'summary' => '标签可以标记资源，允许企业或个人将同类型的模板进行资源归类，便于搜索和资源聚合。如果模板不再适用于当前已绑定的标签，可以从模板中解绑标签。您可以删除单个标签，也可以批量删除标签。', + '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' => '资源类型，默认填写TEMPLATE。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TEMPLATE', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID，默认填写cn-hangzhou。'."\n" + .'更多地域ID请参见[服务接入点](~~419270~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '是否删除该模板下的所有标签。取值：'."\n" + ."\n" + .'- **true**：是。'."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + 'default' => 'false', + ], + ], + [ + 'name' => 'ProdCode', + 'in' => 'query', + 'schema' => [ + 'description' => '产品名。默认取值：**dysms**。', + 'type' => 'string', + 'required' => false, + 'example' => 'dysms', + 'default' => 'dysms', + ], + ], + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签键。单次添加的标签数量不超过20。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键。'."\n" + .'在[模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面标签栏查看标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'sampleTagKey', + ], + 'required' => false, + 'example' => 'TestKey', + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '短信模板Code。数量不能超过20条。', + 'type' => 'array', + 'items' => [ + 'description' => '短信模板Code。'."\n" + ."\n" + .'>- 在[CreateSmsTemplate](~~CreateSmsTemplate~~)接口的返回参数中获取短信模板Code。'."\n" + .'>- 在[国内消息>模板管理](https://dysms.console.aliyun.com/domestic/text/template)页面查看短信模板Code。', + 'type' => 'string', + 'required' => false, + 'example' => 'SMS_2342****', + ], + 'required' => false, + 'example' => 'SMS_23423423', + 'maxItems' => 51, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '请求状态码。取值：'."\n" + ."\n" + .'- OK：代表请求成功。'."\n" + .'- 其他错误码，请参见[错误码列表](~~101346~~)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Data' => [ + 'description' => '删除标签的执行结果。取值：'."\n" + ."\n" + .'- **true**：成功。'."\n" + ."\n" + .'- **false**：失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '819BE656-D2E0-4858-8B21-B2E477085AAF'."\n", + ], + ], + ], + ], + ], + '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' => '删除模板标签', + 'description' => '### QPS限制'."\n" + .'本接口的单用户QPS限制为50次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + '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' => '[{"TagKey":"test2","TagValue":"测试修改,test22"},{"TagKey":"book","TagValue":"sanguo"}]', + ], + ], + [ + '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' => '访问被拒绝详细信息，只有RAM校验失败才会返回此字段。', + 'type' => 'string', + 'example' => 'None', + ], + 'RequestId' => [ + 'title' => '', + 'description' => '本次调用请求的 ID，是由阿里云为该请求生成的唯一标识符，可用于排查和定位问题。', + 'type' => 'string', + 'example' => '示例值', + ], + 'Message' => [ + 'title' => '', + 'description' => '错误信息，仅错误时返回错误信息。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Data' => [ + 'description' => '返回数据。', + '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' => [ + 'description' => '单个模板详情', + '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' => [ + 'description' => '标签', + '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' => [ + 'description' => '模板可用状态', + 'type' => 'string', + 'example' => 'MISSING_SIGNATURE'."\n", + ], + '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' => '请求状态码。取值：'."\n" + ."\n" + .'* OK：代表请求成功。'."\n" + .'* 其他错误码，请参见本章节的**错误码**列表或产品[API错误码](~~101346~~)。', + 'type' => 'string', + 'example' => '示例值示例值', + ], + 'Success' => [ + 'title' => '', + 'description' => '接口调用是否成功。取值：'."\n" + ."\n" + .'- **true**：调用成功。'."\n" + ."\n" + .'- **false**：调用失败。', + '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"}]', + 'title' => '查询模板列表', + ], + ], + '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/zh_cn/dysmsapi/2018-05-01/api-docs.php b/data/zh_cn/dysmsapi/2018-05-01/api-docs.php new file mode 100644 index 0000000..0705fca --- /dev/null +++ b/data/zh_cn/dysmsapi/2018-05-01/api-docs.php @@ -0,0 +1,1201 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'Dysmsapi', + 'version' => '2018-05-01', + ], + 'directories' => [ + [ + 'id' => 349009, + 'title' => '发送', + 'type' => 'directory', + 'children' => [ + 'BatchSendMessageToGlobe', + 'SendMessageWithTemplate', + 'SendMessageToGlobe', + ], + ], + [ + 'id' => 349013, + 'title' => '查询', + 'type' => 'directory', + 'children' => [ + 'QueryMessage', + ], + ], + [ + 'id' => 349015, + 'title' => '短信转化率', + 'type' => 'directory', + 'children' => [ + 'ConversionData', + 'SmsConversion', + ], + ], + ], + 'components' => [ + 'schemas' => [], + ], + 'apis' => [ + 'BatchSendMessageToGlobe' => [ + 'summary' => '批量发送短信到中国境外。', + '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' => '接收方号码。号码格式为：国际区号+号码。'."\n" + ."\n" + .'电话代码详情，请参见[电话代码](https://www.alibabacloud.com/help/zh/short-message-service/latest/dialing-codes)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[\\"931520581****\\",\\"931530581****\\",\\"931540581****\\",\\"931550581****\\"]', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'title' => '发送方号码。支持SenderID的发送，只允许数字+字母，含有字母标识最长11位，纯数字标识支持15位。', + 'description' => '发送方号码。支持Sender ID的发送，只允许数字、字母，含有字母标识最长11位，纯数字标识支持15位。', + 'type' => 'string', + 'required' => false, + 'example' => 'Alicloud321', + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'title' => '短信内容。', + 'description' => '短信内容。'."\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' => '短信类型。取值：'."\n" + ."\n\n" + .'- **NOTIFY**：通知短信。'."\n" + ."\n" + .'- **MKT**：推广短信。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'NOTIFY', + 'enum' => [], + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务ID。长度不超过255个字符。可以在回执的TaskId获取。', + 'description' => '任务ID。长度不超过255个字符。可以在短信回执消息体的TaskId字段获取。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '123789****', + ], + ], + [ + 'name' => 'ValidityPeriod', + 'in' => 'query', + 'schema' => [ + 'title' => '短信有效时长', + 'description' => '短信有效时长，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '600', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'title' => '短信通道id', + 'description' => '短信通道id', + 'type' => 'string', + 'required' => false, + 'example' => 'sms-djnfjn344', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '接口返回参数。', + 'type' => 'object', + 'properties' => [ + 'ResponseCode' => [ + 'title' => '状态码。返回OK代表请求成功，其他错误码，请参见错误码列表。', + 'description' => '状态码。返回OK代表请求成功，其他错误码，请参见[错误码列表](https://www.alibabacloud.com/help/zh/short-message-service/latest/error-codes)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8D28D3', + ], + 'FailedList' => [ + 'title' => '发送失败的号码列表。', + 'description' => '发送失败的号码列表。', + 'type' => 'string', + 'example' => '["931520581****","931530581****"]', + ], + 'ResponseDescription' => [ + 'title' => '状态码描述。', + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'The SMS Send Request was accepted', + ], + 'From' => [ + 'title' => '发送方标识，返回传入的SenderID。', + 'description' => '发送方标识，返回传入的Sender ID。', + 'type' => 'string', + 'example' => 'Alicloud321', + ], + 'MessageIdList' => [ + 'title' => '发送成功的消息ID。', + 'description' => '发送成功的消息ID。', + 'type' => 'string', + 'example' => '["123****","124****"]', + ], + 'SuccessCount' => [ + 'title' => '成功发送条数。', + 'description' => '成功发送条数。', + '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' => '批量发送短信到中国境外', + 'description' => '- 该接口不支持往中国内地发送短信。'."\n" + .'- BatchSendMessageToGlobe接口主要小批量发送推广类、通知类短信。大批量发送短信请使用短信控制台的快速发送功能。'."\n" + .'- 若对短信时效性有要求，请使用[SendMessageToGlobe](https://www.alibabacloud.com/help/zh/sms/developer-reference/api-dysmsapi-2018-05-01-batchsendmessagetoglobe)接口。'."\n" + .'- 在一次请求中，最多可以向1000个手机号码分别发送短信。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户（同一个阿里云账号）QPS限制为1次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'extraInfo' => "\n", + ], + 'SendMessageWithTemplate' => [ + 'summary' => '使用短信模板发送短信，只支持发往中国内地。', + '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' => '接收短信号码。号码格式为：国际区号+号码。例如：861503871\\*\\*\\*\\*。'."\n" + ."\n" + .'电话代码详情，请参见[电话代码](https://www.alibabacloud.com/help/zh/short-message-service/latest/dialing-codes)。', + 'type' => 'string', + 'required' => true, + 'example' => '861503871****', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'title' => '发送方标识，请传入短信签名名称。您可以登录短信服务控制台，选择发往中国大陆 > 短信签名，在短信签名列表查看签名名称。', + 'description' => '发送方标识，请传入短信签名名称。您可以登录[短信服务控制台](https://sms-intl.console.aliyun.com/overview)，选择**发往中国大陆** > **短信签名**，在短信签名列表查看签名名称。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Alicloud321', + ], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'query', + 'schema' => [ + 'title' => '短信模板编码。您可以登录短信服务控制台，选择发往中国大陆 > 短信内容，在短信内容列表查看短信模板编码。', + 'description' => '短信模板编码。您可以登录[短信服务控制台](https://sms-intl.console.aliyun.com/overview)，选择**发往中国大陆** > **短信内容**，在短信内容列表查看短信模板编码。'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'SMS_****', + ], + ], + [ + 'name' => 'TemplateParam', + 'in' => 'query', + 'schema' => [ + 'title' => '短信模板变量对应的实际值。如果模板中存在变量，该参数为必填项。', + 'description' => '短信模板变量对应的实际值。如果模板中存在变量，该参数为必填项。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '{"code":"1234","product":"ytx"}', + ], + ], + [ + 'name' => 'SmsUpExtendCode', + 'in' => 'query', + 'schema' => [ + 'title' => '上行短信扩展码。', + 'description' => '上行短信扩展码。', + 'type' => 'string', + 'required' => false, + 'example' => '90999', + ], + ], + [ + 'name' => 'ValidityPeriod', + 'in' => 'query', + 'schema' => [ + 'title' => '短信有效时长', + 'description' => '短信有效时长', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '通道ID', + 'type' => 'string', + 'required' => false, + 'example' => '5739', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ResponseCode' => [ + 'title' => '短信提交状态码。', + 'description' => '短信提交状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'NumberDetail' => [ + 'title' => '号码明细。', + 'description' => '号码明细。', + 'type' => 'object', + 'properties' => [ + 'Carrier' => [ + 'title' => '号码所属的运营商网络。', + 'description' => '号码所属的运营商网络。', + 'type' => 'string', + 'example' => 'China Mobile', + ], + 'Region' => [ + 'title' => '号码所属地区。', + 'description' => '号码所属地区。', + 'type' => 'string', + 'example' => 'Nanjing, Jiangsu', + ], + 'Country' => [ + 'title' => '号码所属国家。', + 'description' => '号码所属国家。', + 'type' => 'string', + 'example' => 'China', + ], + ], + ], + 'ResponseDescription' => [ + 'title' => '短信提交状态的详细描述。', + 'description' => '短信提交状态的详细描述。', + 'type' => 'string', + 'example' => 'The SMS Send Request was accepted', + ], + 'Segments' => [ + 'title' => '短信计费条数。', + 'description' => '短信计费条数。', + 'type' => 'string', + 'example' => '1', + ], + 'To' => [ + 'title' => '接收短信号码。号码格式为：国际区号+号码。', + 'description' => '接收短信号码。号码格式为：国际区号+号码。例如：861503871\\*\\*\\*\\*。', + 'type' => 'string', + 'example' => '861503871****', + ], + 'MessageId' => [ + 'title' => '短信消息ID。由阿里云国际短信平台生成。', + 'description' => '消息ID。', + 'type' => 'string', + 'example' => '1**************3', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + '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' => '使用短信模板发送短信', + 'description' => '### 使用说明'."\n" + .'SendMessageWithTemplate接口仅支持往中国内地发送短信。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SendMessageToGlobe' => [ + 'summary' => '发送短信到中国香港、中国澳门、中国台湾以及中国境外地区。', + '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' => '接收方号码。号码格式为：`国际区号+号码`。例如：8521245567\\*\\*\\*\\*。'."\n" + ."\n" + .'电话代码详情，请参见[电话代码](https://www.alibabacloud.com/help/zh/short-message-service/latest/dialing-codes)。'."\n" + ."\n" + .'> SendMessageToGlobe接口不支持往中国内地发送短信。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '8521245567****', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'title' => '发送方号码。支持SenderId的发送，只允许数字+字母，含有字母标识最长11位，纯数字标识支持15位。', + 'description' => '发送方号码。支持Sender ID的发送，只允许数字、字母，含有字母标识最长11位，纯数字标识支持15位。', + 'type' => 'string', + 'required' => false, + 'example' => 'Alicloud321', + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'title' => '短信的内容。', + 'description' => '短信的内容。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Hello', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '短信类型。取值：'."\n" + .'OTP：验证码短信。'."\n" + .'NOTIFY：通知短信。'."\n" + .'MKT：推广短信。', + 'description' => '短信类型。取值：'."\n" + .'- OTP：验证码短信。'."\n" + .'- NOTIFY：通知短信。'."\n" + .'- MKT：推广短信。', + 'type' => 'string', + 'required' => false, + 'example' => 'NOTIFY', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'title' => '任务ID。长度不超过255个字符。可以从回执的TaskId字段获取。', + 'description' => '任务ID。长度不超过255个字符。可以在短信回执消息体的TaskId字段获取。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '123****789', + ], + ], + [ + 'name' => 'ValidityPeriod', + 'in' => 'query', + 'schema' => [ + 'title' => '短信有效时长', + 'description' => '短信有效时长，单位：秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '600', + ], + ], + [ + 'name' => 'ChannelId', + 'in' => 'query', + 'schema' => [ + 'description' => '通道ID。', + 'type' => 'string', + 'required' => false, + 'example' => '3790', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '接口返回参数。', + 'type' => 'object', + 'properties' => [ + 'ResponseCode' => [ + 'title' => '短信提交状态码。', + 'description' => '短信提交状态码。', + 'type' => 'string', + 'example' => 'OK', + ], + 'NumberDetail' => [ + 'title' => '号码明细。', + 'description' => '号码明细。', + 'type' => 'object', + 'properties' => [ + 'Carrier' => [ + 'title' => '号码所属的运营商网络。', + 'description' => '号码所属的运营商网络。', + 'type' => 'string', + 'example' => 'CMI', + ], + 'Region' => [ + 'title' => '号码所属地区。', + 'description' => '号码所属地区。', + 'type' => 'string', + 'example' => 'HongKong', + ], + 'Country' => [ + 'title' => '号码所属国家。', + 'description' => '号码所属国家。', + 'type' => 'string', + 'example' => 'China', + ], + ], + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'F655A8D5-B967-440B-8683-DAD6FF8DE990', + ], + 'Segments' => [ + 'title' => '短信计费条数。', + 'description' => '短信计费条数。', + 'type' => 'string', + 'example' => '1', + ], + 'ResponseDescription' => [ + 'title' => '短信提交状态码描述。', + 'description' => '短信提交状态码描述。', + 'type' => 'string', + 'example' => 'The SMS Send Request was accepted', + ], + 'From' => [ + 'title' => '发送方号码，返回传入的SenderId。', + 'description' => '发送方号码，返回传入的Sender ID。', + 'type' => 'string', + 'example' => 'Alicloud321', + ], + 'To' => [ + 'title' => '接收方号码。', + 'description' => '接收方号码。', + 'type' => 'string', + 'example' => '1380000****', + ], + 'MessageId' => [ + 'title' => '短信消息ID。由阿里云国际短信平台生成', + 'description' => '消息ID。', + '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' => '发送短信到港澳台及中国境外', + 'description' => '- 您可调用此接口发送短信至港澳台及中国境外，或在[发送任务](https://sms.console.alibabacloud.com/batch)界面手动发送短信至港澳台及中国境外。'."\n" + ."\n" + .'- 此接口不支持往中国内地发送短信。'."\n" + ."\n" + .'- 套餐包在账户欠费时不可使用，请在调用接口前检查[账户余额](https://home.console.alibabacloud.com/home/dashboard/ProductAndService)及[套餐包余量](https://sms-intl.console.aliyun.com/expense)。'."\n" + ."\n" + .'- 国际站短信服务按照短信提交状态计费，即便运营商回执为“失败”，仍然收费。套餐包及按量计费详情请参见[产品计费](https://www.alibabacloud.com/help/zh/sms/product-overview/pricing)。'."\n" + ."\n" + .'### QPS限制'."\n" + .'本接口的单用户（同一个阿里云账号）QPS限制为2000次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + ], + 'QueryMessage' => [ + 'summary' => '使用短信MessageId查询短信发送记录。', + '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' => '消息ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1008030xxx3003', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '接口返回参数。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'title' => '短信的发送状态。'."\n" + ."\n" + .'1：成功（Delivered）'."\n" + .'2：失败（Delivery Failed）'."\n" + .'3：发送中（Delivering）', + 'description' => '短信的发送状态。'."\n" + .'- 1：成功（Delivered）'."\n" + .'- 2：失败（Delivery Failed） '."\n" + .'- 3：发送中（Delivering）', + 'type' => 'string', + 'example' => '1', + ], + 'ErrorDescription' => [ + 'title' => '短信发送状态码的描述。', + 'description' => '短信发送状态码的描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'ResponseCode' => [ + 'title' => '短信提交状态码。', + 'description' => '短信提交状态。', + 'type' => 'string', + 'example' => 'OK', + ], + 'ReceiveDate' => [ + 'title' => '发送短信收到运营商回执的时间。', + 'description' => '发送短信收到运营商回执的时间。', + 'type' => 'string', + 'example' => 'Mon, 24 Dec 2018 16:58:22 +0800', + ], + 'NumberDetail' => [ + 'title' => '号码明细。', + 'description' => '号码明细。', + 'type' => 'object', + 'properties' => [ + 'Carrier' => [ + 'title' => '号码所属的运营商网络。', + 'description' => '号码所属的运营商网络。', + 'type' => 'string', + 'example' => 'CMI', + ], + 'Region' => [ + 'title' => '号码所属地区。', + 'description' => '号码所属地区。', + 'type' => 'string', + 'example' => 'HongKong', + ], + 'Country' => [ + 'title' => '号码所属国家。', + 'description' => '号码所属国家。', + 'type' => 'string', + 'example' => 'China', + ], + ], + ], + 'Message' => [ + 'title' => '短信内容。', + 'description' => '短信内容。', + 'type' => 'string', + 'example' => 'Hello!', + ], + 'ResponseDescription' => [ + 'title' => '短信提交状态的详细描述。', + 'description' => '短信提交状态的详细描述。', + 'type' => 'string', + 'example' => 'The SMS Send Request was accepted', + ], + 'ErrorCode' => [ + 'title' => '短信发送状态码。', + 'description' => '短信发送状态码。', + 'type' => 'string', + 'example' => 'DELIVERED', + ], + 'SendDate' => [ + 'title' => '短信转发给运营商的时间。', + 'description' => '短信转发给运营商的时间。', + 'type' => 'string', + 'example' => 'Mon, 24 Dec 2018 16:58:22 +0800', + ], + 'To' => [ + 'title' => '接收方号码。', + 'description' => '接收方号码。', + 'type' => 'string', + 'example' => '6581xxx810', + ], + 'MessageId' => [ + 'title' => '短信消息ID。', + 'description' => '消息ID。', + 'type' => 'string', + 'example' => '1008030xxx3003', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + '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' => '查询短信发送记录', + 'description' => '### QPS限制'."\n" + .'本接口的单用户（同一个阿里云账号）QPS限制为300次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ConversionData' => [ + 'summary' => '将短信转化率统计数据反馈给阿里云国际短信平台。', + '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' => '转化率观测的时间点。必须是Unix时间戳，毫秒级别长整型。'."\n" + ."\n" + .'>如果不指定该字段：默认当前的时间戳。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1349055900000', + ], + ], + [ + 'name' => 'ConversionRate', + 'in' => 'formData', + 'schema' => [ + 'title' => '转化率监控回报值。该参数取值为double类型 ，区间是[0,1]。', + 'description' => '转化率监控回报值。'."\n" + .'>该参数取值为double类型 ，区间是\\[0,1]。', + 'type' => 'string', + 'required' => true, + 'example' => '0.53', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '接口返回参数。', + 'type' => 'object', + 'properties' => [ + 'ResponseCode' => [ + 'title' => '状态码。返回OK代表请求成功，其他错误码，请参见错误码列表。', + 'description' => '状态码。返回OK代表请求成功，其他错误码，请参见[错误码列表](https://www.alibabacloud.com/help/zh/doc-detail/180674.html)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'ResponseDescription' => [ + 'title' => '状态码描述。', + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + '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' => '转化率数据接入API', + 'description' => '指标说明：'."\n" + ."\n" + .'- OTP发送量：验证码发送量。'."\n" + ."\n" + .'- OTP转化量：验证码转换量。（用户成功获取验证码，并进行回传）'."\n" + ."\n" + .'转化率=OTP转化量/OTP发送量。', + ], + 'SmsConversion' => [ + 'summary' => '将每一条消息ID(MessageId) 对应短信的接收情况反馈给阿里云国际短信平台。', + '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' => '消息ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1008030300****', + ], + ], + [ + 'name' => 'Delivered', + 'in' => 'query', + 'schema' => [ + 'title' => '如果您的用户确认接收到了您发送的消息，例如，回填了短信验证码，则设置为 true。否则，设置为 false。', + 'description' => '如果您的用户回复了您发送的消息，则设置为 true。否则，设置为 false。', + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'ConversionTime', + 'in' => 'query', + 'schema' => [ + 'title' => '触达发送目标的时间戳。必须是Unix时间戳，毫秒级别长整型。'."\n" + ."\n" + .'如果不指定该字段：默认当前的时间戳。'."\n" + .'如果指定该字段：该时间戳必须大于发送时间并且小于当前时间戳。', + 'description' => '触达发送目标的时间戳。必须是Unix时间戳，毫秒级别长整型。'."\n" + ."\n" + .'- 如果不指定该字段：默认当前的时间戳。'."\n" + ."\n" + .'- 如果指定该字段：该时间戳必须大于发送时间并且小于当前时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1349055900000', + ], + ], + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'title' => '短信手机号', + 'description' => '接收方号码。号码格式为：国际区号+号码。'."\n" + ."\n" + .'电话代码详情，请参见[电话代码](~~158400~~)。', + 'type' => 'string', + 'required' => false, + 'example' => '8521245567****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '接口返回参数。', + 'type' => 'object', + 'properties' => [ + 'ResponseCode' => [ + 'title' => '状态码。返回OK代表请求成功，其他错误码，请参见错误码列表。', + 'description' => '状态码。返回OK代表请求成功，其他错误码，请参见[错误码列表](https://www.alibabacloud.com/help/zh/doc-detail/180674.html)。', + 'type' => 'string', + 'example' => 'OK', + ], + 'ResponseDescription' => [ + 'title' => '状态码描述。', + 'description' => '状态码描述。', + 'type' => 'string', + 'example' => 'OK', + ], + 'RequestId' => [ + 'title' => '请求ID。', + 'description' => '请求ID。', + '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' => '短信转化反馈', + 'description' => '指标说明：'."\n" + ."\n" + .'- OTP发送量：验证码发送量。'."\n" + ."\n" + .'- OTP转化量：验证码转换量。（用户成功获取验证码，并进行回传）'."\n" + ."\n" + .'转化率=OTP转化量/OTP发送量。'."\n" + ."\n" + .'> 转化率反馈功能会对业务系统有一定的侵入性，为了防止调用转化率API的抖动影响业务逻辑，请考虑： - 使用异步模式（例如：队列或事件驱动）调用API。 - 添加可降级的方案保护业务逻辑（例如：手动降级开工或者使用断路器自动降级）。', + ], + ], + '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', + ], + ], +]; |