云池物联API能力调用
V1.1-发布日期[2017/12/05]-更新日期[2018/05/02]文档下载
1、接口规范命名规则
   1.1、路径规范
   参数说明:
参数名称 是否必填 参数含义 说明
appid 应用ID 系统分配
restkey 密钥 系统分配
sign 数据签名 详见签名sign生成方法
   1.2、命名规则
A)、提交方式统一POST;
B)、APPID(系统分配)、RESTKEY(系统分配)、SIGN(SHA-256);
   1.3、Sign生成方法
A)、将post提交参数【除sign参数外】按照ASCII码键值降序排列;
B)、将排序的集合拼接成key=value形式字符串且尾部添加上系统分配的appid得到代签名字符串;
D)、将代签名字符串进行SHA-256得到sign
   1.4、数据规范
数据结果以JSON格式返回
   {"code":0,"message":"SUCCESS"}

字段 说明
code 状态码
message 响应消息具体解释
   1.5、返回码规范
状态码 含义
0 正常请求
400 无效的appid或restkey
401 签名不正确
402 请确认提交参数
403 发送内容不能包含有不雅用语
404 短信内容长度不得超过160个字符
405 短信订单生成失败
406 短信记录生成失败
407 当前账户余额不足
408 短信内容不能为空
409 iccid卡号总条数不能大于30条
410 卡片运营商不相同
411 卡片必须为激活状态
412 卡片未开通短信功能
413 客户经理账户余额不足
414 卡片已到期
415 短信发送失败
416 备注内容不能为空
417 备注失败
418 备注内容不能大于30个字
500 当前没有数据
501 提交的卡片不在当前用户卡片范围
502 平台下发短信到物联网卡必须是已激活状态且已开通短信服务
503 卡片需为已激活或停机状态
504 未有套餐类型
505 续费周期最低为一个月
506 续费卡片的套餐规格必须相同
507 提交卡片包含非请求类型
508 移动卡片结算日不支持续费
800 提交方式错误
2、账户信息查询
   2.1、接口地址
   http://iot.yunchiiot.com/capi/api/index
   2.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
   2.3、返回结果数据
{
"code": 0,
"data": {
"result": {
"number": "ABCD",
"company_name": "上海XX科技有限公司",
"link_user": "王先生",
"phone": "13366554477",
"money": 6.4,
"addtime": "2017-12-25 13:22:21",
"cardSummary": {
"unicom": 10,
"cmcc": 50
}
}
},
"msg": "SUCCESS"
}
   2.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 对象 obj
result 数组 array
number 账号名称 string
company_name 公司名称 string
link_user 联系人 string
phone 手机号 string
money 账户余额 string
addtime 注册时间 string
cardSummary 卡片数组 array
unicom 联通卡片[未有联通卡片改元素不会被返回] int
cmcc 移动卡片[未有移动卡片改元素不会被返回] int
telcom 电信卡片[未有电信卡片改元素不会被返回] int
3、资质认证查询
   3.1、接口地址
   http://iot.yunchiiot.com/capi/api/approve
   3.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
   3.3、返回结果数据
{
"code": 0,
"data": {
"approve_result": {
"register_number": "sss11",
"register_img": "/public/uploads/22.jpg",
"operator": "/public/uploads/11.jpg",
"company_name": "上海xxx有限公司",
"company_address": "",
"addtime": "2017-12-25 13:24:15",
"type": 1
}
},
"msg": "SUCCESS"
}
   3.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 对象 object
approve_result 数组 array
register_number 工商注册号 string
register_img 工商营业执照 string
operator 经办人手持身份证 string
company_name 公司名称 string
company_address 注册地址 string
addtime 添加时间 string
type 是否通过审核0:不通过 1:通过 2:审核中 int
msg 成功返回信息 string
4、卡片管理
4.1、卡片详情
   4.1.1、接口地址
   http://iot.yunchiiot.com/capi/api/iccid_details
   4.1.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
iccid 卡片iccid号码 string
   4.1.3、返回结果数据
{
"code": 0,
"data": {
"iccid": "1234567890123",
"imsi": "55664488",
"msisdn": "2556",
"card_type": 1,
"status": "已激活",
"globalsimtype": "联通",
"pkg_spec": "月套餐/100M",
"pkg_total": "100M",
"pkg_used": "0M",
"agent_number": "C1A51C5",
"dateagent": "2017-12-25 13:33:55",
"client_remarks": "",
"agent_iccid_period": "3",
"dateexpire": "2018-05-26 23:59:59",
"dateActivated": "2018-02-27 14:30:01",
"grace": ""
},
"msg": "SUCCESS"
}
   4.1.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 对象 object
