DirectMailApi2.0
  1. 模板管理
DirectMailApi2.0
  • 鉴权说明
  • 订单状态
  • webhooks
  • 公共接口
    • 获取授权
      GET
    • 获取用户信息
      GET
    • 规格信息
      GET
    • 系统常量
      GET
    • 获取公告
      GET
    • 上传模版图片
      POST
    • webhooks
      POST
    • 获取历史公告
      GET
  • 用户接口
    • 订单管理
      • 明细订单统计
      • 月统计
      • 订单列表
      • 明细订单
      • 取消订单
      • 创建直邮订单
      • 创建数据订单
      • 修改订单标签
      • 获取订单内容
      • 批量获取订单内容
      • 历史订单列表
      • 创建直邮订单(新)
    • 财务管理
      • 余额变化列表
      • 充值订单
      • 历史余额变化列表
      • 历史充值订单
    • 模板管理
      • 模版列表
        GET
      • 新增模版
        POST
      • 删除模版
        POST
      • 修改模版名称
        POST
      • 历史模版列表
        GET
      • 模版预览
        GET
    • 地址管理
      • 地址标签列表
      • 明细地址列表
      • 创建地址标签
      • 删除地址标签
      • 地址绑定标签
      • 历史地址标签列表
    • 快捷标签管理
      • 快捷标签
      • 新增快捷标签
      • 删除快捷标签
    • 发件人管理
      • 发件人列表
      • 新增发件人
      • 删除发件人
    • 用户管理
      • 邀请用户
    • 子帐户管理
      • 子用户列表
      • 编辑子账号钱包
      • 创建子账号
    • 二维码
      • 创建二维码
        • 创建二维码-回邮
        • 创建二维码-落地页
        • 创建二维码-第三方链接
      • 二维码列表
        • 获取二维码列表
        • 修改二维码列表
        • 删除二维码
        • 禁用启用恢复二维码
        • 复制二维码
      • 场景分类管理
        • 获取分类管理
        • 修改分类管理
        • 添加分类管理
        • 删除分类管理
      • 案例
        • 添加案例
          • 添加回邮案例
          • 添加落地页案例
        • 获取案例列表
        • 删除案例
        • 复制案例
  • 更新日志
    • 2024-10-22 地址验证流程优化
    • 2024-10-14 地址后验证
  1. 模板管理

新增模版

测试环境
http://api.testagent.mumamail.com/user
测试环境
http://api.testagent.mumamail.com/user
POST
/createTemplate

模版内容说明#

front_img，back_img字段说明#

front_img 正面模版图片（内容面），用于方便对模版内容进行预览，不代表最终的模版内容。
back_img 背面模版图片（地址面），用于方便对模版内容进行预览，不代表最终的模版内容。

不同规格的宽高可通过调用/公共接口/规格信息：/common/specsList 进行查看#

图片尺寸要求，格式要求：jpg#
美国4x6明信片 图片像素：宽1875，高1275。
正面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/US4x6Front.jpg
背面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/US4x6Back.jpg
美国6x9明信片 图片像素：宽长2775，高1875。
正面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/US6x9Front.jpg
背面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/US6x9Back.jpg
美国6x11明信片 图片像素：宽3375，高1875。
正面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/US6x11Front.jpg
背面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/US6x11Back.jpg
美国8.5x11信件 图片像素：宽2625，高3375。
示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/US8.5x11Front.jpg
加拿大4x6明信片，图片像素：宽1871，高1271。
正面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/CA4x6Front.jpg
背面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/CA4x6Back.jpg
加拿大6x9明信片，图片像素：宽2771，高1871。
正面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/CA6x9Front.jpg
背面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/CA6x9Back.jpg
加拿大6x11明信片，图片像素：宽3371，高1871。
正面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/CA6x11Front.jpg
背面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/CA6x11Back.jpg
加拿大8.5x11信件，图片像素：宽2621，高3371。
示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/CA8.5x11Front.jpg
日本A6明信片，图片像素：宽1748，高1181。
示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/JPA6Front.jpg
日本A4信件，图片像素：宽2480，高3508。
示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/JPA4Front.jpg
日本A5信件，图片像素：宽1677，高2409。
示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/JPA5Front.jpg
英国A5明信片，图片像素：宽2551，高1819。
正面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/GBA5Front.jpg
背面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/GBA5Back.jpg
英国A6明信片，图片像素：宽1819，高1311。
正面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/GBA6Front.jpg
背面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/GBA6Back.jpg
英国A4信件，图片像素：宽2551，高3579。
示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/GBA4Front.jpg
欧洲A6明信片，图片像素：宽1819，高1311。
正面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/DEA6Front.jpg
背面示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/DEA6Back.jpg
欧洲A4信件，图片像素：宽2551，高3579。
示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/DEA4Front.jpg
德国A4E信件(经济)，图片像素：宽2551，高3579。
示例图：https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/DEA4EFront.jpg

