1. 首页
  2. 短信服务
  3. 短信产品接口文档

短信产品接口文档

短信模板新增接口

接口地址

POST https://sms-api.upyun.com/api/templates

参数定义

参数 说明 Required(必填)
title 模板标题(少于12个字) ✔️
content 模板内容(模版签名+模版内容+2少于350个字) ✔️
temp_sign 模版签名(3~8个字) ✔️
sign_location 模版签名位置 (top,bottom) ✔️
type 模板类型 (industry, marketing) ✔️
report_type 审核类型(vip, general) ✔️

响应

创建成功返回响应码和内容。

201 Created
{
  "title": "title",
  "temp_sign": "sign",
  "content": "content",
  "sign_location": "top",
  "type": "industry",
  "status": "review",
  "updated_at": "2017-04-10T02:58:12.000Z",
  "report_type": "vip",
  "id": 4,
  "owner": {
    "id": 1,
    "name": "taevas",
    "general": 8000,
    "vip": 0,
    "industry": 4,
    "marketing": 0
  }
}

响应值说明

参数 说明
title 模板标题
temp_sign 模板签名
content 模板内容
status 模板状态(审核中、通过、失败)
type 短信类型(营销、行业)
updated_at 创建时间
report_type 审核类型(免签, 普通)
id 模板编号
owner 创建者信息
owner.id 用户编号
owner.name 用户昵称
owner.general 普通短信剩余条数
owner.vip 免签短信剩余条数
owner.industry 已发送行业短信条数
owner.marketing 已发送营销短信条数

请求示例

POST https://sms-api.upyun.com/api/templates HTTP/1.1
Authorization: <your token>
{
  "title": "title",
  "content": "content",
  "temp_sign": "sign",
  "sign_location": "top",
  "type": "industry",
  "report_type": "vip"
}

短信模板删除接口

接口地址

DELETE https://sms-api.upyun.com/api/templates/{template_id}

参数定义

参数 说明 Required(必填)
template_id 模板编号 ✔️

响应

204 No Content

请求示例

DELETE https://sms-api.upyun.com/api/templates/4
Authorization: <your token>

短信模板修改接口

接口地址

PATCH /api/templates/{template_id}

参数定义

参数 说明 Required(必填)
template_id 模板编号 ✔️
title 模板标题(少于12个字)
content 模板内容(模版签名+模版内容+2少于350个字)
temp_sign 模版签名(3~8个字)
sign_location 模版签名位置 (top,bottom)

响应

200 OK
{
  "title": "hello",
  "temp_sign": "sign",
  "content": "content",
  "sign_location": "top",
  "type": "industry",
  "status": "review",
  "updated_at": "2017-04-10T03:31:18.000Z",
  "id": 3,
  "report_type": "vip",
  "owner": {
    "id": 1,
    "name": "taevas",
    "general": 8000,
    "vip": 0,
    "industry": 4,
    "marketing": 0
  }
}

响应值说明

参数 说明
title 模板标题
temp_sign 模板签名
content 模板内容
status 模板状态(审核中、通过、失败)
type 短信类型(营销、行业)
updated_at 创建时间
report_type 审核类型(免签, 普通)
id 模板编号
owner 创建者信息
owner.id 用户编号
owner.name 用户昵称
owner.general 普通短信剩余条数
owner.vip 免签短信剩余条数
owner.industry 已发送行业短信条数
owner.marketing 已发送营销短信条数

请求示例

PATCH https://sms-api.upyun.com/api/templates/3
Authorization: <your token>
{
  "title": "hello"
}

查询模板接口

接口地址

GET https://sms-api.upyun.com/api/templates

参数定义

参数 说明 Required(必填)
status 模板状态 (review, success, defeat)
type 模板类型 (industry, marketing)
report_type 审核类型(vip, general)

响应

