ConversationPbxQueue.md

ConversationPbxQueue

Properties

Name	Type	Description	Notes
aiPriority	AiPriorityEnum	AI Agent Priority compared to human agents	[optional]
aiSummaryEnabled	Boolean	If true, AI summaries are generated for answered calls in this queue	[optional]
aiSummaryInstructions	String	Custom instructions injected into the AI summary system prompt for this queue	[optional]
aiTimeoutSeconds	Integer	AI timeout seconds	[optional]
announceQueuePosition	Boolean	If true, the customer is told their queue position upon entering the queue	[optional]
automaticCoachAgentUuid	String	AI Agent UUID to automatically engage to provide coaching	[optional]
callbackAnnounceAudioUuid	String	Custom audio file UUID for the callback offer prompt	[optional]
callbackAnnounceSay	String	Custom TTS text for the callback offer prompt	[optional]
callbackConfirmAudioUuid	String	Custom audio file UUID for the callback confirmation message	[optional]
callbackConfirmSay	String	Custom TTS text for the callback confirmation message	[optional]
callbackEnabled	Boolean	If true, the callback option is enabled for this queue	[optional]
callbackHoursOnly	Boolean	When true, only offer callbacks during business hours	[optional]
callbackMaxAttempts	Integer	Maximum number of times the system will attempt to call the customer back	[optional]
callbackMaxOffers	Integer	Maximum number of times the callback option is offered to a caller per call	[optional]
callbackMaxPending	Integer	Maximum number of pending callbacks allowed per queue	[optional]
callbackOfferAfterSeconds	Integer	Seconds a caller must wait in queue before the callback option is offered	[optional]
callbackOfferIntervalSeconds	Integer	Seconds between repeat callback offers to the same caller	[optional]
callbackRetryDelaySeconds	Integer	Delay in seconds between callback retry attempts	[optional]
contextMerchantId	String	Optional child merchant ID this resource is assigned to. Null = shared across the linked merchant group.	[optional]
conversationPbxQueueUuid	String	Conversation Pbx Queue unique identifier	[optional]
conversationVoicemailMailboxUuid	String	The voicemail mailbox associated with this queue	[optional]
holdConversationPbxAudioUuid	String	The audio to play while holding in a queue	[optional]
maxHoldSeconds	Integer	The maximum number of seconds for a customer to hold in a queue	[optional]
members	ConversationPbxQueueMembers		[optional]
merchantId	String	Merchant Id	[optional]
name	String	Name of queue	[optional]
noAgentAvailablePlayAudioUuid	String	When no agent is available after the max_hold_seconds, say this	[optional]
noAgentAvailableSay	String	When no agent is available after the max_hold_seconds, say this	[optional]
noAgentAvailableSayVoice	NoAgentAvailableSayVoiceEnum	The type of voice used to say text when no agent is available	[optional]
playAudioUuid	String	Audio played when customer enters a queue	[optional]
recordCall	Boolean	If true, any calls in this queue are recorded	[optional]
say	String	Say text when a customer enters queue	[optional]
sayVoice	SayVoiceEnum	The type of voice to use when say text is spoken	[optional]
twilioTaskrouterWorkflowSid	String	Twilio taskrouter workflow sid	[optional]
twilioWorkspaceQueueSid	String	Twilio workspace queue sid	[optional]
voicemail	Boolean	If true, this queue has a voicemail associated with it	[optional]
waitCriticalSeconds	Integer	Wait time in seconds before critical	[optional]
waitWarningSeconds	Integer	Wait time in seconds before warning	[optional]
wrapUpSeconds	Integer	Wrap up time in seconds	[optional]
zohoDeskDepartmentId	String	Zoho Desk department ID to create tickets in	[optional]
zohoDeskTicketEnabled	Boolean	If true, a Zoho Desk ticket is automatically created for answered calls in this queue	[optional]

Enum: AiPriorityEnum

Name	Value
NEUTRAL	"neutral"
FIRST	"first"
BACKUP	"backup"

Enum: NoAgentAvailableSayVoiceEnum

Name	Value
MAN	"man"
WOMAN	"woman"

Enum: SayVoiceEnum

Name	Value
MAN	"man"
WOMAN	"woman"