{"base_path":null,"components":null,"consumes":"","definitions":{"SignatureRequest":{"description":"短信签名请求体。","properties":{"app_id":{"description":"短信应用ID。","example":"81a72bf6-8555-4bd3-87c3-40faf821e36b","maxLength":50,"minLength":1,"type":"string"},"apply_desc":{"description":"申请说明。","maxLength":80,"minLength":0,"type":"string"},"file_id":{"description":"营业执照文件ID。调用上传申请文件接口获取。","example":"xxxxxxxx-c074-4a0b-8184-c29c4394f1eb","maxLength":50,"minLength":1,"type":"string"},"is_involved_third":{"description":"是否涉及第三方权益。若为yes,则还需要传入授权委托书。","enum":["yes:涉及","no:不涉及"],"example":"no","maxLength":10,"minLength":1,"type":"string"},"power_attorney_file_id":{"description":"授权委托书文件ID。调用上传申请文件接口获取。","maxLength":50,"minLength":1,"type":"string"},"signature_name":{"description":"签名名称。","example":"新应用SKU签名","maxLength":16,"minLength":2,"type":"string"},"signature_source":{"description":"签名来源。","enum":["0:企事业单位的全称或简称","1:工信部备案网站的全称或简称","2:APP应用的全称或简称","3:公众号或小程序的全称或简称","4:电商平台店铺名的全称或简称","5:商标名的全称或简称"],"example":0,"type":"integer"},"signature_type":{"description":"签名类型。","enum":["PROMOTION_TYPE:营销类","NOTIFY_TYPE:通知类"],"example":"NOTIFY_TYPE","maxLength":20,"minLength":1,"type":"string"},"source_title_content":{"description":"签名来源标题内容,填写内容需和签名来源对应,具体如下。\n- 网站域名:仅当“签名来源”为“工信部备案网站的全称或简称”时,需要输入工信部备案网站域名,如huawei.com。\n- APP应用下载地址:仅当“签名来源”为“APP应用的全称或简称”时,需要填写。\n- 公众号或者小程序的全称:仅当“签名来源”为“公众号或小程序的全称或简称”时,需要填写。\n- 电商平台店铺地址:仅当“签名来源”为“电商平台店铺名的全称或简称”时,需要填写。","maxLength":180,"minLength":1,"type":"string"}},"required":["signature_name","signature_type","app_id","file_id","signature_source","is_involved_third"],"type":"object"},"SmsErrorMsg":{"description":"错误模型。","properties":{"error_code":{"description":"结果状态码。","maxLength":32,"minLength":0,"type":"string"},"error_msg":{"description":"结果详情。","maxLength":32,"minLength":0,"type":"string"}},"type":"object"},"SmsSignatureVo":{"description":"短信签名返回体。","properties":{"signature_id":{"description":"签名ID。","type":"string"},"signature_name":{"description":"签名名称。","type":"string"}},"type":"object"}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"0924bbfc752e4ec285d99318d8163fae","info_version":"v1","method":"post","name":"AddAimMsgSignature","parameters":{},"paths":{"/v1/sms/signatures":{"post":{"consumes":["application/json"],"description":"该接口用于用户创建短信签名。","operationId":"AddAimMsgSignature","parameters":[{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"创建短信签名请求体。","in":"body","name":"AddAimMsgSignatureRequestBody","required":true,"schema":{"$ref":"#/definitions/SignatureRequest"}}],"produces":["application/json"],"responses":{"200":{"description":"创建短信签名响应体。","examples":{"application/json":{"signature_id":"fc0c9b20-cbe0-4e95-a166-2897****bd34","signature_name":"API创建测试签名"}},"schema":{"$ref":"#/definitions/SmsSignatureVo"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/SmsErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/SmsErrorMsg"}}},"schemes":["https"],"security":[{"apig-auth-iam":[]}],"summary":"创建短信签名","tags":["AimSmsSignature"],"x-api-type":"open-api","x-apigateway-backend":{"httpVpcEndpoints":{"description":"","method":"POST","name":"lb-km-aim","path":"/v1/sms/signatures","scheme":"https","timeout":30000},"type":"HTTP-VPC"},"x-apigateway-cors":false,"x-apigateway-match-mode":"NORMAL","x-apigateway-query-string-encode":"ENABLE","x-apigateway-request-type":"public","x-is-registered":"Y","x-order":0,"x-request-examples-1":{"app_id":"36d93093-8941-4969-82e8-*****9b276","apply_desc":"签名申请说明","file_id":"cec80a6b-95b6-405b-bbab-*****2a022","is_involved_third":"no","signature_name":"API创建测试签名","signature_source":0,"signature_type":"NOTIFY_TYPE"},"x-request-examples-description-1":"创建一个名称为\"API创建测试签名\",类型为通知类的短信签名。","x-request-examples-text-1":{"app_id":"36d93093-8941-4969-82e8-*****9b276","apply_desc":"签名申请说明","file_id":"cec80a6b-95b6-405b-bbab-*****2a022","is_involved_third":"no","signature_name":"API创建测试签名","signature_source":0,"signature_type":"NOTIFY_TYPE"},"x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/sms/signatures","x-support-sdk":"Y"}}},"product_short":"KooMessage","region_id":"cn-north-4","schemes":["HTTPS"],"security_definitions":{"apig-auth-app":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-type":"AppSigv1"},"apig-auth-app-optional":{"in":"header","name":"Authorization","type":"apiKey","x-apigateway-auth-opt":{"access-auth-type":"optional"},"x-apigateway-auth-type":"AppSigv1"},"apig-auth-iam":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM"},"apig-auth-iam-none":{"in":"header","name":"unused","type":"apiKey","x-apigateway-auth-type":"IAM_NONE"}},"summary":"创建短信签名","tags":"短信签名","uri":null,"version":"2.0"}