huawei-cloud-api-definitions-KooMessage 0.1.20240404

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"","definitions":{"Page":{"description":"分页信息。","properties":{"limit":{"description":"每页显示的条目数量。","example":20,"type":"integer"},"offset":{"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。","example":1,"type":"integer"},"total":{"description":"总条数。","example":222,"type":"integer"}}},"SmsErrorMsg":{"description":"错误模型。","properties":{"error_code":{"description":"结果状态码。","maxLength":32,"minLength":0,"type":"string"},"error_msg":{"description":"结果详情。","maxLength":32,"minLength":0,"type":"string"}},"type":"object"},"SmsPageResponse2":{"description":"短信记录查询结果。","properties":{"page_info":{"$ref":"#/definitions/Page","description":"分页信息。"},"result":{"description":"查询结果。","items":{"$ref":"#/definitions/SmsSignatureInfo"},"type":"array"}},"type":"object"},"SmsSignatureInfo":{"description":"查询短信签名详情返回体。","properties":{"app_id":{"description":"应用ID。","maxLength":50,"minLength":1,"type":"string"},"app_name":{"description":"应用名称。","maxLength":30,"minLength":1,"type":"string"},"apply_desc":{"description":"申请说明。","maxLength":100,"minLength":0,"type":"string"},"channel_num":{"description":"国内短信通道号,仅当签名审核成功,运营人员配置完成后返回。","maxLength":21,"minLength":1,"type":"string"},"create_time":{"description":"创建时间。","maxLength":20,"minLength":1,"type":"string"},"file_id":{"description":"营业执照文件ID。","maxLength":50,"minLength":1,"type":"string"},"is_involved_third":{"description":"是否涉及第三方权益。","type":"string"},"power_attorney_file_id":{"description":"授权委托书文件ID。","maxLength":50,"minLength":1,"type":"string"},"review_desc":{"description":"审核意见。","maxLength":500,"minLength":0,"type":"string"},"signature_id":{"description":"签名ID。","maxLength":50,"minLength":1,"type":"string"},"signature_name":{"description":"签名名称。","maxLength":30,"minLength":1,"type":"string"},"signature_source":{"description":"签名来源。","maximum":20,"minimum":0,"type":"integer"},"signature_type":{"description":"签名类型。","maxLength":20,"minLength":1,"type":"string"},"source_title_content":{"description":"标题内容。","maxLength":180,"minLength":1,"type":"string"},"status":{"description":"状态。","enum":["PENDING_REVIEW:待审核","PROCESSING:内容审核通过签名在处理中","REVIEW_PASSED:处理完毕","REVIEW_NOT_PASS:审核不通过","TO_BE_ACTIVATED:待激活","PENDING_ACTIVATE:激活审核中"],"type":"string"},"urge_desc":{"description":"催审描述。","maxLength":64,"minLength":0,"type":"string"},"urge_status":{"description":"催审状态。","maxLength":20,"minLength":1,"type":"string"},"urge_time":{"description":"催审时间。","maxLength":20,"minLength":1,"type":"string"}},"type":"object"}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"966d50ecc7314d23805d3c4cf6ec9e5c","info_version":"v1","method":"get","name":"ListAimMsgSignature","parameters":{},"paths":{"/v1/sms/signatures":{"get":{"description":"该接口用于用户查询已创建的短信签名。","operationId":"ListAimMsgSignature","parameters":[{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"应用名称。","in":"query","name":"app_name","required":false,"type":"string"},{"description":"签名ID。","in":"query","name":"signature_id","required":false,"type":"string"},{"description":"签名名称。","in":"query","name":"signature_name","required":false,"type":"string"},{"description":"签名类型。","in":"query","name":"signature_type","required":false,"type":"string"},{"description":"开始时间。","in":"query","name":"begin_time","required":false,"type":"string"},{"description":"结束时间。","in":"query","name":"end_time","required":false,"type":"string"},{"description":"状态。","in":"query","name":"status","required":false,"type":"string"},{"description":"每页显示的条目数量。","format":"int32","in":"query","name":"limit","required":false,"type":"integer"},{"description":"偏移量,表示从此偏移量开始查询,offset大于等于0。","in":"query","name":"offset","required":false,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"返回信息。","examples":{"application/json":{"page_info":{"limit":10,"offset":0,"total":1},"result":[{"app_id":"2353cb25-c169-4e20-adcf-3****b4e0f9e","app_name":"Huawei_12688","apply_desc":"203测试","channel_num":"882308042****","create_time":"2023-08-07T02:28:45","file_id":"c2d3613c-2864-48ce-8de6-db****23ad32","is_involved_third":"no","power_attorney_file_id":null,"review_desc":null,"signature_id":"23a73eef-0790-49e4-9735-7****27a3bc5","signature_name":"签名创建测试5555","signature_source":0,"signature_type":"PROMOTION_TYPE","source_title_content":"","status":"PENDING_REVIEW","urge_desc":null,"urge_status":null,"urge_time":null}]}},"schema":{"$ref":"#/definitions/SmsPageResponse2"}},"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":"GET","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":1,"x-request-examples-description-1":"查询应用Huawei_12688下审核通过的短信签名。","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/sms/signatures?app_name=Huawei_12688&status=REVIEW_PASSED","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"}