文档

CreateCardSmsTemplate - 创建卡片短信模板

更新时间:

创建卡片短信模板。

接口说明

  • 保存卡片短信模板信息,提交手机厂商审核,并返回模板Code。
  • 使用CreateCardSmsTemplate创建卡片短信模板,若模板中包含厂商不支持的模板类型或事件时,将不向对应厂商提交审核。更多信息,请参见厂商支持的模板说明
  • 更多卡片短信模板的示例,请参见卡片短信模板示例

QPS限制

本接口的单用户QPS限制为300次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
dysms:CreateCardSmsTemplateWrite
  • 全部资源
    acs:dysms:*:{#accountId}:*

请求参数

名称类型必填描述示例值
TemplateNamestring

卡片短信模板名称。

阿里云图文类模板
Templateobject

卡片短信的模板内容。

说明
  • Template、ExtendInfo、TemplateContent、TmpCard、Action等字段说明,请参见卡片短信模板参数字段说明
  • 不同类型的卡片短信模板的内容结构不同,详情请参见卡片短信模板示例
  • { "extendInfo":{ "scene":"HMOVM图文", "purpose":"2", "userExt":{ "outId":"1234554321" } }, "templateContent":{ "pages":[ { "tmpCards":[ { "type":"IMAGE", "srcType":1, "src":"28755", "actionType":"OPEN_APP", "action":{ "target":"https://s.tb.cn/c.KxzZ", "merchantName":"测试-图文模板", "packageName":[ "com.taobao.taobao"], "floorUrl":"https://s.tb.cn/c.KxzZ" }, "positionNumber":1 }, { "type":"TEXT", "content":"测试- BENZ AMG 2020 试驾邀请", "isTextTitle":true, "positionNumber":2 }, { "type":"TEXT", "content":"测试-梅赛德斯-奔驰,创新激情永不灭。作为汽车 XXXX", "isTextTitle":false, "positionNumber":3 }, { "type":"BUTTON", "content":"预约试驾", "actionType":"OPEN_BROWSER", "action":{ "target":"https://www.mercedes-benz.com.cn", "merchantName":"测试-正在跳转梅赛德斯-奔驰" }, "positionNumber":4 }] }] }, "cardSignName":"阿里云", "cardType":5 }
    Memostring

    对上传模板的描述。

    图文类模板
    Factorysstring

    模板提交的厂商。厂商类型取值:

    • HuaWei:表示华为厂商。
    • XiaoMi:表示小米厂商。
    • OPPO:表示OPPO厂商。
    • VIVO:表示VIVO厂商。
    • MEIZU:表示魅族厂商。
    说明 该参数不填时,系统自动匹配模板支持的手机厂商。
    XiaoMi

    返回参数

    名称类型描述示例值
    object

    数据对象。

    Codestring

    请求状态码。

    • 返回OK代表请求成功。
    • 其他错误码,请参见错误码列表
    OK
    RequestIdstring

    请求ID。

    F655A8D5-B967-440B-8683-DAD6FF8DE990
    Successboolean

    调用接口是否成功。取值:

    • true
    • false
    true
    Dataobject

    返回对象。

    TemplateCodestring

    卡片短信模板CODE。

    您可以登录短信服务控制台,选择国内卡片消息,在模板管理页面查看模板CODE,如:CARD_SMS_2****。

    说明 必须是已添加、并通过审核的卡片短信模板。
    CARD_SMS_2****

    示例

    正常返回示例

    JSON格式

    {
      "Code": "OK",
      "RequestId": "F655A8D5-B967-440B-8683-DAD6FF8DE990",
      "Success": true,
      "Data": {
        "TemplateCode": "CARD_SMS_2****"
      }
    }

    错误码

    HTTP status code错误码错误信息描述
    200ForbiddenActionAccess to the account is denied. Please contact the administrator.没有访问权限,请联系管理员

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2023-04-03OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:200
    • 本页导读 (1)
    文档反馈