Skip to content

yuvarajucet/phoneinfopy

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

10 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PhoneInfopy

PhoneInfopy is a python tool to directly make request to Truecaller API's and get response. This module will allow you to register your number, validate OTP while registering and search information about a phone number.

Table to Contents

Requirements

To use PhoneInfopy module you need below pre requirements.

  • valid mobile number
  • python
  • truecaller auth token [This token will get by login/register process]

Command Line Usage

You can install PhoneInfopy package using pip

  • phoneinfopy -h [--help] for help
  • phoneinfopy -l [--login] for login [Need to mention country code]
  • phoneinfopy -c [--code] for country code
  • phoneinfopy -i [--info] for search mobile number [Need to mention country code]

Installation

pip install phoneinfopy

Login

python3 -m phoneinfopy.cli -c <countryCode> -l <phoneNumber>

Example

python3 -m phoneinfopy.cli -c +91 -l 98xxxxxxxx

search-Number

You can search phone number by using below command

python3 -m phoneinfopy.cli -c +91 -i 98xxxxxxxx

Module-usage

Install

You can install the phoneinfopy moudle using pip:

pip install phoneinfopy

Register

from phoneinfopy import register_phone_number

number = "+9198xxxxxxxx"
response = register_phone_number(number)

# register_phone_number method will return json object
# example:
# {
#   status : bool,
#   message: str
#   requestId: str
# }

Validate-OTP:

Once you get success response from register method next you need to verify the OTP to get access token.

from phoneinfopy import validate_OTP

number = "+9198xxxxxxxx"
OTP = "123456"
requestId = "<you get this ID while register process>"
response = validate_OTP(number, OTP, requestId)

# validate_OTP method will return json object
# {
#   status: bool
#   message: str
#   access_token: str  [If OTP validatino is success]
# }

Search-number

You need to get user information using phone number you can use like this..

from phoneinfopy import get_phone_info

target_number = "98xxxxxxxx"
country_code = "+91"
access_token = "a10--******" ["you get this token while validating OTP"]

response = get_phone_info(target_number, country_code, access_token)

# get_phone_info will return json object 
#{
#   status: bool
#   message: str
#   data: object [if user info found]
# }

Contribution

Contributions to the phoneinfopy package are welcome!... If you faced any issue or you have good idea to improve please open a issue or submit a pull request.

Let's Connect: