Struct GeneralDispatchAgentParams 

pub struct GeneralDispatchAgentParams {
    pub agent_id: Option<String>,
    pub meeting_id: Option<String>,
    pub room_id: Option<String>,
    pub room_options: Option<AgentRoomOptions>,
    pub sip_options: Option<Map<String, Value>>,
    pub metadata: Option<Map<String, Value>>,
    pub version_id: Option<String>,
}

The parameters for AgentsResource::general_dispatch, a managed or low-code dispatch. Unlike the others, this ignores version_tag and wait.

Fields

agent_id: Option<String>

The deployed agent to dispatch.

meeting_id: Option<String>

The room to join. One of meeting_id or room_id is required.

room_id: Option<String>

An alias of meeting_id.

room_options: Option<AgentRoomOptions>

Per-dispatch room behavior.

sip_options: Option<Map<String, Value>>

When present, also places an outbound SIP call.

metadata: Option<Map<String, Value>>

Free-form metadata handed to the agent.

version_id: Option<String>

The deployment version. Required.

Trait Implementations

impl Clone for GeneralDispatchAgentParams

fn clone(&self) -> GeneralDispatchAgentParams

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GeneralDispatchAgentParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GeneralDispatchAgentParams

fn default() -> GeneralDispatchAgentParams

Returns the “default value” for a type.

impl From<GeneralDispatchAgentParams> for DispatchAgentParams

fn from(params: GeneralDispatchAgentParams) -> Self

Converts to this type from the input type.