模板管理

接口列表

1. 创建模板

1.1 接口说明

接口地址：https://smssh.253.com/sms/v2/template/add 通用接口说明详见 API 调用说明

1.2 请求参数

variableParams 参数

guideUrl 参数

补充说明：content 需与实际下发链接一致，不同场景的填写示例如下：

guidePhone 参数

1.3 请求示例

复制成功⧉
{
  "productType": "verify",
  "content": "您的验证码是{s}，请勿泄露。",
  "contentName": "验证码模板",
  "signName": "创蓝253",
  "needUnsubscribe": "0",
  "businessCategory": "1",
  "businessSubcategory": "101",
  "remark": "登录验证码",
  "variableParams": "[{\"name\":\"变量1\",\"type\":\"code\",\"length\":\"6\",\"position\":0}]"
}

1.4 响应参数

返回数据示例（JSON）：

复制成功⧉
{
  "code": "000000",
  "msg": "成功",
  "data": {
    "templateCode": "100001"
  }
}

2. 查询模板类型枚举

2.1 接口说明

接口地址：https://smssh.253.com/sms/v2/template/query-type-enum 通用接口说明详见 API 调用说明

2.2 请求参数

2.3 请求示例

复制成功⧉
{
  "productType": "notify"
}

2.4 响应参数

data 参数

data.businessTypes 参数

返回数据示例（JSON）：

复制成功⧉
{
  "code": "000000",
  "data": {
    "variableTypes": [
      {
        "id": "1",
        "type": "字符型"
      },
      {
        "id": "2",
        "type": "整数型"
      },
      {
        "id": "3",
        "type": "小数型"
      },
      {
        "id": "4",
        "type": "字符数据混合型"
      }
    ],
    "mobileTypes": [
      {
        "id": "1",
        "type": "手机号码"
      },
      {
        "id": "2",
        "type": "固定号码"
      },
      {
        "id": "3",
        "type": "400电话"
      },
      {
        "id": "4",
        "type": "800电话"
      },
      {
        "id": "5",
        "type": "95开头号码"
      },
      {
        "id": "6",
        "type": "96开头号码"
      },
      {
        "id": "7",
        "type": "1开头号码（非手机号码）"
      },
      {
        "id": "8",
        "type": "其他号码"
      }
    ],
    "urlTypes": [
      {
        "id": "1",
        "type": "ip类型链接"
      },
      {
        "id": "2",
        "type": "域名类型链接"
      }
    ],
    "businessTypes": [
      {
        "id": "00",
        "type": "业务管理和服务类",
        "details": [
          {
            "id": "00",
            "type": "其他用途"
          },
          {
            "id": "01",
            "type": "通知服务"
          },
          {
            "id": "02",
            "type": "验证码"
          },
          {
            "id": "03",
            "type": "业务提醒（非金融类）"
          },
          {
            "id": "04",
            "type": "业务提醒（金融类）"
          },
          {
            "id": "05",
            "type": "还款通知"
          }
        ]
      },
      {
        "id": "01",
        "type": "商业性",
        "details": [
          {
            "id": "00",
            "type": "其它营销类别"
          },
          {
            "id": "01",
            "type": "金融推销（贷款理财和保险推销）"
          },
          {
            "id": "02",
            "type": "零售业推销"
          },
          {
            "id": "03",
            "type": "电信业务宣传"
          },
          {
            "id": "04",
            "type": "网络游戏推广"
          },
          {
            "id": "05",
            "type": "教育培训推销"
          },
          {
            "id": "06",
            "type": "房产中介推销"
          },
          {
            "id": "07",
            "type": "股票证券推销"
          },
          {
            "id": "08",
            "type": "医疗卫生推销"
          },
          {
            "id": "09",
            "type": "猎头招聘推广"
          },
          {
            "id": "10",
            "type": "旅游推广"
          },
          {
            "id": "11",
            "type": "未主动更新"
          }
        ]
      },
      {
        "id": "02",
        "type": "公益性",
        "details": [
          {
            "id": "00",
            "type": "其他公益信息"
          },
          {
            "id": "01",
            "type": "政务民生信息"
          },
          {
            "id": "02",
            "type": "应急通知"
          }
        ]
      }
    ]
  },
  "msg": "深度接口枚举类型查询成功"
}

