Models

BroadcastResultCopy Anchor Link

class Inverge.Nexus.Models.BroadcastResult

The acknowledgement of a multi-room broadcast.

CountCopy Anchor Link

int Count { get; }

How many rooms were emitted to. A message whose room name or event list was empty is skipped server-side, so this can be lower than what you sent.

OkCopy Anchor Link

bool Ok { get; }

Whether the broadcast was accepted.

ResultsCopy Anchor Link

IReadOnlyList<JsonNode> Results { get; }

The per-room acknowledgements.

EmitResultCopy Anchor Link

class Inverge.Nexus.Models.EmitResult

The acknowledgement of a realtime emit.

EventsCopy Anchor Link

IReadOnlyList<string> Events { get; }

The event names emitted.

OkCopy Anchor Link

bool Ok { get; }

Whether the emit was accepted.

RecipientsCopy Anchor Link

int Recipients { get; }

How many connected sockets received it. Zero is the signature of an environment mismatch — rooms are environment-scoped, so a subscriber using a key from another environment is never in the room you emitted to.

RelatedCopy Anchor Link

IReadOnlyList<string> Related { get; }

Linked rooms the message was also delivered to.

RoomCopy Anchor Link

string? Room { get; }

The room it went to.

SkippedCopy Anchor Link

bool Skipped { get; }

Whether the environment's realtime limit dropped it.

ErrorCaptureResultCopy Anchor Link

class Inverge.Nexus.Models.ErrorCaptureResult

What became of a captured error.

Three outcomes all arrive as a 2xx, and they are not the same thing: stored (Id set), dropped because the issue is marked ignored in the console (Ignored), or dropped because the environment hit its error limit (Skipped). An ignored issue is not billed.

GroupIdCopy Anchor Link

string? GroupId { get; }

The issue group it was folded into.

IdCopy Anchor Link

string? Id { get; }

The stored occurrence's id, when it was stored.

IgnoredCopy Anchor Link

bool Ignored { get; }

Whether the issue is marked ignored, so the occurrence was dropped and not billed.

SkippedCopy Anchor Link

bool Skipped { get; }

Whether the environment's error limit dropped it.

StoredCopy Anchor Link

bool Stored { get; }

Whether the occurrence was actually stored.

FlagEvaluationCopy Anchor Link

class Inverge.Nexus.Models.FlagEvaluation

Every active flag resolved for one person.

One evaluation covers every flag in the environment, so asking the result several questions costs one request. Calling IsEnabledAsync three times costs three.

FlagsCopy Anchor Link

IReadOnlyDictionary<string, JsonNode?> Flags { get; }

Flag keys mapped to their resolved value: a boolean for an on/off flag, the variant name for a multivariate one.

IsEmptyCopy Anchor Link

bool IsEmpty { get; }

Whether any flag came back. An empty result usually means a usage cap.

PayloadsCopy Anchor Link

IReadOnlyDictionary<string, JsonNode?> Payloads { get; }

Flag keys mapped to their attached JSON payload.

Contains()Copy Anchor Link

bool Contains(string key)

Whether the evaluation mentions a flag at all.

Parameters

Returns bool

IsEnabled()Copy Anchor Link

bool IsEnabled(string key)

Whether a flag is on — true for an enabled boolean flag, and for any resolved variant of a multivariate one.

Parameters

Returns bool

Payload()Copy Anchor Link

JsonNode? Payload(string key)

The flag's attached JSON payload, or null.

Parameters

Returns JsonNode?

Variant()Copy Anchor Link

string? Variant(string key)

The resolved variant of a multivariate flag, or null.

Parameters

Returns string?

IdentifyResultCopy Anchor Link

class Inverge.Nexus.Models.IdentifyResult

The person created or updated by an identify call.

DistinctIdCopy Anchor Link

string? DistinctId { get; }

The distinct id you identified them by.

SubjectCopy Anchor Link

JsonObject? Subject { get; }

The stored subject record.

SubjectIdCopy Anchor Link

string? SubjectId { get; }

Nexus's own id for the person.

IvrInstructionCopy Anchor Link

