wxc_sdk.telephony.ai_receptionists package

class wxc_sdk.telephony.ai_receptionists.AIReceptionistApi(*, session: RestSession, base: str = None)

Bases: ApiChild

AI Receptionist

AI Receptionist for Webex Calling allows administrators to configure and manage AI-powered receptionists that handle incoming calls. This includes validating countries and AI receptionist names, listing available phone numbers, managing templates, and retrieving intents.

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

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

A partner administrator can retrieve or change settings in another organization using the optional orgId query parameter.

sessions(ai_receptionist_id: str, interaction_id: str = None, limit: int = None, offset: int = None) → AIRSessions

List AI Receptionist Sessions

List the AI Receptionist sessions for the given aiReceptionistId.

A session represents a single conversation between a caller and the AI Receptionist. You can optionally filter sessions by interaction_id (which corresponds to the call correlation ID retrievable from the Webex Control Hub troubleshooting page) to locate the session associated with a specific call.

This API requires a full administrator auth token with a CI role of id_full_admin.

Parameters:

• ai_receptionist_id (str) – Unique identifier of the AI Receptionist. AI Receptionist ID from the response of List AI Receptionists API.

• interaction_id (str) – Filter sessions by the call correlation ID retrieved from Webex Control Hub troubleshooting page.

• limit (int) – Maximum number of sessions to return in a single page. Must be between 1 and 100.

• offset (int) – Pagination offset. Starting index of the result set.

Return type:

AIRSessions

session_transcripts(ai_receptionist_id: str, session_id: str, limit: int = None, offset: int = None) → TranscriptsResponse

Get AI Receptionist Session Transcripts

Retrieve the transcript (messages exchanged between the caller and the AI Receptionist) for a specific session.

Each message represents a single utterance, identified by user_type (human or bot). For bot messages, the message is an array of text objects; for human messages, it is a plain string. Additional metadata may include tool invocations, knowledge-base lookups, and latency information useful for debugging.

This API requires a full administrator auth token with a CI role of id_full_admin.

Parameters:

• ai_receptionist_id (str) – Unique identifier of the AI Receptionist. AI Receptionist ID from the response of List AI Receptionists API.

• session_id (str) – Identifier of the session returned by the List AI Receptionist Sessions API.

• limit (int) – Maximum number of messages to return in a single page. Must be between 1 and 1000.

• offset (int) – Pagination offset. Starting index of the result set.

Return type:

TranscriptsResponse

list(location_id: str = None, name: str = None, phone_number: str = None, org_id: str = None, **params: Any) → Generator[AiReceptionist, None, None]

List AI Receptionists

Get list of AI Receptionists.

AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services. These APIs let administrators manage AI receptionist resources across organizations and locations.

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

Parameters:

• location_id (str) – Location identifier. If not specified, returns AI receptionists from all locations.

• name (str) – Search AI receptionists by name (contains match).

• phone_number (str) – Search (Contains) based on number or extension. Search cannot be performed based on esn.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Returns:

Generator yielding AiReceptionist instances

validate_country(country_code: str, location_id: str = None, org_id: str = None) → None

Validate Country for AI Receptionist

Validates if country passed in the request supports AI Receptionist.

AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls.

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

Parameters:

• country_code (str) – Two letter country code of the location for which AI Receptionist needs to be validated.

• location_id (str) – Location associated with the AI Receptionist.

• org_id (str) – Optional; target organization ID, otherwise defaults to token’s org.

Return type:

None

templates(org_id: str = None) → list[IdAndName]

List AI Receptionist Templates

Get AI Receptionist template list.

AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Templates help standardize greetings, goals, and guidelines.

Returns all templates in a single response.

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

Parameters:

org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

list[AiReceptionistLocation]

get_template(template_id: str, org_id: str = None) → AIRTemplate

Get AI Receptionist template details.

AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Use templates to define goals, messages, and guidelines.

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

Parameters:

• template_id (str) – Template Id.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

AIRTemplate

knowledge_bases(name: str = None, org_id: str = None, **params: Any) → Generator[KnowledgeBase, None, None]

List Knowledge Bases

Get list of Knowledge Bases for an organization.

Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries. This API returns all knowledge bases available in the organization.

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

Parameters:

• name (str) – Search knowledge bases by name (contains match).

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Returns:

Generator yielding KnowledgeBaseSummary instances

create_knowledge_base(name: str, description: str = None, org_id: str = None) → str

