Detect Phones Numbers API - ApyHub

Detect Phones Numbers API

Artificial IntelligenceData ExtractionMarketing#content#detect#text
job
SharpAPI
SharpAPI
verified icon
1000 atoms
AI tier

About

The Phone Number Detection API parses the provided text for any phone numbers and returns the original detected version in E.164 format. This API is useful for processing and validating large datasets to identify phone numbers or detecting phone numbers in inappropriate places.
This API is ideal for developers working on data validation tools, form processing applications, or compliance monitoring systems. It automates the extraction and standardization of phone numbers, ensuring accuracy and consistency. Use cases include cleaning and validating customer databases, monitoring for unauthorized phone number inclusion, and enhancing contact information management.
Apy Jobs are long running calls which are split into two actions:
1. Submitting the job
2. Checking the status of the job and receiving the response on successful completion of the job.
Select API Endpoints
Input(s)

API Playground

API Documentation

Detect Phones Numbers Submit Job
POST
https://api.apyhub.com/sharpapi/api/v1/content/detect_phones

Request example

1
```cURL
2


3
curl --location --request POST 'https://api.apyhub.com/sharpapi/api/v1/content/detect_phones' \
4
--header 'apy-token: {{token}}' \
5
--header 'Content-Type: application/json' \
6
--data '{
7
    "content": "Where to find us \n Call with a sales tech advisor: Call: 1800-394-7486 \n or our Singapore office +65 8888 8888"
8
}'
Method: POST
Content Type: application/json
Request Body
AttributeTypeMandatoryDescription
contentStringYesProvide the content from where mobile number needs to be detected.
Sample Response
1
{
2
  "status_url": "https://api.apyhub.com/sharpapi/api/v1/content/detect_phones/job/status/5de4887a-0dfd-49b6-8edb-9280e468c210",
3
  "job_id": "5de4887a-0dfd-49b6-8edb-9280e468c210"
4
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
202The job was submitted successfully.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - if the file is invalid or corrupted
500If any unexpected error occurs while submitting the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles