TelephonyCallJob Class

Definition

Namespace:

Azure.AI.Projects.Agents

Assembly:

Azure.AI.Projects.Agents.dll

Package:

Azure.AI.Projects.Agents v3.0.0-beta.3

Source:

TelephonyCallJob.cs

A durable direct or campaign-created outbound call intent.

public class TelephonyCallJob : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.TelephonyCallJob>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.TelephonyCallJob>

type TelephonyCallJob = class
    interface IJsonModel<TelephonyCallJob>
    interface IPersistableModel<TelephonyCallJob>

Public Class TelephonyCallJob
Implements IJsonModel(Of TelephonyCallJob), IPersistableModel(Of TelephonyCallJob)

Inheritance

Object

TelephonyCallJob

Implements

IJsonModel<TelephonyCallJob> IPersistableModel<TelephonyCallJob> IPersistableModel<T>

Properties

Name	Description
AgentName	The name of the voice agent used at execution time.
AttemptCount	The number of provider attempts created so far.
Cancellation	The recorded cancellation request, when cancellation was requested.
ConnectionName	The Foundry connection name in the current project used to originate the call. Its category selects Twilio or Azure Communication Services / Teams Phone Extension. No inbound telephony binding is required.
CreatedOn	The Unix timestamp in seconds when the call job was created.
Destination	The phone destination to call.
Id	The service-generated call-job identifier.
NextAttemptOn	The Unix timestamp in seconds at which the next retry becomes eligible.
Object	The object type. Always telephony.call_job.
Purpose	An optional customer-declared purpose for placing the call.
RetryPolicy	The frozen provider-attempt retry policy.
Revision	The monotonically increasing optimistic-concurrency revision.
Schedule	The optional execution window.
Source	The caller identity used to originate the call. For a Twilio connection, provide an authorized E.164 phone number. For an Azure Communication Services / Teams Phone Extension connection, provide the Teams Resource Account object ID. The identity type is inferred from the connection category; originating does not change inbound routing.
Status	The current call-job lifecycle status.
StructuredInputs	Structured input values available to the agent and greeting for this call. Agent-declared inputs are validated against their schemas; omitted optional inputs may use their Agent-defined default values, while omitted required inputs are rejected. Additional inputs remain available as dynamic template variables. To assign an object to the value of this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). Examples: BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo". BinaryData.FromString("\"foo\""). : Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.
TerminalReason	The stable service-generated reason for the overall outbound call job, which can span multiple provider attempts, when available. Interpret this with status: a queued job can retain a temporary dispatch-deferral reason. Additional string codes may be returned.
UpdatedOn	The Unix timestamp in seconds when the call job was last updated.

Methods

Name	Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Operators

Name	Description
Explicit(ClientResult to TelephonyCallJob)

Explicit Interface Implementations

Name	Description
IJsonModel<TelephonyCallJob>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<TelephonyCallJob>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<TelephonyCallJob>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<TelephonyCallJob>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<TelephonyCallJob>.Write(ModelReaderWriterOptions)