使用SMS-Activate的API协议

参数：

$api_key - API 密钥

$country * - 国家号码 见表

$operator * - 移动运营商号码，您可以指定多个以逗号分隔的号码（仅适用于**）：

**可用于 $country = 0, $country = 1, $country = 2

答案：

服务答案有json形式， 比如:

{"vk_0":76,"ok_0":139,"wa_0":90,"vi_0":223,"tg_0":158,"wb_0":106,"go_0":182,"av_0":244,"av_1":211,"fb_0":107}
连号是服务的名称，指定之后是否要开启呼叫转移。0-否，1-是。

全部服务清单

参数：

$api_key - API 密钥

$service * - 服务 见表

* 可选参数。如果未指定，默认情况下将显示所有服务的顶级国家/地区。

$freePrice * - 可选参数。如果被提供 true，数量和价格将根据 Free Price 会被提供。

答案：

服务答案有json形式， 比如:

$freePrice = true:

参数：

$api_key - API 密钥

答案：

ACCESS_BALANCE： '账户余额'

可能有错误:

BAD_KEY - api 密钥不正确

ERROR_SQL - sql服务的错误

参数：

$api_key - API 密钥

$country- 国家代码

答案：

服务的响应将为json格式：

例子：

*在“国家运营商”内 - 关键将是国家代码

可能有错误:

BAD_KEY - api 密钥不正确

ERROR_SQL - sql服务的错误

OPERATORS_NOT_FOUND - 未找到记录（例如，不存在的国家/地区已转移）

参数：

$api_key - API 密钥

答案：

服务的响应将为json格式：

可能有错误:

BAD_KEY - api 密钥不正确

ERROR_SQL - sql服务的错误

NO_ACTIVATIONS - 未找到条目（无活动激活）

参数：

$api_key - API 密钥

$service - 订购服务 见表

$forward * - 是否有必要通过转发请求号码

* 可选参数，接受0（不执行，默认设置），1（执行）

$maxPrice * - 您准备以Free Price购买号码的最高价格

* 可选参数，如果不指定则按正常价格购买

$phoneException * - 为俄罗斯号码排除的字冠。请使用逗号输入。记录格式：国家代码和 3 至 6 位掩码数字（如 7918、7900111）。默认数值为账户中指定的数值。

$operator* 是号码的移动运营商，你可以使用逗号指定几个（仅适用于 **）

$activationType - 激活类型：0 - 通过短信（默认），1 - 通过号码，2 - 通过语音

$language - 数据采集的语言（通过语音激活时必须使用） 见表

$userId * - 用户 ID。适用于因激活统计数据差而禁用，转售者的账户不受影响。

* 可选字段

**可用于 $country = 0, $country = 1, $country = 2

$ref - 转移推荐 ID 更多细节

$country - 国家号码 见表

$useCashBack* - 取值为 boolean，如果参数为 "true " 的话，购买号码时会花返现。返现用完后，所有后续购物都将使用余额。请务必记住，所有后续购物将首先使用现金返还，然后才使用主余额（即使以后提供的参数是 "false" 也是如此）。

* 可选的参数，接受 ”true“

通过API接收号码后，即表示您同意 点击“购买”您同意项目规则

可能有错误:

WRONG_MAX_PRICE:$min- 输入的最高价格低于允许的价格

$min - 最低允许价格

BAD_ACTION - 错误的动作

BAD_SERVICE - 不正确的服务名称

BAD_KEY - api 密钥不正确

ERROR_SQL - sql服务的错误

BANNED:'YYYY-m-d H-i-s' - 帐户被封锁的时间

WRONG_EXCEPTION_PHONE - 不正确的排除前缀

NO_BALANCE_FORWARD - 没有足够的资金购买呼叫转移

CHANNELS_LIMIT - 账户被封锁

NO_NUMBERS - 没有数字

如果您尝试获取不在所选国家/地区运营或没有所选服务的特定运营商的号码，则将返回第一个与请求参数匹配的运营商的号码

参数：

$orderId- 转售家系统中的激活 ID。购买时，这些数据将与我们系统中的激活 ID 和转售家相匹配。我们希望通过这种方式实现等幂性（同一订单不会再次被处理）。

答案：

如果请求成功，响应将采用以下格式：

