Phone Number Identify

Here is an example API documentation for the endpoint used for Phone Number Identify.

REQUEST

Endpoint

https://stopbot.net/api/phone?apikey={APIKEY}&number={phonenumber}

Method

GET

Parameters

  • apikey (string, required): The API key provided to the user.
  • number (string, required): The number to be identified. Example: +11231231234 +6562502222 +6281212341234

Example Request

CURL "https://stopbot.net/api/phone?apikey=9ca6f45b2e9821b3a964c0f79cb67dc3&number=+6281212341234"

Example Response

Success Response

If the HTTP response is 200 (success response), it will generate the following response:
{
"number": "+6281212341234",
"isValid": 1,
"info": {
"phonenumber": "+62 812-1234-1234",
"type": "MOBILE",
"carrier": "TELKOMSEL",
"location": "INDONESIA",
"countryCode": "ID"
},
"status": "success",
"timeResponse": "2023-06-8 23:00"
}

Description on successful response

  • number: This field represents the input phone number that was requested for identification.
  • isValid: This field indicates whether the provided phone number is valid (1) or not valid (0).
  • info: This object contains additional information about the phone numbe.
    • phonenumber: This field represents the formatted version of the phone number.
    • type: This field indicates the type of the phone number. The "type" field can have different values to represent various types of phone numbers. Here are some commonly used types:
      1. 1.
        FIXED_LINE: Indicates that the phone number is a fixed line number. It is usually used for home or office telephone numbers that are physically connected.
      2. 2.
        MOBILE: Indicates that the phone number is a mobile number. It is typically used for phone numbers associated with mobile devices or cell phones.
      3. 3.
        TOLL_FREE: Indicates that the phone number is a toll-free number. It is commonly used for phone numbers that do not incur charges for the calling party.
      4. 4.
        PREMIUM_RATE: Indicates that the phone number is a premium rate number. It is often used for phone numbers that provide specialized services with additional charges.
      5. 5.
        SHARED_COST: Indicates that the call cost for the phone number is shared between the caller and the recipient. This type may be used for phone numbers that have shared costs between the parties involved.
      6. 6.
        VOIP: Indicates that the phone number is used for voice services over the internet protocol (Voice over IP / VoIP). It is typically used for phone numbers connected through internet networks.
      7. 7.
        PERSONAL_NUMBER: Indicates that the phone number is a personal number. This type may be used for phone numbers issued to individuals as an alternative to fixed line or mobile numbers.
      8. 8.
        PAGER: Indicates that the phone number is a pager number. It is commonly used for phone numbers used to send short messages or notifications.
      9. 9.
        UAN: Indicates that the phone number is a universal access number. This type may be used for phone numbers that provide access to special services or general access numbers.
      10. 10.
        EMERGENCY: Indicates that the phone number is an emergency number.
      11. 11.
        VOICEMAIL: Indicates that the phone number is a voicemail number.
      12. 12.
        SHORT_CODE: Indicates that the phone number is a short code number.
      13. 13.
        STANDARD_RATE: Indicates that the phone number is a standard rate number.
      14. 14.
        UNKNOWN: Indicates that the phone number type cannot be determined. This can occur if the library is unable to classify the phone number correctly or if the phone number is invalid.
    • carrier: This field specifies the mobile carrier associated with the phone number.
    • location: This field indicates the country where the phone number is registered.
    • countryCode: This field represents the country code of the phone number.
  • status: Indicates the success or failure of the request.
  • timeResponse: Date and time when the response was sent.

Failed Response

If the HTTP response is 400 or 401 (failed response), it will generate the following response:
{
"status": "failed",
"timeResponse": "2023-06-8 23:00"
}

Description on failed response:

  • status: Response Status: The value is "failed" if the request fails.
  • timeResponse: Date and time when the response was sent.