wxc_sdk.telephony.access_codes module

Access codes API for locations

Use Access Codes to bypass the set permissions for all persons/workspaces at this location.

class wxc_sdk.telephony.access_codes.LocationAccessCodesApi(*, session: RestSession, base: str | None = None)[source]

Bases: ApiChild

Access codes API

read(location_id: str, org_id: str | None = None) → list[AuthCode][source]

Get Location Access Code

Retrieve access codes details for a customer location.

Use Access Codes to bypass the set permissions for all persons/workspaces at this location.

Retrieving access codes details requires a full, user or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

  • location_id (str) – Retrieve access codes details for this location.

  • org_id (str) – Retrieve access codes details for a customer location in this organization

Returns:

list of wxc_sdk.common.CallPark

create(location_id: str, access_codes: list[AuthCode], org_id: str | None = None) → list[AuthCode][source]

Create access code in location

Parameters:

  • location_id (str) – Add new access code for this location.

  • access_codes (list of wxc_sdk.common.AuthCode) – Access code details

  • org_id (str) – Add new access code for this organization.

delete_codes(location_id: str, access_codes: list[str | AuthCode], org_id: str | None = None) → list[AuthCode][source]

Delete Access Code Location

Deletes the access code details for a particular location for a customer.

Use Access Codes to bypass the set permissions for all persons/workspaces at this location.

Modifying the access code location details requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

  • location_id (str) – Deletes the access code details for this location.

  • access_codes (list of wxc_sdk.common.AuthCode or str) – access codes to delete

  • org_id (str) – Delete access codes from this organization.

delete_all(location_id: str, org_id: str | None = None)[source]

Delete Outgoing Permission Location Access Codes

Deletes all the access codes for a particular location for a customer.

Use Access Codes to bypass the set permissions for all persons/workspaces at this location.

Deleting the access codes requires a full or user administrator or location administrator auth token with the spark-admin:telephony_config_write scope.

Parameters:

  • location_id (str) – Deletes all the access codes for this location.

  • org_id (str) – Deletes the access codes for a customer location.

Return type:

None

base = 'telephony/config/locations'