Skip to main content
POST
Create a routing group

Authorizations

x-token
string
header
required

Body

application/json
name
string
required

Display name for the routing group.

type
enum<string>
required

Ring mode. simultaneous rings all members at once; sequential tries each in order.

Available options:
simultaneous,
sequential
destination
object

Ring target configuration. Supports ringType of user, phone, browser, agent, or multi.

ringDurationSeconds
number

How long (in seconds) to ring each target before moving on. Defaults to 20.

callerExperience
object

Caller-side experience config. Set mode to ring (default) or hold-music.

maxWaitSeconds
number

Maximum time (in seconds) a caller will wait before overflow handling triggers.

overflow
object

Overflow/voicemail config. Supports greetingText and voicemailNotification (array of emails).

Response

Routing group created.

_id
string

ID of the created routing group.