TUTORIAL Updated SCCP Tutorial for Asterisk 11 and 13

rjaiswal · Jul 31, 2013

NOTE: These instructions have been updated to support Asterisk 13. Current as of Sep. 6, 2015.

Earlier today, I posted instructions on how I got Exchange 2013 UM to talk with PiaF. Now, I'm going to post instructions on how I was able to add SCCP to my PiaF install, so I could use the native protocol for the Cisco 79xx series of phones.

These instructions allowed me to get SCCP running on PiaF installs that I've setup in the past. I like using SCCP, because I can get the cisco phones for dirt cheap on ebay and craigslist. I tell clients, who need a phone system, but can't afford new hardware what I plan on doing. Most will take the gamble of using used equipment, some don't. You can still buy new SCCP phones from cisco resellers.

Also, I've spent the last 2 years subscribed to the Chan-SCCP-B mailing list. Diederick and Marcello are AWESOME! They are very responsive to questions regarding SCCP and will quickly respond to bug issues. If you want to deploy SCCP in a commercial environment, I HIGHLY recommend joining the mailing list.

1. Download and untar the latest stable release of Chan SCCP-B. Current link is for latest 4.2 stable release. Please check the Chan SCCP-B website for the latest version.

Code:

cd /usr/src
wget -O Chan_SCCP-V4.2_STABLE.tar.gz http://sourceforge.net/projects/chan-sccp-b/files/V4/Chan_SCCP-v4.2_STABLE_r6168.tar.gz/download
tar -zxvf Chan*

2. Once untarred, you have to cd into the newly created directory and compile and install the SCCP source code:

Code:

cd Chan*
./configure --enable-debug --enable-conference --disable-optimization
make && make install

3. Open TCP port 2000 in IPtables to allow communication between asterisk and phones running SCCP (NOTE: One of these commands will give an error depending upon your OS. Ignore it.):

Code:

sed -i '/9080/a \-A INPUT \-p tcp \-m tcp \-\-dport 2000 \-j ACCEPT' /etc/iptables/rules.v4
sed -i '/9080/a \-A INPUT \-p tcp \-m tcp \-\-dport 2000 \-j ACCEPT' /etc/sysconfig/iptables
iptables-restart

4. Adjust /etc/asterisk/modules.conf to support SCCP:

Code:

echo "noload = chan_skinny.so" >> /etc/asterisk/modules.conf

5. Restart Asterisk to load the SCCP module: amportal restart

You have to add extensions in Freepbx, as well, as SCCP. They need to be the same. Freepbx will generate the dialplan, while SCCP will use the extension list to map extensions to handsets. When creating the extensions in Freepbx, you'll select "other (custom) device", instead of generic sip.

In the add extensions screen, use "SCCP/(ext. number)" as the dial string. Everything else in the add extensions screen can be modified to suit your installation.

For SCCP paging, Diederick created a macro that works pretty well. This was copied from the Chan-SCCP-B mailing list. Credit goes to Diederick for creating the script, and Bob for testing:

I added the following to extensions_custom.conf: (macro by Diederick)
;sof
[macro-2way-paging]
exten => s,1(check),ChanIsAvail(SCCP/${ARG1},sj)
exten => s,n,Dial(SCCP/${ARG1}/aa=2wb,5,A(beep))
exten => s,n(end),Busy(20)
exten => s,n,Macro(hangupcall,)
exten => s,check+101,Busy(20)
exten => s,n,Macro(hangupcall,)
;eof

Ran cli command
CLI> dialplan reload

I used the this to add the extensions to the db:
pbx1*CLI> database put DEVICE/4032/autoanswer macro 2way-paging
Updated database successfully
pbx1*CLI> database put DEVICE/4074/autoanswer macro 2way-paging
Updated database successfully

Step by step instructions:

1. Configure your paging group 9001 in FreePBX

- add a single phone to test with and add as system resources
allow - paging is VERY system resource intense so paging 100 phones all
at once can have bad results.

2. Add the following to /etc/asterisk/extensions_custom.conf:

[macro-1way-paging]

exten => s,1(check),ChanIsAvail(SCCP/${ARG1},sj)

