wxc_sdk.me.secondary_line.forwarding package

class wxc_sdk.me.secondary_line.forwarding.MeSecondaryLineForwardingApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

settings(lineowner_id: str) → PersonForwardingSetting[source]

Get My Secondary Line Owner’s Call Forwarding Settings

Get details of call forwarding settings associated with a secondary line of the authenticated user.

Note that an authenticated user can only retrieve information for their configured secondary lines.

Three types of call forwarding are supported:

  • Always - forwards all incoming calls to the destination you choose.

  • When busy - forwards all incoming calls to the destination you chose while the phone is in use or the person

is busy.

  • When no answer - forwarding only occurs when you are away or not answering your phone.

In addition, the Business Continuity feature will send calls to a destination of your choice if your phone is not connected to the network for any reason, such as a power outage, failed Internet connection, or wiring problem.

This API requires a user auth token with a scope of spark:telephony_config_read.

Parameters:

lineowner_id (str) – Unique identifier for the secondary line owner (applicable only for Virtual Lines).

Return type:

PersonForwardingSetting

configure(lineowner_id: str, forwarding: PersonForwardingSetting)[source]

Update My Secondary Line Owner’s Call Forwarding Settings

Update call forwarding settings associated with a secondary line owner of the authenticated user.

Note that an authenticated user can only modify information for their configured secondary lines.

Three types of call forwarding are supported:

  • Always - forwards all incoming calls to the destination you choose.

  • When busy - forwards all incoming calls to the destination you chose while the phone is in use or the person

is busy.

  • When no answer - forwarding only occurs when you are away or not answering your phone.

In addition, the Business Continuity feature will send calls to a destination of your choice if your phone is not connected to the network for any reason, such as a power outage, failed Internet connection, or wiring problem.

This API requires a user auth token with a scope of spark:telephony_config_write.

Parameters:

lineowner_id (str:param forwarding: new forwarding settings) – Unique identifier for the secondary line owner (applicable only for Virtual Lines).

base = 'telephony/config/people/me'