BetaVoiceAgentsTelephonyOperations interface

Package:

@azure/ai-projects

Operations for managing voice agent telephony.

Properties

cancelCallJob	Requests cancellation of a durable outbound call job. A connected call is allowed to finish.
createBinding	Creates a telephony binding for the voice agent named in the path.
createCallJob	Creates one durable direct outbound call job. The latest agent definition is resolved when each attempt executes.
deleteBinding	Deletes a telephony binding owned by the voice agent named in the path.
endCall	Ends an active inbound call owned by the voice agent named in the path.
getBinding	Retrieves a telephony binding owned by the voice agent named in the path.
getCall	Retrieves a durable inbound call record owned by the voice agent named in the path.
getCallJob	Retrieves a durable direct or campaign-created outbound call job.
getTransferTargets	Returns all transfer targets configured for the voice agent named in the path.
listBindings	Returns the telephony bindings owned by the voice agent named in the path.
listCalls	Returns the durable inbound call history for the voice agent named in the path.
replaceTransferTargets	Replaces all transfer targets configured for the voice agent named in the path.
transferCall	Transfers an active inbound call to a configured target for the voice agent named in the path.
updateBinding	Updates a telephony binding owned by the voice agent named in the path.

Property Details

cancelCallJob

Requests cancellation of a durable outbound call job. A connected call is allowed to finish.

cancelCallJob: (agentName: string, callJobId: string, ifMatch: string, options?: BetaVoiceAgentsTelephonyCancelCallJobOptionalParams) => Promise<TelephonyCallJob>

Property Value

(agentName: string, callJobId: string, ifMatch: string, options?: BetaVoiceAgentsTelephonyCancelCallJobOptionalParams) => Promise<TelephonyCallJob>

createBinding

Creates a telephony binding for the voice agent named in the path.

createBinding: (agentName: string, telephonyBinding: CreateTelephonyBindingRequestUnion, options?: BetaVoiceAgentsTelephonyCreateBindingOptionalParams) => Promise<TelephonyBindingUnion>

Property Value

(agentName: string, telephonyBinding: CreateTelephonyBindingRequestUnion, options?: BetaVoiceAgentsTelephonyCreateBindingOptionalParams) => Promise<TelephonyBindingUnion>

createCallJob

Creates one durable direct outbound call job. The latest agent definition is resolved when each attempt executes.

createCallJob: (agentName: string, idempotencyKey: string, body: CreateTelephonyCallJobRequest, options?: BetaVoiceAgentsTelephonyCreateCallJobOptionalParams) => Promise<TelephonyCallJob>

Property Value

(agentName: string, idempotencyKey: string, body: CreateTelephonyCallJobRequest, options?: BetaVoiceAgentsTelephonyCreateCallJobOptionalParams) => Promise<TelephonyCallJob>

deleteBinding

Deletes a telephony binding owned by the voice agent named in the path.

deleteBinding: (agentName: string, bindingId: string, ifMatch: string, options?: BetaVoiceAgentsTelephonyDeleteBindingOptionalParams) => Promise<void>

Property Value

(agentName: string, bindingId: string, ifMatch: string, options?: BetaVoiceAgentsTelephonyDeleteBindingOptionalParams) => Promise<void>

endCall

Ends an active inbound call owned by the voice agent named in the path.

endCall: (agentName: string, callId: string, options?: BetaVoiceAgentsTelephonyEndCallOptionalParams) => Promise<TelephonyCallRecord>

Property Value

(agentName: string, callId: string, options?: BetaVoiceAgentsTelephonyEndCallOptionalParams) => Promise<TelephonyCallRecord>

getBinding

Retrieves a telephony binding owned by the voice agent named in the path.

getBinding: (agentName: string, bindingId: string, options?: BetaVoiceAgentsTelephonyGetBindingOptionalParams) => Promise<TelephonyBindingUnion>

Property Value

