huawei-cloud-api-definitions-KooMessage 0.1.20260108

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"","definitions":{"AimErrorMsg":{"description":"错误模型。","properties":{"error_code":{"description":"结果状态码。","type":"string"},"error_message":{"description":"结果详情。\n\n> 该字段在以后可能会废弃,建议使用error_msg字段对接。\n"},"error_msg":{"description":"结果详情。","type":"string"}}},"CheckMobileCapabilityRequestBody":{"description":"校验AIM能力消息体。","properties":{"encryption_alg":{"description":"加密类型。\n\n- NONE:不加密\n- SHA1:使用SHA1加密算法加密\n\n> 默认为NONE。\n","type":"string"},"mobiles":{"description":"待查询的手机号码,一次最多请求100个。\n\n>不加密时,参数可传入纯手机号或国家码加手机号,国家码不带“+”号,例如国内手机号“131****0000”,参数可传入“131****0000”、“86131****0000”、“0086131****0000”。使用SHA1加密,mobiles传入号码国家码与手机号码的SHA1算法后的摘要,国家码格式为纯数字,不带“+”,去掉前面的0,例如国内手机号“131****0000”,使用“86131****0000”进行SHA1加密。\n","example":["130****0000"],"items":{"maxLength":40,"minLength":1,"type":"string"},"maxItems":100,"minItems":1,"type":"array"},"tpl_id":{"description":"智能信息模板ID,由9位数字组成。\n> - 填写时,根据该模板所支持的厂商返回手机终端展示智能信息的能力状态\n> - 不填则返回手机终端在所有厂商展示智能信息的能力状态\n","example":"6000001","maxLength":32,"minLength":0,"type":"string"}},"required":["mobiles"]},"CheckMobileCapabilityRsp":{"description":"校验AIM能力消息体。","properties":{"supported_mobiles":{"description":"支持智能信息手机号码列表。","items":{"type":"string"},"type":"array"},"tpl_id":{"description":"智能信息模板ID,由9位数字组成。\n","example":"6000001","type":"string"},"unsupported_mobiles":{"description":"不支持智能信息手机号码列表。","items":{"type":"string"},"type":"array"}}}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"595e90f7fa47442ab60ff72bc4d38749","info_version":"v1","method":"post","name":"CheckMobileCapability","parameters":{},"paths":{"/v1/aim/mobile-capabilities/check":{"post":{"consumes":["application/json"],"description":"用户在下发智能信息前,通过此接口批量查询对应手机的智能信息解析能力。","operationId":"CheckMobileCapability","parameters":[{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"请求体参数类型,该字段必须设置为:application/json。","in":"header","name":"Content-Type","required":true,"type":"string"},{"description":"智能信息能力查询报文。","in":"body","name":"CheckMobileCapabilityRequestBody","required":true,"schema":{"$ref":"#/definitions/CheckMobileCapabilityRequestBody"}}],"produces":["application/json"],"responses":{"200":{"description":"返回信息。","examples":{"application/json":{"supported_mobiles":["131****0000"],"tpl_id":"600000001","unsupported_mobiles":["131****0001"]}},"schema":{"$ref":"#/definitions/CheckMobileCapabilityRsp"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/AimErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/AimErrorMsg"}}},"summary":"查询手机号智能信息解析能力","tags":["AIMResolveTask"],"x-apigateway-request-type":"Public","x-is-registered":"Y","x-opseverity":"Info","x-request-examples-1":{"encryption_alg":"NONE","mobiles":["131****0000","131****0001"],"tpl_id":"600000001"},"x-request-examples-2":{"encryption_alg":"SHA1","mobiles":["de005a80a77f52080d7c67c65ba8663e5b0f0be1","1837ec7308eb38494fda35da8a34038ab7533e6a"],"tpl_id":"600000001"},"x-request-examples-description-1":"检查手机号智能信息解析能力-原始手机号。模板ID为\"600000001\",手机号码不加密。","x-request-examples-description-2":"检查手机号智能信息解析能力-SHA1加密。模板ID为\"600000001\",加密方式为\"SHA1\"。","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/aim/mobile-capabilities/check","x-request-examples-url-2":"https://koomessage.myhuaweicloud.cn/v1/aim/mobile-capabilities/check","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"}