{"base_path":null,"components":null,"consumes":"","definitions":{"AddCallbackRequestBody":{"description":"回调地址请求体。","properties":{"callback_url":{"description":"回调地址。\n\n> - 必须http或https开头,建议使用https\n> - 支持域名或公网IP回调地址,不支持私网IP回调地址\n","example":"https://localhost:8080/test","maxLength":1000,"minLength":1,"type":"string"},"url_type":{"description":"回调类型。\n\n- 0:智能信息单条发送回调\n- 1:模板状态回调\n- 2:智能信息批量发送回调\n","type":"integer"}},"required":["callback_url"],"type":"object"},"AimCallbacksRsp":{"properties":{"data":{"$ref":"#/definitions/Callback"},"message":{"description":"响应信息。","example":"success","type":"string"},"status":{"description":"状态码。","example":"200","type":"string"}}},"AimErrorMsg":{"description":"错误模型。","properties":{"error_code":{"description":"结果状态码。","type":"string"},"error_message":{"description":"结果详情。\n\n> 该字段在以后可能会废弃,建议使用error_msg字段对接。\n"},"error_msg":{"description":"结果详情。","type":"string"}}},"Callback":{"description":"注册详情。","properties":{"callback_url":{"description":"回调地址。","example":"https://localhost:8080/test","type":"string"},"id":{"description":"注册回调的唯一标识ID。","example":"1bf6bb05-faa0-4451-8512-80b8e40c8785","type":"string"},"url_type":{"description":"回调类型。\n\n- 0:智能信息单条发送回调\n- 1:模板状态回调\n- 2:智能信息批量发送回调\n","type":"integer"}},"type":"object"}},"description":null,"group_id":"57a445a5fb5d4ba5b80445bd4c5ec9b3","host":"koomessage.myhuaweicloud.cn","id":"35f5e484f1b34926b1e58dd86e921dc0","info_version":"v1","method":"post","name":"AddCallBack","parameters":{},"paths":{"/v1/aim/callbacks":{"post":{"description":"用户根据要求创建回执接口后,可以调用此接口进行注册,注意:此接口仅允许te_admin角色用户调用。","operationId":"AddCallBack","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":"AddCallbackRequestBody","required":true,"schema":{"$ref":"#/definitions/AddCallbackRequestBody"}}],"responses":{"200":{"description":"返回信息。\n","examples":{"application/json":{"data":{"callback_url":"https://www.xxxx.com/v1/send-resolve-status","id":"18d1bcad-4d13-4db1-bcdd-32565457cccc"},"message":"success","status":"200"}},"schema":{"$ref":"#/definitions/AimCallbacksRsp"}},"400":{"description":"非法参数。","schema":{"$ref":"#/definitions/AimErrorMsg"}},"500":{"description":"内部错误。","schema":{"$ref":"#/definitions/AimErrorMsg"}}},"schemes":["https"],"security":[{"apig-auth-iam":[]}],"summary":"注册智能信息回执URL","tags":["AIMCallBack"],"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-request-examples-1":{"callback_url":"https://www.xxxx.com/v1/send-resolve-status","url_type":0},"x-request-examples-2":{"callback_url":"https://www.xxxx.com/v1/template-status","url_type":1},"x-request-examples-3":{"callback_url":"https://www.xxxx.com/v1/template-status","url_type":2},"x-request-examples-description-1":"注册回执-智能信息单条发送回执","x-request-examples-description-2":"注册回执-智能信息模板状态回执","x-request-examples-description-3":"注册回执-智能信息批量发送回执","x-request-examples-url-1":"https://koomessage.myhuaweicloud.cn/v1/aim/callbacks","x-request-examples-url-2":"https://koomessage.myhuaweicloud.cn/v1/aim/callbacks","x-request-examples-url-3":"https://koomessage.myhuaweicloud.cn/v1/send-resolve-status","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"}