# Call Forwarding

## Get call forwarding for a line

`lines.call_forwarding.retrieve(strsendblue_number)  -> CallForwardingRetrieveResponse`

**get** `/api/lines/{sendblue_number}/call-forwarding`

Returns the current call forwarding number for a dedicated phone line.

Per-line forwarding takes priority over the company default forwarding number
but is overridden by seat-level forwarding when a seat has a forwarding number set.

**Priority order:** seat forwarding → per-line forwarding → company default forwarding

### Parameters

- `sendblue_number: str`

### Returns

- `class CallForwardingRetrieveResponse: …`

  - `forwarding_number: Optional[str]`

    The number calls are forwarded to, or null if not set

  - `sendblue_number: str`

    The Sendblue phone number (E.164)

### Example

```python
import os
from sendblue_api import SendblueAPI

client = SendblueAPI(
    api_key=os.environ.get("SENDBLUE_API_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SENDBLUE_API_API_SECRET"),  # This is the default and can be omitted
)
call_forwarding = client.lines.call_forwarding.retrieve(
    "+12125550101",
)
print(call_forwarding.forwarding_number)
```

#### Response

```json
{
  "forwarding_number": "+16692138010",
  "sendblue_number": "+12125550101"
}
```

## Set call forwarding for a line

`lines.call_forwarding.update(strsendblue_number, CallForwardingUpdateParams**kwargs)  -> CallForwardingUpdateResponse`

**put** `/api/lines/{sendblue_number}/call-forwarding`

Sets a call forwarding number for a specific dedicated phone line.
Inbound calls to this line will be forwarded to the specified number.

The `forwarding_number` is normalized to E.164 format before storage.
US numbers can be supplied in local format (e.g. `2125550199`).

### Parameters

- `sendblue_number: str`

- `forwarding_number: str`

  Phone number to forward calls to (E.164 or US local format)

### Returns

- `class CallForwardingUpdateResponse: …`

  - `forwarding_number: Optional[str]`

    The number calls are forwarded to, or null if not set

  - `sendblue_number: str`

    The Sendblue phone number (E.164)

### Example

```python
import os
from sendblue_api import SendblueAPI

client = SendblueAPI(
    api_key=os.environ.get("SENDBLUE_API_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SENDBLUE_API_API_SECRET"),  # This is the default and can be omitted
)
call_forwarding = client.lines.call_forwarding.update(
    sendblue_number="+12125550101",
    forwarding_number="+16692138010",
)
print(call_forwarding.forwarding_number)
```

#### Response

```json
{
  "forwarding_number": "+16692138010",
  "sendblue_number": "+12125550101"
}
```

## Clear call forwarding for a line

`lines.call_forwarding.delete(strsendblue_number)  -> CallForwardingDeleteResponse`

**delete** `/api/lines/{sendblue_number}/call-forwarding`

Removes the per-line call forwarding number. After clearing, inbound calls
will fall back to the company default forwarding number (if configured).

This operation is idempotent — calling it on a line with no forwarding set
returns 200 with `forwarding_number: null`.

### Parameters

- `sendblue_number: str`

### Returns

- `class CallForwardingDeleteResponse: …`

  - `forwarding_number: Optional[str]`

    The number calls are forwarded to, or null if not set

  - `sendblue_number: str`

    The Sendblue phone number (E.164)

### Example

```python
import os
from sendblue_api import SendblueAPI

client = SendblueAPI(
    api_key=os.environ.get("SENDBLUE_API_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SENDBLUE_API_API_SECRET"),  # This is the default and can be omitted
)
call_forwarding = client.lines.call_forwarding.delete(
    "+12125550101",
)
print(call_forwarding.forwarding_number)
```

#### Response

```json
{
  "forwarding_number": "+16692138010",
  "sendblue_number": "+12125550101"
}
```

## Domain Types

### Call Forwarding Retrieve Response

- `class CallForwardingRetrieveResponse: …`

  - `forwarding_number: Optional[str]`

    The number calls are forwarded to, or null if not set

  - `sendblue_number: str`

    The Sendblue phone number (E.164)

### Call Forwarding Update Response

- `class CallForwardingUpdateResponse: …`

  - `forwarding_number: Optional[str]`

    The number calls are forwarded to, or null if not set

  - `sendblue_number: str`

    The Sendblue phone number (E.164)

### Call Forwarding Delete Response

- `class CallForwardingDeleteResponse: …`

  - `forwarding_number: Optional[str]`

    The number calls are forwarded to, or null if not set

  - `sendblue_number: str`

    The Sendblue phone number (E.164)