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":{"AddVmsCallBackRequestBody":{"properties":{"callback_url":{"description":"回调地址,必须是http或https开头的字符串,不能为空。\n\n> 建议使用https。\n","maxLength":1000,"minLength":1,"type":"string"},"remark":{"description":"备注。","maxLength":1000,"minLength":0,"type":"string"},"url_type":{"description":"回调类型。\n\n- 0:发送状态回执\n- 1:上行消息回执\n","type":"integer"}},"required":["callback_url","url_type"]},"AddVmsCallBackResponseRsp":{"properties":{"message":{"description":"状态描述。","type":"string"},"status":{"description":"请求状态,固定200。","type":"string"}}},"VmsErrorMsg":{"description":"错误模型。","properties":{"error_code":{"description":"结果状态码。","type":"string"},"error_msg":{"description":"结果详情。","type":"string"}}}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"222384d02bf943cfa7fa55b32dc87229","info_version":"v1","method":"post","name":"AddVmsCallBack","parameters":{},"paths":{"/v1/aim-basic/callbacks":{"post":{"consumes":["application/json"],"description":"用户根据要求创建智能信息基础版回执接口后,可以调用此接口进行注册。\n","operationId":"AddVmsCallBack","parameters":[{"description":"用户Token。通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。","in":"header","maxLength":2000,"minLength":0,"name":"X-Auth-Token","required":true,"type":"string"},{"description":"请求体参数类型,该字段必须设置为:application/json。","in":"header","name":"Content-Type","required":true,"type":"string"},{"description":"注册智能信息基础版回执接口请求体","in":"body","name":"AddVmsCallBackRequestBody","required":true,"schema":{"$ref":"#/definitions/AddVmsCallBackRequestBody"}}],"responses":{"200":{"description":"返回信息。\n","examples":{"application/json":{"message":"success","status":"200"}},"schema":{"$ref":"#/definitions/AddVmsCallBackResponseRsp"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/VmsErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/VmsErrorMsg"}}},"security":[{"apig-auth-iam":[]}],"summary":"注册智能信息基础版回执URL","tags":["VMSSendTask"],"x-apigateway-request-type":"Public","x-is-registered":"Y","x-request-examples-1":{"callback_url":"https://www.xxxx.com/vms/send-callback","remark":"发送状态回执","url_type":0},"x-request-examples-description-1":"注册智能信息基础版发送状态回执接口","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/aim-basic/callbacks","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":"注册智能信息基础版回执URL","tags":"智能信息基础版发送","uri":null,"version":"2.0"}