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

# Pickup Call

> Use the RingQ API Web Hook to programmatically answer a ringing call on another extension — enable click-to-pickup in supervisor tools or shared agent interfaces.

The Pickup Call web hook instructs RingQ to intercept and answer a call that is ringing on another extension. The call is answered on the requesting extension rather than the one it was originally ringing on.

## Prerequisites

Before you begin, you need your **API Key** from the RingQ admin dashboard.

1. Log in to the RingQ admin dashboard.
2. Go to **Settings** → **API**.
3. Copy the **API Key** shown on this page. You will use it in every web hook URL.

## API URL Format

```
https://{your-ringq-domain}/api/v2/{api-key}/pickupcall/{extension}/{ringing-extension}
```

| Parameter           | Description                                                                  |
| ------------------- | ---------------------------------------------------------------------------- |
| `your-ringq-domain` | The domain or IP address of your RingQ instance (e.g. `pbx.yourdomain.com`). |
| `api-key`           | Your API key from Settings → API.                                            |
| `extension`         | The extension that will pick up the call (the one answering).                |
| `ringing-extension` | The extension that currently has the ringing call.                           |

## Example

To have extension **102** pick up a call ringing on extension **108**:

```
https://pbx.yourdomain.com/api/v2/abc123xyz/pickupcall/102/108
```

RingQ will pull the ringing call from extension 108 and connect it to extension 102.

## Response

A successful request returns HTTP `200` with a JSON body:

```json theme={null}
{ "result": "success" }
```

If there is no ringing call on the target extension, or the call was already answered, an error response is returned.

<Tip>Pickup Call is useful in shared reception or team workflows where a supervisor or colleague needs to answer a call on behalf of an unavailable agent.</Tip>