200 OK
{
  "templates": [
    {
      "title": "hello",
      "temp_sign": "sign",
      "content": "content",
      "sign_location": "top",
      "type": "industry",
      "status": "review",
      "updated_at": "2017-04-10T03:31:18.000Z",
      "id": 3,
      "report_type": "vip",
      "owner": {
        "id": 1,
        "name": "taevas",
        "general": 8000,
        "vip": 0,
        "industry": 4,
        "marketing": 0
      }
    }
  ]
}

响应值说明

参数 说明
title 模板标题
temp_sign 模板签名
content 模板内容
status 模板状态(审核中、通过、失败)
type 短信类型(营销、行业)
updated_at 创建时间
report_type 审核类型(免签, 普通)
id 模板编号
owner 创建者信息
owner.id 用户编号
owner.name 用户昵称
owner.general 普通短信剩余条数
owner.vip 免签短信剩余条数
owner.industry 已发送行业短信条数
owner.marketing 已发送营销短信条数

请求示例

GET https://sms-api.upyun.com/api/templates?type=industry&report_type=vip
Authorization: <your token>

短信发送接口

接口地址

POST https://sms-api.upyun.com/api/messages

参数定义

参数 说明 Required(必填)
mobile 手机号,逗号分隔 ✔️
template_id 模板编号 ✔️
vars 短信参数(以 | 分隔)

响应

200 OK
{
  "message_ids": [
    {
      "error_code": "ILLEGAL_MOBILE",
      "mobile": "15757"
    },
    {
      "message_id": 30,
      "mobile": "15757654321”
    }
  ]
}

响应值说明

参数 说明
message_ids 给所有手机号发送短信的结果
error_code 错误情况
message_id message 编号
mobile 手机号

请求示例

POST https://sms-api.upyun.com/api/messages
Authorization: <your token>
{
  "template_id": 2,
  "mobile": "15757,15757654321”
}

短信报表查询接口

接口地址

GET https://sms-api.upyun.com/api/messages

参数定义

参数 说明 Required(必填)
date 日期
mobile 手机号
status 消息发送的状态
page 页码
per_page 每页显示数量

响应

200 OK
{
  "messages": [
    {
      "id": 4,
      "template_id": 2,
      "report_type": "vip",
      "title": "测试测试",
      "type": "industry",
      "content": "hello,hello",
      "temp_sign": "落子時",
      "mobile": "15757654321”,
      "sent_at": null,
      "created_at": "2017-04-07T08:47:37.000Z",
      "status": "processing",
      "quantity": 1,
      "owner": {
        "id": 1,
        "name": "taevas",
        "general": 8000,
        "vip": 0,
        "industry": 4,
        "marketing": 0
      }
    }
    {
      "id": 2,
      "template_id": 2,
      "report_type": "vip",
      "title": "测试测试",
      "type": "industry",
      "content": "hello,hello【落子時】",
      "temp_sign": "落子時",
      "mobile": "15757123456”,
      "sent_at": "2017-04-06T08:36:01.000Z",
      "created_at": "2017-04-06T08:36:00.000Z",
      "status": "success",
      "quantity": 1,
      "owner": {
        "id": 1,
        "name": "taevas",
        "general": 8000,
        "vip": 0,
        "industry": 4,
        "marketing": 0
      }
    }
  ],
  "total": 2
}

响应值说明

参数 说明
id 短信编号
template_id 模板编号
report_type 审核类型
title 模板标题
type 短信类型(营销、行业)
content 模板内容
temp_sign 模板签名
mobile 手机号
sent_at 发送时间
created_at 创建时间
status 短信发送状态
owner 创建者信息
owner.id 用户编号
owner.name 用户昵称
owner.general 普通短信剩余条数
owner.vip 免签短信剩余条数
owner.industry 已发送行业短信条数
owner.marketing 已发送营销短信条数

请求示例

curl -H "Authorization: <your token>" https://sms-api.upyun.com/api/messages?mobile=15757654321

这篇文章有帮助吗?

相关文章