Skip to content

Commit

Permalink
Update set-up.md
Browse files Browse the repository at this point in the history
  • Loading branch information
joannechester committed Jun 11, 2015
1 parent 96fc724 commit 60234ab
Showing 1 changed file with 28 additions and 39 deletions.
67 changes: 28 additions & 39 deletions sms-text-messaging/set-up.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,12 @@ Set-up

In this chapter, the steps required to set up an SMS gateway will be
explored. Once configured, you will be able to send text messages to
individual contacts and mass mailing lists within CiviCRM. For more
information, see "What is SMS?"
individual contacts and mass mailing lists within CiviCRM.

Configuring a Clickatell SMS Gateway {style="letter-spacing: normal; line-height: 17px; "}
Configuring a Clickatell SMS Gateway
------------------------------------

### Registering for a Clickatell account 
### Registering for a Clickatell account

The Clickatell service is an online SMS gateway designed for the sending
of text messages via the Internet. They offer several products, but here
Expand All @@ -19,41 +18,40 @@ achieved through APIs; see the CiviCRM developer guide for more
information). Registering for a Clickatell account is free, and they
supply 10 complimentary credits to try the service. To sign up, visit:

> [http://www.clickatell.com/register/
> ](http://www.clickatell.com/register/)
[http://www.clickatell.com/register/](http://www.clickatell.com/register/)

Once you have registered for a Developer's Central account, please
sign-in and follow the steps below (when logging in you must select
sign-in and follow the steps below (when logging in you must select
"Central API" as the product and enter your Client ID):

1.
In the Central Home dashboard, click "Create a new Connection" under
"Connection Status"

![](../_edit/static/CiviCRM_SMS_clickatell-create-connection.png)
![](../_edit/static/CiviCRM_SMS_clickatell-create-connection.png)

1.
Select "HTTP/S" as the connection type

1.
Four optional settings will appear, including:



- Description: change the name of the connection (e.g. "CiviCRM HTTP")
- Replace leading zero: enable this option if phone numbers against
your contacts begin with "0". For delivery to be successful, all
numbers must begin with the country code if this is not enabled.
- Enable IP Address Restriction: if you know the IP address of your
CiviCRM server, you can enter it here to ensure that text messages
cannot be sent using your account elsewhere (your username and
password would be needed to do this)

**Click "Submit and Get API ID" to generate an API ID, and on the next
page, make a note of it. 
- Description: change the name of the connection (e.g. "CiviCRM HTTP")
- Replace leading zero: enable this option if phone numbers against
your contacts begin with "0". For delivery to be successful, all
numbers must begin with the country code if this is not enabled.
- Enable IP Address Restriction: if you know the IP address of your
CiviCRM server, you can enter it here to ensure that text messages
cannot be sent using your account elsewhere (your username and
password would be needed to do this)

1.
Click "Submit and Get API ID" to generate an API ID, and on the next
page, make a note of it.

### Completing the SMS Provider settings in CiviCRM

You now have all of the information needed to configure SMS in CiviCRM.
To continue, return to CiviCRM and go to: **Administer** > **System
Settings**> **SMS Providers**. Click "Add New Provider". 
Settings**> **SMS Providers**. Click "Add New Provider".

![](/images/CiviCRM_SMS_adding-a-provider.png)

Expand All @@ -65,21 +63,14 @@ Complete the following settings:
- Username: enter your Clickatell username
- Password: and your Clickatell password
- API type: select "http"
- API URL: type the URL as follows: https://api.clickatell.com

- API URL: type the URL as follows: https://api.clickatell.com
- API Parameters: this is where you should provide your API ID. The
format required is:

> > api_id=8473658


format required is: `api_id=8473658`
- Is this provider active?: tick to enable the SMS gateway

- Is this a default provider?: check this option to make it the
default, where multiple SMS providers are available

CiviCRM will now be configured to send text messages to your contacts. 
CiviCRM will now be configured to send text messages to your contacts.

### Testing the SMS gateway

Expand All @@ -89,8 +80,6 @@ chapter "Everyday tasks". However, please note that if you are using the
purchased credits Clickatell will replace the content with thank you
text like the message below:

> "Thanks for testing Clickatell's gateway coverage. You will be able to
> change the content of your message after your initial purchase of
> message credits."

```
Thanks for testing Clickatell's gateway coverage. You will be able to change the content of your message after your initial purchase of message credits.
```

0 comments on commit 60234ab

Please sign in to comment.