Create a Knowledge Base

Create a new Knowledge Base for an organization.

Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries.

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

Parameters:

• name (str) – The display name assigned to the Knowledge Base. Used to identify the KB across the platform.

• description (str) – A human-readable description providing additional context about the purpose or contents of the Knowledge Base.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

str

delete_knowledge_base(knowledge_base_id: str, org_id: str = None) → None

Delete a Knowledge Base.

Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries.

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

Parameters:

• knowledge_base_id (str) – Unique identifier for the Knowledge Base.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

None

get_knowledge_base(knowledge_base_id: str, org_id: str = None) → KnowledgeBase

Get Knowledge Base Details

Get details of a specific Knowledge Base.

Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries.

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

Parameters:

• knowledge_base_id (str) – Unique identifier for the Knowledge Base.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

KnowledgeBase

update_knowledge_base(knowledge_base_id: str, name: str = None, description: str = None, org_id: str = None) → None

Modify a Knowledge Base

Modify an existing Knowledge Base.

Knowledge Bases are repositories of information that AI Receptionists use to answer caller queries.

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

Parameters:

• knowledge_base_id (str) – Unique identifier for the Knowledge Base.

• name (str) – The display name assigned to the Knowledge Base. Used to identify the KB across the platform.

• description (str) – A human-readable description providing additional context about the purpose or contents of the Knowledge Base.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

None

list_knowledge_base_documents(knowledge_base_id: str, org_id: str = None, **params: Any) → Generator[KnowledgeBaseDocumentDetails, None, None]

List Knowledge Base Documents

Get list of documents in a Knowledge Base.

Documents are files uploaded to a Knowledge Base that AI Receptionists use to answer caller queries.

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

Parameters:

• knowledge_base_id (str) – Unique identifier for the Knowledge Base.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Returns:

Generator yielding KnowledgeBaseDocumentDetails instances

create_knowledge_base_document(knowledge_base_id: str, name: str, content: str, org_id: str = None) → str

Create Knowledge Base Document

Create a new document in a Knowledge Base.

Documents are content entries in a Knowledge Base that AI Receptionists use to answer caller queries. This API creates a document with specified name and content.

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

Parameters:

• knowledge_base_id (str) – Unique identifier for the Knowledge Base.

• name (str) – The display name assigned to the Knowledge Base document. Used to identify the document across the platform.

• content (str) – The content of the document.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

str

upload_knowledge_base_document(knowledge_base_id: str, file: str, org_id: str = None) → str

Upload Knowledge Base Document

Upload a document to a Knowledge Base.

Documents are files uploaded to a Knowledge Base that AI Receptionists use to answer caller queries. Supported file types include PDF, TXT, DOCX, XLSX, XLS, and CSV.

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

Parameters:

• knowledge_base_id (str) – Unique identifier for the Knowledge Base.

• file (str) – The document file to upload. Supported file types: PDF, TXT, DOCX, XLSX, XLS, CSV. Maximum file size: 10MB.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

str

delete_knowledge_base_document(knowledge_base_id: str, document_id: str, org_id: str = None) → None

Delete Knowledge Base Document

Delete a document from a Knowledge Base.

Documents are files uploaded to a Knowledge Base that AI Receptionists use to answer caller queries.

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

Parameters:

• knowledge_base_id (str) – Unique identifier for the Knowledge Base.

• document_id (str) – Unique identifier for the document.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

None

get_knowledge_base_document(knowledge_base_id: str, document_id: str, org_id: str = None) → KnowledgeBaseDocumentDetails

Get Knowledge Base Document Details

Get details of a specific document in a Knowledge Base.

Documents are content entries in a Knowledge Base that AI Receptionists use to answer caller queries. This API returns document metadata including name, content, status, and timestamps.

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

Parameters:

• knowledge_base_id (str) – Unique identifier for the Knowledge Base.

• document_id (str) – Unique identifier for the document.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

KnowledgeBaseDocumentDetails

update_knowledge_base_document(knowledge_base_id: str, document_id: str, name: str = None, content: str = None, org_id: str = None) → None

Modify Knowledge Base Document

Modify a document in a Knowledge Base.

Documents are content entries in a Knowledge Base that AI Receptionists use to answer caller queries. This API allows updating the name and content of an existing document.

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

Parameters:

• knowledge_base_id (str) – Unique identifier for the Knowledge Base.

• document_id (str) – Unique identifier for the document.

