2.1.3 GA
Description

Trunk

REST Name 
trunk
Methods
status
Retrieve Status
retrieve
Retrieve
create
Create
list
List
update
Update
delete
Delete
Properties
Name Data Possible Values Description
ingress

Type

  • Enumeration

Default

  • __none__

Rules

  • required

Values

  • __none__ - ( SIP Profile Default )

Ingress

Use a specific ingress Header Manipultion plan for this SIP Trunk.

contact-host

Type

  • string

Default

  • None

Contact Host

Optional custom contact host (@host) in the Contact header of the SIP messages exchanged with this SIP Trunk.

Note this value must be an IP of FQDN routable back to the SBC in order to receive calls.

from-user

Type

  • string

Default

  • None

Rules

  • min_length[1]
  • max_length[254]

From User

User Name that will be used in the SIP "FROM" header. If not provided, the authentication username will be used.

call-routing

Type

  • Enumeration

Default

  • __none__

Rules

  • required

Values

  • default - default
  • __none__ - ( SIP Profile Default )

Routing Plan

Use a specific routing plan for this SIP Trunk.

retry-seconds

Type

  • string

Default

  • 30

Rules

  • required[register]
  • greater_than[4]

Register Retry Seconds

Number of seconds to wait until retrying registration after a timeout or a failure.

For 503 (service unavailable) errors or timeout, the retry period remains constant (always the value specified here)

For other registration errors (ie, 403 Forbidden), the retry period will increase linearly multiplied by the number of failures.

egress

Type

  • Enumeration

Default

  • __none__

Rules

  • required

Values

  • __none__ - ( SIP Profile Default )

Egress

Use a specific egress Header Manipultion plan for this SIP Trunk.

outbound-proxy

Type

  • string

Default

  • None

Rules

  • valid_ip_port_domain

Outbound Proxy Address

Domain name or IP address to use as the SIP outbound proxy. If not provided, the Domain provided will be used.

Outbound Proxy address can also be in IP:PORT notation (i.e. 10.10.0.1:8888).

inbound-media-profile

Type

  • Enumeration

Default

  • __none__

Rules

  • required

Values

  • default - default
  • __none__ - ( SIP Profile Default )

Inbound Media Profile

Media profile that will be used on all incoming calls.

register-proxy

Type

  • string

Default

  • None

Rules

  • valid_ip_port_domain

Registrar Proxy Address

Domain name or IP address to use as the Registrar proxy. If not provided, the Proxy address will be used.

Registrar Proxy address can also be in IP:PORT notation (i.e. 10.10.0.1:8888).

timeout-seconds

Type

  • string

Default

  • 60

Rules

  • required[register]
  • greater_or_equal[5]

Register Timeout Seconds

Number of seconds to wait before declaring a REGISTER request unsuccessful if no reply

realm

Type

  • string

Default

  • None

Rules

  • required
  • valid_ip_or_domain rule

Domain

Domain Name (if DNS is supported) or IP address provided by the ITSP

caller-id-in-from

Type

  • Enumeration

Default

  • true

Rules

  • required

Values

  • false - Disabled
  • true - Enabled

Transparent CallerID

For outbound calls, whether to use the From user caller id as received from the inbound leg. If disabled, the From user configured for this SIP trunk is used.

ping

Type

  • string

Default

  • None

Rules

  • greater_than[4]

OPTIONS Ping Frequency

How many seconds to wait between SIP OPTIONS ping messages to see if the SIP host is responsive (minimum is 5 seconds).

If left empty no OPTIONS Ping requests will be sent to determine trunk

outbound-media-profile

Type

  • Enumeration

Default

  • __none__

Rules

  • required

Values

  • default - default
  • __none__ - ( SIP Profile Default )

Outbound Media Profile

Media profile that will be used on all outgoing calls.

from-domain

Type

  • string

Default

  • None

From Domain

Domain name that will be used in the SIP "FROM" header. If not provided, the Domain provided will be used

session-rate-limit

Type

  • string

Default

  • None

Rules

  • greater_than[0]
  • less_than[65536]
  • is_natural

Session Rate Limit

Maximum number of sessions per period of time configured in 'Session Rate Period'

username

Type

  • string

Default

  • None

Rules

  • required[password]
  • alpha_dash

User Name

The authentication username to be used in all outgoing INVITE and REGISTER messages in this trunk.

register-transport

Type

  • Enumeration

Default

  • udp

Rules

  • required

Values

  • tls - TLS
  • udp - UDP
  • tcp - TCP

Transport

SIP Transport used for calls in this SIP Trunk.

max-sessions

Type

  • string

Default

  • None

Rules

  • greater_than[0]
  • less_than[65536]
  • is_natural

Max Sessions

Maximum allowed concurrent sessions

proxy

Type

  • string

Default

  • None

Rules

  • valid_ip_port_domain

Proxy Address

Domain name or IP address to use as the SIP proxy. If not provided, the Domain provided will be used.

Proxy address can also be in IP:PORT notation (i.e. 10.10.0.1:8888).

password

Type

  • password

Default

  • None

Rules

  • required[username]

Password

The SIP trunk authentication password.

distinct-to

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • true - User Name
  • false - From User

Register To: Header

This affects how the REGISTER To: header is created.

If 'From User' is selected, the REGISTER To: header will be the same as the user in the From: header. This is normal RFC3261 behavior.

If 'Username' is selected, the REGISTER To: header will be created using the specified 'User Name' for this sip trunk.

expire-seconds

Type

  • string

Default

  • 3600

Rules

  • required[register]
  • greater_than[10]

Register Expire Seconds

Time until SIP registration expires. In seconds.

sip_profile

Type

  • Enumeration

Default

  • Profile1

Rules

  • required

Values

  • Profile1 - Profile1

SIP Profile

The SIP Profile this SIP trunk will be associated to.

register

Type

  • Enumeration

Default

  • false

Rules

  • required

Values

  • false - Disable
  • true - Enable

Registration

Indicates whether or not to register to the trunk.

contact-params

Type

  • string

Default

  • None

Contact Parameters

Extra SIP parameters to send in the "Contact" header of the SIP messages exchanged with this SIP Trunk.

session-rate-period

Type

  • string

Default

  • None

Rules

  • required[session-rate-limit]
  • greater_than[0]
  • less_than[65536]
  • is_natural

Session Rate Period

Period of time in seconds to enforce the rate limit specified in 'Session Rate Limit'

ping-max

Type

  • string

Default

  • None

Rules

  • greater_than[0]
  • greater_or_equal[ping-min]

OPTIONS Max Ping

Each successful ping is counted and tracked up to this value. It must be bigger than 0.

This is useful to control the number of successful and failed pings before declaring a SIP trunk available or unavailable.

Each successful ping will increase the counter, when the counter reaches 'OPTIONS Min Ping' the SIP trunk will be declared available

Each failed ping will decrease the counter, when the counter goes below 'OPTIONS Min Ping' the SIP trunk will be declared unavailable

If left empty it will default to 1

ping-min

Type

  • string

Default

  • None

Rules

  • greater_than[0]

OPTIONS Min Ping

The minimum value of ping counts to reach before declaring a SIP trunk available. It must be bigger than 0.

This is useful to control the number of successful and failed pings before declaring a SIP trunk available or unavailable.

Each successful ping will increase the counter, when the counter reaches 'OPTIONS Min Ping' the SIP trunk will be declared available

Each failed ping will decrease the counter, when the counter goes below 'OPTIONS Min Ping' the SIP trunk will be declared unavailable

If left empty it will default to 1

Copyright ©2013 Sangoma Technologies Corp.