API de alquiler

API es el protocolo de comunicación entre su software y nuestro servidor de alquiler de números.

Descripción del protocolo API

Todas las solicitudes deben ir a https://api.sms-man.com/rent-api/ solicitud GET. Todas las solicitudes deben tener una clave de API en forma de parámetro de token

Solicitud de saldo

Parámetros

Parámetro	Tipo	Requerido	Valor
`token`	String	Sí	Su CLAVE API

Resultado

{
  "balance": "799.70"
}

Errores posibles

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

Obtener límites

Parámetros

Parámetro	Tipo	Requerido	Valor
`token`	String	Sí	Su CLAVE API
`country_id`	Integer	Sí
`type`	String	Sí	`hour` / `day` / `week` / `month`
`time`	String	Sí	Tiempo de alquiler

Resultado

{
  "type": "hour",
  "time": "4",
  "limits": [
    {"country_id":"1","count":"127","cost":"151.68"},
    {"country_id":"2","count":"49","cost":"113.56"},
    {"country_id":"4","count":"0","cost":"151.68"}
  ]
}

Errores posibles

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

Solicitar un número de alquiler

Parámetros

Parámetro	Tipo	Requerido	Valor
`token`	String	Sí	Su CLAVE API
`country_id`	Integer	Sí
`type`	String	Sí	`hour` / `day` / `week` / `month`
`time`	String	Sí	Tiempo de alquiler

Resultado

{
  "request_id": 1,
  "country_id": 1,
  "number": "79002415539"
}

Errores posibles

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

Solicitar un número parcial en alquiler

Parámetros

Parámetro	Tipo	Requerido	Valor
`token`	String	Sí	Su CLAVE API
`country_id`	Integer	Sí
`application_id`	Integer	Sí
`type`	String	Sí	`hour` / `day` / `week` / `month`
`time`	String	Sí	Tiempo de alquiler

Resultado

{
  "request_id": 1,
  "country_id": 1,
  "application_id": 1,
  "number": "79002415539"
}

Errores posibles

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

Cambiar estado

Parámetros

Parámetro	Tipo	Requerido	Valor
`token`	String	Sí	Su CLAVE API
`request_id`	Integer	Sí	ID de solicitud
`status`	String	Sí	`close` - finalizar el alquiler

Resultado

{
  "request_id": 1,
  "success": true
}

Errores posibles

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

Recibir el último SMS

Parámetros

Parámetro	Tipo	Requerido	Valor
`token`	String	Sí	Su CLAVE API
`request_id`	Integer	Sí	ID de solicitud

Resultado

{
  "request_id": "10",
  "country_id": 1,
  "number": "79633002801",
  "sms": {"message":"message","code":"code","time":"2020-12-12 14:50:31"}
}

Errores posibles

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

Recibir todos los sms

Parámetros

Parámetro	Tipo	Requerido	Valor
`token`	String	Sí	Su CLAVE API
`request_id`	Integer	Sí	ID de solicitud

Resultado

{
  "request_id": "10",
  "country_id": 1,
  "number": "79633002801",
  "sms": [
    {"message":"message","code":"code","time":"2020-12-12 14:50:31"}
  ]
}

Errores posibles

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}

Obtener una lista con todos los números

Parámetros

Parámetro	Tipo	Requerido	Valor
`token`	String	Sí	Your API KEY

Resultado

[
  {"id":1,"country_id":1,"number":"79002415539","status":"cancel"}
]

Errores posibles

{
  "success": false,
  "error_code": "wrong_token",
  "error_msg": {"token":"Wrong token!"}
}