class Inverge.Nexus.Models.IvrInstruction

One step of an IVR flow, as a directive to act on.

Transfers and queues are resolved server-side into a connect, so the client never has to know about queues or agent availability — it either gets somebody to call, or no_agents.

ActionCopy Anchor Link

string? Action { get; }

What to do: play, collect, voicemail, hangup, connect, no_agents or ended.

EndpointTypeCopy Anchor Link

string? EndpointType { get; }

For connect: app, pstn or sip.

HasNoAgentsCopy Anchor Link

bool HasNoAgents { get; }

Whether a queue resolved to nobody being available.

IsConnectCopy Anchor Link

bool IsConnect { get; }

Whether this instruction is telling you to place a call.

IsEndedCopy Anchor Link

bool IsEnded { get; }

Whether the flow is over.

RawCopy Anchor Link

JsonObject Raw { get; }

The instruction as sent, including action-specific fields.

ReasonCopy Anchor Link

string? Reason { get; }

Why the flow ended, when it did.

ToCopy Anchor Link

string? To { get; }

For connect: the address or identity to call.

IvrResultCopy Anchor Link

class Inverge.Nexus.Models.IvrResult

An IVR flow's current step.

InstructionCopy Anchor Link

IvrInstruction? Instruction { get; }

What to do next.

SessionIdCopy Anchor Link

string? SessionId { get; }

The IVR session id, returned when the flow starts.

While the caller is still in the menu this is a synthetic id held in Redis — no call session exists in the database until the flow resolves to a connect, because only then is there a real call.

LiveActivityResultCopy Anchor Link

class Inverge.Nexus.Models.LiveActivityResult

How many devices a Live Activity reached, per platform.

AndroidCopy Anchor Link

int Android { get; }

Android devices reached.

IosCopy Anchor Link

int Ios { get; }

iOS devices reached.

IosTargetsCopy Anchor Link

int IosTargets { get; }

Start only: iOS devices registered for the activity type.

IosWarningCopy Anchor Link

string? IosWarning { get; }

Start only: why iOS got fewer deliveries than targets — no registered devices, APNs not configured, or Apple's rejection. Null when all is well.

TotalCopy Anchor Link

int Total { get; }

Devices reached in total.

NexusAckCopy Anchor Link

class Inverge.Nexus.Models.NexusAck

The answer from an endpoint that only confirms it did the thing.

Skipped is the one to watch. Several ingest endpoints answer {"skipped": true} with a 2xx when the environment has hit a usage limit — the call succeeded, and the data was not stored. Treating that as success hides a billing problem as missing data.

OkCopy Anchor Link

bool Ok { get; }

Whether the server acknowledged the call.

SkippedCopy Anchor Link

bool Skipped { get; }

Whether the server accepted the call but stored nothing, usually a usage cap.

NexusEventCopy Anchor Link

class Inverge.Nexus.Models.NexusEvent

One analytics event, for a batch send.

NexusEventCopy Anchor Link

new NexusEvent(string name, object? properties = null, DateTimeOffset? timestamp = null)

Creates an event.

Parameters

NameCopy Anchor Link

string Name { get; }

The event name.

PropertiesCopy Anchor Link

object? Properties { get; }

The event's properties.

TimestampCopy Anchor Link

DateTimeOffset? Timestamp { get; }

When it happened.

NexusLogEntryCopy Anchor Link

class Inverge.Nexus.Models.NexusLogEntry

One log line, for a batch send.

NexusLogEntryCopy Anchor Link

new NexusLogEntry(NexusLogLevel level, string message, string? source = null, object? context = null, DateTimeOffset? timestamp = null)

Creates a log entry.

Parameters

ContextCopy Anchor Link

object? Context { get; }

Structured context attached to the line.

LevelCopy Anchor Link

NexusLogLevel Level { get; }

The severity.

MessageCopy Anchor Link

string Message { get; }

The message. Over-long messages are truncated server-side, not rejected.

SourceCopy Anchor Link

string? Source { get; }

Where it came from — a subsystem, a logger name.

TimestampCopy Anchor Link

DateTimeOffset? Timestamp { get; }

