truecallerjs

TruecallerJS

欢迎来到 TruecallerJS！这是一个使用 Truecaller API 检索电话号码详细信息的库。它提供了一种简单便捷的方式来访问 Node.js、JavaScript 和 TypeScript 项目中的电话号码信息。

描述

TruecallerJS 旨在简化获取电话号码详细信息的过程。借助此库，您可以轻松地将 Truecaller 功能集成到 Node.js、JavaScript 和 TypeScript 应用程序中。它抽象了与 Truecaller API 交互的复杂性，并提供了一个用于获取和处理电话号码信息的简化接口。

特征

• 电话号码查找：检索有关电话号码的详细信息，包括所有者的姓名、位置等。

• 支持 Node.js、JavaScript 和 TypeScript ：TruecallerJS 可以在 Node.js 项目以及 JavaScript 和 TypeScript 应用程序中使用。

• 简单且轻量级：TruecallerJS 的设计目标是易于使用且轻量级。

目录

• TruecallerJS
  • 描述
  • 特征
  • 目录
  • 安装
  • 命令行使用
    • 局限性
  • 用法
    • 简单的例子
    • 批量搜索多个电话号码
  • 免责声明
  • 贡献
  • 执照
  • 致谢

安装

您可以使用 npm 安装 TruecallerJS：

npm install truecallerjs

从命令行使用 TruecallerJS

npm install -g truecallerjs

注意：如果您使用的truecallerjs版本早于 1.1.2，我们建议您参阅 truecallerjs-v1.1.2 文档以获取说明。注意：如果您使用的是truecallerjs 1.1.3 至 1.1.5 版本，请参阅 truecallerjs-v1.1.5 文档以获取说明。

命令行使用

要从命令行使用 TruecallerJS，您可以运行truecallerjs命令，后跟所需的选项和参数。

以下是可用选项的一些示例：

• truecallerjs login ：使用此命令登录您的 Truecaller 帐户。

• truecallerjs -s [number] ：使用此命令搜索电话号码并检索来电者姓名和相关信息。

• truecallerjs --bulksearch, --bs命令用于使用 Truecaller 服务执行批量号码搜索。它允许您一次搜索多个电话号码，从而可以方便地在单个请求中处理大量电话号码。

• truecallerjs --bulksearch, --bs ：使用此命令执行批量号码搜索。

• 其他选项包括--raw 、 --name 、 --email 、 --json 、 --xml 、 --yaml 、 --text 、 --nc 、 --installationid 、 --verbose和--help 。

例如：

 ~ $ truecallerjs -s [phone] --json
{
     ...
     " name " : " Sumith Emmadi "
     ...
}

~ $ truecallerjs -s [phone] --name
Name : Sumith Emmadi

批量搜索示例

truecallerjs --bulksearch < phone_number_ 1> , < phone_number_ 2> , < phone_number_ 3> ,..., < phone_number_n >

将<phone_number_1>, <phone_number_2>, ..., <phone_number_n>替换为您要搜索的实际电话号码。用逗号分隔每个电话号码。

 ~ $ truecallerjs --bs 9912345678,[phone],[phone]

注意：如果电话号码未指定国家代码，则默认使用您自己的国家代码。

局限性

使用--bulksearch选项时请注意以下限制：

1. 最大电话号码数：该工具支持在单个请求中一次搜索 30 个或更少的电话号码。如果超过此限制，您可能需要将输入拆分为多个请求。

2. 格式：确保电话号码格式正确且不包含任何其他字符或空格。该工具期望以逗号分隔的格式提供电话号码。

用法

要使用该项目，首先通过 npm 安装truecallerjs包：

npm install truecallerjs

简单的例子

以下是如何执行电话号码的常规搜索的基本示例：

 import truecallerjs , { SearchData , Format } from "truecallerjs" ;