如果您尝试获取不在所选国家/地区运营或没有所选服务的特定运营商的号码，则将返回第一个与请求参数匹配的运营商的号码

可能有错误:

ORDER_ALREADY_EXISTS- 订单已创建

当您收到发送给某个号码的短信时，如果您在设置中启用了 Webhooks 功能，我们将使用 POST 请求将有关短信的信息发送到您指定的地址

答案：

响应格式如下：

参数：

$api_key - API 密钥

$service - 订购服务 见表

$forward * - 是否有必要通过转发请求号码

* 可选参数，转发字符用逗号分隔，转发位数必须与参数中传输的服务数匹配 $service. 只允许使用重定向传输 1 个服务，例如“0,1,0,0” - 正确，“0,1,1,0” - 不正确。取 0（不执行，默认），1（执行）

$operator * - 号码的移动运营商，您可以指定多个以逗号分隔的号码（仅适用于**）：

$ref - 转移推荐 ID 更多细节

$country - 国家号码 见表

通过API接收号码后，即表示您同意 点击“购买”您同意项目规则

答案：

NO_NUMBERS - 没有数字

NO_BALANCE - 余额已结束

{{'phone':phone,'activation':activation,'service':service},
{'phone':phone,'activation':activation,'service':service}}, 在哪里 (phone - id 业务, activation - 电话号码, service - 服务)

可能有错误:

BAD_ACTION - 错误的动作

BAD_SERVICE - 不正确的服务名称

BAD_KEY - api 密钥不正确

ERROR_SQL - sql服务的错误

BANNED:'YYYY-m-d H-i-s' - 帐户被封锁的时间

参数：

$api_key - API 密钥

$id - 激活ID

$forward * - 您要转发到的电话号码

* 您需要呼叫转移的电话号码 （一定，如果getNumber传递了forward = 1参数） forward=1.

$status - 激活状态

* 如果有“收到代码”状态 - 标记它成功并完成，如果有“准备” - 删除并标记错误，如果有状态“等待重试” - 将激活转移到 SMS 挂起

**如果号码已到达，则无法更改选择呼叫验证方法的激活状态

答案：

ACCESS_READY 号码准备状态成功确认

ACCESS_RETRY_GET 期待新短信

ACCESS_ACTIVATION 服务成功激活

ACCESS_CANCEL - 激活取消

可能有错误:

EARLY_CANCEL_DENIED - 最先 2 分钟内无法取消号码

ERROR_SQL - sql服务的错误

NO_ACTIVATION - id 激活没存在

BAD_SERVICE - 不正确的服务名称

BAD_STATUS - 不正确的状态

BAD_KEY - api 密钥不正确

BAD_ACTION - 错误的动作

WRONG_ACTIVATION_ID - неверный ID или ID не является числом.

参数：

$api_key - API 密钥

$id - 激活ID

答案：

STATUS_WAIT_CODE - 等待短信

STATUS_WAIT_RETRY“过去的不合适代码”-等待代码完善

STATUS_WAIT_RESEND - 等待重新发送短信 *

* 软件必须按重新发送短信并将状态更改为6

STATUS_CANCEL - 激活取消

STATUS_OK: '激活码' - 收到的代码

可能有错误:

NO_ACTIVATION - id 激活没存在

ERROR_SQL - sql服务的错误

BAD_KEY - api 密钥不正确

BAD_ACTION - 错误的动作

参数：

$api_key - API 密钥

$id - 激活ID

STATUS_CANCEL - 激活取消

可能有错误:

NO_ACTIVATION - id 激活没存在

ERROR_SQL - sql服务的错误

BAD_KEY - api 密钥不正确

BAD_ACTION - 错误的动作

参数：

$api_key - API 密钥

$start - Unix Timestamp 格式的时间戳（没有必要）- 考虑激活的起始日期

$end - Unix Timestamp 格式的时间戳（没有必要）- 考虑激活的结束日期

$offset - 回复中返回的第一个元素的移动。默认值为 0

$limit - 返回记录的最大数量。最多为 100 个。默认为 50 个。

答案：

响应格式如下：

可能有错误:

ERROR_SQL - sql服务的错误

BAD_KEY - api 密钥不正确

BAD_ACTION - 错误的动作

参数：

$api_key - API 密钥

