API是SMS为你提供的获取SMS用户相应授权信息的API,当你获得用户授权后通过以下API可以轻松的访问相应的资源。
http://api.111sms.com
错误返回格式: httpCode 为200情况:
{
"message": "重复请求",
"data": [],
"code": 10001
}
code值:
10001
nonceStr重复提交请求导致;10002
timestamp 大于校验时间,超时;10003
签名不正确..;10004
nonceStr 长度不是16位20001
AccessToken 过期20002
AccessToken校验失败20000
普通错误提示语40000
字段缺失(或必填字段为空)40004
获取ACCESS_TOKEN未找到用户,请核实数据40005
该用户已被拉黑40006
不在IP白名单内,不允许请求40029
请求频繁;httpCode 为500; 系统错误,联系管理员
备注:
1分钟只允许请求一次;自行保存数据
请求方式: GET
GET请求参数:
参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
---|---|---|---|---|
appid | 是 | String | APPID | |
app_secret | 是 | String | APP_SECRET |
接口请求地址
GET http://api.111sms.com/api/sms/project?appid=&app_secret=
成功返回结果:JSON示例
{
"code": 0,
"data": [
{
"country_name": "USA",
"country_code": "+1",
"image": "images/e44f88ba65ff146b50d01bcdd33b10db.jpg",
"operators": [
{
"operator_name": "T-mobile",
"projects": [
{
"project_name": "Google",
"introduction": null,
"price": "1.0000",
"keyword": null,
"sms_keyword": "Google",
"secondary_deduction": 1,
"type": 1,
"project_id": 159992131
}
],
"operator_id": 1
}
],
"country_id": 1
}
],
"message": "请求成功"
}
参数名 | 参数值 | 参数类型 | 描述说明 |
---|---|---|---|
code | 0 | Number | |
data | Object | 返回数据 | |
data.country_name | USA | String | 国家名称 |
data.country_id | 1 | Number | 国家ID |
data.country_code | +1 | String | 国家代码 |
data.image | images/e44f88ba65ff146b50d01bcdd33b10db.jpg | String | 图片 |
data.operators | Object | 运营商 | |
data.operators.operator_id | 1 | Number | 运营商ID |
data.operators.operator_name | T-mobile | String | 运营商名称 |
data.operators.projects | Object | 项目 | |
data.operators.projects.project_id | 159992131 | Number | 项目ID |
data.operators.projects.project_name | String | 项目名称 | |
data.operators.projects.introduction | Object | 简介 | |
data.operators.projects.price | 1.0000 | String | 价格 |
data.operators.projects.keyword | Object | 搜索关键词 | |
data.operators.projects.sms_keyword | String | 短信关键词 | |
data.operators.projects.secondary_deduction | 1 | Number | 是否二次收费【1收费 0不收费】 |
data.operators.projects.type | 1 | Number | 类型【1普通,2vip】 |
message | 请求成功 | String |
备注:
请求方式: GET
GET请求参数:
参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
---|---|---|---|---|
appid | 是 | String | APPID | |
app_secret | 是 | String | APP_SECRET |
接口请求地址
GET http://api.111sms.com/api/sms/user/profile?appid=&app_secret=
成功返回结果:JSON示例
{
"code": 0,
"data": {
"balance": "99813.0200",
"available_balance": "99199.02",
"nickname": "catlane123",
"email": "1111@111sms.com"
},
"message": "请求成功"
}
参数名 | 参数值 | 参数类型 | 描述说明 |
---|---|---|---|
code | 0 | Number | |
data | Object | 返回数据 | |
data.balance | 99813.0200 | String | 总余额 |
data.available_balance | 99999 | String | 可用余额(总余额-订单未结算余额) |
data.nickname | test | String | 昵称 |
data.email | 1111@111sms.com | String | 电子邮箱 |
message | 请求成功 | String |
备注:
请求方式: GET
GET请求参数:
参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
---|---|---|---|---|
appid | 是 | String | APPID | |
app_secret | 是 | String | APP_SECRET | |
num | 5 | 是 | String | 搜索手机号数量 |
search_old | 1 | 是 | String | 是否获取历史号码【1获取,0不获取】 |
country_id | 1 | 是 | String | 国家ID |
operator_id | 1 | 是 | String | 运营商ID |
project_id | 10000 | 是 | String | 项目ID |
接口请求地址
GET http://api.111sms.com/api/sms/order/set-search-num?appid=&app_secret=
成功返回结果:JSON示例
{
"code": 0,
"data": {
"group_id": "search.3_62f3ebd60416b"
},
"message": "手机号查询中"
}
参数名 | 参数值 | 参数类型 | 描述说明 |
---|---|---|---|
code | 0 | Number | |
data | Object | 返回数据 | |
data.group_id | search.3_62f3ebd60416b | String | group_id,用这个id来轮询请求手机号 |
message | 手机号查询中 | String |
备注:
请求方式: GET
GET请求参数:
参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
---|---|---|---|---|
appid | 是 | String | APPID | |
app_secret | 是 | String | APP_SECRET | |
group_id | search.3_62f4d036e9dc3 | 是 | String | group_id,来自【提交搜索数量接口】 |
接口请求地址
GET http://api.111sms.com/api/sms/order/search-mobile?appid=&app_secret=
成功返回结果:JSON示例
{
"code": 0,
"data": {
"is_all": 1,
"list": [
{
"country_code": "+1",
"phone": "7348770332",
"time": "2022-08-11 17:56:50",
"project_name": "test02",
"price": "10.0000",
"country_name": "USA",
"operator_name": "T-mobile",
"order_id": 100085
}
]
},
"message": "已获取全部.."
}
参数名 | 参数值 | 参数类型 | 描述说明 |
---|---|---|---|
code | 0 | Number | |
data | Object | 返回数据 | |
data.is_all | 1 | Number | 是否已返回全部手机号【1是 0否】 |
data.list | Object | ||
data.list.country_code | +1 | String | 国家代码 |
data.list.phone | 7348770332 | String | 手机号 |
data.list.time | 2022-08-11 17:56:50 | String | 创建时间 |
data.list.project_name | test02 | String | 项目名称 |
data.list.price | 10.0000 | String | 价格 |
data.list.country_name | USA | String | 国家名称 |
data.list.operator_name | T-mobile | String | 运营商名称 |
data.list.order_id | 100085 | Number | 订单ID |
message | 已获取全部.. | String |
备注:
请求方式: GET
GET请求参数:
参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
---|---|---|---|---|
appid | 是 | String | APPID | |
app_secret | 是 | String | APP_SECRET | |
order_id | 1 | 是 | String | 订单ID |
接口请求地址
GET http://api.111sms.com/api/sms/order/cancel-order?appid=&app_secret=
成功返回结果:JSON示例
{
"code": 0,
"data": [],
"message": "取消成功"
}
参数名 | 参数值 | 参数类型 | 描述说明 |
---|
备注:
请求方式: GET
GET请求参数:
参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
---|---|---|---|---|
appid | 是 | String | APPID | |
app_secret | 是 | String | APP_SECRET | |
order_id | 1 | 是 | String | 订单ID |
接口请求地址
GET http://api.111sms.com/api/sms/order/black-order?appid=&app_secret=
成功返回结果:JSON示例
{
"code": 0,
"data": [],
"message": "禁用成功"
}
参数名 | 参数值 | 参数类型 | 描述说明 |
---|
备注:
请求方式: GET
GET请求参数:
参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
---|---|---|---|---|
appid | 是 | String | APPID | |
app_secret | 是 | String | APP_SECRET | |
order_id | 是 | String | 订单ID |
接口请求地址
GET http://api.111sms.com/api/sms/order/get-order?appid=&app_secret=&order_id=
成功返回结果:JSON示例
{
"code": 0,
"data": {
"order_id": 1,
"uid": 3,
"country_name": "USA",
"operator_name": "T-mobile",
"project_name": "goole",
"phone": "7348770332",
"country_code": "+1",
"sms_code": "",
"content": "G-944969 is your Google verification code.",
"price": "10.00",
"status": 3
},
"message": "获取成功"
}
参数名 | 参数值 | 参数类型 | 描述说明 |
---|---|---|---|
code | 0 | Number | |
data | Object | 返回数据 | |
data.order_id | 1 | Number | 订单ID |
data.uid | 3 | Number | |
data.country_name | USA | String | 国家名称 |
data.operator_name | T-mobile | String | 运营商名称 |
data.project_name | String | 项目 | |
data.phone | 7348770332 | String | 手机号 |
data.country_code | +1 | String | 国家代码 |
data.sms_code | Object | 短信验证码 | |
data.content | G-944969 is your Google verification code. | String | 短信内容 |
data.price | 10.00 | String | 价格 |
data.status | 3 | Number | 订单状态[0等待 1完成 2人工取消 3禁止 4自动取消] |
data.finish_status | 1 | Number | |
message | 获取成功 | String |
备注:
请求方式: GET
GET请求参数:
参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
---|---|---|---|---|
appid | 是 | String | APPID | |
app_secret | 是 | String | APP_SECRET | |
order_id | 100081 | 是 | String | 订单ID |
接口请求地址
GET http://api.111sms.com/api/sms/order/again-order?appid=&app_secret=
成功返回结果:JSON示例
{
"code": 0,
"data": {
"time": "2022-08-12 00:45:39",
"project_name": "test02",
"price": "0.0000",
"is_kou_fei": 0,
"country_name": "USA",
"operator_name": "T-mobile",
"order_id": 100089,
"phone": "4057236314"
},
"message": "创建订单成功"
}
参数名 | 参数值 | 参数类型 | 描述说明 |
---|---|---|---|
code | 0 | Number | |
data | Object | 返回数据 | |
data.time | 2022-08-12 00:44:11 | String | 创建时间 |
data.project_name | test02 | String | 项目 |
data.price | 0.0000 | String | 价格 |
data.is_kou_fei | 0 | Number | 是否二次扣费【1扣费 0不扣费】 |
data.country_name | USA | String | 国家名称 |
data.operator_name | T-mobile | String | 运营商名称 |
data.order_id | 100088 | Number | 新订单ID |
data.phone | 15033718924 | String | 手机号 |
message | 创建订单成功 | String |
备注:
请求方式: GET
GET请求参数:
参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
---|---|---|---|---|
project_name | 否 | String | 项目名称 | |
phone | 否 | String | 手机号 | |
limit | 10 | 否 | String | 每页个数:默认为10 |
page | 1 | 否 | String | 页码:默认为1 |
appid | 是 | String | APPID | |
app_secret | 是 | String | APP_SECRET |
接口请求地址
GET http://api.111sms.com/api/sms/user/order?project_name=&phone=&limit=10&page=1&appid=&app_secret=
成功返回结果:JSON示例
{
"code": 0,
"data": {
"current_page": 1,
"data": [
{
"id": 100067,
"uid": 3,
"group_id": "search.3_62e6a197ec4e3",
"country_id": 1,
"operator_id": 1,
"project_id": 159992136,
"country_name": "美国1",
"country_en_name": "USA",
"operator_name": "T-mobile",
"operator_en_name": "T-mobile",
"project_name": "测试VIP",
"project_en_name": "测试VIP",
"phone": "13024798100",
"country_code": "+1",
"content": "",
"price": "3.00",
"before_balance": null,
"after_balance": null,
"status": 0,
"finish_status": 0,
"created_at": "2022-07-31 23:38:19",
"updated_at": "2022-07-31 23:38:19",
"sms_code": ""
}
],
"first_page_url": "/api/sms/user/order?page=1",
"from": 1,
"last_page": 8,
"last_page_url": "/api/sms/user/order?page=8",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
}
],
"next_page_url": "/api/sms/user/order?page=2",
"path": "/api/sms/user/order",
"per_page": "10",
"prev_page_url": null,
"to": 10,
"total": 77
},
"message": "获取成功"
}
参数名 | 参数值 | 参数类型 | 描述说明 |
---|---|---|---|
code | 0 | Number | |
data | Object | 返回数据 | |
data.current_page | 1 | Number | 当前页码 |
data.data | Object | 返回数据 | |
data.data.id | 100067 | Number | 订单id |
data.data.uid | 3 | Number | 当前用户UID |
data.data.group_id | search.3_62e6a197ec4e3 | String | |
data.data.country_id | 1 | Number | 国家ID |
data.data.operator_id | 1 | Number | 运营商ID |
data.data.project_id | 159992136 | Number | 项目ID |
data.data.country_name | 美国1 | String | 国家中文名 |
data.data.country_en_name | USA | String | 国家英文名 |
data.data.operator_name | T-mobile | String | 运营商中文名 |
data.data.operator_en_name | T-mobile | String | 运营商英文名 |
data.data.project_name | 测试VIP | String | 项目中文名称 |
data.data.project_en_name | 测试VIP | String | 项目英文名称 |
data.data.phone | 13024798100 | String | 手机号 |
data.data.country_code | +1 | String | 国家编号 |
data.data.content | Object | 短信内容 | |
data.data.price | 3.00 | String | 订单价格 |
data.data.before_balance | Object | 忽略 | |
data.data.after_balance | Object | 忽略 | |
data.data.status | 0 | Number | 订单状态【0等待 1完成 2人工取消 3禁止 4自动取消】 |
data.data.finish_status | 0 | Number | 最终完成状态【0未完成,待匹配短信等情况,1完成,已扣费,或者超时未匹配到数据】 |
data.data.created_at | 2022-07-31 23:38:19 | String | 创建时间 |
data.data.updated_at | 2022-07-31 23:38:19 | String | |
data.data.sms_code | Object | 短信验证码 | |
data.first_page_url | /api/sms/user/order?page=1 | String | 忽略 |
data.from | 1 | Number | 忽略 |
data.last_page | 8 | Number | 总页数 |
data.last_page_url | /api/sms/user/order?page=8 | String | |
data.links | Object | ||
data.links.url | Object | ||
data.links.label | « Previous | String | |
data.links.active | |||
data.next_page_url | /api/sms/user/order?page=2 | String | |
data.path | /api/sms/user/order | String | |
data.per_page | 10 | String | |
data.prev_page_url | Object | ||
data.to | 10 | Number | |
data.total | 77 | Number | 总数量 |
message | 获取成功 | String |
备注:
status
switch(origin){
//充值
case 1:
status = 0 未支付
status = 1 支付成功
status = 2 支付确认中
status = -1 支付失败
//卡密兑换
case 2:
status = 1 兑换成功
status = 0 兑换失败
//短信扣费
case 3:
status = 1 扣费成功
status = 0 扣费失败
//充值赠送
case 4:
status = 1 赠送成功
status = 0 赠送失败
//后台扣减余额
case 5:
status = 1 扣减成功
status = 0 扣减失败
}
origin = 1,2,4为收入 origin = 3,5为支出
请求方式: GET
GET请求参数:
参数名 | 参数值 | 是否必填 | 参数类型 | 描述说明 |
---|---|---|---|---|
origin | 否 | String | 来源【1充值,2卡密兑换,3短信扣费 4充值赠送, 5后台修改】 | |
type | 否 | String | 消费类型[1支出 2收入] | |
limit | 10 | 否 | String | |
page | 1 | 否 | String | |
appid | 是 | String | APPID | |
app_secret | 是 | String | APP_SECRET |
接口请求地址
GET http://api.111sms.com/api/sms/user/consume?origin=&type=&limit=10&page=1&appid=&app_secret=
成功返回结果:JSON示例
{
"code": 0,
"data": {
"current_page": 1,
"data": [
{
"id": 55,
"uid": 3,
"order_id": "100063",
"origin": 3,
"type": 1,
"price": "3.00",
"rate": 0,
"rate_price": "0.00",
"before_balance": "99816.02",
"after_balance": "99813.02",
"status": 1,
"reason": null,
"created_at": "2022-07-31 16:57:28",
"updated_at": "2022-07-31 16:57:28",
"extend": {
"卡密": "V4Hi3DWIPg",
"标题": "666"
},
"pay_id": ""
}
],
"first_page_url": "/api/sms/user/consume?page=1",
"from": 1,
"last_page": 5,
"last_page_url": "/api/sms/user/consume?page=5",
"links": [
{
"url": null,
"label": "« Previous",
"active": false
}
],
"next_page_url": "/api/sms/user/consume?page=2",
"path": "/api/sms/user/consume",
"per_page": "10",
"prev_page_url": null,
"to": 10,
"total": 46
},
"message": "获取成功"
}
参数名 | 参数值 | 参数类型 | 描述说明 |
---|---|---|---|
code | 0 | Number | |
data | Object | 返回数据 | |
data.current_page | 1 | Number | 当前页码 |
data.data | Object | 返回数据 | |
data.data.id | 55 | Number | 订单id |
data.data.uid | 3 | Number | 当前用户UID |
data.data.order_id | 100063 | String | 订单ID |
data.data.origin | 3 | Number | 来源【1充值,2卡密兑换,3短信扣费 4充值赠送, 5后台修改】 |
data.data.type | 1 | Number | 消费类型[1支出 2收入] |
data.data.price | 3.00 | String | 消费价格 |
data.data.rate | 0 | Number | 手续费比例(仅充值) |
data.data.rate_price | 0.00 | String | 手续费金额(仅充值) |
data.data.before_balance | 99816.02 | Object | 操作前余额 |
data.data.after_balance | 99813.02 | Object | 操作后余额 |
data.data.status | 1 | Number | 看接口说明 |
data.data.reason | Object | ||
data.data.created_at | 2022-07-31 16:57:28 | String | 创建时间 |
data.data.updated_at | 2022-07-31 16:57:28 | String | |
data.data.extend | Object | 其他属性,json格式 | |
data.data.extend.卡密 | V4Hi3DWIPg | String | |
data.data.extend.标题 | 666 | String | |
data.data.pay_id | Object | ||
data.first_page_url | /api/sms/user/consume?page=1 | String | 忽略 |
data.from | 1 | Number | 忽略 |
data.last_page | 5 | Number | 总页数 |
data.last_page_url | /api/sms/user/consume?page=5 | String | |
data.links | Object | ||
data.links.url | Object | ||
data.links.label | « Previous | String | |
data.links.active | |||
data.next_page_url | /api/sms/user/consume?page=2 | String | |
data.path | /api/sms/user/consume | String | |
data.per_page | 10 | String | |
data.prev_page_url | Object | ||
data.to | 10 | Number | |
data.total | 46 | Number | 总数量 |
message | 获取成功 | String |