短信

模板短信单发

请求URL

  1. POST ${BASE_URL}/msg/sms/send

请求参数列表

参数 有效值范围 是否必填 说明
mobile 字符串 是 目标号码
tempId 字符串 是 模板编号
tempArgs 字符串 否 模板中对应的参数值(中文请使用utf-8编码)，多个参数值以分号间隔。 参数值顺序与模板中变量顺序对应。 参数值个数必须与模板中变量个数一致，否则返回失败。

响应参数列表

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

参数详解

data对象属性列表

属性 有效值范围 说明
msgKey 字符串 消息任务标识，用于查询消息发送结果
state int 1成功，0失败
invalidMobiles 数组 群发时有号码失败则有该字段，失败的号码

示例

请求:

  1. POST ${BASE_URL}/msg/sms/send HTTP/1.1
  2. Host: api.yunhuni.com
  3. Content-Type: application/json
  4. Accept-Type: application/json
  5. Content-Length: xxx
  6. {
  7.    "mobile":"13750012158",
  8.    "tempId":"100001",
  9.    "tempArgs": "参数值1;参数值2"
  10. }

响应:

  1. HTTP/1.1 200 OK
  2. Content-Type: application/json
  3. Content-Length: xxx
  5. {
  6.   "code": "000000",
  7.   "msg": "请求成功",
  8.   "data": {
  9.       "msgKey":"40288ac9580a67f501580a6a42a40001",
  10.       "state":1，
  11.     }
  12. }

模板短信群发

请求URL

  1. POST ${BASE_URL}/msg/sms/mass/task

请求参数列表

参数 有效值范围 是否必填 说明
taskName 字符串 是 群发任务名称
tempId 字符串 是 模板编号
tempArgs 字符串 否 模板中对应的参数值(中文请使用utf-8编码)，多个参数值以分号间隔。 参数值顺序与模板中变量顺序对应。 参数值个数必须与模板中变量个数一致，否则返回失败。
mobiles 字符串 是 发送号码，多个以逗号分割，最大数量为10000个
sendTime 字符串 是 发送时间，格式为“yyyy-MM-dd HH:mm:ss“（时间提交规则与群发任务功能一致，如果时间小于当前时间10分钟，则自动设置为当前时间+10分钟）， 发送时间小于当前时间+7天，大于当前时间+10分钟

响应参数列表

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

示例

请求:

  1. POST ${BASE_URL}/msg/sms/mass/task HTTP/1.1
  2. Host: api.yunhuni.com
  3. Content-Type: application/json
  4. Accept-Type: application/json
  5. Content-Length: xxx
  6. {
  7.    "taskName":"测试消息",
  8.    "tempId":"100001",
  9.    "tempArgs": "参数值1;参数值2",
  10.    "mobiles": "13750012158,13750012159",
  11.    "sendTime": "2017-02-12 10:25:45"
  12. }

响应:

  1. HTTP/1.1 200 OK
  2. Content-Type: application/json
  3. Content-Length: xxx
  5. {
  6.   "code": "000000",
  7.   "msg": "请求成功",
  8.   "data": {
  9.     "msgKey":"40288ac9580a67f501580a6a42a40001",
  10.     "state":1，
  11.     "invalidMobiles":["13750012158"]，
  12.   }
  13. }

发送结果查询

请求URL

  1. GET ${BASE_URL}/msg/sms[/{msgKey}]

URL 不包含 {msgKey} 参数，则获取列表，否则获取具体的某个发送的sms信息。

请求参数列表

请求参数列表

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

响应参数列表

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

参数详解

发送结果data对象属性列表

属性 有效值范围 说明
msgKey 字符串 消息任务标识，用于查询消息发送结果
taskName 字符串 任务名称
tempId 字符串 模板编号
tempArgs 字符串 模板参数
sendTime 字符串 发送时间
sendType 字符串 发送类型
isMass boolean 是否是群发
sumNum int 发送总数量
state int 发送状态
succNum int 发送成功数量
failNum int 发送失败数量
pendingNum int 待发送数量

示例

请求单个:

  1. GET ${BASE_URL}/msg/sms/40288ac9580a67f501580a6a42a40001 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.     "msgKey":"40288ac9580a67f501580a6a42a40001",
  10.     "taskName":"2017双11促销",
  11.     "tempId":"tempId",
  12.     "tempArgs":"参数值1;参数值2",
  13.     "sendTime":"2017-02-12 10:25:45",
  14.     "sendType":"msg_sms",
  15.     "isMass":true,
  16.     "sumNum":"10000",
  17.     "state":"1",
  18.     "succNum":"7000",
  19.     "failNum":"2000",
  20.     "pendingNum":"1000"
  21.   }
  22. }

请求多个:

  1. GET ${BASE_URL}/msg/sms?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.         "msgKey":"40288ac9580a67f501580a6a42a40001",
  17.         "taskName":"2017双11促销",
  18.         "tempId":"tempId",
  19.         "tempArgs":"参数值1;参数值2",
  20.         "sendTime":"2017-02-12 10:25:45",
  21.         "sendType":"msg_sms",
  22.         "isMass":true,
  23.         "sumNum":"10000",
  24.         "state":"1",
  25.         "succNum":"7000",
  26.         "failNum":"2000",
  27.         "pendingNum":"1000"
  28.       },
  29.       {
  30.          "msgKey":"40288ac9580a67f501580a6a42a40002",
  31.          "taskName":"2017双11促销",
  32.          "tempId":"tempId",
  33.          "tempArgs":"参数值1;参数值2",
  34.          "sendTime":"2017-02-12 10:25:45",
  35.          "sendType":"msg_sms",
  36.          "isMass":true,
  37.          "sumNum":"10000",
  38.          "state":"1",
  39.          "succNum":"7000",
  40.          "failNum":"2000",
  41.          "pendingNum":"1000"
  42.       },
  43.       {
  44.         "msgKey":"40288ac9580a67f501580a6a42a40003",
  45.         "taskName":"2017双11促销",
  46.         "tempId":"tempId",
  47.         "tempArgs":"参数值1;参数值2",
  48.         "sendTime":"2017-02-12 10:25:45",
  49.         "sendType":"msg_sms",
  50.         "isMass":true,
  51.         "sumNum":"10000",
  52.         "state":"1",
  53.         "succNum":"7000",
  54.         "failNum":"2000",
  55.         "pendingNum":"1000"
  56.       }
  57.     ]
  58.   }
  59. }