模板管理

添加模板

请求

URL

  1. POST ${BASE_URL}/msg/template

请求参数列表

参数 有效值范围 是否必填 说明
name 字符串 是 名称
type 字符串 否 类型（目前有两个有效值：msg_sms、msg_ussd）不填默认为 msg_sms
content 字符串 是 模板内容 注意：实际发送内容，中文长度不超过62个字（包含标点符号）
1.无参数模板示例：
天猫双11全球狂欢节，全球好货不只5折。亿万优惠券10点准时开抢，现在打开淘宝或天猫客户端，开始抢红包啦！
2.带参数模板示例：
【支付宝】你的支付宝发生##元的交易，校验码：##打死都不能告诉别人哦！唯一热线95188
1、变量用#*#代替
2、内容+变量不能超过62字符
remark 字符串 否 备注

响应

　响应参数列表

参数 有效值范围 说明
code 数字文本 状态码，全0表示正确
msg 文本 返回情况说明
data JSON 对象 返回数据对象，参见data对象属性列表

　参数详解

data对象属性列表

属性 有效值范围 说明
name 字符串 名称
type 字符串 模板类型，msg_sms代码短信模板，msg_ussd代表闪印模板
tempId 字符串 模板ID
content 字符串 模板内容
status [1,0,-1] 模板状态，1表示审核通过，0等待审核，-1审核不通过
remark 字符串 备注
checkTime 字符串 审核时间，格式：yyyy-MM-dd hh-mm-ss
reason 字符串 失败原因

示例

请求:

  1. POST ${BASE_URL}/msg/template HTTP/1.1
  2. Host: api.yunhuni.com
  3. Content-Type: application/json
  4. Accept-Type: application/json
  5. Content-Length: xxx
  6. {
  7.    "name":"双11打折",
  8.    "type":"msg_sms",
  9.    "content":"天猫双11全球狂欢节，全球好货不只5折。",
  10.    "remark":"双11模板"
  11. }

响应:

  1. HTTP/1.1 200 OK
  2. Content-Type: application/json
  3. Content-Length: xxx
  5. {
  6.   "code": "000000",
  7.   "msg": "请求成功",
  8.   "data": {
  9.               "name":"双11打折",
  10.               "type":"msg_sms",
  11.               "tempId":"10001",
  12.               "content":"天猫双11全球狂欢节，全球好货不只5折。",
  13.               "status":1,
  14.               "remark":"双11模板",
  15.               "checkTime":"",
  16.               "reason":""
  17.            }
  18. }

修改模板

请求

URL

  1. PUT ${BASE_URL}/msg/template/{tempId}

　请求参数列表

参数 有效值范围 是否必填 说明
name 字符串 否 名称
type 字符串 否 类型（目前有两个有效值：msg_sms、msg_ussd）不填默认为 msg_sms
content 字符串 否 模板内容 注意：实际发送内容，中文长度不超过62个字（包含标点符号）
1.无参数模板示例：
天猫双11全球狂欢节，全球好货不只5折。亿万优惠券10点准时开抢，现在打开淘宝或天猫客户端，开始抢红包啦！
2.带参数模板示例：
【支付宝】你的支付宝发生##元的交易，校验码：##打死都不能告诉别人哦！唯一热线95188
1、变量用#*#代替
2、内容+变量不能超过62字符
remark 字符串 否 备注

响应

响应参数列表

参数 有效值范围 说明
code 数字文本 状态码，全0表示正确
msg 文本 返回情况说明
data JSON 对象 返回数据对象，参见data对象属性列表

示例

请求:

  1. POST ${BASE_URL}/msg/template/100001 HTTP/1.1
  2. Host: api.yunhuni.com
  3. Content-Type: application/json
  4. Accept-Type: application/json
  5. Content-Length: xxx
  6. {
  7.    "name":"双11打折",
  8.    "type":"msg_sms",
  9.    "content":"天猫双11全球狂欢节，全球好货不只5折。",
  10.    "remark":"双11模板"
  11. }

