API de aluguel

O API é o protocolo para a comunicação entre o seu software e o nosso servidor de aluguel de número.

Descrição do protocolo API

Todas as solicitações devem ir para https://api.sms-man.com/rent-api/ Faça a solicitação GET. Todas as solicitações devem incluir a chave API como um parâmetro token Todas as respostas estão em formato json.

Solicitação de saldo

Parâmetros

Parâmetro	Tipo	Obrigatório	Valor
`token`	String	Sim	Sua chave API

Resultado

{
  "balance": "799.70"
}

Possíveis erros

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

Obter limites

Parâmetros

Parâmetro	Tipo	Obrigatório	Valor
`token`	String	Sim	Sua chave API
`country_id`	Integer	Sim
`type`	String	Sim	`hour` / `day` / `week` / `month`
`time`	String	Sim	Tempo de aluguel

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"}
  ]
}

Possíveis erros

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

Solicitando um número para alugar

Parâmetros

Parâmetro	Tipo	Obrigatório	Valor
`token`	String	Sim	Sua chave API
`country_id`	Integer	Sim
`type`	String	Sim	`hour` / `day` / `week` / `month`
`time`	String	Sim	Tempo de aluguel

Resultado

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

Possíveis erros

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

Solicitar um número parcial para aluguel

Parâmetros

Parâmetro	Tipo	Obrigatório	Valor
`token`	String	Sim	Sua chave API
`country_id`	Integer	Sim
`application_id`	Integer	Sim
`type`	String	Sim	`hour` / `day` / `week` / `month`
`time`	String	Sim	Tempo de aluguel

Resultado

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

Possíveis erros

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

Mudar status

Parâmetros

Parâmetro	Tipo	Obrigatório	Valor
`token`	String	Sim	Sua chave API
`request_id`	Integer	Sim	ID da solicitação
`status`	String	Sim	`close` - encerrar o aluguel

Resultado

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

Possíveis erros

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

Receba a última mensagem de texto

Parâmetros

Parâmetro	Tipo	Obrigatório	Valor
`token`	String	Sim	Sua chave API
`request_id`	Integer	Sim	ID da solicitação

Resultado

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

Possíveis erros

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

Receber todos os SMS

Parâmetros

Parâmetro	Tipo	Obrigatório	Valor
`token`	String	Sim	Sua chave API
`request_id`	Integer	Sim	ID da solicitação

Resultado

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

Possíveis erros

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

Obtenha uma lista de todos os números

Parâmetros

Parâmetro	Tipo	Obrigatório	Valor
`token`	String	Sim	Your API KEY

Resultado

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

Possíveis erros

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