TelephonyCallJob Class

Return a dict that can be turned into json using json.dump.

as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]

Keyword-Only Parameters

Returns

Remove all items from the dictionary.

clear() -> None

copy() -> Model

Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: The value for key if key is in the dictionary, else default. :rtype: any

get(key: str, default: Any = None) -> Any

Parameters

items() -> ItemsView[str, Any]

Returns

keys() -> KeysView[str]

Returns

Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.

pop(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if the dictionary is empty.

popitem() -> tuple[str, Any]

Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any

setdefault(key: str, default: ~typing.Any = <object object>) -> Any

Parameters

Update the dictionary from a mapping or an iterable of key-value pairs. :param any args: Either a mapping object or an iterable of key-value pairs.

update(*args: Any, **kwargs: Any) -> None

values() -> ValuesView[Any]

Returns

The name of the voice agent used at execution time. Required.

agent_name: str

The number of provider attempts created so far. Required.

attempt_count: int

The recorded cancellation request, when cancellation was requested.

cancellation: _models.TelephonyCallJobCancellation | None

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. Required.

connection_name: str

The Unix timestamp in seconds when the call job was created. Required.

created_at: datetime

The phone destination to call. Required.

destination: _models.TelephonyOutboundDestination

The service-generated call-job identifier. Required.

id: str

The Unix timestamp in seconds at which the next retry becomes eligible.

next_attempt_at: datetime | None

The object type. Always telephony.call_job. Required. Default value is "telephony.call_job".

object: Literal['telephony.call_job']

An optional customer-declared purpose for placing the call.

purpose: str | None

The frozen provider-attempt retry policy. Required.

retry_policy: _models.TelephonyOutboundRetryPolicy

The monotonically increasing optimistic-concurrency revision. Required.

revision: int

The optional execution window.

schedule: _models.TelephonyCallJobSchedule | None

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. Required.

source: str

"accepted", "waiting_for_schedule", "queued", "dispatching", "in_progress", "waiting_for_retry", "cancellation_requested", "completed", "blocked", "expired", "failed", and "cancelled".

status: str | _models.TelephonyCallJobStatus

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.

structured_inputs: dict[str, Any] | None

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. Known values are: "no_answer", "no_answer_timeout", "answer_failed", "bridge_cancelled", "bridge_failed", "voice_session_configuration_invalid", "connection_project_mismatch", "outbound_connection_changed", "outbound_connection_unavailable", "telephony_binding_invalid", "telephony_binding_not_found", "telephony_binding_inactive", "telephony_binding_changed", "campaign_not_found", "campaign_cancelled", "campaign_completed", "campaign_failed", "origination_fence_not_recorded", "origination_reconciliation_timeout", "cancellation_reconciliation_timeout", and "provider_callback_timeout_cancellation_reconciliation_timeout".

terminal_reason: str | _models.TelephonyCallJobTerminalReason | None

The Unix timestamp in seconds when the call job was last updated. Required.

updated_at: datetime