(agentName: string, bindingId: string, options?: BetaVoiceAgentsTelephonyGetBindingOptionalParams) => Promise<TelephonyBindingUnion>

getCall

Retrieves a durable inbound call record owned by the voice agent named in the path.

getCall: (agentName: string, callId: string, options?: BetaVoiceAgentsTelephonyGetCallOptionalParams) => Promise<TelephonyCallRecord>

Property Value

(agentName: string, callId: string, options?: BetaVoiceAgentsTelephonyGetCallOptionalParams) => Promise<TelephonyCallRecord>

getCallJob

Retrieves a durable direct or campaign-created outbound call job.

getCallJob: (agentName: string, callJobId: string, options?: BetaVoiceAgentsTelephonyGetCallJobOptionalParams) => Promise<TelephonyCallJob>

Property Value

(agentName: string, callJobId: string, options?: BetaVoiceAgentsTelephonyGetCallJobOptionalParams) => Promise<TelephonyCallJob>

getTransferTargets

Returns all transfer targets configured for the voice agent named in the path.

getTransferTargets: (agentName: string, options?: BetaVoiceAgentsTelephonyGetTransferTargetsOptionalParams) => Promise<TelephonyTransferTargets>

Property Value

(agentName: string, options?: BetaVoiceAgentsTelephonyGetTransferTargetsOptionalParams) => Promise<TelephonyTransferTargets>

listBindings

Returns the telephony bindings owned by the voice agent named in the path.

listBindings: (agentName: string, options?: BetaVoiceAgentsTelephonyListBindingsOptionalParams) => PagedAsyncIterableIterator<TelephonyBindingListItemUnion, TelephonyBindingListItemUnion[], PageSettings>

Property Value

(agentName: string, options?: BetaVoiceAgentsTelephonyListBindingsOptionalParams) => PagedAsyncIterableIterator<TelephonyBindingListItemUnion, TelephonyBindingListItemUnion[], PageSettings>

listCalls

Returns the durable inbound call history for the voice agent named in the path.

listCalls: (agentName: string, options?: BetaVoiceAgentsTelephonyListCallsOptionalParams) => PagedAsyncIterableIterator<TelephonyCallSummary, TelephonyCallSummary[], PageSettings>

Property Value

(agentName: string, options?: BetaVoiceAgentsTelephonyListCallsOptionalParams) => PagedAsyncIterableIterator<TelephonyCallSummary, TelephonyCallSummary[], PageSettings>

replaceTransferTargets

Replaces all transfer targets configured for the voice agent named in the path.

replaceTransferTargets: (agentName: string, ifMatch: string, transferTargets: TelephonyTransferTarget[], options?: BetaVoiceAgentsTelephonyReplaceTransferTargetsOptionalParams) => Promise<TelephonyTransferTargets>

Property Value

(agentName: string, ifMatch: string, transferTargets: TelephonyTransferTarget[], options?: BetaVoiceAgentsTelephonyReplaceTransferTargetsOptionalParams) => Promise<TelephonyTransferTargets>

transferCall

Transfers an active inbound call to a configured target for the voice agent named in the path.

transferCall: (agentName: string, callId: string, target: string, options?: BetaVoiceAgentsTelephonyTransferCallOptionalParams) => Promise<TelephonyCallRecord>

Property Value

(agentName: string, callId: string, target: string, options?: BetaVoiceAgentsTelephonyTransferCallOptionalParams) => Promise<TelephonyCallRecord>

updateBinding

Updates a telephony binding owned by the voice agent named in the path.

updateBinding: (agentName: string, bindingId: string, ifMatch: string, body: UpdateTelephonyBindingRequest, options?: BetaVoiceAgentsTelephonyUpdateBindingOptionalParams) => Promise<TelephonyBindingUnion>

Property Value

(agentName: string, bindingId: string, ifMatch: string, body: UpdateTelephonyBindingRequest, options?: BetaVoiceAgentsTelephonyUpdateBindingOptionalParams) => Promise<TelephonyBindingUnion>