Add new SMS setups (self-serve)

Only relevant to self-serve clients. For other packages, Clickatell does this on your behalf.

You can add as many SMS setups as you want. This page explains how to:

• Add a new setup

• Select setup type & regions

  • Select number(s)

• Select API type

  • Set up API details

• Send test messages

Adding a new SMS setup

1. Navigate to My Workspace -> SMS.

2. Click + New SMS Setup.

1. Follow the steps as prompted by the setup wizard (shown below).

Select the setup type and regions

1. Select how you plan to use the SMS channel:

   • Via API: You're prompted to select either the 1-way (sending only) or 2-way (sending & receiving) messaging type.
   • Via Campaign Manager: This tool is ideal for campaigns such as promotions, reminders, alerts, event information, and quick polls. This is managed as a separate tool.

Note: In certain countries, one-way messaging is not allowed.

Select number(s)

If you've selected two-way communication, you must also:

1. Select a long number/short code.

2. Add a new number or use an existing one.

See this section of the guide for more details on SMS numbers.

Since short codes require an application process and are not available immediately, we recommend you apply for a short number before adding a new SMS setup if you plan on using a short code for your SMS communications.

Select the API type

1. Choose between:

   • HTTP (if you are using SMS as the only channel), or

   • One API (for use with WhatsApp, SMS, and future channels)

2. Create a new API setup or link an existing one.

Set up API details (new API setups only)

1. Enter a name for the API.

2. Select whether this must be added in the Sandbox (recommended) or Production environment.

3. Select a delivery option under SMS Service Class:

   • Priority SMS delivery: Our fastest and most direct line of delivery of time-sensitive SMS messages such as one-time PINs (OTPs) and transactional messages.

     • Not to be used for marketing or promotional notifications.

   • Standard SMS delivery: For high-quality, reliable SMS delivery of non-time-sensitive SMS messages such as marketing promotions, brand announcements, or CRM messages.

4. Edit other optional settings (e.g., enabling message parts and configuring callbacks for delivery notifications) using the toggles.

Send test messages (optional)

• You can add a maximum of two test phones to your account.

• The number of free test SMS messages you can send per account is limited to 10 per day with an overall maximum of 100 per month.

• Test messages are always free, however, you need a positive account balance before you can send test messages.

• You will be charged for messages sent once the integration is promoted to production.

Your API details are displayed.

1. The unique API key is the authorization key required to interface with the Clickatell platform.

   • The API key is prepopulated in our example scripts that you can copy and paste.

1. Test the sending/receiving of messages from the Sandbox environment by adding up to three test phone numbers to your account.
2. Click + Add test phone and follow the prompts.

Phone numbers must be entered in the international format and contain no spaces or other non-numeric characters.

1. Click Complete.

   • Your new SMS Setup is added to the My SMS Setups table and is visible on the API Integrations page.