exten => s,n,Dial(SCCP/${ARG1}/aa=1wb,5,A(beep))

exten => s,n(end),Busy(20)

exten => s,n,Macro(hangupcall,)

exten => s,check+101,Busy(20)

exten => s,n,Macro(hangupcall,)

In CLI... add the paging group in the database:

database put DEVICE/9100/autoanswer macro 1way-paging

To remove the paging group in the database:

database del DEVICE/9100/autoanswer macro

If you want 2 way paging use: (not suggested for multiple phones)

[macro-2way-paging]

exten => s,1(check),ChanIsAvail(SCCP/${ARG1},sj)

exten => s,n,Dial(SCCP/${ARG1}/aa=2wb,5,A(beep))

exten => s,n(end),Busy(20)

exten => s,n,Macro(hangupcall,)

exten => s,check+101,Busy(20)

exten => s,n,Macro(hangupcall,)

In CLI... add the paging group in the database:

database put DEVICE/9100/autoanswer macro 2way-paging

To remove the paging group in the database:

database del DEVICE/9100/autoanswer macro

rjaiswal · Jul 31, 2013

And here is my SCCP.conf

Code:

;=========================================================================================
;
; general definitions
;
;=========================================================================================
[general]
servername = FreePbxSCCP
keepalive = 60
debug = 1
context = from-internal-xfer
dateformat = M.D.YA
bindaddr = 0.0.0.0
port = 2000
disallow=all
allow=alaw
allow=ulaw
firstdigittimeout = 16
digittimeout = 2
autoanswer_ring_time = 1
autoanswer_tone = 0x32
remotehangup_tone = 0x32
transfer_tone = 0
callwaiting_tone = 0x2d
musicclass=default
language=en
deny=0.0.0.0/0.0.0.0
permit=192.168.15.0/255.255.255.0
dnd = on
sccp_tos = 0x68
sccp_cos = 4
audio_tos = 0xB8
audio_cos = 6
video_tos = 0x88
video_cos = 5
echocancel = on
silencesuppression = off
private = on
callanswerorder=oldestfirst
hotline_enabled=yes                    ;can devices without configuration register
hotline_context=default                    ; context for hotline
hotline_extension=250                    ; extension will be dialed on offHook
 
;=========================================================================================
;
; include files
;
;=========================================================================================
#include sccp_hardware.conf
#include sccp_extensions.conf

rjaiswal · Jul 31, 2013

sccp_hardware.conf

Code:

[SEPEC44761E0A55]
description = 3rd Fl. Bedroom
addon =
devicetype = 7942
park = on
button = line, 216                    ; Assign Line 98011 to Device
;button = line, empty                    ; Assign an Empty Line
;button = line, 98012                    ; Assign Line 98012 to Device
button = speeddial,Page All, 300, 300@hints    ; Add SpeedDial to Phone Number button = speeddial,Helpdesk, 98112, 98112@hints      ; Add SpeedDial to Helpdesk Two Line 1
cfwdall = off
type = device
keepalive = 60
;tzoffset = +2
transfer = on
park = on
cfwdall = off
cfwdbusy = off
cfwdnoanswer = off
directed_pickup = on
directed_pickup_context = from-internal-xfer
directed_pickup_modeanswer = on
dtmfmode = inband
imageversion = P00405000700
deny=0.0.0.0/0.0.0.0
permit=192.168.15.0/255.255.255.0
dndFeature = on
nat=off
directrtp=off
earlyrtp = progress
private = on
mwilamp = on
mwioncall = off
setvar=testvar=value
cfwdall = on
 