iccid 卡片号码ICCID string
imsi 号码IMSI string
msisdn 号码MSISDN string
card_type 卡类型 0:单卡 1:流量卡 int
status 卡片状态 string
globalsimtype 运营商 string
pkg_spec 套餐规格 string
pkg_total 套餐总量 string
pkg_used 套餐已用量 string
agent_number 关联客户经理 string
dateagent 发卡日期 string
client_remarks 备注描述 string
agent_iccid_period 订购周期 string
dateexpire 卡到期时间 string
dateActivated 卡激活时间 string
grace 卡片沉默期 string
msg 成功返回信息 string
4.2、卡片状态查询
   4.2.1、接口地址
   http://iot.yunchiiot.com/capi/api/card_status
   4.2.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
iccid 卡片iccid号码 string
   4.2.3、返回结果数据
{
"code": 0,
"data": {
"iccid": "89860117750025878464",
"imsi": "460012005774686",
"status": "已激活"
},
"msg": "SUCCESS"
}
   4.2.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 对象 object
iccid 卡片号码ICCID string
imsi 号码IMSI string
status 卡状态 string
msg 成功返回信息 string
4.3、卡片续费记录
   4.3.1、接口地址
   http://iot.yunchiiot.com/capi/api/renew_log
   4.3.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
page 分页【从0开始,不传递默认取第一页】 int
   4.3.3、返回结果数据
返回结果数据字段参考参数说明
   4.3.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 对象 object
renewlog_result 数组 array
order_number 续费订单号 string
payer 支付名称 string
money 支付金额 float
addtime 下单时间 string
source 交易方式 string
renew_msg 续费周期 int
operator 续费卡片运营商 string
iccid 续费卡片ICCID string
pkg_kind 续费的套餐 string
pageNumber 分页总数 int
msg 成功返回信息 string
4.4、卡片更改套餐记录
   4.4.1、接口地址
   http://iot.yunchiiot.com/capi/api/modify_pkg_log
   4.4.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
page 分页【从0开始,不传递默认取第一页】 int
   4.4.3、返回结果数据
返回结果数据字段参考参数说明
   4.4.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 对象 object
list 数组 array
order_number 更改套餐订单号 string
payer 支付名称 string
money 支付金额 float
addtime 下单时间 string
save_pkg 套餐类型 string
iccid 卡片号码ICCID string
pageNumber 分页总数 int
msg 成功返回信息 string
4.5、卡片叠加包记录
   4.5.1、接口地址
   http://iot.yunchiiot.com/capi/api/superposition_log
   查询流量池叠加记录
   4.5.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
page 分页【从0开始,不传递默认取第一页】 int
   4.5.3、返回结果数据
返回结果数据字段参考参数说明
   4.5.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 对象 object
renewlog_result 数组 array
order_number 叠加包订单号 string
payer 支付名称 string
money 支付金额 float
addtime 下单时间 string
multiple 叠加倍数 string
flow 叠加流量 int
pkg 叠加规格 string
operator_type 运营商 string
pageNumber 分页总数 int
msg 成功返回信息 string
4.6、卡片加油包记录
   4.6.1、接口地址
   http://iot.yunchiiot.com/capi/api/dataplus
   查询单卡加油包记录
   4.6.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
page 分页【从0开始,不传递默认取第一页】 int
   4.6.3、返回结果数据
返回结果数据字段参考参数说明
   4.6.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 对象 object
list 数组 array
order_number 加油包订单号 string
payer 支付名称 string
money 支付金额 float
addtime 下单时间 string
save_pkg 加油包套餐类型 string
iccid 卡片号码ICCID string
pageNumber 分页总数 int
msg 成功返回信息 string
4.7、卡片历史记录
   4.7.1、接口地址
   http://iot.yunchiiot.com/capi/api/hoistory
   4.7.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
month 查询年月【格式为201802】 注【不传递默认为当前年月】 string
page 分页【从0开始,不传递默认取第一页】 int
   4.7.3、返回结果数据
返回结果数据字段参考参数说明
   4.7.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 对象 object
return_result 数组 array
month 历史记录时间 string
link_flow 已使用流量 string
link_voice 语音 string
link_msg 短信 string
iccid 卡片号码ICCID string
reveal_name 运营商 string
flow_total 套餐总量 string
pkg_kind 套餐规格 string
total_page 总页码 int
msg 成功返回信息 string
4.8、卡片备注
   4.8.1、接口地址
   http://iot.yunchiiot.com/capi/api/cardremark
   卡片支持批量备注,多个iccid号码请用‘,’号隔开,批量备注不得大于30条iccid,备注字数限定在30字内
   4.8.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
iccid 卡片号码ICCID string
remark 备注内容 string
   4.8.3、返回结果数据
{
"code": 0,
"data": [],
"msg": "SUCCESS"
}
   4.8.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 成功返回空数组 array
