> ## Documentation Index
> Fetch the complete documentation index at: https://deepline.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Meer API: Meerapi Check Phone Number

> Check whether a phone number is on its country do-not-call (DNC) register before calling or texting. Returns do_not_call true or false and the register that.

Check whether a phone number is on its country do-not-call (DNC) register before calling or texting. Returns do\_not\_call true or false and the register that.

> [!NOTE]
>
> Tool ID: `meerapi_check_phone_number`

## Run this action

Use the TypeScript SDK for one call. Use `ctx.tools.execute(...)` inside a Play for durable calls, scheduled calls, or CSV processing.

```ts theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
import { Deepline } from 'deepline';

const deepline = await Deepline.connect();
const result = await deepline.tools.execute(
  'meerapi_check_phone_number',
  {
    "phone_number": "+14155550123"
  },
);

console.log(result.toolResponse.raw);
```

### CLI

```bash theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
deepline tools execute meerapi_check_phone_number --input '{
  "phone_number": "+14155550123"
}' --json
```

## Example response

The SDK returns this shape at `result.toolResponse.raw`. The example values illustrate the response.

```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
{
  "data": {
    "do_not_call": true,
    "timestamp": "2026-01-15T12:00:00Z",
    "dnc_list_source": "example"
  }
}
```

Use `deepline describe meerapi_check_phone_number --json` for the latest machine-readable contract.

## Input reference

Returns whether the phone number is on its country do-not-call register (do\_not\_call true or false), the register that answered, and when it was checked. This is a compliance check, not a validity, line-type or carrier lookup. Read-only. Send E.164 numbers with the national leading zero dropped: UK 01000822380 is +441000822380.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `payload.phone_number` | `string` | Yes | — | E.164 with a leading + and digits only, e.g. +441000822380. |

<details>
  <summary>Show raw input schema</summary>

  ### Input JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Returns whether the phone number is on its country do-not-call register (do_not_call true or false), the register that answered, and when it was checked. This is a compliance check, not a validity, line-type or carrier lookup. Read-only. Send E.164 numbers with the national leading zero dropped: UK 01000822380 is +441000822380.",
    "properties": {
      "phone_number": {
        "type": "string",
        "description": "E.164 with a leading + and digits only, e.g. +441000822380."
      }
    },
    "required": [
      "phone_number"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Output reference

Standard tool result payload.

| Name | Type | Required | Default | Details |
| - | - | - | - | - |
| `result.data` | `object` | Yes | — | Provider response payload. |
| `result.data.do_not_call` | `boolean` | Yes | — | `true` if the number is on the register. |
| `result.data.timestamp` | `string` | Yes | — | When the check ran. Format: `date-time`. |
| `result.data.dnc_list_source` | `string \| null` | Yes | — | The register that answered. Can be `null` when the number is not listed. |
| `result.meta` | `object` | No | — | Additional response metadata (status, paging). |

<details>
  <summary>Show raw output schema</summary>

  ### Output JSON Schema

  ```json theme={"languages":{"custom":["/languages/deepline-prompt.json"]}}
  {
    "type": "object",
    "description": "Standard tool result payload.",
    "properties": {
      "data": {
        "type": "object",
        "description": "Provider response payload.",
        "properties": {
          "do_not_call": {
            "type": "boolean",
            "description": "`true` if the number is on the register."
          },
          "timestamp": {
            "type": "string",
            "description": "When the check ran.",
            "format": "date-time"
          },
          "dnc_list_source": {
            "type": [
              "string",
              "null"
            ],
            "description": "The register that answered. Can be `null` when the number is not listed."
          }
        },
        "required": [
          "do_not_call",
          "timestamp",
          "dnc_list_source"
        ],
        "additionalProperties": false
      },
      "meta": {
        "type": "object",
        "description": "Additional response metadata (status, paging).",
        "additionalProperties": true
      }
    },
    "required": [
      "data"
    ],
    "additionalProperties": false
  }
  ```
</details>

## Deepline cost

* Pricing model: `fixed` (per call).
* Estimated Deepline credits: `0` per pricing unit.
* Provider-native pricing may still exist outside Deepline credit billing.

## Related documentation

* [Meer API provider guide](https://deepline.com/docs/providers/meerapi/guide.md)
* [SDK V2 quickstart](https://deepline.com/docs/sdk-v2/quickstart.md)
* [SDK reference](https://deepline.com/docs/sdk-v2/sdk-reference.md)
* [Run tools across a CSV](https://deepline.com/docs/sdk-v2/batch-csv.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.