• name (str) – The display name assigned to the Knowledge Base document. Used to identify the document across the platform.

• content (str) – The content of the document.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

None

download_knowledge_base_document(knowledge_base_id: str, document_id: str, org_id: str = None) → str

Download Knowledge Base Document

Download a document from a Knowledge Base.

Documents are files uploaded to a Knowledge Base that AI Receptionists use to answer caller queries. The response contains the file content with appropriate Content-Type and Content-Disposition headers.

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

WARNING: This API is not callable using the developer portal web interface due to the lack of support for binary file downloads. This API can be utilized using other tools that support binary responses, such as Postman or curl.

Parameters:

• knowledge_base_id (str) – Unique identifier for the Knowledge Base.

• document_id (str) – Unique identifier for the document.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

str

create(location_id: str, name: str, enabled: bool, default_action: DefaultAction, ai_agent: AiAgent, phone_number: str = None, extension: str = None, direct_line_caller_id_name: AIRDirectLineCallerIdName = None, dial_by_name: str = None, org_id: str = None) → str

Create an AI Receptionist

Create a new AI Receptionist for a location.

AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services.

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

Parameters:

• location_id (str) – Location ID.

• name (str) – Name of the AI Receptionist. This has to be unique across location.

• enabled (bool) – Flag to indicate AI receptionist is enabled or not. When disabled, incoming calls to this AI receptionist will not be answered.

• default_action (DefaultAction) – Default action configuration for the AI Receptionist

• ai_agent (AiAgent) – AI Agent configuration

• phone_number (str) – Phone number of the AI Receptionist. Either phoneNumber or extension is mandatory. At least one is required.

• extension (str) – Extension of the AI Receptionist. Either phoneNumber or extension is mandatory. At least one is required.

• direct_line_caller_id_name (AIRDirectLineCallerIdName) – Direct line caller ID name configuration

• dial_by_name (str) – A dial by name used for AI Receptionist name dialing. Characters of %, +, `, `” and Unicode characters are not allowed.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

str

validate(location_id: str, name: str, org_id: str = None) → None

Validate AI Receptionist

Validates AI Receptionist name at location level and max limit at org level.

AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls.

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

Parameters:

• location_id (str) – Location ID.

• name (str) – Name of the AI Receptionist.

• org_id (str) – Optional target organization identifier, defaults to the token’s org if not provided.

Return type:

None

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

List Available Numbers for AI Receptionist

List and search numbers that can be assigned as AI Receptionist number.

AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Numbers listed here can be assigned to an AI receptionist at a location.

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

Parameters:

• location_id (str) – Location ID.

• phone_number (str) – Search (Contains) based on number or extension. Search cannot be performed based on esn.

• org_id (str) – Optional target organization identifier. Defaults to the token’s org Id if not provided.

Returns:

Generator yielding AvailableNumber instances

voices(location_id: str, org_id: str = None) → list[AiEngine]

Get AI Receptionist Voices

Get list of available AI Receptionist voices.

AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. This API returns the available voice options that can be configured for an AI Receptionist. The response returns all available engines and voices; no pagination is required.

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

Parameters:

• location_id (str) – Location ID.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

list[AiEngine]

delete(location_id: str, ai_receptionist_id: str, org_id: str = None) → None

Delete an AI Receptionist.

AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services.

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

Parameters:

• location_id (str) – Location ID.

• ai_receptionist_id (str) – Unique identifier for the AI Receptionist.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

None

details(location_id: str, ai_receptionist_id: str, org_id: str = None) → AiReceptionist

Get AI Receptionist details.

AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services.

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

Parameters:

• location_id (str) – Location ID.

• ai_receptionist_id (str) – Unique identifier for the AI Receptionist.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

AiReceptionist

update(location_id: str, ai_receptionist_id: str, settings=<class 'wxc_sdk.telephony.ai_receptionists.AiReceptionist'>, org_id: str = None) → None

Update an AI Receptionist.

AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls to people or services.

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

Parameters:

• location_id (str) – Location ID.

• ai_receptionist_id (str) – Unique identifier for the AI Receptionist.

• settings (AiReceptionist) – settings for AI Receptionist

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

None

intents(location_id: str, ai_receptionist_id: str, org_id: str = None) → list[AIRIntent]

List AI Receptionist Intents

Get list of AI Receptionist Intents.

AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent call-handling behaviors such as transfers.

Returns all intents in a single response.

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