[SEP001818C87DBE]
description = Home Office
addon =
devicetype = 7960
park = on
button = line, 250                    ; Assign Line 98011 to Device
button = line, empty                    ; Assign an Empty Line
button = line, empty                    ; Assign an Empty Line
button = line, empty                    ; Assign an Empty Line
;button = line, 98012                    ; Assign Line 98012 to Device
button = speeddial,Page All, 300, 300@hints    ; Add SpeedDial to Phone Number button = speeddial,Helpdesk, 98112, 98112@hints      ; Add SpeedDial to Helpdesk Two Line 1
cfwdall = off
type = device
keepalive = 60
;tzoffset = +2
transfer = on
park = on
cfwdall = off
cfwdbusy = off
cfwdnoanswer = off
directed_pickup = on
directed_pickup_context = from-internal-xfer
directed_pickup_modeanswer = on
dtmfmode = inband
imageversion = P00405000700
deny=0.0.0.0/0.0.0.0
permit=192.168.15.0/255.255.255.0
dndFeature = on
nat=off
directrtp=off
earlyrtp = progress
private = on
mwilamp = on
mwioncall = off
setvar=testvar=value
cfwdall = on
 
[SEP0023049A0BE6]
description = Equipment Room
addon =
devicetype = 7960
park = on
button = line, 218                    ; Assign Line 98011 to Device
button = line, empty                    ; Assign an Empty Line
button = line, empty                    ; Assign an Empty Line
button = line, empty                    ; Assign an Empty Line
;button = line, 98012                    ; Assign Line 98012 to Device
button = speeddial,Page All, 300, 300@hints    ; Add SpeedDial to Phone Number button = speeddial,Helpdesk, 98112, 98112@hints      ; Add SpeedDial to Helpdesk Two Line 1
cfwdall = off
type = device
keepalive = 60
;tzoffset = +2
transfer = on
park = on
cfwdall = off
cfwdbusy = off
cfwdnoanswer = off
directed_pickup = on
directed_pickup_context = from-internal-xfer
directed_pickup_modeanswer = on
dtmfmode = inband
imageversion = P00405000700
deny=0.0.0.0/0.0.0.0
permit=192.168.15.0/255.255.255.0
dndFeature = on
nat=off
directrtp=off
earlyrtp = progress
private = on
mwilamp = on
mwioncall = off
setvar=testvar=value
cfwdall = on
 
[SEP001562289B4E]
description = Laundry
addon =
devicetype = 7940
park = on
button = line, 217                    ; Assign Line 98011 to Device
;button = line, 98012                    ; Assign Line 98012 to Device
button = speeddial,Page All, 300, 300@hints    ; Add SpeedDial to Phone Number button = speeddial,Helpdesk, 98112, 98112@hints      ; Add SpeedDial to Helpdesk Two Line 1
cfwdall = off
type = device
keepalive = 60
;tzoffset = +2
transfer = on
park = on
cfwdall = off
cfwdbusy = off
cfwdnoanswer = off
directed_pickup = on
directed_pickup_context = from-internal-xfer
directed_pickup_modeanswer = on
dtmfmode = inband
imageversion = P00405000700
deny=0.0.0.0/0.0.0.0
permit=192.168.15.0/255.255.255.0
dndFeature = on
nat=off
directrtp=off
earlyrtp = progress
private = on
mwilamp = on
mwioncall = off
setvar=testvar=value
cfwdall = on

sccp_extensions.conf:

Code:

[216]
id = 1000
type = line
pin = 1234
label = 3rd Fl. Bedroom
description = Line 216
mailbox = 216
cid_name = 3rd Fl. Bedroom
cid_num = 216
accountcode=
callgroup=
pickupgroup=
;amaflags =
context = from-internal
incominglimit = 2
transfer = on
vmnum = *97
meetme = on
meetmeopts = qxd
meetmenum = 500
trnsfvm = *98
secondary_dialtone_digits = 9
secondary_dialtone_tone = 0x22
musicclass=default
language=en
echocancel = on
silencesuppression = off
setvar=testvar2=my value
dnd = on
 
[217]
id = 1001
type = line
pin = 1234
label = Laundry
description = Line 217
mailbox = 217
cid_name = Laundry
cid_num = 217
accountcode=
callgroup=
pickupgroup=
;amaflags =
context = from-internal
incominglimit = 2
transfer = on
vmnum = *97
meetme = on
meetmeopts = qxd
meetmenum = 500
trnsfvm = *98
secondary_dialtone_digits = 9
secondary_dialtone_tone = 0x22
musicclass=default
language=en
echocancel = on
silencesuppression = off
setvar=testvar2=my value
dnd = on
 
