API compatible
API es el protocolo de interacción entre su software y nuestro servidor de activación. API es necesario para automatizar el proceso de recepción de sms en su lado Para trabajar con la API tiene que utilizar su clave de API, se puede obtener en su sección de perfil, pasando simple procedimiento de registro. Nuestra API es totalmente compatible con los sitios web de la competencia.
Descripción del protocolo API
Todas las solicitudes deben ir a https://api.sms-man.com/stubs/handler_api.php POST o GET solicitud. Todas las solicitudes deben contener la clave API en forma del parámetro api_key. Todas las respuestas en formato json
Solicitud de saldo
Parámetros
Parámetro | Tipo | Requerido | Valor |
|---|---|---|---|
action | String | Sí | getBalance |
api_key | String | Sí | Su CLAVE API |
Resultado
ACCESS_BALANCE:$balance(donde$balancees el saldo de su cuenta)
Errores posibles
Error | Descripción |
|---|---|
BAD_KEY | Clave API incorrecta |
Obtener precios actuales
Parámetros
Parámetro | Tipo | Requerido | Valor |
|---|---|---|---|
action | String | Sí | getPrices |
api_key | String | Sí | Su CLAVE API |
country | Number | No | |
service | String | No |
Resultado
{
"0": {"vk":{"cost":"15","count":6455},"wb":{"cost":"50","count":124}},
"1": {"fb":{"cost":"6","count":1000}}
}Errores posibles
Error | Descripción |
|---|---|
BAD_KEY | Clave API incorrecta |
Conseguir número
Parámetros
Parámetro | Tipo | Requerido | Valor |
|---|---|---|---|
action | String | Sí | getNumber |
api_key | String | Sí | Su CLAVE API |
country | Number | Sí | |
service | String | Sí | |
maxPrice | Number | No | su valor deseado |
currency | String | No | RUB/USD/EUR |
ref | String | No | Pasar el ID de referencia |
Resultado
ACCESS_NUMBER:$id:$number$id- id de activación$number- número de teléfono
Errores posibles
Error | Descripción |
|---|---|
BAD_KEY | Clave API incorrecta |
NO_NUMBERS | No hay números, inténtelo más tarde |
NO_BALANCE | Saldo bajo |
Obtener estado de activación
Parámetros
Parámetro | Tipo | Requerido | Valor |
|---|---|---|---|
action | String | Sí | getStatus |
api_key | String | Sí | Su CLAVE API |
id | Number | Sí | Id de activación |
Resultado
STATUS_WAIT_CODE- sms pendientesSTATUS_WAIT_RETRY:$lastcode- esperando refinamiento de código (donde$lastcode- último, código fallido)STATUS_WAIT_RESEND— esperando el reenvío de un SMS (el software debe pulsar reenviar el SMS y realizar un cambio de estado a 6)STATUS_CANCEL— la activación se ha canceladoSTATUS_OK:$code— código recibido (donde$codees el código de activación)
Errores posibles
Error | Descripción |
|---|---|
BAD_KEY | Clave API incorrecta |
NO_ACTIVATION | No hay ninguna activación |
Obtener estado de activación V2
Parámetros
Parámetro | Tipo | Requerido | Valor |
|---|---|---|---|
action | String | Sí | getStatusV2 |
api_key | String | Sí | Su CLAVE API |
id | Number | Sí | Id de activación |
Resultado
{
"verificationType": 0,
"sms": {"dateTime":"0000-00-00 00:00:00","code":"code","text":"sms text"}
}
STATUS_CANCEL
STATUS_WAIT_CODEErrores posibles
Error | Descripción |
|---|---|
BAD_KEY | Clave API incorrecta |
NO_ACTIVATION | No hay ninguna activación |
Modificar el estado de activación
Parámetros
Parámetro | Tipo | Requerido | Valor |
|---|---|---|---|
action | String | Sí | setStatus |
api_key | String | Sí | Su CLAVE API |
id | Number | Sí | Id de activación |
status | Number | Sí | Estado de activación |
Posibles estados
-1— Cancelar activación1— Notificar el envío de SMS (opcional)3— Solicitar otro código6— Completar la activación (si el estado era "código recibido" - marca éxito y completa, si el estado era "preparación" - borra y marca error, si el estado era "esperando repetición" - cambia activación a esperando SMS)8— Informa de que el número está utilizado y cancela la activación
Resultado
ACCESS_READY- disponibilidad del número confirmadaACCESS_RETRY_GET- esperando un nuevo smsACCESS_ACTIVATION- el servicio se ha activado correctamenteACCESS_CANCEL- la activación se ha canceladoEARLY_CANCEL_DENIED- No está permitido cancelar un número durante los primeros 2 minutos.
Errores posibles
Error | Descripción |
|---|---|
BAD_KEY | Clave API incorrecta |
NO_ACTIVATION | El ID de activación no existe |
BAD_STATUS | Estado incorrecto |
Obtener lista de todos los países
Parámetros
Parámetro | Tipo | Requerido | Valor |
|---|---|---|---|
action | String | Sí | getCountries |
api_key | String | Sí | Su CLAVE API |
Resultado
[
{"id":0,"name":"Россия","name_en":"Russia"},
{"id":3,"name":"Китай","name_en":"China"}
]Errores posibles
Error | Descripción |
|---|---|
BAD_KEY | Clave API incorrecta |
Obtener lista de todos los servicios
Parámetros
Parámetro | Tipo | Requerido | Valor |
|---|---|---|---|
action | String | Sí | getServices |
api_key | String | Sí | Su CLAVE API |
Resultado
[
{"id":"vk","name":"Вконтакте"},
{"id":"wb","name":"WeChat"},
{"id":"tg","name":"Telegram"}
]Errores posibles
Error | Descripción |
|---|---|
BAD_KEY | Clave API incorrecta |
BAD_ACTION | Acción incorrecta |
