获取短信模板清单

更新时间:2023-06-20 12:39:05下载pdf

本文介绍获取短信模板清单的 API。

接口描述

获取短信模板清单

接口地址

GET: /v1.0/iot-03/msg-templates/sms

请求参数

参数名类型参数位置是否必填说明
page_noIntegerqueryfalse分页参数,第 n 页(不传默认查第一页)
page_sizeIntegerqueryfalse查询分页的数量(不传默认为10)
sortIntegerqueryfalse排序字段(0:创建时间升序,1:创建时间降序,不传默认按创建时间降序)

返回参数

参数名类型说明
resultTemplatesListRes

result 说明

参数名类型说明
totalLong模板清单总数量
listList模板清单列表
has_moreBoolean是否还有下一页

has_more 说明

参数名类型说明
template_idString模板id
nameString模板名称(长度为1~40个字符)
contentString模板内容(长度为1~60个字符)
statusInteger模板审核状态,0:审核中,1:审核通过,2:审核未通过

请求示例

GET: /v1.0/iot-03/msg-templates/sms?page_no=1&page_size=10&sort=1
?page_no=1&page_size=10&sort=1

返回示例

{
    "result": {
        "list": [
            {
                "content": "您正在申请注册,验证码为:${code},5分钟内有效!",
                "name": "短信验证码",
                "template_id": "a5s59kn**",
                "status": 1
            }
        ],
        "total": 1,
        "has_more": false
    },
    "t": 1586153261345,
    "success": true
}

错误码

参考 错误码