Create a RoutingConfig

Creates one routing config on your organisation.

Name. name must be unique within your organisation. A duplicate is rejected with a 400.

Routes. routes is a list. Every route needs an integer priority and a destination. Priorities must be unique across the list. A lower priority number is tried first.

Destinations. A destination is phone or voice_agent. A phone destination needs number in digits only — a leading + is rejected. The number must be a real, dial-able E.164 number; the API normalises it and stores the digits-only form. A voice_agent destination needs agent_config, the UUID of a SUMI agent config on your organisation.

Conditions. conditions decides when a route applies. time_of_day takes days, start and end. public_holiday is a boolean and needs country to be set on the config.

Fallback. fallback catches a failed leg. It needs on and destination. timeout_seconds is optional and runs from 5 to 120.

Default destination. default_destination is used when no route matches. It takes the same shape as a route destination.

Request

Body Params application/jsonRequired

Examples

Office-hours route with a fallbackPublic holidays go to a voice agentName only

Calls inside office hours go to the office number. A busy or unanswered leg falls back to the second number after 30 seconds. Everything else goes to the default destination.

{
    "name": "Cape Town office hours",
    "timezone": "Africa/Johannesburg",
    "country": "ZA",
    "routes": [
        {
            "priority": 1,
            "conditions": {
                "time_of_day": {
                    "days": [
                        "mon",
                        "tue",
                        "wed",
                        "thu",
                        "fri"
                    ],
                    "start": "08:00",
                    "end": "17:00"
                }
            },
            "destination": {
                "type": "phone",
                "number": "27821234567"
            },
            "fallback": {
                "on": [
                    "busy",
                    "no_answer"
                ],
                "timeout_seconds": 30,
                "destination": {
                    "type": "phone",
                    "number": "27821234568"
                }
            }
        }
    ],
    "default_destination": {
        "type": "phone",
        "number": "27821234569"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢201Created

application/json

The routing config was created.

Bodyapplication/json

Example

{
    "uuid": "3f1c8a20-0000-4c00-8a00-2d3e4f5a6b7c",
    "name": "Cape Town office hours",
    "timezone": "Africa/Johannesburg",
    "country": "ZA",
    "routes": [
        {
            "priority": 1,
            "conditions": {
                "time_of_day": {
                    "days": [
                        "mon",
                        "tue",
                        "wed",
                        "thu",
                        "fri"
                    ],
                    "start": "08:00",
                    "end": "17:00"
                }
            },
            "destination": {
                "type": "phone",
                "number": "27821234567"
            },
            "fallback": {
                "on": [
                    "busy",
                    "no_answer"
                ],
                "timeout_seconds": 30,
                "destination": {
                    "type": "phone",
                    "number": "27821234568"
                }
            }
        }
    ],
    "default_destination": {
        "type": "phone",
        "number": "27821234569"
    },
    "created": "2026-08-20T09:14:52.418000Z",
    "modified": "2026-08-20T09:14:52.418000Z"
}

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠429Too Many Requests