Home | Manufacturers and Developers | Engineers | Forum

A free, simple, easy-to-implement, standards-based,
feature-rich dialtone for your SIP hardware or softphone...

Plug-n-Dial

Engineers Testing or Implementing Plug-N-Dial

The APS Configuration File

The SIP configuration file retrieved from the APS server should contain only SIP centric/specific data. Local network settings and firmware-specific data are not included. For example information such as "dial plans" or "ring tones" or "use dynamic ip address" or "use static address" et cetra are network/device specific configuration and must be omitted from the configuration file.

A field value in the configuration may be left as NULL (or null). This must be interpreted as do not overwrite existing value. That is it must not be taken literally. A null value means "do not overwrite this value" as opposed to "set this value to null".


Following is a sample SIP configuration file from the APS server.



PND Configuration fields (with sample values)

# SIP Configuration File, Plug'n'Dial APS v1.2

# The MAC ID of the SIP device you are testing.

mac=000b820c2371

# FQDN of the server that handles SIP session negotiation. Plug'n'Dial partners should use proxy01.sipphone.com.

sip_server=proxy01.sipphone.com

# SIP Domain of this account.

sip_domain=northamerica.sipphone.com

# The port on which the SIP Server listens. Value must be a positive integer. Plug'n'Dial partners should use 5060.

sip_server_port=5060

# FQDN of the proxy server, if any, to which all outgoing requests from the SIP device will be routed.
# By default SIPphone does not require an outbound proxy. Should the user be behind a symmetric NAT then
# this value should be set to the value of sip_server and sip_server_port

outboundproxy=null
outboundproxy_port=null

# The "user" part of the SIP address associated with the SIP device, e.g. the "xxx" in
# "sip:xxx@proxy01.sipphone.com".

userid=17475551212

# The login ID used to authenticate a user with the SIP server. Not currently used by SIPphone.com.
authenticateid=17475551212

# The password used in conjunction with User ID (or Authenticate ID) to authenticate a user with the SIP Server.

password=mypassword

# 1st, 2nd, 3rd ... 6th choice of codec for voice encoding: G711a, G711u, G723, G726-16, iLBC, etc.

codec1=G711u
codec2=G711a
codec3=G723
codec4=G729a
codec5=G729b
codec6=G726-32

# Number of voice frames per packet to be transmitted by SIP device when Codec 1 .. 6 is in use. Value must be a positive integer.

codec1_voice_frames_per_tx=10
codec2_voice_frames_per_tx=10
codec3_voice_frames_per_tx=30
codec4_voice_frames_per_tx=20
codec5_voice_frames_per_tx=20
codec6_voice_frames_per_tx=20

# Used to enable/disable the silence suppression feature of G73 and G729 codecs. Set to 'yes' or 'no'.

silence_suppression=no

# Layer 3 QoS parameter used for IP Precedence, Diff-Serv, or MPLS. See RFC 2330 for possible values.

ipqos=48

# Layer 2 VLAN tag value.

vlantag=0

# Frequency (in minutes) at which SIP device will refresh it's registration with the SIP Server. Value must be a positive integer.

registration_expiration=10

# The port on which the SIP device will listen and transmit. Value must be a positive integer.

local_sip_port=5060

# The base RTP port for RTP-RTCP port pair. Value must be a positive integer.

local_rtp_port=5004

# Tells SIP device whether to randomly generate local SIP and RTP port numbers. Usually necessary when multiple SIP devices are behind the same NAT. Set to 'yes' or 'no'.

use_random_rtp_port=no

# FQDN of STUN server/port for NAT Traversal.

stun_server=stun01.sipphone.com
stun_server_port=3478

# FQDN of TFTP Server/Port from which device will retrieve new SIP configuration and/or firmware at boot time.

tftp_server=aps.plugndial.com
tftp_server_port=69

# The method by which the device sends DTMF events:
# in audio, via RTP in accordance with RFC 2833, or via SIP INFO.
# Possible values are 'in_audio', 'rfc2833', and 'sip_info'.

send_dtmf=in_audio

# This field is relevant if the Send DTMF field is set to rfc2833. See RFC 2833 for possible values.

dtmf_payload_type=101

# FQDN Network Time Protocol server that the device will use to diplay current date/time.

ntp_server=ntp01.sipphone.com

# Time zone relative to GMT of region in which device will be used. Used to adjust the date/time from NTP server for display purposes. Format as +HH:MM or -HH:MM.

time_zone=+08:00

Home | Manufacturers and Developers | Engineers | Forum