Parameters:

• location_id (str) – Location ID.

• ai_receptionist_id (str) – Unique identifier for the AI Receptionist.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

list[AIRIntent]

create_intent(location_id: str, ai_receptionist_id: str, name: str, description: str, transfer_to: TransferTo, org_id: str = None) → str

Create AI Receptionist Intent

Create a new AI Receptionist Intent.

AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent call-handling behaviors such as transfers.

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

Parameters:

• location_id (str) – Location ID.

• ai_receptionist_id (str) – Unique identifier for the AI Receptionist.

• name (str) – Name of the intent.

• description (str) – Description of the intent (Action).

• transfer_to (TransferTo)

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

str

delete_intent(location_id: str, ai_receptionist_id: str, intent_id: str, org_id: str = None) → None

Delete AI Receptionist Intent

Delete an AI Receptionist Intent.

AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent call-handling behaviors such as transfers.

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

Parameters:

• location_id (str) – Location ID.

• ai_receptionist_id (str) – Unique identifier for the AI Receptionist.

• intent_id (str) – Unique identifier for a specific AI Receptionist intent within a given location and AI Receptionist instance.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

None

get_intent(location_id: str, ai_receptionist_id: str, intent_id: str, org_id: str = None) → AIRIntent

Get AI Receptionist Intent

Get details of a specific AI Receptionist Intent.

AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent call-handling behaviors such as transfers.

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

Parameters:

• location_id (str) – Location ID.

• ai_receptionist_id (str) – Unique identifier for the AI Receptionist.

• intent_id (str) – Unique identifier for a specific AI Receptionist intent within a given location and AI Receptionist instance.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

AIRIntent

modify_intent(location_id: str, ai_receptionist_id: str, intent_id: str, settings: AIRIntent, org_id: str = None) → None

Modify AI Receptionist Intent

Modify an existing AI Receptionist Intent.

AI Receptionist is a Webex Calling feature that uses AI to greet callers and intelligently route calls. Intents represent call-handling behaviors such as transfers.

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

Parameters:

• location_id (str) – Location ID.

• ai_receptionist_id (str) – Unique identifier for the AI Receptionist.

• intent_id (str) – Unique identifier for a specific AI Receptionist intent within a given location and AI Receptionist instance.

• settings (AIRIntent) – Settings for this AIRIntent.

• org_id (str) – Optional target organization identifier. Defaults to token’s organization if not provided.

Return type:

None

base = ''

class wxc_sdk.telephony.ai_receptionists.AiAgent(*, agentId: str | None = None, voice: AiVoice | None = None, knowledgeBaseId: str | None = None, guidelines: AiGuidelines | None = None, **extra_data: Any)

Bases: ApiModel

agent_id: str | None

AI Agent ID from Webex AI Agent Studio

voice: AiVoice | None

Voice configuration for the AI Agent

knowledge_base_id: str | None

Unique identifier for the Knowledge Base used by the AI Agent to answer caller queries.

guidelines: AiGuidelines | None

AI Agent guidelines

class wxc_sdk.telephony.ai_receptionists.AiEngine(*, name: AiEngineName | None = None, voices: list[Voice] | None = None, **extra_data: Any)

Bases: ApiModel

name: AiEngineName | None

AI engine name. - PRO — Available in all supported countries. - PRO_US — Available in the United States only.

voices: list[Voice] | None

List of available voices for this AI engine.

class wxc_sdk.telephony.ai_receptionists.AiEngineName(*values)

Bases: str, SafeEnum

An enumeration.

pro = 'PRO'

pro_us = 'PRO_US'