[218]
id = 1002
type = line
pin = 1234
label = Equipment Room
description = Line 218
mailbox = 218
cid_name = Equipment Room
cid_num = 218
accountcode=
callgroup=
pickupgroup=
;amaflags =
context = from-internal
incominglimit = 2
transfer = on
vmnum = *97
meetme = on
meetmeopts = qxd
meetmenum = 500
trnsfvm = *98
secondary_dialtone_digits = 9
secondary_dialtone_tone = 0x22
musicclass=default
language=en
echocancel = on
silencesuppression = off
setvar=testvar2=my value
dnd = on
 
[250]
id = 1003
type = line
pin = 1234
label = Home Office
description = Line 250
mailbox = 250
cid_name = Home Office
cid_num = 250
accountcode=
callgroup=
pickupgroup=
;amaflags =
context = from-internal
incominglimit = 2
transfer = on
vmnum = *97
meetme = on
meetmeopts = qxd
meetmenum = 500
trnsfvm = *98
secondary_dialtone_digits = 9
secondary_dialtone_tone = 0x22
musicclass=default
language=en
echocancel = on
silencesuppression = off
setvar=testvar2=my value
dnd = on

XMLDefault.cnf.xml:

Code:

<Default>
<callManagerGroup>
<members>
<member priority=”0″>
<callManager>
<ports>
<ethernetPhonePort>2000</ethernetPhonePort>
<mgcpPorts>
<listen>2427</listen>
<keepAlive>2428</keepAlive>
</mgcpPorts>
</ports>
<processNodeName></processNodeName>
</callManager>
</member>
</members>
</callManagerGroup>
<loadInformation>P0030801SR02</loadInformation>
<authenticationURL></authenticationURL>
<directoryURL>http://192.168.15.10/openxml/PhoneUI</directoryURL>
<idleURL></idleURL>
<informationURL></informationURL>
<messagesURL></messagesURL>
<servicesURL></servicesURL>
</Default>

7940/60 xml:

Code:

<device>
<devicePool>
<callManagerGroup>
<members>
<member priority="0">
<callManager>
<ports>
<ethernetPhonePort>2000</ethernetPhonePort>
</ports>
<processNodeName>192.168.15.10</processNodeName>
</callManager>
</member>
</members>
</callManagerGroup>
</devicePool>
<versionStamp>{May 18 2005 02:22:00}</versionStamp>
<loadInformation></loadInformation>
<userLocale>
<name>United_States</name>
<langCode>en</langCode>
</userLocale>
<networkLocale>United_States</networkLocale>
<idleTimeout>0</idleTimeout>
<authenticationURL></authenticationURL>
<directoryURL>http://192.168.15.10/extensions.xml</directoryURL>
<idleURL></idleURL>
<informationURL></informationURL>
<messagesURL></messagesURL>
<proxyServerURL></proxyServerURL>
<servicesURL></servicesURL>
</device>

xml for Java based phones:

Code:

<?xml version="1.0" ?>
<device>
<devicePool>
  <dateTimeSetting>
      <dateTemplate>M-D-YA</dateTemplate>
      <timeZone>Eastern Standard/Daylight Time</timeZone>
      <ntps>
        <ntp>
          <name>192.168.15.10</name>
          <ntpMode>Unicast</ntpMode>
        </ntp>
      </ntps>
    </dateTimeSetting>
  <callManagerGroup>
  <members>
    <member  priority="0">
    <callManager>
      <ports>
      <ethernetPhonePort>2000</ethernetPhonePort>
      </ports>
      <processNodeName>192.168.15.10</processNodeName>
    </callManager>
    </member>
  </members>
  </callManagerGroup>
</devicePool>
<versionStamp>{Jan 01 2002 00:00:00}</versionStamp>
<loadInformation>SCCP42.9-3-1SR1-1S</loadInformation>
<userLocale>
  <name>English_United_States</name>
  <langCode>en</langCode>