When it was written.

NexusLogLevelCopy Anchor Link

enum Inverge.Nexus.Models.NexusLogLevel

Severity of a Nexus log line.

NexusReplayEventCopy Anchor Link

class Inverge.Nexus.Models.NexusReplayEvent

One replay event, as produced by a recorder.

NexusReplayEventCopy Anchor Link

new NexusReplayEvent(object payload)

Creates a replay event from an already-shaped payload.

Parameters

FromPayloads()Copy Anchor Link

static IEnumerable<NexusReplayEvent> FromPayloads(IEnumerable<object> payloads)

Wraps a sequence of raw payloads.

Parameters

Returns IEnumerable<NexusReplayEvent>

PayloadCopy Anchor Link

object Payload { get; }

The event payload.

NexusResultCopy Anchor Link

abstract class Inverge.Nexus.Models.NexusResult

Base for the SDK's response types.

Each result reads the fields the endpoint documents into typed properties and keeps the whole payload in Raw. That combination is deliberate: you get IntelliSense and compile-time names for the contract, and a field the server adds next month is reachable immediately without waiting for an SDK release.

HasPayloadCopy Anchor Link

bool HasPayload { get; }

Whether a response body arrived at all.

RawCopy Anchor Link

JsonNode? Raw { get; }

The decoded response, exactly as the API sent it. null when the response had no body, or when a silent client swallowed a failure.

NexusStackFrameCopy Anchor Link

class Inverge.Nexus.Models.NexusStackFrame

One stack frame, as the console renders it.

NexusStackFrameCopy Anchor Link

new NexusStackFrame(string? function, string? filename = null, int? lineNumber = null, string? contextLine = null)

Creates a frame.

Parameters

ContextLineCopy Anchor Link

string? ContextLine { get; }

The source line itself, when known.

FilenameCopy Anchor Link

string? Filename { get; }

The source file, when symbols were available.

FunctionCopy Anchor Link

string? Function { get; }

The method, qualified by its declaring type.

LineNumberCopy Anchor Link

int? LineNumber { get; }

The line number, when symbols were available.

PushSendResultCopy Anchor Link

class Inverge.Nexus.Models.PushSendResult

The outcome of a transactional push send.

FailedCopy Anchor Link

int Failed { get; }

How many were rejected. A steady non-zero count usually means stale tokens or provider credentials that need attention — the send itself still reports success.

RecipientsCopy Anchor Link

int Recipients { get; }

How many devices the audience resolved to.

SentCopy Anchor Link

int Sent { get; }

How many device deliveries the providers accepted.

RemoteConfigPublishResultCopy Anchor Link

class Inverge.Nexus.Models.RemoteConfigPublishResult

A published Remote Config version.

CreatedAtCopy Anchor Link

DateTimeOffset? CreatedAt { get; }

When it was published.

ETagCopy Anchor Link

string ETag { get; }

The new version's ETag.

VersionNumberCopy Anchor Link

int VersionNumber { get; }

The new version number.

RemoteConfigSnapshotCopy Anchor Link

class Inverge.Nexus.Models.RemoteConfigSnapshot

A resolved Remote Config template: typed getters over the values the server evaluated for your context.

Conditions — platform, version, country, percentile, custom attributes — are evaluated server-side, so what arrives here is final. Nothing is decided locally except the in-app defaults you registered, which fill a key the template does not define.

DefaultsCopy Anchor Link

IReadOnlyDictionary<string, object?> Defaults { get; }

The in-app defaults in force for this snapshot.

ETagCopy Anchor Link

string ETag { get; }

The ETag of the resolved result. It hashes the evaluated values, not just the template, so a changed context produces a new ETag rather than a false "not modified".

NotModifiedCopy Anchor Link

bool NotModified { get; }

Whether the server said nothing changed since the ETag we sent.

ParametersCopy Anchor Link

IReadOnlyDictionary<string, RemoteConfigValue> Parameters { get; }

The resolved parameters, by key.

ThrottledCopy Anchor Link

bool Throttled { get; }

