Interface DispatchAgentOptions

interface DispatchAgentOptions {
    agentId: string;
    meetingId?: string;
    metadata?: Record<string, unknown>;
    roomId?: string;
    roomOptions?: AgentRoomOptions;
    sipOptions?: AgentSipOptions;
    versionId?: string;
    versionTag?: string;
    wait?: unknown;
}

Index

Properties

agentId meetingId? metadata? roomId? roomOptions? sipOptions? versionId? versionTag? wait?

Properties

agentId

agentId: string

The deployed agent to dispatch. Required.

`Optional`meetingId

meetingId?: string

The room/meeting to join. Provide meetingId or roomId (at least one).

`Optional`metadata

metadata?: Record<string, unknown>

`Optional`roomId

roomId?: string

`Optional`roomOptions

roomOptions?: AgentRoomOptions

`Optional`sipOptions

sipOptions?: AgentSipOptions

`Optional`versionId

versionId?: string

Pin a specific deployment version (cloud / no-code).

`Optional`versionTag

versionTag?: string

Resolve a no-code published version by tag.

`Optional`wait

wait?: unknown

Forwarded to the registry if defined.