</userLocale>
<networkLocale>United_States</networkLocale>
<idleTimeout>0</idleTimeout>
<authenticationURL></authenticationURL>
<directoryURL>http://192.168.15.10/extensions.xml</directoryURL>
<idleURL></idleURL>
<informationURL></informationURL>
<messagesURL></messagesURL>
<proxyServerURL></proxyServerURL>
<servicesURL>http://192.168.15.10/openxml/PhoneUI</servicesURL>
</device>

Now I'm still working on getting the external directory up and running. Once I have that working, I'll post instructions on how I did it.

Please keep in mind, that I have to work for a living. I will try to look at the thread once a day to answer any questions. Please be patient.

thanks,

Riten

tm1000 · Jul 31, 2013

While I agree that SCCP is the way to go with cisco phones (because their implementation of SIP is horrible). I simply do not agree with modifying freepbx code without ever having posted a feature request! Come on guys!

rjaiswal · Jul 31, 2013

tm1000 said:
While I agree that SCCP is the way to go with cisco phones (because their implementation of SIP is horrible). I simply do not agree with modifying freepbx code without ever having posted a feature request! Come on guys!

Will post a feature request. All I really wanted was the ability to see sccp as an option when creating an extension. How would I phrase that as a feature request?

**edit**
Feature request created. I had no idea how easy it was! Sorry about the modification... I thought it would be easier than selecting custom device, and then under device option, entering the dial string SCCP/"ext" number...

phoneguy · Jul 31, 2013

The reason FreePBX does not support skinny is its a Cisco format and not GPL compliant. Its why neither chan_skinny nor chan_sccp are included in Asterisk by default. Cisco requires a license agreement for this from what we have been informed in the past so doing this is all on your own peril and pocket book.

rjaiswal · Aug 1, 2013

phoneguy said:
The reason FreePBX does not support skinny is its a Cisco format and not GPL compliant. Its why neither chan_skinny nor chan_sccp are included in Asterisk by default. Cisco requires a license agreement for this from what we have been informed in the past so doing this is all on your own peril and pocket book.

I thought when you bought the phone, the client license came with it...

tm1000 · Aug 1, 2013

No you as the end user have to buy a license from cisco but you do not obtain it from them when you buy a phone and that still doesnt solve the legal delima from software developers such as asterisk and freepbx

rjaiswal said:
I thought when you bought the phone, the client license came with it...

briankelly63 · Aug 1, 2013

phoneguy said:
The reason FreePBX does not support skinny is its a Cisco format and not GPL compliant. Its why neither chan_skinny nor chan_sccp are included in Asterisk by default. Cisco requires a license agreement for this from what we have been informed in the past so doing this is all on your own peril and pocket book.

I wonder if, from a non-developer perspective, whether such a license can actually be obtained and how much would it cost? I thinking in terms of a single site.

tm1000 · Aug 1, 2013

It's $15 dollars per phone. Pretty cheap. That's end user only. Not developers or companies developing or supporting software

briankelly63 said:
I wonder if, from a non-developer perspective, whether such a license can actually be obtained and how much would it cost? I thinking in terms of a single site.

Jake · Aug 2, 2013

Nice write up! Thanks for sharing!

briankelly63 · Aug 2, 2013

tm1000 said:
It's $15 dollars per phone. Pretty cheap. That's end user only. Not developers or companies developing or supporting software

Thanks for the info... That is cheap. Nice to know its an option in certain situations.

phoneguy · Aug 2, 2013

Guys

That license is not for the rights to run SCCP on a PBX. Its to move your phone to a non Cisco system that is licensed for SCCP. At least that is what we have been told from people with knowledge of the Cisco SCCP license structure and why Cisco came out with the SPA line of phones to use where SCCP is not used.

briankelly63 · Aug 3, 2013

Perhaps someone on the thread who has the most knowledge of Cisco and SCCP could reach out to Cisco to get clarification, a letter or a reference in and existing document that would have the most up to date information. There's no reason for us to speculate or perhaps be dealing with outdated information. I'd call them but I don't use their equipment so it be difficult to have a conversation with them.

tm1000 · Aug 3, 2013

I doubt they would waste their time. "phoneguy" is Tony Lewis. Owner of Schmoozecom. He's had his lawyers look into this four years ago so it's not "speculation"

