模板管理

1、文本模板报备

1.1 请求地址

• 请求方式：post
• Content-Type：application/json
• 请求地址：https://cwl.chuanglan.com/api/v1/message/sms/template/add

1.2 请求参数

参数名	类型	是否必传	描述
nonce	string	是	随机数。 可使用uuid
timestamp	string	是	时间戳
signature	string	是	验签加密串。根据验签示例说明进行加密
app_id	string	是	账户app_id。从系统的页面-》系统管理 可以获取
name	string	是	模板名称。
business_type	string	是	模板类型(业务类型)。说明：01-行业 02-营销
content	string	是	模板内容。
is_var	string	否	内容是否是包含{short_chain}的标识。说明：主要是因为发送aim短信，需要包含{short_chain}用来替换短链使用的
sign_id	string	是	签名id。
sign	string	是	签名。
sms_type	string	是	文本模板短信类型。说明：0-普通 1-智慧AIM
unsubscribe	string	是	取消订阅id。说明：见取消订阅枚举值

取消订阅枚举值

枚举值	枚举值解释
01	退订回T
02	退订回N
03	退订回复TD
04	退订回复T
05	退订回复N
06	退订回TD
07	退订回TD
08	回T退订
09	回N退订
10	TD退订
11	褪定回T
12	退订T
13	退订TD
14	拒收回T
15	退定回T
16	拒D
17	拒d
18	回N取关
19	取关回N

1.3 响应参数

参数名	类型	默认值	描述
code	string		000000 代表成功，其他代表失败，会有 message 错误信息返回
msg	string		提示信息
data	object		返回数据

data数据结构

参数名	类型	默认值	描述
template_id	string		模板id

{
    "code": "000000",
    "message": "成功",
    "data": {
        "template_id": "BLSMS202208191543581138599633920"
    }
}

1.4 请求示例

{
    "nonce": "80e33b2f03b44db8b5f7b4114f370602",
    "timestamp": "1659163692047",
    "signature": "32c591a830043d37f0db7b4c47f58296ce4d6fbaa40770ebb11dc925fae3d5b1",        
    "app_id": "nRYcU4fYExYjw2m8",
    "name": "模板名词",
    "business_type": "02",
    "content": "22222",
    "is_var": "N",
    "sign_id": "202203081916339328592556032",
    "sign": "测试签名",
    "sms_type": "0",
    "unsubscribe": "01"
}

2、智慧消息(AIM)模板报备

2.1 请求地址

• 请求方式：post
• Content-Type：application/json
• 请求地址：https://cwl.chuanglan.com/api/v2/aim/template/create

2.2 请求参数