3. 模板列表

3.1 接口说明

接口地址：https://smssh.253.com/sms/v2/template/list 通用接口说明详见 API 调用说明

3.2 请求参数

3.3 请求示例

复制成功⧉
{
  "productType": "market",
  "pageNo": 1,
  "pageSize": 10
}

3.4 响应参数

data.list 参数

返回数据示例（JSON）：

复制成功⧉
{
  "code": "000000",
  "msg": "成功",
  "data": {
    "total": 5,
    "list": [
      {
        "templateCode": "100001",
        "webOrApi": "0",
        "accountId": "252289",
        "type": "6",
        "contentTask": "",
        "content": "您的验证码是{s}，请勿泄露。",
        "needUnsubscribe": "0",
        "remark": "",
        "createTime": "2025-01-01 10:00:00",
        "status": "1",
        "auditDate": "",
        "auditReason": null,
        "signName": "创蓝",
        "contentName": "验证码模板",
        "cmOperatorStatus": "2",
        "ctOperatorStatus": "2",
        "cuOperatorStatus": "2"
      }
    ]
  }
}

4. 模板详情

4.1 接口说明

接口地址：https://smssh.253.com/sms/v2/template/detail 通用接口说明详见 API 调用说明

4.2 请求参数

4.3 请求示例

复制成功⧉
{
  "productType": "notify",
  "templateCode": "341708"
}

4.4 响应参数

data 参数

data.variableParams 参数

data.guideUrl 参数

data.*OperatorRejectReason 参数

返回数据示例（JSON）：

复制成功⧉
{
  "code": "000000",
  "msg": "操作成功",
  "data": {
    "templateCode": "1021146428",
    "webOrApi": "0",
    "accountId": "2036723",
    "auditDate": "1766730322",
    "auditReason": null,
    "businessCategory": "00",
    "businessSubcategory": "00",
    "content": "天气预报,12{s}天气多云,风力一级,注意防护",
    "contentName": "1226",
    "contentTask": "",
    "createTime": "1766730311",
    "modelId": "1021146428",
    "needUnsubscribe": "0",
    "remark": "",
    "remoteId": "1021146428",
    "signName": "222",
    "signature": "222",
    "status": "1",
    "statusDesc": "已审核",
    "type": "4",
    "unsubscribe": "",
    "guidePhone": null,
    "guideUrl": null,
    "variableParams": [
      {
        "length": "2",
        "name": "变量1",
        "position": 1,
        "type": "1"
      }
    ],
    "cmOperatorStatus": "1",
    "ctOperatorStatus": "3",
    "cuOperatorStatus": "1",
    "cmOperatorRejectReason": null,
    "ctOperatorRejectReason": [
      {
        "issueDesc": "引流类型",
        "issueType": 5,
        "modifyModules": "6",
        "operationRecommend": "修改链接材料"
      },
      {
        "issueDesc": "请联系人工客服处理",
        "issueType": null,
        "modifyModules": null,
        "operationRecommend": null
      }
    ],
    "cuOperatorRejectReason": null
  }
}

5. 编辑模板

5.1 接口说明

接口地址：https://smssh.253.com/sms/v2/template/update 通用接口说明详见 API 调用说明

5.2 请求参数

variableParams 参数

guideUrl 参数

补充说明：content 需与实际下发链接一致，不同场景的填写示例如下：

guidePhone 参数

5.3 请求示例

复制成功⧉
{
  "productType": "verify",
  "templateCode": "100001",
  "content": "您的验证码是{s}，有效期5分钟。",
  "remark": "更新有效期提示"
}

5.4 响应参数

返回数据示例（JSON）：

复制成功⧉
{
  "code": "000000",
  "msg": "成功",
  "data": null
}

6. 删除模板

6.1 接口说明

接口地址：https://smssh.253.com/sms/v2/template/delete 通用接口说明详见 API 调用说明

6.2 请求参数

6.3 请求示例

复制成功⧉
{
  "productType": "notify",
  "templateCode": "750665"
}

6.4 响应参数

返回数据示例（JSON）：

复制成功⧉
{
  "code": "000000",
  "msg": "深度接口根据 id 删除模板成功"
}