Whether the environment hit its fetch limit. The values here are the last good ones plus your defaults — the server deliberately served and billed nothing.

VersionCopy Anchor Link

int Version { get; }

The published template version these values came from.

Contains()Copy Anchor Link

bool Contains(string key)

Whether the key is defined by the template or by your defaults.

Parameters

Returns bool

GetBoolean()Copy Anchor Link

bool GetBoolean(string key, bool fallback = false)

A boolean parameter — the shape a kill switch takes.

Parameters

Returns bool

GetInt32()Copy Anchor Link

int GetInt32(string key, int fallback = 0)

An integer parameter.

Parameters

Returns int

GetJson()Copy Anchor Link

JsonNode? GetJson(string key, JsonNode? fallback = null)

A JSON parameter.

Parameters

Returns JsonNode?

GetNumber()Copy Anchor Link

double GetNumber(string key, double fallback = 0)

A numeric parameter.

Parameters

Returns double

GetString()Copy Anchor Link

string GetString(string key, string fallback = "")

A string parameter.

Parameters

Returns string

SourceOf()Copy Anchor Link

string? SourceOf(string key)

Which condition supplied a key's value, or null for the default.

Parameters

Returns string?

ToDictionary()Copy Anchor Link

IReadOnlyDictionary<string, JsonNode?> ToDictionary()

A flat key-to-value map, defaults merged underneath.

Returns IReadOnlyDictionary<string, JsonNode?>

Value()Copy Anchor Link

RemoteConfigValue Value(string key)

The parameter, falling back to the in-app default you registered.

Parameters

Returns RemoteConfigValue

RemoteConfigValueCopy Anchor Link

class Inverge.Nexus.Models.RemoteConfigValue

One resolved Remote Config parameter, with conversions.

The conversions are forgiving on purpose: configuration is edited by people, and a parameter typed as a string in the console but read as a number here should still work rather than throwing in production.

HasValueCopy Anchor Link

bool HasValue { get; }

Whether a value was resolved at all.

KeyCopy Anchor Link

string Key { get; }

The parameter key.

SourceCopy Anchor Link

string? Source { get; }

Which condition supplied the value, or null when it came from the parameter's default. Useful when a rollout is not behaving as expected.

ValueCopy Anchor Link

JsonNode? Value { get; }

The resolved value, as JSON.

ValueTypeCopy Anchor Link

string? ValueType { get; }

The declared type: STRING, NUMBER, BOOLEAN or JSON.

AsBoolean()Copy Anchor Link

bool AsBoolean(bool fallback = false)

The value as a boolean, reading "true", "1", "yes" and friends.

Parameters

Returns bool

AsInt32()Copy Anchor Link

int AsInt32(int fallback = 0)

The value as an int.

Parameters

Returns int

AsInt64()Copy Anchor Link

long AsInt64(long fallback = 0)

The value as a long.

Parameters

Returns long

AsJson()Copy Anchor Link

JsonNode? AsJson(JsonNode? fallback = null)

The value as JSON. A value stored as a JSON string is parsed, so a parameter typed STRING but holding {"a":1} still comes back usable.

Parameters

Returns JsonNode?

AsNumber()Copy Anchor Link

double AsNumber(double fallback = 0)

The value as a double.

Parameters

Returns double

AsString()Copy Anchor Link

string AsString(string fallback = "")

The value as a string.

Parameters

Returns string

RoomResultCopy Anchor Link

class Inverge.Nexus.Models.RoomResult

A registered realtime room.

IdCopy Anchor Link

string? Id { get; }

The room's id, as used by the link and schema endpoints.

NameCopy Anchor Link

string? Name { get; }

The room name, as joined by subscribers.

RoomCopy Anchor Link

JsonObject? Room { get; }

The room record.

TypeCopy Anchor Link

string? Type { get; }

The room type, when one was set.

RoomSchemaResultCopy Anchor Link

class Inverge.Nexus.Models.RoomSchemaResult

A room's payload schema and whether it is enforced.

EnabledCopy Anchor Link

bool Enabled { get; }

Whether validation is actually enforced. A schema can be attached and switched off, which is why these are two separate things.

