wxc_sdk.telephony.callqueue.dnis package

class wxc_sdk.telephony.callqueue.dnis.CallQueueDnisApi(*, session: RestSession, base: str = None)[source]

Bases: ApiChild

available_phone_numbers(location_id: str, phone_number: str = None, org_id: str = None, **params: Any) → Generator[AvailableNumber, None, None][source]

Get Available Phone Numbers for DNIS

Get the list of available phone numbers that can be assigned to a DNIS for call queues at a location.

Retrieving available numbers requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

location_id (str) – The location ID.
phone_number (str) – Filter by phone number.
org_id (str) – The organization ID of the customer.

Returns:

Generator yielding AvailableNumber instances

bulk_delete(location_id: str, queue_id: str, items: list[str], org_id: str = None) → None[source]

Bulk Delete DNIS for a Call Queue

Bulk delete a list of DNIS (Dialed Number Identification Service) entries for a call queue.

A maximum of 99 DNIS entries can be deleted in a single request.

Deleting DNIS entries requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

location_id (str) – The location ID where the call queue exists.
queue_id (str) – The call queue ID.
items (list[str]) – Array of DNIS IDs to be deleted.
org_id (str) – The organization ID of the customer.

Return type:

None

list(location_id: str, queue_id: str, org_id: str = None) → list[Dnis][source]

Get List of DNIS for a Call Queue

Get the list of DNIS (Dialed Number Identification Service) entries for a call queue.

DNIS allows call queues to distinguish between primary and alternate numbers when delivering calls to agents. Each DNIS entry can have its own name, phone number, extension, ring pattern, and custom announcement settings.

The maximum number of DNIS entries per call queue is 100.

Retrieving this list requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

location_id (str) – The location ID where the call queue exists.
queue_id (str) – The call queue ID.
org_id (str) – The organization ID of the customer.

Return type:

list[Dnis]

create(location_id: str, queue_id: str, name: str, ring_pattern: RingPattern, phone_number: str = None, extension: str = None, org_id: str = None) → str[source]

Create a DNIS for a Call Queue

Create a new DNIS (Dialed Number Identification Service) entry for a call queue.

DNIS allows call queues to distinguish between primary and alternate numbers when delivering calls to agents.

The maximum number of DNIS entries per call queue is 100. Either phoneNumber or extension is required.

Creating a DNIS requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

location_id (str) – The location ID where the call queue exists.
queue_id (str) – The call queue ID.
name (str) – Name of the DNIS. Must be unique across the call queue.
ring_pattern (RingPattern) – Ring pattern of the DNIS.
phone_number (str) – Phone number of the DNIS. Must be a valid phone number from the same location. Either phoneNumber or extension is required.
extension (str) – Extension of the DNIS. Either phoneNumber or extension is required.
org_id (str) – The organization ID of the customer.

Return type:

str

get_settings(location_id: str, queue_id: str, org_id: str = None) → DnisSettings[source]

Get DNIS Settings for a Call Queue

Get DNIS (Dialed Number Identification Service) settings for a call queue.

Retrieving DNIS settings requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

location_id (str) – The location ID where the call queue exists.
queue_id (str) – The call queue ID.
org_id (str) – The organization ID of the customer.

Return type:

DnisSettings

modify_settings(location_id: str, queue_id: str, settings: DnisSettings, org_id: str = None) → None[source]

Modify DNIS Settings for a Call Queue

Modify DNIS (Dialed Number Identification Service) settings for a call queue.

Modifying DNIS settings requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

location_id (str) – The location ID where the call queue exists.
queue_id (str) – The call queue ID.
settings (DnisSettings) – DNIS settings for this call queue.
org_id (str) – The organization ID of the customer.

Return type:

None

delete(location_id: str, queue_id: str, dnis_id: str, org_id: str = None) → None[source]

Delete a DNIS for a Call Queue

Delete a DNIS (Dialed Number Identification Service) entry for a call queue.

Deleting a DNIS requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

location_id (str) – The location ID where the call queue exists.
queue_id (str) – The call queue ID.
dnis_id (str) – The DNIS ID.
org_id (str) – The organization ID of the customer.

Return type:

None

details(location_id: str, queue_id: str, dnis_id: str, org_id: str = None) → Dnis[source]

Get a DNIS for a Call Queue

Get details of a specific DNIS (Dialed Number Identification Service) entry for a call queue.

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

Parameters:

