更新时间:2024-11-22 GMT+08:00
分享

定义模板状态回执

功能介绍

用户按接口定义实现模板状态回执接口。

响应参数仅供参考,客户可以返回任意响应消息给平台,平台不会对响应消息处理。

URI

POST /v1/aim/template-status

请求参数

表1 请求Header参数

参数

是否必选

参数类型

描述

Content-Type

String

请求体参数类型,该字段必须设置为:application/json。

表2 请求Body参数

参数

是否必选

参数类型

描述

tpl_id

String

智能信息模板ID。

说明:

智能短信平台生成的模板ID,由9位数字组成。

tpl_state

Integer

模板状态。

说明:
  • 0:禁用

  • 1:启用

audit_state

Integer

审核状态。

  • 2:审核通过

  • 3:审核未通过

说明:
  • 模板提交审核后,为了方便客户尽快使用,只需要超过1个厂商激活,模板即可审核通过。

  • 模板审核通过后,如果手机厂商激活状态发生变化,会再次推送模板审核状态信息,可根据factory_info来获取手机厂商当前的激活状态。

factory_info

Array of FactoryInfo objects

各终端厂商的审核状态。

audit_desc

String

审核意见。

表3 FactoryInfo

参数

是否必选

参数类型

描述

factory_type

String

厂商类型。

  • HuaWei:表示华为厂商

  • XiaoMi:表示小米厂商

  • OPPO:表示OPPO厂商

  • VIVO:表示VIVO厂商

  • MEIZU:表示魅族厂商

  • SAMSUNG:表示三星厂商

state

Integer

厂商审核状态。

  • 0:禁用

  • 1:启用

  • 2:未启用

响应参数

请求示例

模板状态回执。设置模板状态为启用,审核通过,厂商审核启用为"HuaWei",未启用为"XiaoMi",禁用为"MEIZU"。

https://koomessage.myhuaweicloud.cn/v1/aim/template-status

{
  "tpl_id" : "600000001",
  "tpl_state" : 1,
  "audit_state" : 2,
  "audit_desc" : "审核通过",
  "factory_info" : [ {
    "factory_type" : "HuaWei",
    "state" : 1
  }, {
    "factory_type" : "XiaoMi",
    "state" : 2
  }, {
    "factory_type" : "MEIZU",
    "state" : 0
  } ]
}

响应示例

状态码

状态码

描述

200

返回信息。

错误码

请参见错误码

相关文档