wxc_sdk.person_settings.outbound_billing_plan package

class wxc_sdk.person_settings.outbound_billing_plan.OutboundBillingPlanApi(*, session: RestSession, selector: ApiSelector = ApiSelector.person)[source]

Bases: PersonSettingsApiChild

API for OBP settings. Used for users, virtual lines and workspaces

feature: str | None = 'outboundBillingPlan'
read(entity_id: str, org_id: str = None) → bool[source]

Retrieve an entity’s Outbound Billing Plan

Not supported for Webex for Government (FedRAMP).

Retrieve the Cisco Calling Plan outbound billing plan setting for an entity.

Cisco Calling Plan outbound billing identifies whether outbound calls for the entity are billed through Cisco Calling Plan.

The response returns enabled as true when Cisco Calling Plan outbound billing is enabled for the entity. Otherwise, the response returns enabled as false.

Retrieving an entity’s outbound billing plan requires a full, user, read-only administrator, or location administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • entity_id (str) – Unique identifier for the entity.

  • org_id (str) – ID of the organization in which the entity resides. Only admin users of another organization, such as partners, may use this parameter. If not specified, the organization from the OAuth token is used.

Return type:

bool

update(entity_id: str, enabled: bool, org_id: str = None) → None[source]

Modify a Person’s Outbound Billing Plan

Not supported for Webex for Government (FedRAMP).

Modify the Cisco Calling Plan outbound billing plan setting for an entity.

Cisco Calling Plan outbound billing identifies whether outbound calls for the entity are billed through Cisco Calling Plan.

Set enabled to true to enable Cisco Calling Plan outbound billing. Setting enabled to true is supported only for an entity in a Cisco Calling Plan location. Set enabled to false to disable it.

Updating an entity’s outbound billing plan requires a full, user, or location administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • entity_id (str) – Unique identifier for the entity.

  • enabled (bool) – Set to true when Cisco Calling Plan outbound billing is enabled for the entity.

  • org_id (str) – ID of the organization in which the entity resides. Only admin users of another organization, such as partners, may use this parameter. If not specified, the organization from the OAuth token is used.

Return type:

None

base = ''