@sharpapi/sharpapi-node-detect-phones

Phone Number Detector API for Node.js

📞 Detect and extract phone numbers from text — powered by SharpAPI AI.

SharpAPI Phone Number Detector parses text content and extracts phone numbers in various international formats. Perfect for lead generation, data extraction, and contact management.

📋 Table of Contents

• Requirements
• Installation
• Usage
• API Documentation
• Examples
• License

Requirements

• Node.js >= 16.x
• npm or yarn

Installation

Step 1. Install the package via npm:

npm install @sharpapi/sharpapi-node-detect-phones

Step 2. Get your API key

Visit SharpAPI.com to get your API key.

Usage

const { SharpApiDetectPhonesService } = require('@sharpapi/sharpapi-node-detect-phones');

const apiKey = process.env.SHARP_API_KEY; // Store your API key in environment variables
const service = new SharpApiDetectPhonesService(apiKey);

const text = `
For customer support, call us at [phone] or toll-free at 1-800-EXAMPLE.
Our international office can be reached at [phone].
`;

async function detectPhones() {
  try {
    // Submit detection job
    const statusUrl = await service.detectPhones(text);
    console.log('Job submitted. Status URL:', statusUrl);

    // Fetch results (polls automatically until complete)
    const result = await service.fetchResults(statusUrl);
    console.log('Detected phones:', result.getResultJson());
  } catch (error) {
    console.error('Error:', error.message);
  }
}

detectPhones();

API Documentation

Methods

detectPhones(text: string): Promise<string>

Detects and extracts phone numbers from the provided text.

Parameters:

• text (string, required): The text content to scan for phone numbers

Returns:

• Promise: Status URL for polling the job result

Example:

const statusUrl = await service.detectPhones(textWithPhones);
const result = await service.fetchResults(statusUrl);

Response Format

The API returns detected phone numbers with parsed components:

{
  "phone_numbers": [
    {
      "detected_number": "[phone]",
      "parsed_number": "[phone]",
      "country_code": "+1",
      "national_number": "5551234567",
      "country": "United States",
      "format": "international",
      "is_valid": true,
      "type": "mobile"
    },
    {
      "detected_number": "[phone]",
      "parsed_number": "[phone]",
      "country_code": "+44",
      "national_number": "2012345678",
      "country": "United Kingdom",
      "format": "international",
      "is_valid": true,
      "type": "landline"
    }
  ]
}

Examples

Basic Phone Detection

const { SharpApiDetectPhonesService } = require('@sharpapi/sharpapi-node-detect-phones');

const service = new SharpApiDetectPhonesService(process.env.SHARP_API_KEY);

const businessCard = `
John Doe
Senior Manager
Mobile: [phone]
Office: [phone]
`;

service.detectPhones(businessCard)
  .then(statusUrl => service.fetchResults(statusUrl))
  .then(result => {
    const phones = result.getResultJson();
    console.log(`Found ${phones.length} phone numbers:`);
    phones.forEach((phone, index) => {
      console.log(`${index + 1}. ${phone.detected_number} (${phone.type})`);
    });
  })
  .catch(error => console.error('Detection failed:', error));

International Phone Number Extraction

const service = new SharpApiDetectPhonesService(process.env.SHARP_API_KEY);

const globalContacts = `
US Office: [phone]
UK Office: [phone]
Australia: [phone]
Germany: [phone]
`;

const statusUrl = await service.detectPhones(globalContacts);
const result = await service.fetchResults(statusUrl);
const phones = result.getResultJson();

phones.forEach(phone => {
  console.log(`${phone.country}: ${phone.parsed_number}`);
});

Custom Polling Configuration

const service = new SharpApiDetectPhonesService(process.env.SHARP_API_KEY);

// Customize polling behavior
service.setApiJobStatusPollingInterval(5);  // Poll every 5 seconds
service.setApiJobStatusPollingWait(120);    // Wait up to 2 minutes

const statusUrl = await service.detectPhones(text);
const result = await service.fetchResults(statusUrl);

Use Cases

• Lead Generation: Extract phone numbers from websites, PDFs, and documents
• Contact Management: Build databases from unstructured data
• Data Validation: Verify phone number formats and validity
• CRM Integration: Automatically populate contact information
• Marketing: Extract phone numbers for outreach campaigns
• Document Processing: Parse phone numbers from scanned documents
• Customer Support: Extract callback numbers from support tickets

Supported Formats

The detector recognizes various phone number formats:

• International: [phone], [phone]
• National: [phone], 555-123-4567
• Toll-free: 1-800-EXAMPLE, 1-888-CALL-NOW
• Extensions: [phone] ext. 123
• Mobile: Various international mobile formats
• Landline: Fixed-line number formats

API Endpoint

POST /content/detect_phones

For detailed API specifications, refer to:

• Postman Documentation
• Product Page

Related Packages

• @sharpapi/sharpapi-node-detect-emails - Email detection
• @sharpapi/sharpapi-node-detect-urls - URL detection
• @sharpapi/sharpapi-node-detect-address - Address detection
• @sharpapi/sharpapi-node-client - Full SharpAPI SDK

License

This project is licensed under the MIT License. See the LICENSE.md file for details.

Support

• Documentation: SharpAPI.com Documentation
• Issues: GitHub Issues
• Email: [e-mail]

Powered by SharpAPI - AI-Powered API Workflow Automation