使用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形式， 比如:

{ 0: { "country: 0, "count": 43575, "price": 15.00, "retail_price": 30.00 }, ... }

$freePrice = true:

{ 0: { "country: 0, "count": 43575, "price": 15.00, "retail_price": 30.00, "freePriceMap": { "15.00": 43242, "18.00": 333 } }, ... }

参数：

$api_key - API 密钥

答案：

ACCESS_BALANCE： '账户余额'

可能有错误:

BAD_KEY - api 密钥不正确

ERROR_SQL - sql服务的错误

参数：

$api_key - API 密钥

$country- 国家代码

答案：

服务的响应将为json格式：

{"status":"success", "countryOperators": {
"Country1Code": ["operator1Name","operator2Name","operator3Name", ...],
"Country2Code": ["operator1Name","operator2Name","operator3Name", ...],
...
}}

例子：

{"status":"success", "countryOperators": {
"0": ["beeline","megafon","mts", ...],
"1": ["life","mts","kyivstar","utel" ...],
...
}}

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

可能有错误:

BAD_KEY - api 密钥不正确

ERROR_SQL - sql服务的错误

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

参数：

$api_key - API 密钥

答案：

服务的响应将为json格式：

{"status":"success", "activeActivations": [
{
"activationId" : "635468021",
"serviceCode" : "vk",
"phoneNumber" : "79********1",
"activationCost" : "12.50",
"activationStatus" : "4",
"smsCode" : ["CODE"],
"smsText" : "[您的代码注册码]",
"activationTime" : "2022-06-01 16:59:16",
"discount" : "0.00",
"repeated" : "0",
"countryCode" : "0",
"countryName" : "Russia",
"canGetAnotherSms" : "1",
}]

可能有错误:

BAD_KEY - api 密钥不正确

ERROR_SQL - sql服务的错误

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

参数：

$api_key - API 密钥

$service - 订购服务 见表

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

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

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

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

$phoneException * - 为俄罗斯的号码排除的的字冠。用逗号指定。记录格式：国家代码和 3 至 6 位掩码（如 7918,7900111）。默认数值为配置文件中指定的数值。

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

$verification * - 如果传输 "true"获得有可能接受来电的号码

* 可选字段

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

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

$country - 国家号码 见表

通过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 - 没有足够的资金购买呼叫转移

答案：

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

{
"activationId": 635468024,
"phoneNumber": "79584******",
"activationCost": "12.50",
"countryCode": "0",
"canGetAnotherSms": "1",
"activationTime": "2022-06-01 17:30:57",
"activationOperator": "mtt"
}

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

答案：

响应格式如下：

{
"activationId": 635468024,
"service": "go",
"text": "Your sms text",
"code": "Your sms code",
"country": 0,
"receivedAt": "2022-06-01 17:30:57",
}

参数：

$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 - 错误的动作

参数：

$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 密钥

$start - Unix 时间戳格式的时间戳（可选）- 从哪个日期开始激活

$end - Unix 时间戳格式的时间戳（可选）- 激活的日期

答案：

响应格式如下：

[{
"id": 635468024,
"date": "2022-11-12 15:58:39",
"phone": "79918529716",
"sms": "sms":"["Your sms code"]",
"cost": 100 //Если активация не завершена, то cost = 0,
"status": "4",
}]

可能有错误:

ERROR_SQL - sql服务的错误

BAD_KEY - api 密钥不正确

BAD_ACTION - 错误的动作

参数：

$api_key - API 密钥

$service - 服务名称

答案：

响应格式如下：

[{
"country": 0,
"share": 50 - // （按国家分列的所选服务购买量占我们服务总购买量的百分比）,
"rate": 50 - //（成功激活占全国激活总数的百分比）
}]

可能有错误:

ERROR_SQL - sql服务的错误

BAD_KEY - api 密钥不正确

WRONG_SERVICE - 服务不正确

BAD_ACTION - 错误的动作

参数：

$api_key - API 密钥

$id - 激活ID

答案：

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

{"status":"2","phone":false}

可能的状态：

可能有错误:

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 密钥

$service 服务的简称 见表

$id - 家长激活码

答案：

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

可能有错误:

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

参数：

$api_key - API 密钥

$activationId - 激活ID

$phone - 要拨打的号码

答案：

JSON - 对象格式 {'status': 'success', 'msg':'呼叫请求创建成功.'},

可能有错误:

CALL_TASK_ALREADY_EXIST - 已创建呼叫请求。

WRONG_ACTIVATION_ID - 无效的激活ID

NUMBER_NOT_EXIST - 您尝试拨打的号码不存在

参数：

$api_key - API 密钥

$activationId - 激活ID，可选参数，如果不传递，将返回所有请求的列表

$date - 格式为 'YYYY-MM-DD' 的日期，可选参数，如果未传递 - 将返回当前日期的列表

答案：

JSON - 对象格式 {"958874106":{"date":"2022-07-29 16:03:23","phoneFrom":"79912556393","status":"IN_PROCESS"}},

参数：

$api_key - API 密钥

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

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

$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 密钥不正确

参数：

$api_key - API 密钥

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

$time * - 以小时为单位的租赁时间（默认情况下：4 小时）。下一个可用时间段是 12 小时，然后是 24 小时。申请一天或更长时间的租金时，您必须发送：24、48、72 等。

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

$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 - 没有号码

SQL_ERROR - sql服务的错误

参数：

$api_key - API 密钥

$id - 订购号码时在响应中收到的租金ID

答案：

服务答案有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" } } }

* 仅当存在SMS时成功（字段“数量”> 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 - 等待第一条短信

参数：

$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 - 租约已经取消

SQL_ERROR - sql服务的错误

参数：

$api_key - API 密钥

答案：

服务的响应将为json格式：

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

可能有错误:

BAD_KEY - api 密钥不正确

BAD_ACTION - 错误的动作

以json格式回答：

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

现场可能的答案 "message":

NO_NUMBERS 没有出租号码

SQL_ERROR - sql服务的错误

参数：

$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 - 错误的动作

以json格式回答：

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

现场可能的答案 "message":

NO_ID_RENT - 没有租金编号

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

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

INVALID_PHONE - 无效的租赁编号

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

SERVER_ERROR - 服务器错误

NO_BALANCE 不充足的资金

参数：

$api_key - API 密钥

$id - id 租

$rent_time - 租用时间

答案：

服务的响应将为json格式：

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

可能有错误:

BAD_KEY - api 密钥不正确

BAD_ACTION - 错误的动作

以json格式回答：

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

现场可能的答案 "message":

NO_ID_RENT - 没有租金编号

INVALID_PHONE - 无效的租赁编号

INVALID_TIME - 错误设置时间

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

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

SERVER_ERROR - 服务器错误

参数：

没有任何

返回类型：

BigDecimal

参数：

没有任何

返回类型：

SMSActivateGetBalanceAndCashBack

参数：

countryId(Integer) - 国家/地区标识符。

service(String) - 服务简称。

forward*(boolean) -是否需要申请转接号码.

operatorSet*(Set) - 一组运算符。

phoneException*(Set) - 仅限俄罗斯的专有前缀，一组3到6的数字（7918.7900111）。

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

返回类型：

SMSActivateActivation

参数：

countryId(Integer) - 国家/地区标识符。

operatorSet*(Set) - 服务中可用的运算符集

返回类型：

SMSActivateGetNumbersStatus

参数：

countryId(Integer) - 激活ID。

service(String) - 服务简称。

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

返回类型：

SMSActivateGetNumbersStatus

参数：

countryId(Integer) - 国家/地区标识符。

serviceMap(Set) - 为其购买激活的一组服务。

multiForwardList(List) - 具有转发服务的列表

operatorSet(Set) - 一组运算符。

返回类型：

SMSActivateGetMultiServiceNumberResponse

参数：

没有任何

返回类型：

SMSActivateGetPriceInfo

参数：

countryId(Integer) - 国家/地区标识符。

service(String) - 服务简称。

返回类型：

SMSActivateGetPriceInfo

参数：

countryId(Integer) - 国家/地区标识符。

返回类型：

SMSActivateGetPriceInfo

参数：

countryId(Integer) - 激活ID。

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

返回类型：

SMSActivateGetStatusResponse

参数：

countryId(Integer) - 激活ID。

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

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

返回类型：

SMSActivateSetStatusResponse

参数：

countryId(Integer) - 国家/地区标识符。

service(String) - 服务简称

hours(Integer)* - 出租时间

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

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

什么是webHook？

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

返回类型：

SMSActivateRentActivation

参数：

countryId(Integer) - 国家/地区标识符。

operatorSet(Set) - 运营商名单

hours(Integer)* - 出租时间.

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

返回类型：

SMSActivateGetRentServicesAndCountriesResponse

参数：

rentId(Integer) - 分配的电话号码的标识符。

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

返回类型：

SMSActivateRentStatus

参数：

$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 - zones 2 - popular）

$mail_domain- 所选的区域或域名

答案：

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

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

可能有错误:

BAD_KEY - api 密钥不正确

BAD_ACTION - 不正确的动作

MAIL_TYPE_ERROR - 为指定的网站没有该域名

参数：

$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
}

参数：

$api_key - API 密钥

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

答案：

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

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