文档首页 > > API参考> API> 短信操作> 查询短信模板

查询短信模板

分享
更新时间: 2019/07/08 GMT+08:00

功能介绍

  • 接口名称

    ListSmsTemplates

  • 功能描述

    查询短信模板列表。

URI

  • URI格式

    GET /v2/{project_id}/notifications/sms_template?offset={offset}&limit={limit}

  • 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID

    获取项目ID请参考获取项目ID

    offset

    int

    偏移量

    偏移量为一个大于0小于资源总个数的整数,表示查询该偏移量后面的所有的资源数,默认值为0。

    limit

    int

    一次返回列表的最大条目数。

    limit大于0且不大于100。

    sms_template_name

    String

    短信模板名称

    长度不得超过64个字符。

    sms_template_type

    int

    短信模板类型

    说明:

    0表示验证码通知类,1表示推广类。当前只支持推广类的短信模板。

    status

    int

    短信模板状态

    状态包括:

    0:审批中

    1:审批通过

    2:审批不通过

    3:已失效

请求

  • 请求样例
    GET https://{SMN_Endpoint}/v2/{project_id}/notifications/sms_template?offset=0&limit=1

响应

  • 要素说明

    名称

    参数类型

    说明

    request_id

    String

    请求的唯一标识ID。

    count

    int

    返回的短信模板数。

    sms_templates

    Sms_template结构体数组

    请参见表1

    表1 Sms_template结构体

    名称

    参数类型

    说明

    sms_template_name

    String

    短信模板名称

    sms_template_type

    int

    短信模板类型

    • 0:通知类模板
    • 1:推广类模板

    sms_template_id

    String

    短信模板唯一标识,符合UUID。

    reply

    String

    运营商审批返回的失败原因

    status

    int

    模板状态

    • 0:审批中
    • 1:审批通过
    • 2:审批不通过
    • 3:已失效

    create_time

    String

    模板创建时间

    时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ

    validity_end_time

    String

    模板失效时间

    时间格式为UTC时间,YYYY-MM-DDTHH:MM:SSZ

    sign_id

    String

    该短信模板关联的签名ID

  • 响应样例
    {
        "request_id":"ce7f2f7343224f8c9597b05a9a0bcc2e",
        "count":4,
        "sms_templates": [{
        "sms_template_name": "推广消息",
        "sms_template_type":1,
        "create_time": "2017-11-11T14:46:29Z",
        "sms_template_id": "734f2f7343224f8c9597b05a9a0bc734",
        "status": 1,
        "reply": "",
        "validity_end_time": "2017-11-18T14:46:29Z",
        "sign_id": "ab34562d36f2d3dc32e3s34d20" 
      }]
    }

返回值

请参考返回值

错误码

请参考错误码说明

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区