OVH SMS Gateway Integration Guide for JoomSMS

This document provides step-by-step instructions for setting up and configuring the OVH SMS Gateway with JoomSMS. This integration allows you to send SMS messages from your Joomla website using your OVH SMS account.

Prerequisites

• A Joomla website with JoomSMS component installed
• An active OVH account
• An active OVH SMS subscription with available credits

Step 1: Obtain OVH API Credentials

To connect JoomSMS with your OVH account, you'll need to create API credentials:

1. Go to the OVH API key creation page: https://api.ovh.com/createToken/

2. Log in with your OVH account credentials.

3. Complete the form with the following information:

   • Application name: JoomSMS Integration (or any name you prefer)
   • Application description: SMS integration for Joomla (optional)
   • Validity: Choose Unlimited for permanent access, or select a specific period

4. Add the following API access rights:

   • GET /sms/*
   • POST /sms/*
   • PUT /sms/*



5. Click "Create keys"

6. On the confirmation screen, you'll receive three credentials:

   • Application Key (AK) - identifies your application
   • Application Secret (AS) - used for request authentication
   • Consumer Key (CK) - authorizes access to your account

   IMPORTANT: Copy and save all three values immediately. The Application Secret will never be displayed again!

Step 2: Locate Your SMS Account Name

You need to find your OVH SMS account identifier:

1. Log in to the OVH Control Panel at https://www.ovh.com/manager/

2. Navigate to the Telecom section, then select SMS

3. Your SMS account will be displayed with a name that starts with sms- followed by additional characters (e.g., sms-ab123456)

4. Note this exact account name for the JoomSMS configuration

Step 3: Set Up a Sender ID

OVH requires a valid sender ID for your messages. You have several options:

Option A: Use a Virtual Number (Recommended)

If you've purchased a virtual SMS number from OVH:

1. In the OVH Control Panel, go to Telecom > SMS > [your account] > Senders
2. Your virtual numbers will be listed here
3. Note the number in international format (e.g., 0033612345678)

Option B: Register an Alphanumeric Sender ID

For branded messages:

1. In the OVH Control Panel, go to Telecom > SMS > [your account] > Senders
2. Click Add to register a new sender
3. Enter your desired alphanumeric name (up to 11 characters)
4. Follow OVH's validation process (may require documentation)

Option C: Use Your Own Phone Number

To use your own mobile number:

1. In the OVH Control Panel, go to Telecom > SMS > [your account] > Senders
2. Click Add
3. Enter your phone number
4. OVH will send a validation code to this number
5. Enter the code to validate your number

Important Note: Sender ID rules vary by country. Some countries don't allow alphanumeric senders, while others require pre-registration of sender IDs.

Step 4: Configure JoomSMS Gateway

1. Log in to your Joomla administration panel

2. Navigate to Components > JoomSMS > Sender Profiles

3. Click New to create a new sender profile, or edit an existing one

4. Fill in the profile details:

   • Name: A name for your profile (e.g., "OVH Gateway")
   • SMS Gateway: Select "OVH" from the dropdown menu
   • Default: Set to "Yes" if you want this to be your default gateway

5. In the gateway parameters section, enter:

   • Application Key: Your OVH Application Key (AK)
   • Application Secret: Your OVH Application Secret (AS)
   • Consumer Key: Your OVH Consumer Key (CK)
   • SMS Account: Your OVH SMS account name (e.g., sms-ab123456)
   • Sender ID: Your approved sender ID or phone number in international format, e.g.:
     • For numeric: 0033612345678 (no "+" sign)
     • For alphanumeric: YOURCOMPANY
   • Include STOP clause: Set to "Yes" for commercial messages (required by regulations)
   • Debug Mode: Set to "Yes" initially to help troubleshoot any issues

6. Click Save & Close

Step 5: Configure Callback URLs (Optional)

To receive delivery reports and incoming SMS messages:

1. In the OVH Control Panel, go to Telecom > SMS > [your account] > Configuration > Callback URLs

2. Add the following callbacks:

   • For Delivery report, use the URL shown in the JoomSMS configuration page
   • For Incoming SMS, use the URL shown in the JoomSMS configuration page

Step 6: Test Your Integration

1. In your Joomla admin panel, go to Components > JoomSMS > Send SMS

2. Select your OVH sender profile

3. Enter a test recipient phone number in international format (e.g., +33612345678)

4. Type a test message

5. Click Send

6. Check the message status in Components > JoomSMS > Reports

Troubleshooting

Phone Number Format Issues

If you see errors like "Invalid recipient phone number":

• Ensure you're using complete international format (e.g., +33612345678)
• Check that the country code is supported by your OVH account
• Remove any spaces or special characters from the number

API Connection Issues

If you see "This call has not been granted" errors:

• Verify all API credentials are entered correctly
• Check that you've added all required API permissions (GET/POST/PUT /sms/*)
• Ensure your Consumer Key has been validated

SMS Account Issues

If you see "The requested object (sms/xxx) does not exist":

• Double-check your SMS account name in the OVH control panel
• Ensure you've entered it exactly as displayed, including the "sms-" prefix

Credits and Billing

If messages aren't being sent:

• Verify you have sufficient SMS credits in your OVH account
• Check for any billing or payment issues

Debugging

If you continue to experience issues:

1. Enable Debug Mode in the gateway configuration
2. Send a test message
3. Check your server logs for detailed error information
4. Contact JoomSMS support with the error details

Regulatory Compliance

Remember that when sending SMS messages:

• Including a STOP option is mandatory for commercial messages in most countries
• Comply with local regulations regarding SMS messaging
• Respect quiet hours for message delivery

Support Resources

• OVH SMS Documentation: https://docs.ovh.com/gb/en/sms/
• OVH API Documentation: https://api.ovh.com/
• JoomSMS Documentation: https://www.joomboost.com/support/documentation/141-joomsms-documentation.html