Skip to main content
GET
Get routing rule

Authorizations

Authorization
string
header
default:<auth-token>
required

Your API token, sent raw (no Bearer prefix).

Path Parameters

ruleId
string
required

Response

The rule.

id
string
Example:

"rr_8k2m1x"

type
enum<string>
Available options:
inbound,
outbound
numbers
string[]
createdAt
string<date-time>
updatedAt
string<date-time>
name
string
phoneNumbers
string[]

E.164 numbers already on your account. Leave it out to attach numbers later.

apiKey
string

Optional. On create, leave it out to use the API key of the token you call with.

agentId
string

Agent to dispatch. Omit to dispatch none.

agentMetadata
object

Flat string map handed to the agent.

room
object
includeHeaders
enum<string>
default:NONE
Available options:
ALL,
SIP_X_HEADERS,
NONE
headers
object

Outbound only. Extra SIP headers to send.

headersToAttributes
object

Inbound only. Maps an incoming header onto a call attribute.

allowedNumbers
string[]

Empty means no restriction.

allowedIpAddresses
string[]

Empty means no restriction.

tags
string[]
recording
boolean
default:false
dtmf
boolean
default:false
noiseCancellation
boolean
default:false
hidePhoneNumber
boolean
default:false