WHwhispa
inbound-routes

Update Inbound Route

put/inbound-routes/{route_id}

Request

  • Base URL
    https://dev.whispa.net (the document declares no server; this is the origin it was published from)
  • Auth
    • OAuth 2
      Password
      Token URL: auth/bearer/login
    • or API key in cookie access_token

Path parameters

route_idstring uuid required

Request body

display_namestring required
scenariostring required

ai_agent scenario with scenario_metadata.supports_inbound

user_idstring uuid required

Owning service user for session ownership/attribution

voice_idstring nullable
opening_linestring nullable

Overrides the scenario's inbound_greeting; raw $placeholder template, rendered per call.

human_destinationstring nullable

Transfer target for this route; empty = offer callback instead

fallback_destinationstring nullable

Queue/voicemail destination (TCN: human hunt group SID) for auto-answered calls the autonomous agent cannot take, and for callers it cannot continue with (unknown caller, model failure, failed identity check)

hours_startstring nullable

'HH:MM' local time

hours_endstring nullable

'HH:MM' local time

hours_daysinteger[] nullable

date.weekday() ints (0=Mon); null = every day

hours_timezonestring nullable
transfer_hours_startstring nullable

'HH:MM' local time; null with end = the team's business hours

transfer_hours_endstring nullable

'HH:MM' local time; null with start = the team's business hours

transfer_hours_daysinteger[] nullable

Live-transfer date.weekday() ints (0=Mon); null = every day

transfer_hours_timezonestring nullable
transfer_hours_exclude_public_holidaysboolean

Close live transfers on Australian national public holidays

unknown_caller_policy'proceed' | 'fallback'

How to treat a caller whose number matches no CRM account.

Multiple matches never use this policy: they require a specialist because v1 deliberately has no account-selection or multi-account self-service.

max_concurrentinteger nullable
provider_refstring nullable

Unified 3CX Route Point DN; editable to repair legacy routes. Omitted by pre-unification clients to keep the current DN.

enabledboolean

Response

Successful Response

display_namestring required
scenariostring required

ai_agent scenario with scenario_metadata.supports_inbound

user_idstring uuid required

Owning service user for session ownership/attribution

voice_idstring nullable
opening_linestring nullable

Overrides the scenario's inbound_greeting; raw $placeholder template, rendered per call.

human_destinationstring nullable

Transfer target for this route; empty = offer callback instead

fallback_destinationstring nullable

Queue/voicemail destination (TCN: human hunt group SID) for auto-answered calls the autonomous agent cannot take, and for callers it cannot continue with (unknown caller, model failure, failed identity check)

hours_startstring nullable

'HH:MM' local time

hours_endstring nullable

'HH:MM' local time

hours_daysinteger[] nullable

date.weekday() ints (0=Mon); null = every day

hours_timezonestring nullable
transfer_hours_startstring nullable

'HH:MM' local time; null with end = the team's business hours

transfer_hours_endstring nullable

'HH:MM' local time; null with start = the team's business hours

transfer_hours_daysinteger[] nullable

Live-transfer date.weekday() ints (0=Mon); null = every day

transfer_hours_timezonestring nullable
transfer_hours_exclude_public_holidaysboolean

Close live transfers on Australian national public holidays

unknown_caller_policy'proceed' | 'fallback'

How to treat a caller whose number matches no CRM account.

Multiple matches never use this policy: they require a specialist because v1 deliberately has no account-selection or multi-account self-service.

max_concurrentinteger nullable
idstring uuid required
providerstring required
provider_refstring required
enabledboolean required
configuration_errorstring nullable
required_provider_refstring nullable
created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.