文档首页 > > API参考> API> 模板操作> 创建消息模板

创建消息模板

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

功能介绍

  • 接口名称

    CreateMessageTemplate

  • 功能描述

    创建一个模板,用户可以按照模板去发送消息,这样可以减少请求的数据量。

    单用户默认可创建100个消息模板,高并发场景下,可能会出现消息模板数量超过100仍创建成功的情况,此为正常现象。

URI

  • URI格式

    POST /v2/{project_id}/notifications/message_template

  • 参数说明

    名称

    是否必选

    参数类型

    说明

    project_id

    String

    项目ID

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

请求消息

  • 参数说明

    名称

    是否必选

    参数类型

    说明

    message_template_name

    String

    创建模板的名称。

    只能包含大写字母、小写字母、数字、-和_,且必须由大写字母、小写字母或数字开头,长度在1到64个字符之间。

    content

    String

    模板内容,模板目前仅支持纯文本模式。

    模板内容不能空,最大支持256KB。

    protocol

    String

    模板支持的协议类型。

    目前支持的协议包括:

    • “email”:邮件传输协议。
    • “default”
    • “sms”:短信传输协议。
    • “functionstage”:FunctionGraph(函数)传输协议.
    • “functiongraph”:FunctionGraph(工作流)传输协议。
    • “dms”:DMS传输协议。
    • “http”、“https”:HTTP/HTTPS传输协议。
  • 请求样例
    POST https://{SMN_Endpoint}/v2/{project_id}/notifications/message_template
    {
        "message_template_name": "confirm_message",
        "protocol": "https",
        "content": "(1/2)You are invited to subscribe to topic({topic_id}). Click the following URL to confirm subscription:(If you do not want to subscribe to this topic, ignore this message.)"
    }

响应消息

  • 要素说明

    名称

    参数类型

    说明

    request_id

    String

    请求的唯一标识ID。

    message_template_id

    String

    模板唯一的资源标识。

  • 响应样例
    { 
        "request_id":"ca03efa691624d8eb2dfeba01a1bcf6e",
        "message_template_id":"57ba8dcecda844878c5dd5815b65d10f"
    }

返回值

请参考返回值

错误码

请参考错误码说明

分享:

    相关文档

    相关产品

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

提交成功!

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

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

*必选

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

字符长度不能超过200

提交反馈 取消

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

跳转到云社区