msg 成功返回信息 string
4.9、套餐列表查询
   4.9.1、接口地址
   http://iot.yunchiiot.com/capi/api/pkg_list
   4.9.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
page 分页【从0开始,不传递默认取第一页】 int
   4.9.3、返回结果数据
返回结果数据字段参考参数说明
   4.9.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 对象 object
pkg_list 数组 array
agent_price 套餐价格 string
operator_type 运营商 float
pkg_kind 套餐类型【0:按月套餐 1:按季度套餐 2:按年套餐】 string
total 套餐流量 string
create_time 套餐生效时间 string
paraneter 套餐参数说明 string
specion 材质规格描述 materials材质 card_price卡费 string
pageNumber 分页 int
msg 成功返回信息 string
5、流量池查询
   5.1、接口地址
   http://iot.yunchiiot.com/capi/api/flow_class
   5.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
operator 运营商【不传默认查询联通 0:联通 1:移动 2:电信】 int
   5.3、返回结果数据
{
"code": 0,
"data": {
"list": [
{
"dateUpdated": "2018-05-01 23:02:30",
"total_number": 487,
"total_active": 486,
"total_notactive": 0,
"total_alreadystop": 1,
"pkg_spec": "10M/月",
"pkg_used": "37.93M",
"total_flow": "4870M",
"total_bag_flow": "0M",
"total_surplus_flow": "4832.07M",
"flow_percent": "0.78%",
"type": "0"
}
],
},
"msg": "SUCCESS"
}
   5.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 对象 object
list 数组 array
dateUpdated 用量更新时间 string
total_number 总卡量 int
total_active 已激活的卡片数量 int
total_notactive 未激活的卡片数量 int
total_alreadystop 已停卡的卡片数量 int
pkg_spec 流量池规格 string
pkg_used 流量已使用总量 string
total_flow 当月流量总量 string
total_bag_flow 叠加流量总量 string
total_surplus_flow 剩余流量 string
flow_percent 使用百分比 string
type 当前运营商 0:联通 1:移动 2:电信 string
msg 成功返回信息 string
6、预警日志查询
   6.1、接口地址
   http://iot.yunchiiot.com/capi/api/early_log
   6.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
page 不传递值默认取第一页 int
   6.3、返回结果数据
返回结果数据字段参考参数说明
   6.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 对象 object
early_log_result 数组 array
early_type 预警类型 string
registerearly_textnumber 预警内容 string
early_inform_type 通知方式 string
addtime 预警时间 string
pagenumber 分页总页码 int
msg 成功返回信息 string
7、短信管理
7.1、联通短信下发
   7.1.1、接口地址
   http://iot.yunchiiot.com/capi/api/link_message
   该接口仅支持联通卡片,联通发送短信最大卡片条数不得大于30条,多个iccid号码请用‘,’号隔开,卡片需开通短信功能且为激活状态
   7.1.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
iccid 卡片号码ICCID string
   7.1.3、返回结果数据
返回结果数据字段参考参数说明
   7.1.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 成功返回空数组 array
msg 成功返回信息 string
7.2、移动短信下发
   7.2.1、接口地址
   http://iot.yunchiiot.com/capi/api/mobil_message
   该接口仅支持联通卡片,移动发送短信最大卡片条数不得大于30条,多个iccid号码请用‘,’号隔开,卡片需开通短信功能且为激活状态
   7.2.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
iccid 卡片号码ICCID string
   7.2.3、返回结果数据
返回结果数据字段参考参数说明
   7.2.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 成功返回空数组 array
msg 成功返回信息 string
7.3、下发短信记录
   7.3.1、接口地址
   http://iot.yunchiiot.com/capi/api/message_log
   7.3.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
page 起始分页【不传递默认第一页】 int
   7.3.3、返回结果数据
{
"code": 0,
"data": {
"list": [
{
"addtime": "2018-01-30 15:27:28",
"content": "这里是云池物联API测试",
"id": 4,
"iccid": "89860617040018878308",
"operator": "联通"
},
{
"addtime": "2018-01-30 15:30:06",
"content": "这是API的测试短信哦",
"id": 6,
"iccid": "89860617040018878308",
"operator": "联通"
},
{
"addtime": "2018-01-30 15:36:38",
"content": "这是多条iccid短信测试",
"id": 7,
"iccid": "89860617040018878308,89860617040018882920",
"operator": "联通"
},
],
"pageNumber": 1
},
"msg": "SUCCESS"
}
   7.3.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 对象 object
list 数组 array
addtime 发送时间 string
content 内容 string
id 发送记录id string
iccid 卡片号码ICCID string
operator 运营商 string
pageNumber 总页码 int
msg 成功信息 string
7.4、累计流量短信语音查询
   7.4.1、接口地址
   http://iot.yunchiiot.com/capi/api/month_flowmess_log
   该接口返回当前月的短信语音流量使用情况,结算日清零
   7.4.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
