文档首页/ 云消息服务 KooMessage/ API参考/ API/ 智能信息服务号资料/ 冻结服务号
更新时间：2024-11-22 GMT+08:00
查看PDF
分享

冻结服务号

功能介绍

支持用户通过此接口冻结服务号。

URI

POST /v1/aim-sa/pubs/{pub_id}/freeze

表1 路径参数

参数

是否必选

参数类型

描述

pub_id

是

String

服务号ID。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。

Content-Type

是

String

请求体参数类型，该字段必须设置为：application/json。
表3 请求Body参数

参数

是否必选

参数类型

描述

change_reason

是

String

冻结原因。

最小长度：1

最大长度：200

响应参数

状态码： 200

表4 响应Body参数

参数

参数类型

描述

data

data object

请求成功返回的数据，为JSON格式。

数组长度：0 - 2147483647
表5 data

参数

参数类型

描述

pub_id

String

服务号ID。

状态码： 400

表6 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

结果详情。

状态码： 500

表7 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

结果详情。

请求示例

根据服务号ID冻结服务号。设置冻结原因为"服务号冻结"。

https://koomessage.myhuaweicloud.com/v1/aim-sa/pubs/11da778df5e14096b0220ee2c279cccc/freeze

{
  "change_reason" : "服务号冻结"
}

响应示例

状态码： 200

返回信息。

{
  "data" : {
    "pub_id" : "11da778df5e14096b0220ee2c279cccc"
  }
}

状态码

状态码

描述

200

返回信息。

400

非法参数。

500

内部错误。

错误码

请参见错误码。

相关文档