ZIM-SMS

Overview

ZIM-SMS is an Asterisk application that allows SMS to be sent from a dialplan as well as voicemail notifications based on information available in voicemail.conf. The application communicates with ZIM using XML-POST and is distributed under GPL as a source code with detailed instructions. Please note, that you will need an account with ZIM to use their service. During the initial, test phase, only Canadian destinations will be covered.

Download

Image
zim-sms-asterisk-1.1.4.tar.gz or Download from the original repository

Functionality

The application ZIM-SMS provides basic and advanced functionality:

Basic mode


The application is accessible from a dialplan with 2 mandatory (recipients sms number; message body) and 1 optional (subject) arguments.
The sample is shown below:

exten => s,1,ZIM-SMS(16132618298|Hello World)
or
exten => s,1,ZIM-SMS(16132618298|Hello World|My Subject:)

Please note if the subject is not provided through a dialplan, ZIM-SMS will check the zim-sms.conf file and use default subject, if available.


The parameters supplied to the application are as follows:

Destination Number(Required):
The mobile number to which the SMS message should be sent. The number should be presented in the international format without the + sign; ie: 16132618288 or 4822608123456

Message Body (Required):
The body of the SMS to be sent. Please note that body + subject should not exceed 160 characters, as per SMS standard.

Message Subject (Optional):
The subject of the SMS to be sent. This is optional, if not available, appliaction will parse zim-sms.conf file and use the default subject, if defined.

Please note that "|" should be used to separate arguments.

Advanced mode


The application provides basic functionality detailed above plus integrated voicemail notification.
In the voicemail.conf file, SMS number could be provided instead of email-> pager address. If provided, Asterisk will send a message through ZIM, if standard e-mail address is used, then standard method will be executed.

Example of voicemail notification

 [default]
 100 => 1010,Traditional user,user1@blah.com,pager1@blah.com	    ; VM notification will be EMAILED to pager1@blah.com
 101 => 1010,ZIM-SMS user,user2@blah.com,16132612888		    ; VM notification will be sent to 16132612888 using ZIM
 102 => 1010,User without SMS,user3@blah.com				    ; No VM notification will be sent

Please contact zim@ZIM.biz to obtain account information for sending SMS through ZIM.

Installation

Pre-requisites



  • Asterisk installed and configured.
  • Access to the Internet, at least port 80, TCP.
  • Account (could be demo) with ZIM.biz

Actual installation:


Due to some differences in Asterisk's API there are two versions of ZIM-SMS provided:
  • ast-zim-sms-1.0.x.tar.gz for Asterisk 1.0.x installations
  • ast-zim-sms-1.2.x.tar.gz for Astersik 1.2.x installations

Unpack the appropriate package.

For basic installation (dialplan application only):

1. copy zim-sms.h to <your asterisk folder>/include/asterisk/

2. copy Makefile.patch and app_zim_sms.c to <your asterisk folder>/apps/

3. go to <your asterisk folder>/apps/ and apply the patch to add compile statements to your Makefile:
patch -p0 < Makefile.patch

4. Recompile and reinstall new version of Asterisk

5. Copy zim-sms.conf into /etc/asterisk and populate it with account information obtained from ZIM.biz

6. Start/Restart Asterisk and confirm that your application has registered by typing on the command line:
"show application ZIM-SMS"

You are now ready to use the application.

Voicemail integration


1. Complete step 1-3 from basic installation steps above

2. copy app_voicemail.c.patch to <your asterisk folder>/apps/

3. go to <your asterisk folder>/apps/ and apply the patch to enable ZIM paging in voicemail application
patch -p0 < app_voicemail.c.patch

4. Recompile and reinstall new version of Asterisk

5. Copy zim-sms.conf into /etc/asterisk and populate it with account information obtained from ZIM.biz

6. Copy modules.conf.patch into /etc/asterisk

7. Apply the patch to modules.conf by going to /etc/asterisk and executing:
patch -p0 < modules.conf.patch

8. Start/Restart Asterisk and confirm that your application has registered by typing on the command line:
"show application ZIM-SMS"

Please noty that we strongly recommend to make copies of files to be patched before executing steps from above:
<asterisk path>/apps/Makefile
<asterisk path>/apps/app_voicemail.c
/etc/asterisk/modules.conf

========================

Sample zim-sms.conf


 ;SMS Application to interface with ZIM.BIZ
 [general]
 ;
 ; Account parameters
 ; These parameters are provided by ZIM
 ;
 code=Your code obtained from ZIM
 key=Your key obtained from ZIM
 subject=


See Also:

Overview