class wxc_sdk.telephony.ai_receptionists.AiReceptionist(*, id: str | None = None, name: str | None = None, phoneNumber: str | None = None, extension: str | None = None, routingPrefix: str | None = None, esn: str | None = None, location: IdAndName | None = None, enabled: bool | None = None, alternateNumbers: list[AlternateNumber] | None = None, directLineCallerIdName: AIRDirectLineCallerIdName | None = None, dialByName: str | None = None, defaultAction: DefaultAction | None = None, aiAgent: AiAgent | None = None, intentCount: int | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier for the AI receptionist.

name: str | None

Name of the AI receptionist. Must be unique within a location.

phone_number: str | None

Phone number of the AI receptionist in E.164 format.

extension: str | None

Extension of the AI Receptionist.

routing_prefix: str | None

Routing prefix of location.

esn: str | None

Routing prefix + extension of the AI Receptionist. If the location has no routing prefix, this will only be the extension. If the AI Receptionist has no extension, this field will not be present.

location: IdAndName | None

Location of the AI Receptionist.

enabled: bool | None

Flag to indicate AI receptionist is enabled or not. When disabled, incoming calls to this AI receptionist will not be answered.

alternate_numbers: list[AlternateNumber] | None

List of alternate phone numbers assigned to the AI Receptionist.

direct_line_caller_id_name: AIRDirectLineCallerIdName | None

Direct line caller ID name configuration

dial_by_name: str | None

A dial by name used for AI Receptionist name dialing. Characters of %, +, `, `” and Unicode characters are not allowed.

default_action: DefaultAction | None

Default action configuration for the AI Receptionist

ai_agent: AiAgent | None

AI Agent configuration

intent_count: int | None

Number of intents configured for this AI Receptionist

class wxc_sdk.telephony.ai_receptionists.AIRIntent(*, id: str | None = None, name: str | None = None, description: str | None = None, transferTo: IntentTransferTo | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier of the intent.

name: str | None

Name of the intent.

description: str | None

Description of the intent (Action).

transfer_to: IntentTransferTo | None

Transfer destination for the intent.

class wxc_sdk.telephony.ai_receptionists.AIRTemplate(*, id: str | None = None, name: str | None = None, goal: str | None = None, welcomeMessage: str | None = None, guideline: str | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier for the AI receptionist template.

name: str | None

Name of the AI Receptionist template.

goal: str | None

Goal of the AI Receptionist.

welcome_message: str | None

Welcome message to be played before the call handling.

guideline: str | None

Guidelines for the AI receptionist to follow. This includes information like identity, role definition, context, behavior, etc.

class wxc_sdk.telephony.ai_receptionists.DefaultAction(*, actionType: DefaultActionType | None = None, audioMessageSelection: Greeting | None = None, audioFile: AnnAudioFile | None = None, transferToNumber: str | None = None, transferTo: TransferTo | None = None, **extra_data: Any)

Bases: ApiModel

action_type: DefaultActionType | None

Default action to be performed when a call is received:

• PLAY_MESSAGE_AND_DISCONNECT - Play an audio message and disconnect the call.

• TRANSFER_TO_OPERATOR - Transfer the call to an operator.

audio_message_selection: Greeting | None

Announcement type to be played. Mandatory if actionType is PLAY_MESSAGE_AND_DISCONNECT:

• DEFAULT - Use the system default audio message.

• CUSTOM - Use a custom uploaded audio file.

audio_file: AnnAudioFile | None

Audio file details. Mandatory if audioMessageSelection is CUSTOM.

transfer_to_number: str | None

Transfer to number. Mandatory if actionType is TRANSFER_TO_OPERATOR.

transfer_to: TransferTo | None

Transfer target configuration. Alternative to transferToNumber

class wxc_sdk.telephony.ai_receptionists.AIRDirectLineCallerIdName(*, directLineCallerIdNameSelection: DirectLineCallerIdNameSelection | None = None, customName: str | None = None, **extra_data: Any)

Bases: ApiModel

direct_line_caller_id_name_selection: DirectLineCallerIdNameSelection | None

Field to indicate the option chosen to represent the Caller ID:

• DISPLAY_NAME - Use the AI Receptionist display name as the caller ID.

• CUSTOM_NAME - Use a custom name as the caller ID.

custom_name: str | None

Carries the customized name when “CUSTOM_NAME” is the chosen option. It can be empty if it’s not configured.

class wxc_sdk.telephony.ai_receptionists.IntentTransferTo(*, contactType: TransferToContactType | None = None, contactId: str | None = None, name: str | None = None, phoneNumber: str | None = None, **extra_data: Any)

Bases: ApiModel

contact_type: TransferToContactType | None

Type of transfer destination. - PEOPLE - A person in the organization. - RESOURCE_GROUP - A group resource such as a call queue or hunt group. - CONTACT - An organization contact. - PHONE_NUMBER - A raw phone number or extension.

contact_id: str | None

Unique identifier for the transfer destination, encoded using the resource type indicated by contactType (PEOPLE, RESOURCE_GROUP, or CONTACT). Not required when contactType is PHONE_NUMBER.

name: str | None

Name of the calling service or contact.

phone_number: str | None

Phone number of calling service or contact.

class wxc_sdk.telephony.ai_receptionists.TransferToContactType(*values)

Bases: str, SafeEnum

An enumeration.

people = 'PEOPLE'

resource_group = 'RESOURCE_GROUP'

contact = 'CONTACT'

phone_number = 'PHONE_NUMBER'

class wxc_sdk.telephony.ai_receptionists.TransferTo(*, contactType: TransferToContactType | None = None, contactId: str | None = None, phoneNumber: str | None = None, **extra_data: Any)

Bases: ApiModel

contact_type: TransferToContactType | None

Contact type. - PEOPLE - A person in the organization. - RESOURCE_GROUP - A group resource such as a call queue or hunt group. - CONTACT - An organization contact. - PHONE_NUMBER - A raw phone number or extension.

contact_id: str | None

Unique identifier for the transfer destination, encoded using the resource type indicated by contactType (PEOPLE, RESOURCE_GROUP, or CONTACT). Not required when contactType is PHONE_NUMBER.

phone_number: str | None

Phone number for intent transfer.

class wxc_sdk.telephony.ai_receptionists.KnowledgeBaseDocument(*, id: str | None = None, name: str | None = None, score: int | None = None, text: str | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier of the knowledge base document.

name: str | None

Name or filename of the knowledge base document.

score: int | None

Relevance score of the document.

text: str | None

Extracted text content from the document.

class wxc_sdk.telephony.ai_receptionists.KnowledgeBaseDocumentDetails(*, id: str | None = None, knowledgeBaseId: str | None = None, name: str | None = None, content: str | None = None, description: str | None = None, fileName: str | None = None, fileSize: int | None = None, knowledgeType: KnowledgeBaseDocumentKnowledgeType | None = None, status: KnowledgeBaseDocumentStatus | None = None, createdAt: datetime | None = None, updatedAt: datetime | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier for the document.

knowledge_base_id: str | None

Unique identifier for the Knowledge Base this document belongs to.

name: str | None

Name of the document.

content: str | None

Content of the document.

description: str | None

Description of the document.

file_name: str | None

Original file name if the document was uploaded as a file.

file_size: int | None

Size of the document in bytes.

knowledge_type: KnowledgeBaseDocumentKnowledgeType | None

Type of knowledge content. - article - Text-based content created directly via API. - file - Content uploaded as a document file.

status: KnowledgeBaseDocumentStatus | None

Processing status of the document. - pending - Document is waiting to be processed. - processing - Document is currently being indexed. - success - Document has been successfully indexed and is available for queries. - failed - Document processing failed.

created_at: datetime | None

Timestamp indicating when the document was created, in ISO 8601 format.

updated_at: datetime | None

Timestamp indicating when the document was last modified, in ISO 8601 format.

class wxc_sdk.telephony.ai_receptionists.KnowledgeBaseDocumentKnowledgeType(*values)

Bases: str, SafeEnum

An enumeration.

article = 'ARTICLE'

file = 'FILE'

class wxc_sdk.telephony.ai_receptionists.KnowledgeBaseDocumentStatus(*values)

Bases: str, SafeEnum

An enumeration.

pending = 'pending'

processing = 'processing'

success = 'success'

failed = 'failed'

class wxc_sdk.telephony.ai_receptionists.KnowledgeBaseMappedBot(*, id: str | None = None, connectedAt: datetime | None = None, agentId: str | None = None, name: str | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier for the AI Receptionist.

connected_at: datetime | None

Timestamp indicating when the Knowledge Base was associated with the AI Receptionist, in ISO 8601 format.

agent_id: str | None

Unique identifier for the AI agent associated with this receptionist.

name: str | None

Name of the AI Receptionist (Bot).

class wxc_sdk.telephony.ai_receptionists.KnowledgeBase(*, id: str | None = None, name: str | None = None, description: str | None = None, documentsCount: int | None = None, filesCount: int | None = None, filesSize: int | None = None, createdAt: datetime | None = None, updatedAt: datetime | None = None, mappedBots: list[KnowledgeBaseMappedBot] | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier of the Knowledge Base.

name: str | None

The display name assigned to the Knowledge Base. Used to identify the KB across the platform.

description: str | None

A human-readable description providing additional context about the purpose or contents of the Knowledge Base.

documents_count: int | None

The total count of documents that have been uploaded or indexed into the Knowledge Base.

files_count: int | None

The total count of files that have been uploaded to the Knowledge Base.

files_size: int | None

The cumulative size (in bytes) of all files stored in the Knowledge Base.

created_at: datetime | None

Timestamp indicating when the Knowledge Base was originally created, in ISO 8601 format.

updated_at: datetime | None

Timestamp indicating when the Knowledge Base was last modified, in ISO 8601 format.

mapped_bots: list[KnowledgeBaseMappedBot] | None

List of AI Receptionists that are currently associated with this Knowledge Base.

class wxc_sdk.telephony.ai_receptionists.MessageMetadata(*, ai_name: str | None = None, ai_version: str | None = None, chat_message_id: str | None = None, engine_identifier: str | None = None, language: str | None = None, latency: int | None = None, parameters: dict[str, Any] | None = None, size: int | None = None, tools: list[ToolInvocation] | None = None, **extra_data: Any)

Bases: ApiModel

ai_name: str | None

Name of the AI engine used.

ai_version: str | None

Version of the AI engine.

chat_message_id: str | None

Unique identifier of the chat message.

engine_identifier: str | None

Identifier of the AI engine.

language: str | None

Language code of the message (e.g., en-US, en-GB).

latency: int | None

Response latency in milliseconds.

parameters: dict[str, Any] | None

Additional parameters associated with the message.

size: int | None

Size of the message in characters.

tools: list[ToolInvocation] | None

List of tools invoked while processing this message.

class wxc_sdk.telephony.ai_receptionists.MessageText(*, text: str | None = None, **extra_data: Any)

Bases: ApiModel

text: str | None

Utterance text.

class wxc_sdk.telephony.ai_receptionists.AIRSessionsMeta(*, limit: int | None = None, offset: int | None = None, total_count: int | None = None, next: str | None = None, previous: str | None = None, **extra_data: Any)

Bases: ApiModel

limit: int | None

Maximum number of items returned per page.

offset: int | None

Zero-based index of the first item in the current page.

total_count: int | None

Total number of items available across all pages.

next: str | None

URL to the next page of results, or null if this is the last page.

previous: str | None

URL to the previous page of results, or null if this is the first page.

class wxc_sdk.telephony.ai_receptionists.SessionObject(*, id: str | None = None, interaction_id: str | None = None, state: AIRSessionState | None = None, created_at: int | None = None, updated_at: int | None = None, is_test: bool | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique session identifier. Use as sessionId in the transcripts API.

interaction_id: str | None

Unique call identifier (This is same as call correlation ID in Control Hub troubleshooting).

state: AIRSessionState | None

State of the session.

created_at: int | None

Creation timestamp in epoch milliseconds.

updated_at: int | None

Last-updated timestamp in epoch milliseconds.

is_test: bool | None

Indicates a test invocation. Always false for AI Receptionist.

class wxc_sdk.telephony.ai_receptionists.AIRSessionState(*values)

Bases: str, SafeEnum

An enumeration.

open = 'open'

closed = 'closed'

class wxc_sdk.telephony.ai_receptionists.AIRSessions(*, meta: AIRSessionsMeta | None = None, objects: list[SessionObject] | None = None, transaction_id: str | None = None, **extra_data: Any)

Bases: ApiModel

meta: AIRSessionsMeta | None

Pagination metadata for the response.

objects: list[SessionObject] | None

List of session objects.

transaction_id: str | None

Unique identifier for this API transaction.

class wxc_sdk.telephony.ai_receptionists.ToolInvocation(*, tool_id: str | None = None, tool_name: str | None = None, type: str | None = None, capability: str | None = None, description: str | None = None, state: str | None = None, latency: int | None = None, size: int | None = None, input: dict[str, Any] | None = None, kb_id: str | None = None, kb_name: str | None = None, kb_docs: list[KnowledgeBaseDocument] | None = None, output: dict[str, Any] | None = None, classification: list[dict[str, Any]] | None = None, slots: list[dict[str, Any]] | None = None, requestId: str | None = None, transaction_id: str | None = None, **extra_data: Any)

Bases: ApiModel

tool_id: str | None

Unique identifier of the tool.

tool_name: str | None

Display name of the tool.

type: str | None

Type of the tool response (e.g., tool_execution_response).

capability: str | None

Capability type of the tool (e.g., custom_transfer).

description: str | None

Human-readable description of the tool’s purpose.

state: str | None

Execution state of the tool invocation (e.g., SUCCESS).

latency: int | None

Time in milliseconds taken to execute the tool.

size: int | None

Size of the tool response in bytes.

input: dict[str, Any] | None

Input parameters passed to the tool.

kb_id: str | None

Unique identifier of the knowledge base used.

kb_name: str | None

Name of the knowledge base used.

kb_docs: list[KnowledgeBaseDocument] | None

Knowledge base documents retrieved during tool execution.

output: dict[str, Any] | None

Output returned by the tool.

classification: list[dict[str, Any]] | None

Classification results from the tool.

slots: list[dict[str, Any]] | None

Slot values collected during tool execution.

request_id: str | None

Request identifier for the tool invocation.

transaction_id: str | None

Transaction identifier for the tool invocation.

class wxc_sdk.telephony.ai_receptionists.TranscriptObject(*, id: str | None = None, transaction_id: str | None = None, user_type: TranscriptObjectUserType | None = None, message: str | list[MessageText] | None = None, metadata: MessageMetadata | None = None, error: bool | None = None, created_at: int | None = None, updated_at: int | None = None, **extra_data: Any)

Bases: ApiModel

id: str | None

Unique identifier of the transcript message.

transaction_id: str | None

Transaction identifier grouping related messages.

user_type: TranscriptObjectUserType | None

Indicates whether the message is from the caller (human) or the AI Receptionist (bot).

message: str | list[MessageText] | None

Message content. For human messages this is a string; for bot messages it is an array of text objects.

metadata: MessageMetadata | None

Additional metadata for the message.

error: bool | None

Indicates whether an error occurred while processing this message.

created_at: int | None

Creation timestamp in epoch milliseconds.

updated_at: int | None

Last-updated timestamp in epoch milliseconds.

class wxc_sdk.telephony.ai_receptionists.TranscriptObjectUserType(*values)

Bases: str, SafeEnum

An enumeration.

human = 'human'

bot = 'bot'

class wxc_sdk.telephony.ai_receptionists.TranscriptsResponse(*, meta: AIRSessionsMeta | None = None, objects: list[TranscriptObject] | None = None, transaction_id: str | None = None, **extra_data: Any)

Bases: ApiModel

meta: AIRSessionsMeta | None

Pagination metadata for the response.

objects: list[TranscriptObject] | None

List of transcript message objects.

transaction_id: str | None

Unique identifier for this API transaction.

class wxc_sdk.telephony.ai_receptionists.AiGuidelines(*, goal: str | None = None, welcomeMessage: str | None = None, guideline: str | None = None, **extra_data: Any)

Bases: ApiModel

goal: str | None

Goal of the AI Receptionist. The combined length of goal and guideline must not exceed 5096 characters.

welcome_message: str | None

Welcome message to be played before the call handling.

guideline: str | None

Guidelines to AI Receptionist to follow. This includes information like Identity, role definition, context, behavior etc.. The combined length of goal and guideline must not exceed 5096 characters.

class wxc_sdk.telephony.ai_receptionists.AiVoice(*, aiEngine: AiEngineName | None = None, displayName: str | None = None, language: str | None = None, languageCode: str | None = None, **extra_data: Any)

Bases: ApiModel

ai_engine: AiEngineName | None

AI engine name.

• PRO — Available in all supported countries.

• PRO_US — Available in the United States only.

display_name: str | None

Display name of the AI Receptionist voice.

language: str | None

Voice language name

language_code: str | None

Voice language locale in BCP 47 format

class wxc_sdk.telephony.ai_receptionists.DefaultActionType(*values)

Bases: str, SafeEnum

An enumeration.

play_message_and_disconnect = 'PLAY_MESSAGE_AND_DISCONNECT'

transfer_to_operator = 'TRANSFER_TO_OPERATOR'

class wxc_sdk.telephony.ai_receptionists.Voice(*, language: str | None = None, languageCode: str | None = None, displayName: str | None = None, isDefault: bool | None = None, gender: VoiceGender | None = None, **extra_data: Any)

Bases: ApiModel

language: str | None

Voice language.

language_code: str | None

Voice locale code.

display_name: str | None

Voice display name.

is_default: bool | None

Field to indicate default voice.

gender: VoiceGender | None

Voice gender. - MALE — Male voice. - FEMALE — Female voice.

class wxc_sdk.telephony.ai_receptionists.VoiceGender(*values)

Bases: str, SafeEnum

An enumeration.

male = 'MALE'

female = 'FEMALE'