Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Section
Column

Configuration Section Format

pjsip.conf is a flat text file composed of sections like most configuration files used with Asterisk. Each section defines configuration for a configuration object within res_pjsip or an associated module.

Sections are identified by names in square brackets. (see SectionName below)

Each section has one or more configuration options that can be assigned a value by using an equal sign followed by a value. (see ConfigOption and Value below)These options and values are the configuration for a particular component of functionality provided by the configuration object's respective Asterisk modules.

Every section will have a type option that defines what kind of section is being configured. You'll see that in every example config section below.

Panel
titleSyntax for res_sip config objects

[  SectionName ]
ConfigOption = Value
ConfigOption = Value

Column
Panel
titleOn this Page

Table of Contents
maxLevel2

Config Section Help and Defaults

Reference documentation for all configuration parameters is available on the wiki:

The same documentation is available at the Asterisk CLI as well. You can use "config show help <res_pjsip module name> <configobject> <configoption>" to get help on a particular option. That help will typically describe the default value for an option as well.

Tip

Defaults: For many config options, it's very helpful to understand their default behavior. For example, for the endpoint section "transport=" option, if no value is assigned then Asterisk will *DEFAULT* to the first configured transport in pjsip.conf which is valid for the URI we are trying to contact.

Section Names

In most cases, you can name a section whatever makes sense to you. For example you might name a transport [transport-udp-nat] to help you remember how that section is being used.

...

There are dozens of config options for some of the sections, but the examples below are very minimal for the sake of simplicity.

...

titleOption Values and Defaults

How do I know what values I can use for an option? Use the built-in configuration help at the CLI or view the wiki section listing all config option help text. You can use "config show help res_pjsip <configobject> <configoption>" to get help on a particular option. The output will typically describe the default value for an option as well. Link to list of config options goes here, once we have them pulled onto the wiki

...

 

ENDPOINT

(provided by module: res_pjsip)

...

The contact config object effectively acts as an alias for a SIP URIs and holds information about an inbound registrations. Contact objects can be associated with an individual SIP User Agent and contain a few config options related to the connection. Contacts are created automatically upon registration to an AOR, or can be created manually by using the "contact=" config option in an AOR section. Manually configuring a CONTACT config object itself is outside the scope of this "getting started" style document.

Config Section Help and Defaults

Once we have the XML configuration help pulled onto the wiki we'll put a link here to that wiki section.

In the meantime use the built-in configuration help to your advantage. You can use "config show help res_pjsip <configobject> <configoption>" to get help on a particular option. That help will typically describe the default value for an option as well. 

Relationships of Configuration Objects in pjsip.conf

...