Skip to content

List routing automations

GET
/v1/numbers/{number}/automations
curl --request GET \
--url https://api.caller9.app/v1/numbers/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/automations \
--header 'Authorization: Bearer <token>'

Lists the number’s scheduled routing automations, ordered by trigger time. Each automation changes the number’s routing at a recurring time of day. Readable on every plan.

number
required
string format: uuid

Phone number ID (UUID), not the phone number itself.

The number’s automations.

Media typeapplication/json
object
automations
required
Array<object>

A recurring routing automation for a number. Exactly one destination is set, matching action: dest_studio_guid (route_studio), dest_trunk_guid (route_trunk), or the forward_* fields (route_forward).

object
guid
required
string
action
required
string
Allowed values: route_studio route_forward route_trunk
number_guid
required
string
dest_studio_guid
required
string | null
dest_trunk_guid
required
string | null
forward_dest_type
required
string | null
Allowed values: sip phone
forward_sip_address
required
string | null
forward_phone_number
required
string | null
label
required
string
days_mask
required

Bitmask of days (bit 0 = Sunday … bit 6 = Saturday).

integer
>= 1 <= 127
trigger_minute
required
integer
<= 1439
timezone
required
string
enabled
required
integer
Allowed values: 0 1
last_fired_at

When the automation last fired. Included on create/update responses only.

string | null format: date-time
studio_guid

Always null for number automations. Included on create/update responses only.

null
action_value

Always null for number automations. Included on create/update responses only.

null
created_at
required
string format: date-time
updated_at
required
string format: date-time

Example

{
"automations": [
{
"action": "route_studio",
"forward_dest_type": "sip",
"enabled": 0
}
]
}

Missing, invalid, expired or revoked API key.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Not found, or belongs to another organization.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}

Too many requests for this API key. Retry after Retry-After seconds.

Media typeapplication/json
object
error
required

Human-readable error message.

string
code

Machine-readable code (authentication failures only, e.g. KEY_EXPIRED, RATE_LIMITED).

string

Example generated

{
"error": "example",
"code": "example"
}
Retry-After
integer

Seconds until the rate-limit window resets.