参数名	类型	是否必传	描述
nonce	string	是	随机数。 可使用uuid
timestamp	string	是	时间戳。
signature	string	是	验签加密串。根据验签示例说明进行加密
app_id	string	是	账户app_id。从系统的页面-》系统管理 可以获取
template_type	string	是	模板类型。说明：1-单图文 2-多图文 3-横滑卡片 4-视频卡片 5-轮播卡片 6-红包 10-一般通知 11-增强通知；具体对应数据与模板内容格式处对应
template_name	string	是	模板名称。
description	string	否	描述。
template_info	string	是	模板内容。格式：JSON；要求：动参以{#param1#}格式设置，param1跟template_params里面的名称对应；说明：1、详见模板类型描述中的模板内容（见下文） 2、也可以在saas端创建模板处获取
is_draft	string	否	是否保存为草稿。说明：Y-是 N-否，默认为N，为N是不可对模板进行修改
model_code	string	是	模板code。说明：1、可以在saas端创建模板处获取 2、也可以在模板内容格式处获取（见下文）
template_sign	string	是	模板签名。说明：1、可以在saas端报备；2、可以调用添加签名接口； 报备签名后需要让运营人员审核
terminal_factory	string	否	指定厂商。说明：多厂商以英文逗号进行分隔；示例：指定小米和OPPO："XIAOMI,OPPO"；指定小米："XIAOMI"
template_params	string	否	动参数据。格式：JSONArray格式；要求：1、动参个数不能超过20个 2、动参对应参数不能为空 内容字段定义：paramName-动参名称 paramType-动参类型（01文本，02数字） paramText-动参示例 paramMinsize-动参内容最小长度 paramMaxsize-动参内容最大长度；示例："[{"paramName": "param1","paramType": "01","paramText": "客","paramMinsize": 1,"paramMaxsize": 20}, {"paramName": "param2","paramType": "01","paramText": "客","paramMinsize": 1,"paramMaxsize": 20}]"
extra_json	string	否	扩展信息。要求：如果terminal_factory包含VIVO，则必须传vivoAdvertiser广告主信息； 说明：vivoAdvertiser对应vivo广告主； 示例：{"vivoAdvertiser":{"agent":"agent001","advertiser":"0103u8fa28989"}}
end_date	string	否	模板截止日期。 格式："yyyyMMdd"
use_type	string	否	模板类型。 说明：1-正式模板 2-测试模板 不传默认1正式模板

2.3 响应参数

参数名	类型	默认值	描述
code	string		000000 代表成功，其他代表失败，会有 message 错误信息返回
msg	string		提示信息
data	object		返回数据（模板id）

{
    "code": "000000",
    "message": "成功",
    "data": "CLAIM202208191454334378604221440"
}

2.4 请求示例（无动参）

{
    "nonce":"123456789",
    "timestamp":"1658974350",
    "signature":"923e2a3ae0c7ca4d1bdf440197ad47bd31eccdc24ba50ba2d6f70fde341cbef0",
    "app_id":"g4goU5kSTf7dzPUZ",
    "template_type":"1",
    "template_name":"【测试】单图文模板",
    "template_sign":"5G事业部",
    "description":"description",
    "template_info":"{\"buttons\":[{\"content\":\"点击查看\",\"action\":{\"url\":\"https://www.baidu.com\",\"type\":\"1\",\"back_url\":\"https://www.taobao.com\",\"package_name\":\"百度一下\",\"jump_title\":\"商户名称\",\"attr\":null},\"button_attrs\":null,\"number\":0}],\"images\":[{\"material_id\":\"202203101352477418590327808\",\"src\":\"http://chuanglan-test.oss-cn-shanghai.aliyuncs.com/yunge/console/441/20220601/image/aea53115-1d00-4305-9a9b-eb3eaa413d32.jpg\",\"action\":{\"url\":\"https://www.baidu.com\",\"type\":\"1\",\"back_url\":\"https://www.taobao.com\",\"package_name\":\"百度一下\",\"jump_title\":\"商户名称\",\"attr\":null},\"main_img\":true,\"image_attrs\":null,\"buttons\":null,\"number\":0}],\"texts\":[{\"title\":\"请输入标题，最多17个字\",\"description\":\"请输入描述文案、最多38个字（包含标点及空格）\",\"action\":{\"url\":\"https://www.baidu.com\",\"type\":\"1\",\"back_url\":\"https://www.taobao.com\",\"package_name\":\"百度一下\",\"jump_title\":\"商户名称\",\"attr\":null},\"number\":0}]}",
    "is_draft":"N",
    "model_code":"001"
}

2.5 请求示例（有动参）

{
    "nonce":"123456789",
    "timestamp":"1658974350",
    "signature":"fa244a40331d1a955f3ee9117b6f211c2fdb32875c64921ac3864179ed7f9b36",
    "app_key":"0AvyA8opHDqDs6X2",
    "template_type":"1",
    "template_name":"【测试】单图文模板00001",
    "template_sign":"testChenax",
    "description":"description",
    "template_info":"{\"buttons\":[{\"content\":\"点击查看\",\"action\":{\"url\":\"https://www.baidu.com/\",\"type\":\"1\",\"back_url\":null,\"package_name\":null,\"jump_title\":\"目标地址，精彩即将呈现\",\"attr\":null},\"button_attrs\":null,\"number\":0}],\"images\":[{\"main_img\":true,\"image_attrs\":null,\"buttons\":null,\"number\":0,\"src\":\"http://chuanglan-test.oss-cn-shanghai.aliyuncs.com/yunge/api/253506/20220901/image/6aededaf-c70c-409d-986d-32a628530c47.png\",\"material_id\":\"202209012145394918603172864\",\"action\":{\"url\":\"https://www.baidu.com/\",\"type\":\"9\",\"back_url\":null,\"package_name\":null,\"jump_title\":\"目标地址，精彩即将呈现\",\"attr\":null}}],\"texts\":[{\"title\":\"测试{#param1#}\",\"number\":0,\"description\":\"测试经常游泳锻炼身体，不伤膝关节\"}],\"attrs\":{},\"videos\":[]}",
    "is_draft":"N",
    "model_code":"008",
    "terminal_factory":"OPPO, XIAOMI,HUAWEI,MEIZU",
    "template_params":"[{\"paramName\":\"param1\",\"paramType\":\"01\",\"paramText\":\"客\",\"paramMinsize\":1,\"paramMaxsize\":10}]"
}