page 起始分页【不传递默认第一页】 int
   7.4.3、返回结果数据
{
"code": 0,
"data": {
"list": [
{
"iccid": "89860617040018882516",
"link_voice": "0",
"link_msg": "0",
"link_flow": 0,
"operator": "联通",
"status": "已停机",
"pkg_flow": "5M",
"pkg_type": "5M/月套餐"
},
{
"iccid": "89860617040018882904",
"link_voice": "0",
"link_msg": "0",
"link_flow": 0,
"operator": "联通",
"status": "已停机",
"pkg_flow": "5M",
"pkg_type": "5M/月套餐"
},
],
"pageNumber": 1
},
"msg": "SUCCESS"
}
   7.4.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 对象 object
list 数组 array
iccid 卡片号码ICCID string
link_voice 累计已使用语音 string
link_msg 累计已使用短信 string
link_flow 累计已使用流量 string
operator 运营商 string
status 卡片状态 string
pkg_flow 流量总量 string
pkg_type 套餐规格 string
pageNumber 分页总数 string
msg 成功信息 string
8、财务管理
8.1、我的财务
   8.1.1、接口地址
   http://iot.yunchiiot.com/capi/api/finance
   8.1.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
   8.1.3、返回结果数据
{
"code": 0,
"data": {
"return_result": [
{
"number": "123456",
"id": 3,
"order_number": "11225544",
"money": 118,
"pay_type": "分配额度",
"source": "线下交易",
"addtime": "2017-12-25 13:33:01"
},
{
"number": "123456",
"id": 3,
"order_number": "11225544",
"money": 118,
"pay_type": "分配额度",
"source": "线下交易",
"addtime": "2017-12-25 13:33:01"
},
]
},
"msg": "SUCCESS"
}
   8.1.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 对象 object
return_result 数组 array
number 登入账号 string
id 交易订单id string
order_number 交易订单号 string
money 金额 string
pay_type 订单类型 string
source 交易方式 string
addtime 添加时间 string
msg 成功信息 string
8.2、发票记录
   8.2.1、接口地址
   http://iot.yunchiiot.com/capi/api/bill
   8.2.2、请求参数
   POST参数:
字段名 字段含义 类型
appid 系统分配 string
restkey 系统分配 string
sign 详见sign生成方法 string
   8.2.3、返回结果数据
{
"code": 0,
"data": {
"bill_log": [
{
"title": "上海xx科技有限公司",
"bill": 2,
"money": "1128.00",
"type": 1,
"number": "91450103310161651A",
"bank": "花旗银行",
"bank_number": "123456",
"regist_address": "火星2号",
"regist_phone": "02222",
"mark": "已开",
"order_number": "123456,123456",
"profile_address": "火星先生,123456789,火星2号99楼",
"addtime": "2017-12-29 15:43:44"
}
]
},
"msg": "SUCCESS"
}
   8.2.4、参数说明
字段名 字段含义 类型
code 状态码 int
data 对象 object
bill_log 数组 array
title 发票抬头名称 string
bill 发票类型 1: 增值税普通发票 2:增值税专用发票 string
money 发票金额 string
type 审核状态 0:待处理 1: 已处理 2: 已作废 3:不通过 int
number 税务登记号 string
bank 开户行名称 string
bank_number 银行卡号 string
regist_address 注册地址 string
regist_phone 注册电话号 string
mark 备注描述 string
order_number 发票订单号 string
profile_address 收件地址 string
addtime 申请时间 string
msg 成功信息 string
9、卡片续费
   9.1、接口地址
   http://iot.yunchiiot.com/capi/api/card_renew
   9.1.2、请求参数
   POST参数:
字段名 字段含义 备注
appid 系统分配
restkey 系统分配
sign 详见sign生成方法
iccid 卡片ICCID号码 卡片iccid号码最大不得超过30条
pkg_type 续费套餐类型 0:月套餐 1:季度套餐 2:年套餐
cycle 续费多长周期 如果pkg_type非0该字段失效
   9.1.3、接口描述
.续费卡片的运营商必须保持一样;
.续费卡片最大条数不得超过30条;
.续费套餐类型与原有套餐类型必须一致;
.续费卡片有效期不得是过期的;
.续费卡片状态必须为已激活或停机;
.业务报文pkg_type 非0时续费周期在原有基础加上一个周期[*注pkg_type为1时默认加上一个季度 2时加上一年*]
*该接口涉及金额操作请确保账户余额充足,如果余额不足请先去充值再续费;
*续费为月套餐时最低周期为一个月;
*移动支持在22日前操作续费,过了这个时间段不能续费或在有效期内下月再续费操作提交;
   9.1.4、返回结果数据参考接口状态码列表
客服热线:400-619-1399
在线客服