ZIM-SMS is an Asterisk application that allows SMS to be sent from a dialplan as well as voicemail notifications based on information available in voicemail.conf. The application communicates with ZIM using XML-POST and is distributed under GPL as a source code with detailed instructions. Please note, that you will need an account with ZIM to use their service. During the initial, test phase, only Canadian destinations will be covered.

Download

Image
zim-sms-asterisk-1.1.4.tar.gz or Download from the original repository

Functionality

The application ZIM-SMS provides basic and advanced functionality:

Basic mode


The application is accessible from a dialplan with 2 mandatory (recipients sms number; message body) and 1 optional (subject) arguments.
The sample is shown below:

exten => s,1,ZIM-SMS(16132618298|Hello World)
or
exten => s,1,ZIM-SMS(16132618298|Hello World|My Subject:)

Please note if the subject is not provided through a dialplan, ZIM-SMS will check the zim-sms.conf file and use default subject, if available.


The parameters supplied to the application are as follows:

Destination Number(Required):
The mobile number to which the SMS message should be sent. The number should be presented in the international format without the + sign; ie: 16132618288 or 4822608123456

Message Body (Required):
The body of the SMS to be sent. Please note that body + subject should not exceed 160 characters, as per SMS standard.

Message Subject (Optional):
The subject of the SMS to be sent. This is optional, if not available, appliaction will parse zim-sms.conf file and use the default subject, if defined.

Please note that "|" should be used to separate arguments.

Advanced mode


The application provides basic functionality detailed above plus integrated voicemail notification.
In the voicemail.conf file, SMS number could be provided instead of email-> pager address. If provided, Asterisk will send a message through ZIM, if standard e-mail address is used, then standard method will be executed.

Example of voicemail notification

 [default]
 100 => 1010,Traditional user,user1@blah.com,pager1@blah.com	    ; VM notification will be EMAILED to pager1@blah.com
 101 => 1010,ZIM-SMS user,user2@blah.com,16132612888		    ; VM notification will be sent to 16132612888 using ZIM
 102 => 1010,User without SMS,user3@blah.com				    ; No VM notification will be sent

Please contact zim@ZIM.biz to obtain account information for sending SMS through ZIM.

Installation

Pre-requisites



  • Asterisk installed and configured.
  • Access to the Internet, at least port 80, TCP.
  • Account (could be demo) with ZIM.biz

Actual installation:


Due to some differences in Asterisk's API there are two versions of ZIM-SMS provided:
  • ast-zim-sms-1.0.x.tar.gz for Asterisk 1.0.x installations
  • ast-zim-sms-1.2.x.tar.gz for Astersik 1.2.x installations

Unpack the appropriate package.

For basic installation (dialplan application only):

1. copy zim-sms.h to <your asterisk folder>/include/asterisk/

2. copy Makefile.patch and app_zim_sms.c to <your asterisk folder>/apps/

3. go to <your asterisk folder>/apps/ and apply the patch to add compile statements to your Makefile:
patch -p0 < Makefile.patch

4. Recompile and reinstall new version of Asterisk

5. Copy zim-sms.conf into /etc/asterisk and populate it with account information obtained from ZIM.biz

6. Start/Restart Asterisk and confirm that your application has registered by typing on the command line:
"show application ZIM-SMS"

You are now ready to use the application.

Voicemail integration


1. Complete step 1-3 from basic installation steps above

2. copy app_voicemail.c.patch to <your asterisk folder>/apps/

3. go to <your asterisk folder>/apps/ and apply the patch to enable ZIM paging in voicemail application
patch -p0 < app_voicemail.c.patch

4. Recompile and reinstall new version of Asterisk

5. Copy zim-sms.conf into /etc/asterisk and populate it with account information obtained from ZIM.biz

6. Copy modules.conf.patch into /etc/asterisk

7. Apply the patch to modules.conf by going to /etc/asterisk and executing:
patch -p0 < modules.conf.patch

8. Start/Restart Asterisk and confirm that your application has registered by typing on the command line:
"show application ZIM-SMS"

Please noty that we strongly recommend to make copies of files to be patched before executing steps from above:
<asterisk path>/apps/Makefile
<asterisk path>/apps/app_voicemail.c
/etc/asterisk/modules.conf

========================

Sample zim-sms.conf


 ;SMS Application to interface with ZIM.BIZ
 [general]
 ;
 ; Account parameters
 ; These parameters are provided by ZIM
 ;
 code=Your code obtained from ZIM
 key=Your key obtained from ZIM
 subject=


See Also:

Created by: virterm, Last modification: Sun 06 of Apr, 2014 (23:20 UTC) by admin
Please update this page with new information, just login and click on the "Edit" or "Discussion" tab. Get a free login here: Register Thanks! - Find us on Google+