$service - 服务名称

答案：

响应格式如下：

可能有错误:

ERROR_SQL - sql服务的错误

BAD_KEY - api 密钥不正确

WRONG_SERVICE - 服务不正确

BAD_ACTION - 错误的动作

参数：

$api_key - API 密钥

$id - 激活ID

答案：

服务答案有json形式， 比如:

可能的状态：

可能有错误:

BAD_KEY - api 密钥不正确

INVALID_ACTIVATION_ID - 无效的激活ID

参数：

$api_key - API 密钥

$service服务的简称 （不一定，所有的服务预设） 见表

$country密码国家名称（不一定，所有的国家预设） 见表

答案：

JSON - 对象格式
{“国家”：{“服务”：{“成本”：成本，“计数”：计数}}}

参数：

$api_key - API 密钥

$service服务的简称 （不一定，所有的服务预设） 见表

答案：

JSON - 对象格式
{"Service":{"Country":{"count":Quantity,"price":"Price"}}}

参数：

$api_key - API 密钥

答案：

JSON - 对象格式 {{'Страна':{'id':0,'rus':"Россия","eng:"Russia","chn":"俄罗斯","visible":1,"retry":1,"rent":1,"multiService":1}},

在哪里 （

id : 国家编号;

rus : 俄文国名;

eng : 英文国名;

chn : 中文国名;

visible : 0 - 网站上不显示国家，1 - 显示;

retry : 0 - 重复短信不可用，1 - 可用;

rent : 0 - 国家未租用，1 - 租用;

multiService 0国家不适用于多种服务，1国家可用

参数：

$api_key- API 密钥

$country *- 国家 ID。如果你提供了国家，我们返回对所选国家有价格的服务

$lang *- 要提供 `name` 的语言。可使用的值：'ru'、'en'、'es'、'cn'。默认为 'en'

* 可选参数

答案：

JSON - 对象格式 { "status": "success", "services": [ { "code": "aoo", "name": "Pegasus Airlines" } ] }

参数：

$api_key - API 密钥

$service 服务的简称 见表

$id - 家长激活码

答案：

ADDITIONAL:$id:$phone - 新激活已成功创建。其中 ID 是新激活的 ID，phone 是电话号码

可能有错误:

WRONG_ADDITIONAL_SERVICE 无效的附加服务（仅允许重定向服务）

WRONG_ACTIVATION_ID - 原来激活 ID 不正确

WRONG_SECURITY - 尝试传输激活 ID 时出现错误，且未重定向，或激活已完成/未激活

REPEAT_ADDITIONAL_SERVICE - 尝试再次订购已购买的服务时出现错误 NO_BALANCE - 资金不足

ERROR_SQL- 数据库错误，联系客服

参数：

$api_key - API 密钥

$activationId - 家长激活码

答案：

ACCESS_NUMBER:$id:$phone - 已成功创建新激活。其中，$id 是新激活的 ID，$phone 是电话号码

可能有错误:

RENEW_ACTIVATION_NOT_AVAILABLE- 该号码不可用于额外激活

WRONG_ACTIVATION_ID - 原来激活 ID 不正确

ERROR_SQL- 数据库错误，联系客服

NEW_ACTIVATION_IMPOSSIBLE- 无法进行额外激活

NO_BALANCE - 账户中没有钱

参数：

$api_key - API 密钥

$activationId - 家长激活码

答案：

JSON - 对象格式 {'status': 'success', 'cost':200,"service":"tw","phone":777777777,"country":14},

可能有错误:

RENEW_ACTIVATION_NOT_AVAILABLE- 该号码不可用于额外激活

WRONG_ACTIVATION_ID - 原来激活 ID 不正确

SIM_OFFLINE - SIM卡离线

参数：

$api_keyapi密码

$id - 激活ID

$newLang - 解析新语言 见表

STATUS_CANCEL - 激活取消

NO_CALL- 没有来电

PARSE_COUNT_EXCEED- 解析尝试次数限制（最多为 4 次）

可能有错误:

WRONG_ACTIVATION_ID - ID 不正确，激活不存在

ERROR_SQL - sql服务的错误

BAD_KEY - api 密钥不正确

BAD_ACTION - 错误的动作

参数：

$api_key - API 密钥

$time* - 租用时间（默认：4小时）

$operator* - 号码的移动运营商，你可以用逗号分隔指定多个运营商（默认：任何）

$country* - 国家（默认：俄罗斯）

$incomingCall * - 如果被提供 "true"获得有可能接受来电的号码

答案：

服务答案有json形式， 比如:

{ "countries": { "0": 0 }, "operators": { "0": "aiva", "1": "any", "2": "beeline", ... "16": "yota" }, "services": { "full": { "cost": 42.93, "quant": 20 }, "vk": { "cost": 21.95, "quant": 20 }, "ok": { "cost": 7.68, "quant": 55 }, "ot": { "cost": 5.2, "quant": 42 } } }

可能有错误:

BAD_KEY - api 密钥不正确

OUT_OF_STOCK - 没有这个国家的号码

参数：

$api_key - API 密钥

$service - 您需要获取号码的服务

$time* - 租赁时间以小时为单位（默认值：4 小时）。下一个可用时间段是 12 小时，然后是 24 小时。当请求租赁一天或以上时，您必须转让：24、48、72 等。

$operator* - 号码的移动运营商，你可以用逗号分隔指定多个运营商（默认：任何）

$country* - 国家（默认：俄罗斯）

$url * - 用于 webhook 的链接 （默认不考虑）

$incomingCall * - 如果被提供 "true"获得有可能接受来电的号码

什么是webHook？

* 可选参数。如果未指定，将使用默认参数。

答案：

服务答案有json形式， 比如:

{ "status": "success", "phone": { "id": 1049, "endDate": "2020-01-31T12:01:52", "number": "79959707564" } }

可能有错误:

BAD_KEY - api 密钥不正确

以json格式回答：

{ "status": "error", "message": "*possible_answer*" }

现场可能的答案 "message":

BAD_SERVICE - 未指定服务或名称不正确

NO_BALANCE - 账户中没有钱

NO_NUMBERS - 没有号码

ACCOUNT_INACTIVE - 没有号码

SERVER_ERROR - 服务器错误

CHANNELS_LIMIT - 账户被封锁

参数：

$api_key - API 密钥

$id - 订购号码时收到的回复中的租用 ID

$page* - 选择开始的页码（页码从0开始，从新到旧；默认为0）

$size* - 页面大小（默认10）

* 可选参数。如果未指定，将使用默认参数。

答案：

服务答案有json形式， 比如:

{ "status": "success", "quantity": "2", "values": { "0": { "phoneFrom": "79180230628", "text": "5", "service": "ot", "date": "2020-01-30 14:31:58" }, "1": { "phoneFrom": "79180230628", "text": "4", "service": "ot", "date": "2020-01-30 14:04:16" } } }

* 仅在有短信时成功（字段 “quantity”> 0）。

可能有错误:

BAD_KEY - api 密钥不正确

以json格式回答：

{ "status": "error", "message": "*possible_answer*" }

现场可能的答案 "message":

NO_ID_RENT - 租用 ID 未提供

INVALID_PHONE - 该号码不是由你租用的 （租用 ID 不正确）

STATUS_FINISH - 租金已付并已完成

STATUS_CANCEL - 租金取消并退款

STATUS_WAIT_CODE - 等待第一条短信

STATUS_REVOKE - 号码已被封锁，您的资金已被退回

参数：

$api_key - API 密钥

$id - 订购号码时收到的回复中的租用 ID

$status 更改状态的代码（数字）

状态取值包括：

答案：

服务的响应将为json格式：

{ "status": "success" }

可能有错误:

BAD_KEY - api 密钥不正确

以json格式回答：

{ "status": "error", "message": "*possible_answer*" }

现场可能的答案 "message":

NO_ID_RENT - 租用 ID 未提供

INCORECT_STATUS 状态缺失或不正确

CANT_CANCEL 无法取消租借（超过20分钟）

INVALID_PHONE - 该号码不是由你租用的 （租用 ID 不正确）

ALREADY_FINISH 租用已完成

ALREADY_CANCEL - 租约已经取消

SERVER_ERROR - 服务器错误

参数：

$api_key - API 密钥

答案：

服务的响应将为json格式：

{ "status": "success", "values": { "0": { "id": "12345", "phone": "79181234567" }, "1": { "id": "12345", "phone": "79181234568" } } }

可能有错误:

BAD_KEY - api 密钥不正确

BAD_ACTION - 错误的动作

以json格式回答：

{ "status": "error", "message": "*possible_answer*" }

现场可能的答案 "message":

NO_NUMBERS 没有出租号码

SERVER_ERROR - 服务器错误

参数：

$api_key - API 密钥

$id - id 租用

$rent_time- 租用期间 （默认：4个小时）

答案：

服务的响应将为json格式：

{ "status": "success", "phone": { "id": 1049, "endDate": "2020-01-31T12:01:52", "number": "79959707564"} }

当一个已完成的租用被延长时，租用就被重新预订，我们把一个新的ID给用户

可能有错误:

BAD_KEY - api 密钥不正确

BAD_ACTION - 错误的动作

SERVER_ERROR - 服务器错误

以json格式回答：

{ "status": "error", "message": "*possible_answer*", "info": "*details*" }

现场可能的答案 "message":

NO_ID_RENT - 没有租用 ID

INVALID_TIME - 不合时机。可用小时数从 4 到 1344

MAX_HOURS_EXCEED - 最大可用的时间被超过

INVALID_PHONE - 租用 ID 不正确

RENT_DIE - 由于数量已过期，因此无法延长租约

NO_BALANCE 不充足的资金

CHANNELS_LIMIT - 账户被封锁

参数：

$api_key - API 密钥

$id - id 租用

$rent_time - 租用时间

答案：

服务的响应将为json格式：

{ "status": "success", "price": 6.33 }

可能有错误:

BAD_KEY - api 密钥不正确

BAD_ACTION - 错误的动作

SERVER_ERROR - 服务器错误

以json格式回答：

{ "status": "error", "message": "*possible_answer*" }

现场可能的答案 "message":

NO_ID_RENT - 没有租用 ID

INVALID_PHONE - 租用 ID 不正确

INVALID_TIME - 错误设置时间

RENT_DIE - 由于数量已过期，因此无法延长租约

MAX_HOURS_EXCEED - 最大可用的时间被超过

CHANNELS_LIMIT - 账户被封锁

参数：

没有任何

返回类型：

BigDecimal

参数：

没有任何

返回类型：

SMSActivateGetBalanceAndCashBack

参数：

countryId(Integer) - 国家标识符

service(String) - 服务的简称

forward*(boolean) -是否要申请有呼叫转移的号码

operatorSet*(Set) - 套运营商

phoneException*(Set) - 不包括仅适用于俄罗斯的字冠，一套从 3 到 6 的数字（7918,7900111)

* 可选字段。如果未指定，将根据配置文件中的设置给出默认数量。

返回类型：

SMSActivateActivation

参数：

countryId(Integer) - 国家标识符

operatorSet*(Set) - 服务可用的运营商套

返回类型：

SMSActivateGetNumbersStatus

参数：

id(Integer) - 激活标识符

service(String) - 服务的简称

您可以传递接收到的类对象，而不是激活标识符 SMSActivateActivation 使用该方法后 getNumber 或使用后的激活之一 getMultiServiceNumber.

返回类型：

SMSActivateGetNumbersStatus

参数：

countryId(Integer) - 国家标识符

serviceMap(Set) - 购买激活的服务套

multiForwardList(List) - 提供转移功能的服务列表

operatorSet(Set) - 套运营商

返回类型：

SMSActivateGetMultiServiceNumberResponse

参数：

没有任何

返回类型：

SMSActivateGetPriceInfo

参数：

countryId(Integer) - 国家标识符

service(String) - 服务的简称

返回类型：

SMSActivateGetPriceInfo

参数：

countryId(Integer) - 国家标识符

返回类型：

SMSActivateGetPriceInfo

参数：

activationId(Integer) - 激活标识符

您可以传递接收到的类对象，而不是激活标识符 SMSActivateActivation 使用该方法后 getNumber 或使用后的激活之一 getMultiServiceNumber.

返回类型：

SMSActivateGetStatusResponse

参数：

id(Integer) - 激活标识符

status(SMSActivateClientStatus) - 为激活要设置的状态

您可以传递接收到的类对象，而不是激活标识符 SMSActivateActivation 使用该方法后 getNumber 或使用后的激活之一 getMultiServiceNumber.

返回类型：

SMSActivateSetStatusResponse

参数：

countryId(Integer) - 国家标识符

service(String) - 服务的简称

hours(Integer)* - 租用期间

operator(String)* - 移动运营商名称

urlWebhook(String)* - webhook的链接（默认情况下不考虑）

可选参数。如果未指定，则默认值为

返回类型：

SMSActivateRentActivation

参数：

countryId(Integer) - 国家标识符

operatorSet(Set) - 移动运营商套

hours(Integer)* - 租用期间

可选参数。如果未指定，则默认值为

返回类型：

SMSActivateGetRentServicesAndCountriesResponse

参数：

rentId(Integer) - 租用的号码标识符

您可以传递生成的类对象，而不是rentId SMSActivateRentActivation 使用该方法后 getRentNumber

返回类型：

SMSActivateRentStatus

描述：

更严格遵守 REST API 的原则，并增加用于注册 Telegram 帐户的 gmail.com 邮箱数量。

参数：

$api_key - API 密钥

$site- 需要邮箱的网站

答案：

服务答案有json形式， 比如:

{
                        "status":"OK",
                        "response":{
                            "zones":[
                                {
                                "name":"info",
                                "cost":2.5
                                },
                                ...
                            ],
                            "popular":[
                                {
                                "name":"mail.ru",
                                "cost":6,
                                "count":159008
                                },
                                ...
                            ]
                        }
                        }

可能有错误:

BAD_SITE- 未指定网站

BAD_KEY - api 密钥不正确

BAD_ACTION - 不正确的动作

参数：

$api_key - API 密钥

$site - 需要邮箱的网站

$mail_type - 邮箱类型：热门域名或区域（1 - 区域 2 - 热门）

$mail_domain - 所选的区域或域名

答案：

服务答案有json形式， 比如:

{
                        "status":"OK",
                        "response":{"email":"[email protected]","id":241}
                        }

可能有错误:

BAD_KEY - api 密钥不正确

BAD_ACTION - 不正确的动作

MAIL_TYPE_ERROR - 指定的网站没有此类域名

CHANNELS_LIMIT - 账户被封锁

参数：

$api_key - API 密钥

$id- 需要重新激活的邮箱 ID

答案：

服务答案有json形式， 比如:

{
                            "status": "OK",
                        "response": {
                            "email": "[email protected]",
                            "id": 360
                            }
                        }

可能有错误:

BAD_KEY - api 密钥不正确

BAD_ACTION - 不正确的动作

BLOCKED_SITE - 阻止的网站

BAD_BALANCE - 资金不足

ACTIVATION_NOT_FOUND - 没有找到该激活

CHANNELS_LIMIT - 账户被封锁

参数：

$api_key - API 密钥

$page- 页面号

$per_page- 每页的购买数量

$search- 搜索行

$sort- 排序方向。(desc, asc）

答案：

服务答案有json形式， 比如:

{
                        "status":"OK",
                        "response":{
                            "list":[
                                {
                                "id":"241",
                                "site":"apple.com",
                                "email":"[email protected]",
                                "status":"3",
                                "value":null,
                                "cost":"6.00",
                                "date":"2023-10-06 14:24:13",
                                "full_message":""
                                }
                            ],
                            "pages":1,
                            "count":1
                        }
                        }

参数：

$api_key - API 密钥

$id- 购物 ID

答案：

服务答案有json形式， 比如:

{
                        "status":"OK",
                        "response":true
                        }

可能有错误:

EARLY_CANCEL_DENIED - 前 2 分钟内您无法取消邮件。

参数：

$api_key - API 密钥

$id- 购买邮件的ID，购买邮件后会退回

答案：

服务答案有json形式， 比如:

{
                        "status":"OK",
                        "response":{
                            "value":"Содержания письма"
                        }
                        }

参数：

$api_key - API 密钥

$id- 需要购买软件的 ID

答案：

服务答案有json形式， 比如:

{                            
                            "status": "success",
                            "key": "F5qrzFoY6afj3zrEq7SeMplbx",
                            "manual": "下载软件的链接："                            
                        }

可能有错误:

BAD_DATA - ID 不正确或 ID 不是数字

BAD_ACTION - 无效 action 或未验证经销商。