## API URL
URL used to send HTTP requests:
```url
https://portal.bulkgate.com/api/1.0/integration/check-phone-numbers
```

> [!NOTE]
> If the request does not reach its destination, repeat it on the [backup server](https://www.bulkgate.com/en/docs/api-administration-tokens/api-backup-server/) `backup1.bulkgate.com`.

```http
POST /api/1.0/integration/check-phone-numbers HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
```

### Table with parameters

| PARAMETER NAME    | VALUE                                                                  | MANDATORY | DEFAULT VALUE |
|:------------------|:-----------------------------------------------------------------------|:---------:|:-------------:|
| application_id    | [Application ID](https://www.bulkgate.com/en/docs/api-administration-tokens/api-administration/)                          |  **Yes**  |       -       | 
| application_token | [Application authentication token](https://www.bulkgate.com/en/docs/api-administration-tokens/api-tokens/)                |  **Yes**  |       -       |
| numbers           | List of phone number structures to be checked, see [Numbers](#numbers) |    No     |       -       |

#### Numbers

| PARAMETER NAME | VALUE                                                                                                                | MANDATORY |           DEFAULT VALUE           |
|:---------------|:---------------------------------------------------------------------------------------------------------------------|:---------:|:---------------------------------:|
| phone_number   | Phone number                                                                                                         | **Yes**   |                 -                 |
| country        | Phone number's [country code](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)    |   No      |                 -                 |



**Example of a complete request:**
```http-json
POST /api/1.0/integration/check-phone-numbers HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json

{
  "application_id": 451,
  "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj",
  "numbers": [
        {
            "phone_number": "420777777777",
            "country": "cz"
        },
        {
            "phone_number": "7777",
            "country": "cz"
        }
    ]
}
```


## The response to this command can be:

**In case of success**
```json
{
    "data": {
        "420777777777": {
            "phone_number": "420777777777",
            "valid": true,
            "country": "cz",
            "call_prefix": 420,
            "network_code": "23003",
            "network_name": "Vodafone"
        },
        "7777": {
            "phone_number": "7777",
            "valid": false,
            "country": null,
            "call_prefix": null,
            "network_code": null,
            "network_name": "unknown"
        }
    }
}
```