Skip to main content
POST
json

Body

application/json
RouteName
string
required

Friendly name for voice route

Example:

"Main SIP Trunk"

RouteType
enum<string>
required

Type of voice routing

Available options:
Trunk,
URL,
Forward
Example:

"Trunk"

VoiceUrl
string<uri>

Webhook URL for voice events

Example:

"https://domain.com"

VoiceUrlMethod
enum<string>

HTTP method for voice URL

Available options:
GET,
POST
Example:

"POST"

VoiceAuthenticationType
enum<string>

Authentication type

Available options:
None,
Basic,
Bearer
VoiceUsername
string

Username for auth

Example:

"admin"

VoicePasswordToken
string

Password or token

Example:

"passwordORbearerToken"

CallbackVoiceUrl
string<uri>

Callback URL

Example:

"https://apiendpoint.com"

CallbackVoiceUrlMethod
enum<string>
Available options:
GET,
POST
Example:

"POST"

TrunkIp1
string

Primary SIP trunk IP

Example:

"20.87.87.87"

TrunkIp2
string

Secondary SIP trunk IP

Example:

"20.87.87.86"

TrunkPort1
string

Primary trunk port

Example:

"5061"

TrunkPort2
string

Secondary trunk port

Example:

"5060"

TrunkTransport1
enum<string>

Primary transport protocol

Available options:
UDP,
TCP,
TLS
Example:

"UDP"

TrunkTransport2
enum<string>

Secondary transport protocol

Available options:
UDP,
TCP,
TLS
Example:

"TCP"

TrunkUri1
string<uri>
Example:

"https://pstn.joonto.com"

TrunkUri2
string<uri>
Example:

"https://pstn2.joonto.com"

TrunkEnabled1
boolean

Enable primary trunk

Example:

true

TrunkEnabled2
boolean

Enable secondary trunk

Example:

false

Trunk1Priortiy
integer

Priority for trunk 1

Example:

10

Trunk1Weight
integer

Weight for trunk 1

Example:

10

Trunk2Priortiy
integer

Priority for trunk 2

Example:

20

Trunk2Weight
integer

Weight for trunk 2

Example:

20

HeaderManipulation
string

Header manipulation ID

Example:

"HMI8802029"

EnableSipRefer
boolean

Enable SIP REFER

Example:

true

TransferCallerId
string

Caller ID for transfers

Example:

"Transferee/Transferor"

SymmetricRtp
boolean

Enable symmetric RTP

Example:

true

EnableTrpSecureTrunk
boolean

Enable secure trunk

Example:

true

EnablePstnTransfer
boolean

Enable PSTN transfer

Example:

true

IpWhitelist
object[]

IP whitelist

CnamLookup
boolean

Enable CNAM lookup

Example:

true

TerminationUriSubdomain
string

Termination URI subdomain

Example:

"client"

EnableCallStreaming
boolean

Enable call streaming

Example:

true

WssUri
string<uri>

WebSocket secure URI

Example:

"wss://192.67.88.2"

RouteEnabled
boolean

Enable/disable route

Example:

true

IntelligentRouteEnabled
boolean

Enable intelligent routing features for this voice route

Example:

true

AccountId
string

Account ID to associate with this voice route

Example:

"DID-1e8939ab-3f3c-4db1-89d7-956d80fd793j"

Response

Success — returns the newly created Voice Route ID (CRID)

The response is of type object.