文档首页/ 云消息服务 KooMessage/ API参考/ API/ 智能信息基础版模板/ 定义智能信息基础版模板状态回执
更新时间:2024-11-22 GMT+08:00
分享

定义智能信息基础版模板状态回执

功能介绍

用户按接口定义实现智能信息基础版模板状态回执接口。

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

URI

POST /v1/aim-basic/template-status

请求参数

表1 请求Body参数

参数

是否必选

参数类型

描述

tpl_id

String

智能信息基础版模板ID。

tpl_size

String

智能信息基础版模板的大小。

说明:

单位:字节,audit_status非0时tpl_size为0。

valid_time

String

模板截止有效日期,格式:yyyy-MM-ddTHH:mm:ssZ,0:表示永久有效。样例:2020-01-31T23:59:59Z。

audit_state

String

智能信息基础版模板审核状态。

  • 0:正常可用

  • 1:审核中

  • 2:审核不通过

  • 3:模板已禁用

  • 4:模板不存在

  • 5:模板已过期

audit_desc

String

智能信息基础版模板状态的描述,若状态是审核不通过或被禁用,描述表示的是不通过或禁用的原因。

说明:

长度不超过 1024 字。

status_detail

Array of StatusDetail objects

运营商的模板状态详情。

preview_url

String

智能信息基础版模板预览地址。

tpl_name

String

智能信息基础版模板名称。

title

String

智能信息基础版模板主题。

tpl_sign

String

智能信息基础版模板签名。

create_time

String

智能信息基础版模板创建时间,格式:yyyy-MM-ddTHH:mm:ssZ。

var_info

Array of VarInfo objects

智能信息基础版模板动参信息,静态模板没有动参,该字段填空。

restags

String

资源分配标签,取值如下:

  • 三网一般

  • 三网抗诉

  • 单网一般

  • 单网抗诉

表2 StatusDetail

参数

是否必选

参数类型

描述

carrier

String

运营商类型。

  • cmcc:中国移动

  • cucc:中国联通

  • ctcc:中国电信

  • oversea:港澳台及国外

  • unknown:未知

status

String

模板状态。

  • 0:正常可用

  • 1:审核中

  • 2:审核不通过

  • 3:模板已禁用

  • 4:模板不存在

  • 5:模板已过期

desc

String

对模板状态的描述。

说明:

若状态是审核不通过或被禁用,描述表示的是不通过或禁用的原因。

表3 VarInfo

参数

是否必选

参数类型

描述

name

String

动参变量占位符名称。

说明:

格式:#p_N#(N表示第几个参数,与模板文件占位名称保持一致),如:#p_1#。

type

String

动参变量类型。类型为文字:txt。

响应参数

请求示例

智能信息基础版模板状态回执。模板ID为"800000001",模板截止有效日期为"20200131",模板审核状态正常可用;运营商审核正常可用为"cucc",模板已过期为"cmcc",审核不通过为"ctcc"。

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

{
  "tpl_id" : "800000001",
  "tpl_size" : 102311,
  "valid_time" : 20200131,
  "audit_state" : 0,
  "restags" : "三网一般",
  "audit_desc" : "正常可用",
  "status_detail" : [ {
    "carrier" : "cmcc",
    "status" : 5,
    "desc" : "正常可用"
  }, {
    "carrier" : "cucc",
    "status" : 0,
    "desc" : "正常可用"
  }, {
    "carrier" : "ctcc",
    "status" : 2,
    "desc" : "审核不通过,携带敏感词汇"
  } ],
  "preview_url" : "http://example.com/000001",
  "tpl_name" : "模板名称",
  "title" : "模板主题",
  "tpl_sign" : "华为云消息",
  "create_time" : "2022-01-01T00:00:00Z",
  "var_info" : [ {
    "name" : "#p_1#",
    "type" : "txt"
  }, {
    "name" : "#p_2#",
    "type" : "txt"
  } ]
}

响应示例

状态码

状态码

描述

200

返回信息。

错误码

请参见错误码

相关文档