front，back字段说明#

front 正面印刷内容，非必传字段。#

美国：front字段格式为raw html内容#
如果传递的front字段有值，请确保传递的raw html格式正确，在html文件中可正常渲染并且渲染的大小合适。我们不会对raw html的格式及效果进行校验。
如果传递的front字段没有值，Mailzone将根据传递的front_img字段自动生成raw html内容。请确保front_img的图片宽高符合规格要求，Mailzone不会对其准确性进行校验。
其他国家：front字段格式为图片url地址#
如果传递的front字段有值，请确保传递的图片格式正确，大小合适。Mailzone不会对其准确性进行校验。
如果传递的front字段没有值，Mailzone将根据传递的front_img字段填充到front字段中。请确保front_img的图片格式及宽高符合规格要求，Mailzone不会对其准确性进行校验。

back 背面印刷内容，非必传字段。除日本明信片以外，其他国家的明信片需有背面印刷内容，back字段的值由调用方提供或Mailzone自动生成#

美国：back字段格式为raw html内容#
如果传递的back字段有值，请确保传递的raw html格式正确，在html文件中可正常渲染并且渲染的大小合适。我们不会对raw html的格式及效果进行校验。
如果传递的back字段没有值，Mailzone将根据传递的back_img字段自动生成raw html内容。请确保back_img的图片宽高符合规格要求，Mailzone不会对其准确性进行校验。
其他国家：back字段格式为图片url地址#
如果传递的back字段有值，请确保传递的图片格式正确，大小合适。Mailzone不会对其准确性进行校验。
如果传递的back字段没有值，Mailzone将根据传递的back_img字段填充到back字段中。请确保back_img的图片格式及宽高符合规格要求，Mailzone不会对其准确性进行校验。

#

Mailzone自动生成的美国模版示例#

raw html中的width，height，backgroud-size中的值,均为模版图片宽高除以300。以美国4x6明信片为例，图片像素：宽1875，高1275。 1875/300=6.25,1275/300=4.25。#

示例中展示的为正确格式的raw html模版，请勿直接复制使用。#

美国4x6明信片#

正面内容front
背面内容back

美国6x9明信片#

正面内容front
背面内容back

美国6x11明信片#

正面内容front
背面内容back

美国8.5x11信件#

正面内容front

preview缩略图url，若使用自有的腾讯云COS或系统提供的上传模板接口，只需在url后面拼接?imageMogr2/thumbnail/!10p即可#

请求参数

Authorization
在 header 添加参数
x-token
示例：
x-token: ********************
Body 参数application/json

示例
{
    "country_code": "US",
    "description": "模版4x6",
    "size": "4x6",
    "front_img": "https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/US4x6Front.jpg",
    "frontVdp": "",
    "back_img": "https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/US4x6Back.jpg",
    "backVdp": "",
    "vdp": -1,
    "template_type": 1,
    "is_sys": 2,
    "preview": "https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/US4x6Front.jpg?imageMogr2/thumbnail/!10p",
    "front": "",
    "back": ""
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://api.testagent.mumamail.com/user/createTemplate' \
--header 'Content-Type: application/json' \
--header 'x-token;' \
--data-raw '{
    "country_code": "US",
    "description": "模版4x6",
    "size": "4x6",
    "front_img": "https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/US4x6Front.jpg",
    "frontVdp": "",
    "back_img": "https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/US4x6Back.jpg",
    "backVdp": "",
    "vdp": -1,
    "template_type": 1,
    "is_sys": 2,
    "preview": "https://muma-1258279456.cos.ap-hongkong.myqcloud.com/template/US4x6Front.jpg?imageMogr2/thumbnail/!10p",
    "front": "",
    "back": ""
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "code": 0,
    "data": {
        "template_id": 1,
        "template_name": "美国4x6",
        "country_code": "US",
        "size": "4x6",
        "template_type": 1
    },
    "msg": "success"
}
修改于 2024-10-18 12:16:08
上一页
模版列表
下一页
删除模版
Built with