SchemaCopy Anchor Link

JsonNode? Schema { get; }

The JSON Schema payloads must satisfy, when one is set.

SessionResultCopy Anchor Link

class Inverge.Nexus.Models.SessionResult

The session a track call started or refreshed.

SessionIdCopy Anchor Link

string? SessionId { get; }

Nexus's id for the session.

SessionKeyCopy Anchor Link

string? SessionKey { get; }

The session key correlating this journey.

SubjectIdCopy Anchor Link

string? SubjectId { get; }

Nexus's id for the person the session belongs to.

SurveyResponseResultCopy Anchor Link

class Inverge.Nexus.Models.SurveyResponseResult

The stored survey response.

CompletedCopy Anchor Link

bool Completed { get; }

Whether the response is marked complete.

IdCopy Anchor Link

string? Id { get; }

The response id. Pass it back as responseId to keep appending answers to the same response instead of creating a second one.

SkippedCopy Anchor Link

bool Skipped { get; }

Whether the environment's survey limit dropped it.

VoiceAccessTokenCopy Anchor Link

class Inverge.Nexus.Models.VoiceAccessToken

A short-lived media access token for joining the session's room.

ExpiresAtCopy Anchor Link

DateTimeOffset? ExpiresAt { get; }

When the token stops working — minutes, not hours.

RawCopy Anchor Link

JsonObject Raw { get; }

The token record as sent.

TokenCopy Anchor Link

string? Token { get; }

The signed join token. Scoped to this one leg; do not cache or reuse it.

UrlCopy Anchor Link

string? Url { get; }

The media server URL to join.

VoiceCallResultCopy Anchor Link

class Inverge.Nexus.Models.VoiceCallResult

A created call session.

SessionCopy Anchor Link

VoiceSession? Session { get; }

The new session.

SessionIdCopy Anchor Link

string? SessionId { get; }

The new session's id.

VoiceDtmfResultCopy Anchor Link

class Inverge.Nexus.Models.VoiceDtmfResult

The result of sending a DTMF digit.

IvrCopy Anchor Link

IvrInstruction? Ivr { get; }

The next IVR step, when the session is inside a flow. null both when there is no IVR and when the flow has just ended.

OkCopy Anchor Link

bool Ok { get; }

Whether the digit was accepted.

VoiceJoinBundleCopy Anchor Link

class Inverge.Nexus.Models.VoiceJoinBundle

Everything a WebRTC client needs to join a call.

AccessCopy Anchor Link

VoiceAccessToken? Access { get; }

The access token to join with.

RawCopy Anchor Link

JsonObject Raw { get; }

The bundle as sent.

RegionCopy Anchor Link

string? Region { get; }

The media region serving the call.

RoomCopy Anchor Link

string? Room { get; }

The media room name.

TurnCopy Anchor Link

VoiceTurnCredential? Turn { get; }

The TURN configuration to use.

VoiceLegCopy Anchor Link

class Inverge.Nexus.Models.VoiceLeg

One participant's leg of a call.

AddressCopy Anchor Link

string? Address { get; }

The dialled address, for SIP and PSTN legs.

DirectionCopy Anchor Link

string? Direction { get; }

The leg's direction.

EndpointTypeCopy Anchor Link

string? EndpointType { get; }

webrtc, sip, pstn or app.

IdCopy Anchor Link

string? Id { get; }

The leg id. Every control call — ring, answer, hold, hangup, mute, transfer — is addressed by this.

IdentityIdCopy Anchor Link

string? IdentityId { get; }

The identity this leg rings, for app legs.

RawCopy Anchor Link

JsonObject Raw { get; }

The leg record as sent.

RoleCopy Anchor Link

string? Role { get; }

caller, callee, agent, supervisor, and so on.

SessionIdCopy Anchor Link

string? SessionId { get; }

The session this leg belongs to.

StatusCopy Anchor Link

string? Status { get; }

The leg's lifecycle status.

VoiceLegResultCopy Anchor Link

class Inverge.Nexus.Models.VoiceLegResult

The outcome of adding a leg to a call.

