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":{"AimSaErrorMsg":{"properties":{"error_code":{"description":"错误码。","type":"string"},"error_msg":{"description":"结果详情。","type":"string"}}},"LockPortRequestBody":{"description":"通道号绑定服务号请求体。","properties":{"ext_port_id":{"description":"关联通道号ID,取通道号列表返回的ID。","example":"38083332fd3b472d929d2db28f915548","maxLength":32,"minLength":32,"type":"string"},"port":{"description":"通道号。\n- port_type=5时,长度必须为5\n- port_type=1或3,长度在21位内\n","example":"port","maxLength":21,"minLength":0,"type":"string"},"province":{"description":"绑定的地区,不允许传入重叠地区。地区取值见《地区名称列表》。","example":"广东省","maxLength":500,"minLength":0,"type":"string"},"pub_id":{"description":"服务号ID。","example":"044c1bf88e391204c92746ee502109cb","maxLength":32,"minLength":0,"type":"string"},"sign":{"description":"绑定签名,必须是该端口号签名的子集。单个签名长度为2-18。","example":["测试"],"items":{"type":"string"},"maxItems":5,"minItems":0,"type":"array"}},"required":["ext_port_id","port","province","pub_id","sign"]},"LockPortResponseModel":{"description":"通道号绑定服务号返回返回体。","properties":{"message":{"description":"信息。","example":"成功","type":"string"}}},"LockPortRsp":{"properties":{"data":{"$ref":"#/definitions/LockPortResponseModel"}}}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"50c8d67ba365429d891aa43d0757330f","info_version":"v1","method":"post","name":"LockPort","parameters":{},"paths":{"/v1/aim-sa/ports/associate":{"post":{"consumes":["application/json"],"description":"通道号绑定服务号。","operationId":"LockPort","parameters":[{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","name":"X-Auth-Token","required":true,"type":"string"},{"description":"绑定通道号和服务号的请求体。","in":"body","name":"LockPortDetailsRequestBody","required":false,"schema":{"$ref":"#/definitions/LockPortRequestBody"}},{"description":"请求体参数类型,该字段必须设置为:application/json。","in":"header","name":"Content-Type","required":true,"type":"string"}],"produces":["application/json"],"responses":{"200":{"description":"返回信息。","examples":{"application/json":{"data":{"message":"成功"}}},"schema":{"$ref":"#/definitions/LockPortRsp"}},"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":{"ext_port_id":"a67928a301364aa38d8cf6f08242cccc","port":"8822053111111","province":"福建省","pub_id":"961b0f7d32314b5cb287fc06fe09cccc","sign":["华为云KooMessage"]},"x-request-examples-description-1":"通道号绑定服务号。通道号为\"8822053111111\",服务号ID为\"961b0f7d32314b5cb287fc06fe09cccc\"。","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/aim-sa/ports/associate","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"}