wxc_sdk.telephony.org_access_codes package

class wxc_sdk.telephony.org_access_codes.OrganisationAccessCodesApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

Viewing an organisation requires a full, user or read-only administrator auth token with a scope of `spark-admin:telephony_config_read.

list(code: list[str] = None, description: list[str] = None, org_id: str = None, **params) → Generator[AuthCode, None, None][source]

Retrieve the organisation’s access codes.

Access codes, also known as authorization codes, provide a mechanism to allow authorized users to enter a code to bypass outgoing or incoming calling permissions.

This API requires a full, user or read-only administrator auth token with a scope of spark-admin:telephony_config_read

Parameters:

  • code (list[str]) – Filter access code based on the comma-separated list provided in the code array.

  • description (list[str]) – Filter access code based on the comma-separated list provided in the description array.

  • org_id (str) – ID of the organisation. Only admin users of another organisation (such as partners) may use this parameter as the default is the same organisation as the token used to access the API.

Returns:

Generator yielding AuthCode instances

delete(delete_codes: list[str] = None, org_id: str = None)[source]

Delete Outgoing Permission Access Code for an Organisation

Deletes the access code details for a particular organisation and max limit is 10k per request.

Access codes, also known as authorization codes, provide a mechanism to allow authorized users to enter a code to bypass outgoing or incoming calling permissions.

This API requires a full or user administrator auth token with the spark-admin:telephony_config_write scope.

Parameters:

  • delete_codes (list[str]) – Indicates access codes to delete.

  • org_id (str) – ID of the organisation. Only admin users of another organisation (such as partners) may use this parameter as the default is the same organisation as the token used to access the API.

Return type:

None

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

Create Access Codes for an Organisation

Create new access codes for the organisation and max limit is 10k per request.

Access codes, also known as authorization codes, provide a mechanism to allow authorized users to enter a code to bypass outgoing or incoming calling permissions.

This API requires a full or user administrator auth token with the spark-admin:telephony_config_write scope.

Parameters:

  • access_codes (list[AuthCode]) – Indicates the set of activation codes and description.

  • org_id (str) – ID of the organisation. Only admin users of another organisation (such as partners) may use this parameter as the default is the same organisation as the token used to access the API.

Return type:

None

base = 'telephony/config/outgoingPermission/accessCodes'