响应:

  1. HTTP/1.1 200 OK
  2. Content-Type: application/json
  3. Content-Length: xxx
  5. {
  6.   "code": "000000",
  7.   "msg": "请求成功",
  8.   "data": {
  9.               "name":"双11打折",
  10.               "type":"msg_sms",
  11.               "tempId":"10001",
  12.               "content":"天猫双11全球狂欢节，全球好货不只5折。",
  13.               "status":1,
  14.               "remark":"双11模板",
  15.               "checkTime":"",
  16.               "reason":""
  17.            }
  18. }

删除模板

请求

URL

  1. DELETE ${BASE_URL}/msg/template/{tempId}

　请求参数列表

无

响应

响应参数列表

参数 有效值范围 说明
code 数字文本 状态码，全0表示正确
msg 文本 返回情况说明
data null 无

参数详解

示例

请求:

  1. DELETE ${BASE_URL}/msg/template/100001 HTTP/1.1
  2. Host: api.yunhuni.com
  3. Content-Type: application/json
  4. Accept-Type: application/json
  5. Content-Length: xxx

响应:

  1. HTTP/1.1 200 OK
  2. Content-Type: application/json
  3. Content-Length: xxx
  5. {
  6.   "code": "000000",
  7.   "msg": "请求成功",
  8.   "data": null
  9. }

查询模板

请求

URL

  1. GET ${BASE_URL}/msg/template[/{tempId}]

URL 不包含 {tempId} 参数，则获取模板列表，否则获取具体的某个模板的信息。

　请求参数

参数 有效值范围 必填 默认值 说明
pageNo 数字 否 1 当获取模板列表时有效，第几页
pageSize 小于1000 否 20 当获取模板列表时有效，每一页的记录数（上限1000）

响应

参数列表

参数 有效值范围 说明
code 数字文本 状态码，全0表示正确
msg 文本 返回情况说明
data JSON 对象 返回数据(或分页数据)对象，参见data对象属性列表

示例

请求单个:

  1. GET ${BASE_URL}/msg/template/10001 HTTP/1.1

响应:

  1. HTTP/1.1 200 OK
  2. Content-Type: application/json
  3. Content-Length: xxx
  5. {
  6.   "code": "000000",
  7.   "msg": "请求成功",
  8.   "data": {
  9.               "name":"双11打折",
  10.               "type":"msg_sms",
  11.               "tempId":"10001",
  12.               "content":"天猫双11全球狂欢节，全球好货不只5折。",
  13.               "status":1,
  14.               "remark":"双11模板",
  15.               "checkTime":"2016-01-01 00:00:00",
  16.               "reason":"不通过原因"
  17.            }
  18. }

请求多个:

  1. GET ${BASE_URL}/msg/template?pageNo=1&pageSize=10 HTTP/1.1

响应多个:

  1. HTTP/1.1 200 OK
  2. Content-Type: application/json
  3. Content-Length: xxx
  5. {
  6.   "code": "000000",
  7.   "msg": "请求成功",
  8.   "data": {
  9.     "pageSize": 10, //每一页的记录数
  10.     "startIndex": 1, //从第几条开始
  11.     "totalCount": 3, //总记录数
  12.     "totalPageCount": 1, //总页数
  13.     "currentPageNo": 1, //当前页数
  14.     "result": [
  15.       {
  16.         "name":"双11打折",
  17.         "type":"msg_sms",
  18.         "tempId":"10002",
  19.         "content":"天猫双11全球狂欢节，全球好货不只5折。",
  20.         "status":1,
  21.         "remark":"双11模板1",
  22.         "checkTime":"2016-01-01 00:00:00",
  23.         "reason":"不通过原因"
  24.       },
  25.       {
  26.          "name":"双11打折",
  27.          "type":"msg_sms",
  28.          "tempId":"10003",
  29.          "content":"天猫双11全球狂欢节，全球好货不只6折。",
  30.          "status":1,
  31.          "remark":"双11模板2",
  32.          "checkTime":"2016-01-01 00:00:00",
  33.          "reason":"不通过原因"
  34.       },
  35.       {
  36.         "name":"双11打折",
  37.         "type":"msg_sms",
  38.         "tempId":"10004",
  39.         "content":"天猫双11全球狂欢节，全球好货不只7折。",
  40.         "status":1,
  41.         "remark":"双11模板3",
  42.         "checkTime":"2016-01-01 00:00:00",
  43.         "reason":"不通过原因"
  44.       }
  45.     ]
  46.   }
  47. }