TelephonyCallTiming Class

Detailed provider-neutral timing for an inbound telephony call.

Constructor

TelephonyCallTiming(*args: Any, **kwargs: Any)

Variables

Name Description
received_at

The Unix timestamp (in seconds) for when the provider webhook was received.

validated_at

The Unix timestamp (in seconds) for when webhook validation completed.

admitted_at

The Unix timestamp (in seconds) for when the call was admitted to an agent binding.

answer_requested_at

The Unix timestamp (in seconds) for when the service requested that the provider answer the call.

answered_at

The Unix timestamp (in seconds) for when the provider reported that the call was answered.

media_connected_at

The Unix timestamp (in seconds) for when the provider media channel connected.

agent_session_ready_at

The Unix timestamp (in seconds) for when the voice-agent session became ready.

first_caller_audio_at

The Unix timestamp (in seconds) for when caller audio was first observed.

first_agent_audio_at

The Unix timestamp (in seconds) for when agent audio was first observed.

ended_at

The Unix timestamp (in seconds) for when the call reached a terminal state.

duration_basis

The timestamp used as the basis for duration. Known values are: "answered" and "received".

timestamp_source

The primary source of the timing milestones. Individual lifecycle events identify their own timestamp source separately. Required. Known values are: "provider", "gateway", and "derived".

Methods

as_dict

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

clear

Remove all items from the dictionary.

copy
get

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

items
keys
pop

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.

popitem

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

setdefault

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

update

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.

values

as_dict

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

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

Keyword-Only Parameters

Name Description
exclude_readonly

Whether to remove the readonly properties.

Default value: False

Returns

Type Description

A dict JSON compatible object

clear

Remove all items from the dictionary.

clear() -> None

copy

copy() -> Model

get

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

Name Description
key
Required
default
Default value: None

items

items() -> ItemsView[str, Any]

Returns

Type Description

a set-like object providing a view on the mapping's items

keys

keys() -> KeysView[str]

Returns

Type Description

a set-like object providing a view on the mapping's keys

pop

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

Name Description
key
Required
default

popitem

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]

setdefault

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

Name Description
key
Required
default

update

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

values() -> ValuesView[Any]

Returns

Type Description

an object providing a view on the mapping's values

Attributes

admitted_at

The Unix timestamp (in seconds) for when the call was admitted to an agent binding.

admitted_at: datetime | None

agent_session_ready_at

The Unix timestamp (in seconds) for when the voice-agent session became ready.

agent_session_ready_at: datetime | None

answer_requested_at

The Unix timestamp (in seconds) for when the service requested that the provider answer the call.

answer_requested_at: datetime | None

answered_at

The Unix timestamp (in seconds) for when the provider reported that the call was answered.

answered_at: datetime | None

duration_basis

"answered" and "received".

duration_basis: str | _models.TelephonyCallDurationBasis | None

ended_at

The Unix timestamp (in seconds) for when the call reached a terminal state.

ended_at: datetime | None

first_agent_audio_at

The Unix timestamp (in seconds) for when agent audio was first observed.

first_agent_audio_at: datetime | None

first_caller_audio_at

The Unix timestamp (in seconds) for when caller audio was first observed.

first_caller_audio_at: datetime | None

media_connected_at

The Unix timestamp (in seconds) for when the provider media channel connected.

media_connected_at: datetime | None

received_at

The Unix timestamp (in seconds) for when the provider webhook was received.

received_at: datetime | None

timestamp_source

The primary source of the timing milestones. Individual lifecycle events identify their own timestamp source separately. Required. Known values are: "provider", "gateway", and "derived".

timestamp_source: str | _models.TelephonyCallTimestampSource

validated_at

The Unix timestamp (in seconds) for when webhook validation completed.

validated_at: datetime | None