async function performTruecallerSearch ( ) : Promise < void > {
  const searchData : SearchData = {
    number : "9912345678" ,
    countryCode : "IN" ,
    installationId : "a1k07--Vgdfyvv_rftf5uuudhuhnkljyvvtfftjuhbuijbhug" ,
  } ;

  try {
    const response : Format = await truecallerjs . search ( searchData ) ;
    console . log ( response . json ( ) ) ;

    // Additional response methods:
    // console.log(response.xml());
    // console.log(response.yaml());
    // console.log(response.text());

    // Example of available data from the response:
    console . log ( response . getName ( ) ) ; // "Sumith Emmadi"
    console . log ( response . getAlternateName ( ) ) ; // "sumith"
    console . log ( response . getAddresses ( ) ) ; // {....}
    console . log ( response . getEmailId ( ) ) ; // [email protected]
    console . log ( response . getCountryDetails ( ) ) ; // {...}
  } catch ( error ) {
    console . error ( "Error occurred:" , error ) ;
  }
}

performTruecallerSearch ( ) ;

在上面的示例中， truecallerjs包用于搜索电话号码。 search_data对象包含必要的参数，包括号码、国家/地区代码和安装 ID。 truecallerjs.search()函数的响应提供了各种方法来访问返回的数据。

注意：确保使用truecallerjs login命令登录并使用truecallerjs -i命令获取您的安装 ID。

批量搜索多个电话号码

truecallerjs包还支持批量搜索多个电话号码：

 import truecallerjs , { BulkSearchData , Format } from "truecallerjs" ;

async function performBulkTruecallerSearch ( ) : Promise < void > {
  const countryCode : string = "IN" ;
  const installationId : string = "a1k07--Vgdfyvv_rftf5uuudhuhnkljyvvtfftjuhbuijbhug" ;
  const phoneNumbers : string = "[phone],[phone],[phone]" ;

  try {
    const response : BulkSearchData = await truecallerjs . bulkSearch ( phoneNumbers , countryCode , installationId ) ;
    console . log ( response ) ;
  } catch ( error ) {
    console . error ( "Error occurred:" , error ) ;
  }
}

performBulkTruecallerSearch ( ) ;

在此示例中， truecallerjs.bulkSearch()函数用于对多个电话号码执行批量搜索。 phoneNumbers参数应包含以逗号分隔的电话号码。 countryCode和installationId参数分别用于指定默认国家/地区代码和安装ID。

注意：确保使用truecallerjs login命令登录并使用truecallerjs -i命令获取您的安装 ID。

有关更多详细信息和附加功能，请参阅文档，包括登录和获取安装 ID 的过程。

免责声明

truecallerjs工具不是 Truecaller 官方产品。它是由 Sumith Emmadi 开发的自定义脚本，其功能依赖于 Truecaller 服务。请负责任地使用此工具并遵守 Truecaller 的服务条款。

如需更多信息和支持，请联系 Sumith Emmadi：[email protected]。

贡献

我们不仅欢迎而且强烈鼓励为truecallerjs做出贡献！

1. 分叉此存储库git clone https://github.com/sumithemmadi/truecallerjs.git
2. 为您的贡献创建一个新分支。
3. 将您的内容添加到适当的文件夹中或创建一个新文件。
4. 提交您的更改并将它们推送到您的分叉存储库。
5. 打开拉取请求，解释您的贡献的性质。

请注意，所有贡献都应符合存储库的精神并适合所有受众。不接受冒犯性或不适当的内容。

执照

TruecallerJS 是开源的，并根据 MIT 许可证获得许可。有关详细信息，请参阅许可证文件。

？赞助并支持我

如果您发现我的项目有帮助或鼓舞人心，请考虑通过 GitHub 赞助商支持我。您的赞助帮助我投入更多的时间和精力来开源开发和创建有影响力的项目。

❤️ 在 github 上赞助我

？赞助商

• 我要向所有赞助商的慷慨支持表示诚挚的谢意。

致谢

感谢您选择 TruecallerJS！我希望它可以帮助您有效地检索电话号码详细信息。

存储库：https://github.com/sumithemmadi/truecallerjs.git