API compatível
O API é o protocolo de interação entre o seu software e o nosso servidor de ativação. A API é necessária para automatizar o processo de recebimento de SMS do seu lado. Para trabalhar com uma API, você precisa usar a sua chave API. Você pode obter uma no seu perfil, ao passar por um processo de cadastramento simples. Nosso API é completamente compatível com sites de competidores.
Descrição do protocolo API
Todos os pedidos precisam ir para https://api.sms-man.com/stubs/handler_api.php POST ou GET um pedido. Todos os pedidos devem conter uma chave API na forma do parâmetro api_key. Todas as respostas em formato json
Solicitação de saldo
Parâmetros
Parâmetro | Tipo | Obrigatório | Valor |
|---|---|---|---|
action | String | Sim | getBalance |
api_key | String | Sim | Sua chave API |
Resultado
ACCESS_BALANCE:$balance(onde o$balanceé o valor disponível na sua conta)
Possíveis erros
Erro | Descrição |
|---|---|
BAD_KEY | Chave API incorreta |
Obtenha preços atuais
Parâmetros
Parâmetro | Tipo | Obrigatório | Valor |
|---|---|---|---|
action | String | Sim | getPrices |
api_key | String | Sim | Sua chave API |
country | Number | Não | |
service | String | Não |
Resultado
{
"0": {"vk":{"cost":"15","count":6455},"wb":{"cost":"50","count":124}},
"1": {"fb":{"cost":"6","count":1000}}
}Possíveis erros
Erro | Descrição |
|---|---|
BAD_KEY | Chave API incorreta |
Adquirir número
Parâmetros
Parâmetro | Tipo | Obrigatório | Valor |
|---|---|---|---|
action | String | Sim | getNumber |
api_key | String | Sim | Sua chave API |
country | Number | Sim | |
service | String | Sim | |
maxPrice | Number | Não | o valor pretendido |
currency | String | Não | RUB/USD/EUR |
ref | String | Não | Passe a ID de indicação |
Resultado
ACCESS_NUMBER:$id:$number$id- ID de ativação$number- número de telefone
Possíveis erros
Erro | Descrição |
|---|---|
BAD_KEY | Chave API incorreta |
NO_NUMBERS | Sem números, tente novamente mais tarde |
NO_BALANCE | Saldo baixo |
Obtenha o status de ativação
Parâmetros
Parâmetro | Tipo | Obrigatório | Valor |
|---|---|---|---|
action | String | Sim | getStatus |
api_key | String | Sim | Sua chave API |
id | Number | Sim | ID de ativação |
Resultado
STATUS_WAIT_CODE- sms pendenteSTATUS_WAIT_RETRY:$lastcode- esperando a apuração do código (onde$lastcode- último, código falho)STATUS_WAIT_RESEND— aguardando o reenvio de um SMS (o software deve clicar em reenviar o SMS e fazer uma mudança no status para 6)STATUS_CANCEL— a ativação foi canceladaSTATUS_OK:$code— código recebido (onde o$codeé o código de ativação)
Possíveis erros
Erro | Descrição |
|---|---|
BAD_KEY | Chave API incorreta |
NO_ACTIVATION | Não há ativação |
Obtenha o status de ativação V2
Parâmetros
Parâmetro | Tipo | Obrigatório | Valor |
|---|---|---|---|
action | String | Sim | getStatusV2 |
api_key | String | Sim | Sua chave API |
id | Number | Sim | ID de ativação |
Resultado
{
"verificationType": 0,
"sms": {"dateTime":"0000-00-00 00:00:00","code":"code","text":"sms text"}
}
STATUS_CANCEL
STATUS_WAIT_CODEPossíveis erros
Erro | Descrição |
|---|---|
BAD_KEY | Chave API incorreta |
NO_ACTIVATION | Não há ativação |
Mude o status de ativação
Parâmetros
Parâmetro | Tipo | Obrigatório | Valor |
|---|---|---|---|
action | String | Sim | setStatus |
api_key | String | Sim | Sua chave API |
id | Number | Sim | ID de ativação |
status | Number | Sim | Status de ativação |
Status possíveis
-1— Cancelar ativação1— Notifique que o SMS foi enviado (opcional)3— Solicite um novo código6— complete a ativação (se o status estiver como "código recebido" - marque que foi bem-sucedido e complete. Se o status estiver em "preparação" - delete e marque erro. Se o status estiver em "esperando repetir" - mude a ativação para esperando pelo SMS)8— informa que o número está sendo usado e cancela ativação
Resultado
ACCESS_READY- a disponibilidade do número está confirmadaACCESS_RETRY_GET- aguardando um novo SMSACCESS_ACTIVATION- o serviço foi ativado com sucessoACCESS_CANCEL- a ativação foi canceladaEARLY_CANCEL_DENIED- Não é permitido cancelar um número nos primeiros 2 minutos.
Possíveis erros
Erro | Descrição |
|---|---|
BAD_KEY | Chave API incorreta |
NO_ACTIVATION | ID de ativação não existe |
BAD_STATUS | Status incorreto |
Obtenha uma lista de todos os países
Parâmetros
Parâmetro | Tipo | Obrigatório | Valor |
|---|---|---|---|
action | String | Sim | getCountries |
api_key | String | Sim | Sua chave API |
Resultado
[
{"id":0,"name":"Россия","name_en":"Russia"},
{"id":3,"name":"Китай","name_en":"China"}
]Possíveis erros
Erro | Descrição |
|---|---|
BAD_KEY | Chave API incorreta |
Obtenha a lista de todos os serviços
Parâmetros
Parâmetro | Tipo | Obrigatório | Valor |
|---|---|---|---|
action | String | Sim | getServices |
api_key | String | Sim | Sua chave API |
Resultado
[
{"id":"vk","name":"Вконтакте"},
{"id":"wb","name":"WeChat"},
{"id":"tg","name":"Telegram"}
]Possíveis erros
Erro | Descrição |
|---|---|
BAD_KEY | Chave API incorreta |
BAD_ACTION | Ação incorreta |