This endpoint reports failure inside a successful response, which is the single most surprising thing about the Voice API. A blocked call, a missing outbound trunk and an unreachable media plane all arrive as 2xx with Error set, so that the SDK can end the call cleanly instead of treating a provisioning problem as a crash.

Check IsSuccess, or call EnsureSuccess to turn the in-body error into an exception.

DialingCopy Anchor Link

JsonObject? Dialing { get; }

For a pstn or sip leg, the room and number being dialled.

ErrorCopy Anchor Link

string? Error { get; }

The in-body error code, when the leg did not come up: call_blocked (fraud policy refused it), no_outbound_trunk (no carrier configured for PSTN), media_unavailable (the media plane is unconfigured or unreachable).

HasNoOutboundTrunkCopy Anchor Link

bool HasNoOutboundTrunk { get; }

Whether PSTN has no outbound carrier configured.

IsBlockedCopy Anchor Link

bool IsBlocked { get; }

Whether the fraud policy refused the destination.

IsMediaUnavailableCopy Anchor Link

bool IsMediaUnavailable { get; }

Whether the media plane could not provision the room.

IsSuccessCopy Anchor Link

bool IsSuccess { get; }

Whether the leg is actually usable.

JoinCopy Anchor Link

VoiceJoinBundle? Join { get; }

The join bundle for a webrtc leg. Hand its token and TURN config to the device SDK.

LegCopy Anchor Link

VoiceLeg? Leg { get; }

The created leg, absent only when the call was blocked outright.

ReasonCopy Anchor Link

string? Reason { get; }

Why a blocked call was blocked.

RiskScoreCopy Anchor Link

double? RiskScore { get; }

The fraud risk score behind a call_blocked decision.

EnsureSuccess()Copy Anchor Link

VoiceLegResult EnsureSuccess()

Returns this result, or throws if the leg did not come up.

Returns VoiceLegResult

VoicePresenceResultCopy Anchor Link

class Inverge.Nexus.Models.VoicePresenceResult

An identity's rolled-up presence after a heartbeat.

OkCopy Anchor Link

bool Ok { get; }

Whether the heartbeat was accepted.

StatusCopy Anchor Link

string? Status { get; }

The identity's status across all its devices — not just the one that heartbeat. A person on a call on their phone is IN_CALL even while their laptop reports ONLINE.

VoiceSessionCopy Anchor Link

class Inverge.Nexus.Models.VoiceSession

A call session — the container every leg belongs to.

ApplicationIdCopy Anchor Link

string? ApplicationId { get; }

The voice application this session belongs to, when one was given.

DirectionCopy Anchor Link

string? Direction { get; }

inbound, outbound or internal.

IdCopy Anchor Link

string? Id { get; }

The session id, which every leg and control call references.

MetadataCopy Anchor Link

JsonObject? Metadata { get; }

Whatever metadata you attached at creation.

RawCopy Anchor Link

JsonObject Raw { get; }

The session record as sent.

RecordingModeCopy Anchor Link

string? RecordingMode { get; }

disabled, mixed, dual_channel or per_track.

StartedAtCopy Anchor Link

DateTimeOffset? StartedAt { get; }

When the session began.

StatusCopy Anchor Link

string? Status { get; }

The session's lifecycle status.

VoiceTurnCredentialCopy Anchor Link

class Inverge.Nexus.Models.VoiceTurnCredential

Short-lived TURN relay credentials for the device to use.

CredentialCopy Anchor Link

string? Credential { get; }

The TURN credential.

ExpiresAtCopy Anchor Link

DateTimeOffset? ExpiresAt { get; }

When it expires.

RawCopy Anchor Link

JsonObject Raw { get; }

The credential record as sent.

TtlSecondsCopy Anchor Link

int TtlSeconds { get; }

How long it is valid for.

UrlsCopy Anchor Link

IReadOnlyList<string> Urls { get; }

The relay URLs. An empty list means TURN is not configured on the backend — calls will still connect wherever a direct path exists and fail behind a symmetric NAT, which is a confusing way to learn about it.

UsernameCopy Anchor Link

string? Username { get; }

The TURN username.