SMS HTTP API is the main place where the SMS HTTP API has to be configured.  You can get the SMS HTTP API from your SMS gate way provider.

For example, the SMSCGATEWAY API would be like the following



Each SMS gateway has its own HTTP API.  You need to configure the API based on the gateway parameters.

The clickatell is having the following format.



Remember: JEEMA SMS Component will work only on the HTTP SMS API.

If you have any doubts/problem on how to configure the HTTP SMS API, please contact This e-mail address is being protected from spambots. You need JavaScript enabled to view it .  We will help you.  You can also click on the below link to see a list of pre-defined API settings
http://www.forum.jeema.net/forum/54-api-and-success-pattern.html

The following screen explains how to configure the SMSCGATEWAY in SMS HTTP API.



This API has to be configured in SMS HTTP API.

Field Definitions:
SMS HTTP API Name – It can be anything for your reference.

URL Prefix – Enter the exact URL prefix.  In our example, the URL would be “http://smscgateway.com/messageapi.asp”

Username Variable – Give the URL user variable that stores the user name.  In our example, the URL user variable would be “username”

Username Value – Give the actual value for the URL user variable.  This is the actual username which provided by your SMS gate way provider.  In our example, the value would be “myusername”

Password Variable – Give the URL password variable that stores the password name.  In our example, the URL password variable would be “password”

Password Value – Give the actual password provided by your SMS gate way provider.  The password value will be encrypted and stored in the database.  In our example, the password would be “mypassword”

Destination Address Variable – Give the URL variable for the target or destination address.  In our example, the destination address variable would be “mobile”

Message Variable – Give the URL message variable.  This is the variable which holds the actual message to be transmitted.  In our example, the message variable would be “message”

Sender Name Variable – Give the URL sender name variable.  This is the variable which hold the ‘from’ name.  In our example, the sender name variable would be “sender”

Extra variable names and values– The above variable names and values are the basic settings for SMS HTTP API.  But there may be some additional parameters would be configured for SMS HTTP API.  For example if you use clicatell you need to configure more variables like api_id and more. In such cases you can use the extra variables.

Extra1 Variable    -    api_id
Extra1 Value        -    123456

Set Default – You can decide whether this SMS API is default or not.  The default SMS API will be applied while creating a new SMS Account.

Success Pattern – Give the success return message pattern.  The pattern would be in the format of PHP “preg_match”.  In our example, the SMS HTTP API would return “Sent Successfully” for the success message.  So, it would be “lk /Sent Successfully/”

Note: The success pattern contains 2 strings separated by a space.  The first part is the condition and the second part is the condition value.  The possible conditions are
lk – Like (works like PHP preg_match)
eq – Equal
gt – Greater Than
lt – Less Than

For example “lk /Sent Successfully/” means the component will parse the return string from the gateway and will identify whether the text “Sent Successfully” matches in the return string to determine whether the gateway accepts the message or not.  Based on this it will deduct the number of credits used for the member.  Refer http://www.forum.jeema.net/forum/54-api-and-success-pattern.html for configuring HTTP API and its Success Patterns.

Primary Chars per credit – Define how many number of characters per SMS credit for the primary.  Normally 160 characters is the standard among most of the SMS providers.  In our example, 160 is the number of characters per credit for primary.

Secondary Chars per credit – Define how many number of characters per SMS credit for the secondary.  Normally 152 characters is the standard among most of the SMS providers.

Credits Allowed – Define the number of credits allowed.  If your SMS provider allows messages greater than 160 characters, then you can specify the number of credits allowed.  If you specify 2 here, then 1*primary+1*secondary characters are allowed.  If you specify 3 then 1*primary+2*secondary characters are allowed.

For example if your SMS provider supports more than 160 characters but 2 pages of SMS is 160 + 152 = 312, 3 pages would be 160 + 152 + 152 = 464.   This can be configured.