huawei-cloud-api-definitions-MSGSMS 0.1.20250110

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":"/","components":null,"consumes":"[\"application/json\"]","definitions":{"ApiSignatureResponse":{"properties":{"id":{"description":"签名主键ID","example":"07cfacbb-d48c-4c4d-b3da-baa8e4664852","maxLength":64,"minLength":1,"type":"string"},"signature_id":{"description":"签名ID","example":"******d1-196f-495f-abbe-42240469b8fc","maxLength":64,"minLength":1,"type":"string"},"signature_name":{"description":"签名名称","example":"auto_test789","maxLength":32,"minLength":1,"type":"string"}},"title":"ApiSignatureResponse"},"SmsSignatureReq":{"properties":{"app_id":{"description":"应用主键ID","example":"9e61f59c-1a6b-4ee5-9651-5bca450694b3","maxLength":64,"minLength":1,"type":"string"},"apply_desc":{"description":"申请说明","example":"test","maxLength":100,"minLength":0,"type":"string"},"file_id":{"description":"营业执照文件ID","example":"057a76ab-1390-4268-9463-73db98cdc2e1","maxLength":64,"minLength":1,"type":"string"},"is_involved_third":{"description":"是否涉及第三方权益\n1. Yes: 是\n2. No: ","example":"No","maxLength":16,"minLength":1,"type":"string","x-annotations":"@NotBlank"},"power_attorney_fileid":{"description":"授权委托书文件ID","example":"057a76ab-1390-4268-9463-73db98cdc2e2","maxLength":128,"minLength":1,"type":"string"},"qualification_id":{"description":"资质ID ,当前考虑存量应用的接口兼容性,代码未做强制校验,但创建签名时请务必携带资质ID,否则会导致资质审核失败","maxLength":64,"minLength":0,"pattern":"^$|^[A-Za-z0-9_-]+$","type":"string"},"signature_name":{"description":"签名名称","example":"auto_test789","maxLength":32,"minLength":1,"type":"string","x-annotations":"@NotBlank"},"signature_source":{"description":"签名来源。支持枚举值:\n1. 0:企事业单位的全称或简称\n2. 1:工信部备案网站的全称或简称\n3. 2: APP应用的全称或简称\n4. 3:公众号或小程序的全称或简称\n5. 4:电商平台店铺名的全称或简称\n6. 5:商标名的全称或简称","example":0,"format":"int32","maximum":2147483647,"minimum":0,"type":"integer"},"signature_type":{"description":"签名类型。支持枚举值:\n1. VERIFY_CODE_TYPE: 验证码类\n2. PROMOTION_TYPE: 推广类\n3. NOTIFY_TYPE: 通知类","example":"NOTIFY_TYPE","maxLength":64,"minLength":1,"type":"string","x-annotations":"@NotBlank"},"source_title_content":{"description":"签名来源标题内容","maxLength":512,"minLength":0,"type":"string"}},"required":["app_id","is_involved_third","signature_name","signature_source","signature_type"],"title":"SmsSignatureReq"}},"description":null,"group_id":"6ec12426d3234d80b6da21f8367b6607","host":"msgsms.cn-north-4.myhuaweicloud.com","id":"ac8a2e2d7e0744d88ac6384d969137ce","info_version":"v2","method":"post","name":"CreateSignature","parameters":{"Content-Type":{"default":"application/json;charset=utf8","description":"请求体参数类型,该字段必须设置为:application/json;charset=utf8","in":"header","maxLength":255,"minLength":1,"name":"Content-Type","required":true,"type":"string","x-example":"application/json;charset=utf8"},"X-Auth-Token":{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)","in":"header","maxLength":32768,"minLength":1,"name":"X-Auth-Token","required":true,"type":"string","x-example":"******JKoZIhvcNAQcCoIIDgzCCXXXXX"},"project_id":{"description":"项目ID。获取方法请参见 [获取帐号、用户、项目的名称和ID](https://support.huaweicloud.com/api-msgsms/sms_05_0020.html)。","in":"path","name":"project_id","pattern":"^[a-fA-F0-9]{1,32}$","required":true,"type":"string","x-example":"******c55c3c4526b2ed7a0213bc9871"}},"paths":{"/v2/{project_id}/msgsms/signatures":{"post":{"consumes":["application/json"],"deprecated":false,"description":"该接口用于用户创建签名。","operationId":"CreateSignature","parameters":[{"$ref":"#/parameters/X-Auth-Token"},{"$ref":"#/parameters/Content-Type"},{"$ref":"#/parameters/project_id"},{"description":"请求Body参数","in":"body","name":"CreateSignatureRequestBody","required":true,"schema":{"$ref":"#/definitions/SmsSignatureReq"}}],"produces":["*/*"],"responses":{"200":{"description":"OK","schema":{"$ref":"#/definitions/ApiSignatureResponse"}},"201":{"description":"Created"},"401":{"description":"Unauthorized"},"403":{"description":"Forbidden"},"404":{"description":"Not Found"}},"schemes":["https"],"summary":"创建短信签名","tags":["SignatureManagement"],"x-api-type":"open-api","x-imports":["com.huawei.cloud.common.RestrictCheck;","com.huawei.cloud.common.operation.*;","com.huawei.cloud.common.log.SourceType;","static com.huawei.cloud.common.restrictcheck.RestrictFrozenType.*;"],"x-internal":false,"x-is-registered":"Y","x-methodAnnotations":["@Operation(name = \"用户添加签名\", action = OperateType.ADD, resource = \"console.root.message.signatures\", requireLog = true, source = SourceType.API)","@RestrictCheck(serviceType = \"hws.service.type.rtcsms\", restrictScene = {TENANT_RESTRICT, TENANT_FROZEN, SERVICE_FROZEN})"],"x-service":"messageService","x-support-sdk":"Y"}}},"product_short":"MSGSMS","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":null,"summary":"创建短信签名","tags":"短信签名API","uri":null,"version":"2.0"}