location_id (str) – The location ID where the call queue exists.
queue_id (str) – The call queue ID.
dnis_id (str) – The DNIS ID.
org_id (str) – The organization ID of the customer.

Return type:

Dnis

modify(location_id: str, queue_id: str, dnis_id: str, settings: Dnis, org_id: str = None) → None[source]

Modify a DNIS for a Call Queue

Modify a DNIS (Dialed Number Identification Service) entry for a call queue.

To remove a phone number or extension from the DNIS, set the field to null.

Modifying a DNIS requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

location_id (str) – The location ID where the call queue exists.
queue_id (str) – The call queue ID.
dnis_id (str) – The DNIS ID.
settings (Dnis) – Settings for the DNIS.
org_id (str) – The organization ID of the customer.

Return type:

None

get_announcements(location_id: str, queue_id: str, dnis_id: str, org_id: str = None) → DnisAnnouncements[source]

Get DNIS Announcements for a Call Queue

Get the announcement settings for a specific DNIS (Dialed Number Identification Service) entry in a call queue.

This includes welcome message, comfort message, music on hold, wait message, and whisper message settings.

Retrieving DNIS announcements requires a full or read-only administrator auth token with a scope of spark-admin:telephony_config_read.

Parameters:

location_id (str) – The location ID where the call queue exists.
queue_id (str) – The call queue ID.
dnis_id (str) – The DNIS ID.
org_id (str) – The organization ID of the customer.

Return type:

DnisAnnouncements

modify_announcements(location_id: str, queue_id: str, dnis_id: str, settings: DnisAnnouncements, org_id: str = None) → None[source]

Modify DNIS Announcements for a Call Queue

Modify the announcement settings for a specific DNIS (Dialed Number Identification Service) entry in a call queue.

This includes welcome message, comfort message, music on hold, wait message, and whisper message settings.

Modifying DNIS announcements requires a full administrator auth token with a scope of spark-admin:telephony_config_write.

Parameters:

location_id (str) – The location ID where the call queue exists.
queue_id (str) – The call queue ID.
dnis_id (str) – The DNIS ID.
settings (DnisAnnouncements) – Announcement settings for the DNIS.
org_id (str) – The organization ID of the customer.

Return type:

None

base = 'telephony/config'

Bases: ApiModel

id: str | None: Unique identifier for the DNIS.

name: str | None: Name of the DNIS.

phone_number: str | None: Phone number of the DNIS.

extension: str | None: Extension of the DNIS.

routing_prefix: str | None: Routing prefix (location dialing code) of the DNIS.

esn: str | None: Enterprise Significant Number (ESN) of the DNIS.

ring_pattern: RingPattern | None: Ring pattern of the DNIS.

custom_dnis_announcement_settings_enabled: bool | None: Use custom announcement settings for the DNIS. Enable custom announcement settings using Modify DNIS API. Modify custom announcement settings using Modify DNIS announcements API.

class wxc_sdk.telephony.callqueue.dnis.DnisSettings(*, distinctiveRingingEnabled: bool | None = None, displayDnisNameAndNumberEnabled: bool | None = None, **extra_data: Any)[source]

Bases: ApiModel

distinctive_ringing_enabled: bool | None: Whether distinctive ringing is enabled for the queue.

display_dnis_name_and_number_enabled: bool | None: Whether the DNIS name and number is displayed to agents.

class wxc_sdk.telephony.callqueue.dnis.DnisAnnouncements(*, customDnisAnnouncementSettingsEnabled: bool | None = None, welcomeMessage: WelcomeMessageSetting | None = None, comfortMessage: ComfortMessageSetting | None = None, comfortMessageBypass: ComfortMessageBypass | None = None, mohMessage: MohMessageSetting | None = None, waitMessage: WaitMessageSetting | None = None, whisperMessage: AudioSource | None = None, **extra_data: Any)[source]

Bases: ApiModel

custom_dnis_announcement_settings_enabled: bool | None: Whether custom DNIS announcement settings are enabled for this DNIS.

welcome_message: WelcomeMessageSetting | None: Welcome message settings.

comfort_message: ComfortMessageSetting | None: Comfort message settings.

comfort_message_bypass: ComfortMessageBypass | None: Comfort message bypass settings.

moh_message: MohMessageSetting | None: Music on hold message settings.

wait_message: WaitMessageSetting | None: Wait message settings.

whisper_message: AudioSource | None: Whisper message settings.