Voip do Brasil

Mobile app APIs V2

Authentication Data

Data and operations for use of the APIs.

Base URL:
https://mobapp.voipdobrasil.com.br/v2/api.php
Authorization Key (key):
a088beef60b6466d14d5604c7de973d2
Request Method:
POST
Result Capture:
JSON
List of APIs (op):
  1. register
  2. forgotpassword
  3. balance
  4. login
  5. payment
  6. common questions
  7. ddi countries

Register API

API Name (op):
register
Input parameters:
name, cpf, code, cellphone, email_id, password (All input parameters are String type)
name:
This is string input.
cpf:
This is string input.
code:
This is string input.
cellphone:
This is string input.
email_id:
In this parameter we can send xyz@gmail.com email formated string.
password:
This is string input.

Expected Response

Sucess Respose:

          {
            "status": "success",
            "message": "user authenticated successfully",
            "sipusername": "65001",
       	    "sippassword": "krify0102",
	    "sip": "voipdobrasil1.net.br:5060"
          }

Fail Response:

          {
            "status": "fail",
            "message": "provided user details are invalid [ put your error message here ]"
          }

Test Example

Register

Attention! All fields are mandatory.

Forgot Password API

API Name (op):
forgotpassword
Input parameters:
email_id (All input parameters are String type)
email_id:
We can send here email id.

Expected Response

Sucess Respose:

          {
            "status": "success",
            "message": "recovery password sent to your email id, please check and login"
          }

Fail Response:

          {
            "status": "fail",
            "message": "provided details are invalid"
          }

Test Example

Forgot Password

Attention! All fields are mandatory.

Balance API

API Name (op):
balance
Input parameters:
sipusername (Type String)
sipusername:
This is string input.

Expected Response

Sucess Respose:

          {
            "status": "success",
            "message": "current customer balance",
            "balance": "0.00000"
          }

Fail Response:

          {
            "status": "fail",
            "message": "client not found or balance not found"
          }

Test Example

Balance

Attention! All fields are mandatory.

QrCode API

API Name (op):
qrcode
Input parameters:
username, password (All input parameters are String type)
sipusername:
Number or extension of your line.
sippassword:
Password for your line or extension.

Expected Response

Sucess Respose:

      {
        "status": "success",
        "message": "user authenticated successfully",
        "sipusername": "65001",
        "sippassword": "krify0102",
        "sip": "voipdobrasil1.net.br:5060"
      }

Fail Response:

      {
        "status": "fail",
        "message": "provided user details are invalid"
      }

Test Example

QrCode

Attention! All fields are mandatory.

Login API

API Name (op):
login
Input parameters:
username, password (All input parameters are String type)
sipusername:
Number or extension of your line.
sippassword:
Password for your line or extension.

Expected Response

Sucess Respose:

          {
            "status": "success",
            "message": "user authenticated successfully",
            "sipusername": "65001",
            "sippassword": "krify0102",
            "sip": "voipdobrasil1.net.br:5060"
          }

Fail Response:

          {
            "status": "fail",
            "message": "provided user details are invalid"
          }

Test Example

Login

Attention! All fields are mandatory.

Payment API

API Name (op):
payment
Input parameters:
sipusername, price
sipusername:
This is string input.
price:
This is float input.

Expected Response

Sucess Respose:

          {
            "status": "success",
            "message": "paid charge",
            "client": "Patrick Ramos"
          }

Fail Response:

          {
            "status": "fail",
            "message": "charge not found"
          }

Test Example

Payment

Attention! All fields are mandatory.

Common Questions API

API Name (op):
questions

Expected Response

Sucess Respose:

          {
            "question": "Chamadas para 0800 são cobradas?",
            "response": "Fique tranquilo! A Voip do Brasil não cobra por chamadas 0800. Elas não são tarifadas, nem possuem limite de tempo.",
          },
	  {
            "question": "Como ligo para números 0800 ou 400X no Brasil, estando em outro país?",
            "response": "Você disca o número direto, como se estivesse aqui no Brasil. Se precisar ligar para a operadora do seu cartão de crédito por exemplo, é só discar 0800 123 4567 ou 400X 1234.",
          },
	  {
            "question": "Como ligo para Fixo ou Móvel no Brasil, estando em outro país?",
            "response": "Você deve discar 0 + Código da cidade + Número. Para ligar para um telefone móvel em São Paulo por exemplo, disque 011998001234",
          }

Fail Response:

          {
            "status": "fail",
            "message": "no results"
          }

Test Example

Common Questions

DDI Countries API

API Name (op):
ddi

Expected Response

Sucess Respose:

        {
            "country": "Alemanha",
            "ddi": "+49"
        },
        {
            "country": "Andorra",
            "ddi": "+376"
        },
        {
            "country": "Angola",
            "ddi": "+244"
        },
        {
            "country": "Anguilla",
            "ddi": "+1"
        }

Fail Response:

          {
            "status": "fail",
            "message": "no results"
          }

Test Example

DDI Countries