GET / phone-numbers

Base URL: https://backend.easify.app/api/v2

This endpoint is used to retrieve the user's active and approved phone numbers.

The user can retrieve their active and approved phone numbers with or without pagination.If the user sends a limit in the parameters, the data will be paginated; otherwise, the entire set of phone numbers will be fetched from the database

There is a rate limit of 60 requests per minute. If you exceed this limit, you will receive a 429 Too Many Requests status, along with a message indicating when you can try again.

Authentication

The Easify API token used for authentication is passed in the header as a Bearer token, which can be obtained from the easify app under Settings > API Settings.

Headers

Authorization string required Bearer << YOUR_EASIFY_API_TOKEN_HERE >>

Query Parameters

limit integer Pagination for phone numbers Optional

Sample Params and Response:

Params:

{
  "limit": 10
}

Success Response:

{
  "status": true,
  "message": "Phone Numbers",
  "data": [
    {
      "id": 52,
      "number": "+185560620**",
      "approved": "Approved",
      "gateway": "Twilio",
      "name": "released number",
      "status": "Active",
      "webhook_url": null,
      "created_at": "07-12-2024 11:03:12 AM"
    }
  ],
  "links": []
}

Api Response Status

Case Status Code Response
If the user does not provide a token in the header or provides an invalid token 401 { "status": false, "message": "Unauthenticated", "errors": [] }
If the user exceeds the allowed rate limit for requests 429 { "status":false, "message":"Too many requests. Try again in 59 seconds", "errors":[] }
If the user's subscription has ended 402 { "status":false,"message":"You need to recharge your account to proceed","errors":[] }
If the user does not have an enterprise plan 403 { "status": false, "message": "Access denied. Your current plan does not allow access to this feature. Please upgrade to the Enterprise plan.", "errors": [] }

PHP-cURL

php
$curl = curl_init();
curl_setopt_array($curl, [
    CURLOPT_URL => 'https://backend.easify.app/api/v2/phone-numbers',
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => '',
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 0,
    CURLOPT_FOLLOWLOCATION => true,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer 1955|43da5bb5-5c2b-4059-a4de-d44bf5c****'
    ],
]);
$response = curl_exec($curl);
curl_close($curl);
echo $response;
pixel for linkedin