文档

GetChatappTemplateDetail - 查询ChatApp模板详情

更新时间:

获取消息模板的详细信息。

接口说明

QPS 限制

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

模板 Code。

****4b5c79c9432497a075bdfca36bf5
Languagestring

模板语言。 详细语言代码,请参见语言代码

en_US
CustWabaIddeprecatedstring

ISV 客户 WabaId。

说明 过时的参数,请使用 CustSpaceId
65921621816****
IsvCodestring

ISV 校验码,用于校验子账号是否由 ISV 授权。

skdi3kksloslikdkkdk
CustSpaceIdstring

ISV 子客户的 SpaceId。

28251486512358****
TemplateTypestring

模板类型。

  • WHATSAPP

  • VIBER

  • LINE(开发中)

WHATSAPP

返回参数

名称类型描述示例值
object

返回数据。

RequestIdstring

请求 ID。

744c4b5c79c9432497a075bdfca3****
Codestring

请求状态码。

  • 返回 OK 代表请求成功。

  • 其他错误码,请参见错误码列表

OK
Messagestring

错误提示信息。

User not authorized to operate on the specified resource.
Dataobject

返回数据。

Categorystring

Whatsapp 模板分类。取值:

  • UTILITY:交易相关。

  • MARKETING:营销性模板。

  • AUTHENTICATION:身份验证。

Viber 模板分类

  • text:纯文本

  • image:纯图片

  • text_image_button:文本 + 图片 + 按钮

  • text_button:文本 + 按钮

  • document: 文件

  • video:视频

  • text_video:文本 + 视频

  • text_video_button:文本 + 视频 + 按钮

  • text_image:文本 + 图片

说明 当 Viber 模板取值为 text_video_button 时,按钮并不能打开网页,只是在网页中打开当前消息的视频,所以按钮的 URL 中不需要填写任何地址信息
UTILITY
TemplateCodestring

模板 Code。

744c4b5c79c9432497a075bdfca3****
Namestring

模板名称。

hello_whatsapp
Languagestring

模板语言。 详细语言代码,请参见语言代码

en_US
Exampleobject

变量举例。

string

模板变量对应的实际值,参数格式为 JSON 格式。

