Skip to main content

Documentation Index

Fetch the complete documentation index at: https://developers.telnyx.com/llms.txt

Use this file to discover all available pages before exploring further.

ENUM

ā€‹
CallState

public enum CallState: Equatable
CallState represents the state of the call

ā€‹
Cases

ā€‹
NEW

case NEW
New call has been created in the client.

ā€‹
CONNECTING

case CONNECTING
The outbound call is being sent to the server.

ā€‹
RINGING

case RINGING
Call is pending to be answered. Someone is attempting to call you.

ā€‹
ACTIVE

case ACTIVE
Call is active when two clients are fully connected.

ā€‹
HELD

case HELD
Call has been held.

ā€‹
DONE(reason:)

case DONE(reason: CallTerminationReason? = nil)
Call has ended.

ā€‹
RECONNECTING(reason:)

case RECONNECTING(reason: Reason)
The active call is being recovered. Usually after a network switch or bad network

ā€‹
DROPPED(reason:)

case DROPPED(reason: Reason)
The active call is dropped. Usually when the network is lost.

ā€‹
Methods

ā€‹
getReason()

public func getReason() -> String?
Helper function to get the reason for the state (if applicable).

ā€‹
==(_:_:)

public static func == (lhs: CallState, rhs: CallState) -> Bool

ā€‹
Parameters

NameDescription
lhsA value to compare.
rhsAnother value to compare.