huawei-cloud-api-definitions-KooMessage 0.1.20240202

Huawei Cloud API definitions, generated from OpenAPI spec
Documentation
1
{"base_path":null,"components":null,"consumes":"","definitions":{"AimSaErrorMsg":{"properties":{"error_code":{"description":"错误码。","type":"string"},"error_msg":{"description":"结果详情。","type":"string"}}},"RegisterPortRequestBody":{"description":"通道号登记请求体。","properties":{"authorization_files":{"description":"授权证明图片资源,最多支持5张。参数格式为:*资源ID:资源URL*,样例:3d214a61672846f88ad77597f935cccc:AimSauploadService/272957b708ac4891a6d5282ccd2175cccc.png。\n> 资源ID与资源URL对应上传智能信息服务号图片资源API返回的resource_id和resource_url。","example":["b16023e2e7c24418aa6b4e471d6b78b8:http://www.xxxx.com","da916e86576d43f1895ffa0f233f5cb2:http://www.xxxx.com"],"items":{"example":"324","type":"string"},"maxItems":5,"minItems":0,"type":"array"},"port":{"description":"通道号。\n- port_type=5时 ,长度必须为5\n- port_type=1或3,长度在21位内\n","example":"6e954dcb2ab54763b0d85ffd6bdf1ae18","maxLength":21,"minLength":0,"type":"string"},"port_type":{"description":"通道号类型。\n- 1:普通\n- 3:前缀号段\n- 5:后缀号段\n","example":1,"maximum":5,"minimum":1,"type":"integer"},"sign":{"description":"签名列表,最大长度为5。单个签名长度为2-18。","example":[123],"items":{"example":"123","maxLength":18,"minLength":2,"type":"string"},"maxItems":5,"minItems":0,"type":"array"},"sign_check":{"description":"是否需要校验。\n\n- 0:不校验 \n- 1:校验签名\n\n> 当port_type为3或者5时,sign_check必须为1。\n","example":1,"format":"int32","maximum":1,"minimum":0,"type":"integer"}},"required":["authorization_files","port","port_type","sign","sign_check"]},"RegisterPortResponseModel":{"description":"登记通道号返回体。","properties":{"data":{"$ref":"#/definitions/RegisterResult","description":"返回数据。"}}},"RegisterPortRsp":{"properties":{"data":{"$ref":"#/definitions/RegisterPortResponseModel"}}},"RegisterResult":{"description":"请求成功返回的数据。","properties":{"port":{"description":"通道号。\n","example":"1114","type":"string"},"port_type":{"description":"通道号类型。\n- 1:普通\n- 3:前缀号段\n- 5:后缀号段\n","example":1,"type":"integer"},"sign":{"description":"签名列表,最大长度为5。","example":"[test123]","items":{"example":"test124","type":"string"},"maxItems":5,"minItems":0,"type":"array"}}}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"84ae436a1a2141edb97b1382aa33b3ea","info_version":"v1","method":"post","name":"RegisterPort","parameters":{},"paths":{"/v1/aim-sa/ports":{"post":{"consumes":["application/json"],"description":"注册通道号。","operationId":"RegisterPort","parameters":[{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":false,"type":"string"},{"description":"请求体。","in":"body","name":"RegisterPortRequestBody","required":false,"schema":{"$ref":"#/definitions/RegisterPortRequestBody"}},{"description":"请求体参数类型,该字段必须设置为:application/json。","in":"header","name":"Content-Type","required":true,"type":"string"}],"responses":{"200":{"description":"返回信息。","examples":{"application/json":{"data":{"data":{"port":"8822053111111","port_type":1,"sign":["华为云KooMessage"]}}}},"schema":{"$ref":"#/definitions/RegisterPortRsp"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/AimSaErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/AimSaErrorMsg"}}},"security":[{"apig-auth-iam":[]}],"summary":"注册通道号","tags":["AimSaPort"],"x-apigateway-request-type":"Public","x-is-registered":"Y","x-request-examples-1":{"authorization_files":["3d214a61672846f88ad77597f935cccc:AimSauploadService/272957b708ac4891a6d5282ccd2175cccc.png"],"port":"8822053111111","port_type":1,"sign":["华为云KooMessage"],"sign_check":0},"x-request-examples-description-1":"注册智能信息服务号通道号。设置通道号为\"8822053111111\",普通类型,不校验签名。","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/aim-sa/ports","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"}