{\"textVariable\":\"text\",\"linkVariable\":\"https://image.developer.aliy\"}
AuditStatusstring

审核状态。取值:

  • pass:通过审核。

  • fail:拒绝审核。

  • auditing:审核中。

  • unaudit:审核暂停处理。

pass
Componentsobject []

消息模板组件列表。

Typestring

组件类型。

  • BODY

  • HEADER

  • FOOTER

  • BUTTONS

  • CAROUSEL

  • LIMITED_TIME_OFFER

说明
  • Whatsapp 类型模板时,BODY 组件的字符长度不超度是 1024 个字符。HEADERFOOTER 组件的字符长度不超过 60 个字符。
  • Viber 类型模板时,FOOTERCAROUSELLIMITED_TIME_OFFER 类型无效。
  • Viber 类型模板中,图片、视频、文件都是放在 HEADER 中(终端将图片显示在文本之下)。
  • BODY
    Urlstring

    素材路径。

    https://image.developer.aliyundoc.com
    Textstring

    发送消息的文本。

    你好
    Captionstring

    文件的描述。

    新文件已上传
    FileNamestring

    文件的名称。

    快递文件
    Formatstring

    格式。

    TEXT
    Buttonsobject []

    按钮列表,仅适用于 BUTTONS 组件。

    说明 Whatsapp 按钮数量说明
  • Whatsapp 在类型为 MARKETING/UTILITY 时,最多允许 10 个按钮
  • PHONE_NUMBER 类型的按钮只允许存在 1 个
  • URL 类型的按钮最多允许存在 2 个
  • QUICK_REPLY 按钮不允许和 PHONE_NUMBER/URL 按钮乱序出现
  • Typestring

    按钮类型。

    • PHONE_NUMBER:拨打电话按钮

    • URL:网页按钮

    • QUICK_REPLY:快速回复按钮

    • COPY_CODE:复制验证码、优惠码

    • ONE_TAP:AUTHENTICATION 模板时回填按钮

    说明
  • Whatsapp 类型模板且 Category 为 AUTHENTICATION 时,按钮只允许存在一个,并且类型只能是 COPY_CODE/ONE_TAP, 当类型选择 COPY_CODE 时,Text 为必填。当类型选择 ONE_TAP 时,Text(在终端没有装目标应用时显示,表示采用复制验证码按钮的名称)必填,SignatureHash, PackageName, AutofillText 属性必填。
  • Viber 类型的模板只允许一个 Button 且只能是 URL 类型。
  • PHONE_NUMBER
    Textstring

    按钮显示的名称。

    打电话
    PhoneNumberstring

    电话号码,仅按钮类型为PHONE_NUMBER时有效。

    861398745****
    Urlstring

    点击链接按钮将访问的网址。

    https://example.com
    UrlTypestring

    网址类型。

    • static:静态

    • dynamic:动态

    static
    SignatureHashstring

    Whatsapp 模板,Category 为 Authentication,并且 Button Type 为 ONE_TAP 时必填,表示 Whatsapp 调起应用的签名 Hash 值。

    2993839
    PackageNamestring

    Whatsapp 模板,Category 为 Authentication,并且 Button Type 为 ONE_TAP 时必填,表示 Whatsapp 调起应用的包名。

    com.aliyun
    AutofillTextstring

    Whatsapp 模板,Category 为 Authentication,并且 Button Type 为 ONE_TAP 时必填,Whatsap Autofill 操作的按钮文本。

    Autofill
    IsOptOutboolean

    Whatsapp 模板,在 Category 为 Marketing,并且 Button type 为 QUICK_REPLY 时有效,表示按钮为营销退订按钮,客户如果点击了此按钮,并且在 chatapp 平台上配置了发送控制操作,则后续 Marketing 消息则不会发送到客户。

    false
    ExtendAttrsobject

    扩展字段。

    NextTemplateCodestring

    下一个模板编码。

    20939920093993
    NextTemplateNamestring

    下一个模板名称。

    abc
    NextLanguageCodestring

    下一个模板语言。

    en
    Actionstring

    事件类型。

    nextCard
    IntentCodestring

    意图编码。

    test
    CouponCodestring

    优惠券码

    202039ksjs
    FlowIdstring

    Flow ID

    3838292983
    FlowActionstring

    flow 数据事件类型 取值范围:NAVIGATE/DATA_EXCHANGE

    NAVIGATE
    NavigateScreenstring

    跳转屏 在 FlowAction=NAVIGATE 时必填

    DETAILS
    ThumbUrlstring

    Viber 带视频消息的缩略图。

    https://img.png
    Durationinteger

    Viber 视频消息的视频时长,取值范围:0~600

    50
    FileTypestring

    Viber 文件消息的文件类型。

    docx
    Latitudestring

    位置纬度属性。

    28.001
    Longitudestring

    位置经度属性。

    120.002
    LocationNamestring

    位置名称。

    杭州
    LocationAddressstring

    位置地址。

    杭州
    AddSecretRecommendationboolean

    Whatsapp 类型模板,Category 为 Authentication,并且 Component Type 为 Body 时有效,表示在 Body 上面显示不要将验证码信息提供给其它人的提示信息。

    false
    CodeExpirationMinutesinteger

    Whatsapp Authentication 模板验证码有效期(分钟),只在 Whatsapp 类型消息,Category 为 Authentication 并且 Component Type 为 Footer 时有效(此信息显示在 Footer 位置)。

    5
    hasExpirationboolean

    LTO 模板中,优惠码是否有过期时间

    true
    OfferExpirationTimeMsstring

    LTO 模板时,优惠码过期变量

    $(offerExpirationTimeMs)
    Cardsobject []

    轮播卡片列表

    CardComponentsobject []

    卡片控件列表

    Typestring

    组件类型

    HEADER
    Textstring

    卡片文本内容

    Body
    Urlstring

    网页地址

    https://aliyun.com
    Formatstring

    Carousel 模板中 Header 的类型,只支持 IMAGE/VIDEO,所有卡片的 Header 必须一致 格式 IMGAGE-图片 VIDEO-视频

    HEADER
    Buttonsobject []

    卡片按钮列表

    Typestring

    Carousel 模板的按钮类型 取值:URL/PHONE_NUMBER/QUICK_REQLY

    URL
    Textstring

    按钮内容

    按钮文本
    Urlstring

    点击按钮后将访问的网址

    https://aliyun.com
    UrlTypestring

    网址类型 static-静态 dynamic-动态

    static
    PhoneNumberstring

    号码

    +86138000
    TemplateTypestring

    模板类型。

    • WHATSAPP

    • VIBER

    • LINE(开发中)

    WHATSAPP
    QualityScorestring

    模板质量。

    GREEN
    MessageSendTtlSecondsinteger

    Whatsapp 中 Authentication 类型模板发送消息时的消息有效期。

    120
    Reasonstring

    模板审核被拒的原因。

    None
    AccessDeniedDetailstring

    访问被拒绝详细信息。

    示例

    正常返回示例

    JSON格式

    {
      "RequestId": "744c4b5c79c9432497a075bdfca3****",
      "Code": "OK",
      "Message": "User not authorized to operate on the specified resource.",
      "Data": {
        "Category": "UTILITY",
        "TemplateCode": "744c4b5c79c9432497a075bdfca3****",
        "Name": "hello_whatsapp",
        "Language": "en_US",
        "Example": {
          "key": "{\\\"textVariable\\\":\\\"text\\\",\\\"linkVariable\\\":\\\"https://image.developer.aliy\\\"}"
        },
        "AuditStatus": "pass",
        "Components": [
          {
            "Type": "BODY",
            "Url": "https://image.developer.aliyundoc.com",
            "Text": "你好",
            "Caption": "新文件已上传",
            "FileName": "快递文件",
            "Format": "TEXT",
            "Buttons": [
              {
                "Type": "PHONE_NUMBER",
                "Text": "打电话",
                "PhoneNumber": "861398745****",
                "Url": "https://example.com\n",
                "UrlType": "static",
                "SignatureHash": "2993839",
                "PackageName": "com.aliyun",
                "AutofillText": "Autofill",
                "IsOptOut": false,
                "ExtendAttrs": {
                  "NextTemplateCode": "20939920093993",
                  "NextTemplateName": "abc",
                  "NextLanguageCode": "en",
                  "Action": "nextCard",
                  "IntentCode": "test"
                },
                "CouponCode": "202039ksjs",
                "FlowId": "3838292983",
                "FlowAction": "NAVIGATE",
                "NavigateScreen": "DETAILS"
              }
            ],
            "ThumbUrl": "https://img.png",
            "Duration": 50,
            "FileType": "docx",
            "Latitude": "28.001",
            "Longitude": "120.002",
            "LocationName": "杭州",
            "LocationAddress": "杭州",
            "AddSecretRecommendation": false,
            "CodeExpirationMinutes": 5,
            "hasExpiration": true,
            "OfferExpirationTimeMs": "$(offerExpirationTimeMs)",
            "Cards": [
              {
                "CardComponents": [
                  {
                    "Type": "HEADER",
                    "Text": "Body",
                    "Url": "https://aliyun.com",
                    "Format": "HEADER",
                    "Buttons": [
                      {
                        "Type": "URL",
                        "Text": "按钮文本",
                        "Url": "https://aliyun.com",
                        "UrlType": "static",
                        "PhoneNumber": "+86138000"
                      }
                    ]
                  }
                ]
              }
            ]
          }
        ],
        "TemplateType": "WHATSAPP",
        "QualityScore": "GREEN",
        "MessageSendTtlSeconds": 120,
        "Reason": "None"
      },
      "AccessDeniedDetail": "无"
    }

    错误码

    HTTP status code错误码错误信息
    400Product.UnsubscriptYou have not subscribed to the specified product.
    400Ram.PermissionDenyYou are not authorized to perform the operation.
    400System.LimitControlThe system is under flow control.
    400Unknown.ResourceOwnerIdThe resource does not belong to the current user.

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

    变更历史

    变更时间变更内容概要操作
    2023-11-21OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    出参OpenAPI 返回结构发生变更
    2023-10-19OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    出参OpenAPI 返回结构发生变更
    2023-09-14OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    出参OpenAPI 返回结构发生变更
    2023-08-17OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    出参OpenAPI 返回结构发生变更
    2023-07-04OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    出参OpenAPI 返回结构发生变更
    2023-05-25OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    出参OpenAPI 返回结构发生变更
    2023-05-08OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    出参OpenAPI 返回结构发生变更
    2023-04-13OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
    出参OpenAPI 返回结构发生变更
    • 本页导读 (1)