briankelly63 said:
Perhaps someone on the thread who has the most knowledge of Cisco and SCCP could reach out to Cisco to get clarification, a letter or a reference in and existing document that would have the most up to date information. There's no reason for us to speculate or perhaps be dealing with outdated information. I'd call them but I don't use their equipment so it be difficult to have a conversation with them.

rjaiswal · Aug 3, 2013

I did speak with my cisco reseller. He's going to look into this and get back to me. When I was buying new sccp phones, he was charging me the $15 license fee. It was a separate line item that I didn't really pay attention too.

rjaiswal · Aug 6, 2013

Just heard back from my distributor. He spoke to his cisco rep, and found out that the license he was selling would not work for asterisk running sccp...

Oh well, it looks like I won't be setting any new systems up like this.

Thank you to tm1000 and phoneguy for the new knowledge. You learn something new everyday.

Jake · Aug 20, 2013

I've been working on a SCCP setup for a while and now I've tried to add some 7960 to the mix and have had some trouble getting them to register. I know they are older phones and should have a different config file so I just wanted to make sure I understand your instructions.

Do I need to include the mac address of each of the 7960 phones in separate file names i.e. "SEP00MACADDRESS.conf.xml" or will the "XMLdefault.cnf.xml" work?

Also, what is the Java based XML? I assume it is for the 7961's and newer phones? Should it be in the "SEP00MACADDRESS.conf.xml" file name format?

You also include the universal "XMLdefault.cnf.xml." Do I need all three of these config files (or more if I need to include each mac address as a separate file) in my t*f*t*p folder? I was under the impression that only the default xml config file was needed.

Lastly, I noticed in your "XMLdefault.cnf.xml" file does not have an ip address in the "<processNodeName></processNodeName>" line which I thought needed to contain the ip address of the Asterisk box.

I hope my question is clear enough.

Jake

rjaiswal · Aug 20, 2013

Jake said:
I've been working on a SCCP setup for a while and now I've tried to add some 7960 to the mix and have had some trouble getting them to register. I know they are older phones and should have a different config file so I just wanted to make sure I understand your instructions.

Do I need to include the mac address of each of the 7960 phones in separate file names i.e. "SEP00MACADDRESS.conf.xml" or will the "XMLdefault.cnf.xml" work?

Also, what is the Java based XML? I assume it is for the 7961's and newer phones? Should it be in the "SEP00MACADDRESS.conf.xml" file name format?

You also include the universal "XMLdefault.cnf.xml." Do I need all three of these config files (or more if I need to include each mac address as a separate file) in my t*f*t*p folder? I was under the impression that only the default xml config file was needed.

Lastly, I noticed in your "XMLdefault.cnf.xml" file does not have an ip address in the "<processNodeName></processNodeName>" line which I thought needed to contain the ip address of the Asterisk box.

I hope my question is clear enough.

Jake

Hi Jake,

Yup, you need a separate SEP(MAC address).cnf.xml for each phone. The older phones will not register without this xml file. Also, if you notice, in the 7940/60 XML, the process node field is filled out there.

Also, some phones, won't upgrade their firmware by just looking at the XMLdefault.cnf.xml. The new firmware needs to be explicitly defined in the SEP(MAC address).cnf.xml file.

The newer Java based phones (ie. 7941+) phones are much more forgiving, if there are missing config files...

Jake · Aug 21, 2013

One other quick question that is more of a linux question. I originally loaded Chan-SCCP-B 4.1 when it was a release candidate and now I'd like to update to the stable release. I've tried to install the stable release but I still show, in my Asterisk CLI issuing the command "sccp show version", that it is the RC version and the date I first installed it. I've reload and restarted to no avail. I've looked around the mailing list but haven't seen any instructions. What am I missing?

TUTORIAL Updated SCCP Tutorial for Asterisk 11 and 13

Active Member

Active Member

Active Member

Schmoozecom INC/FreePBX

Active Member

Guru

Active Member

Schmoozecom INC/FreePBX

Guru

Schmoozecom INC/FreePBX

Active Member

Guru

Guru

Guru

Schmoozecom INC/FreePBX

Active Member

Active Member

Active Member

Active Member

Active Member

Forum statistics