Integrating with V Pixel Pro SMS

Integrating with V Pixel Pro SMS

Introduction

This documentation provides instructions on how to use the V Pixel Pro SMS API with various integration platforms. Before you begin, make sure you have your API key ready. You can find it in your V Pixel Pro SMS account dashboard.

General Steps

  1. API Key: Obtain your V Pixel Pro SMS API key from your account dashboard. This key is essential for authentication.
  2. Endpoint URLs: Familiarize yourself with the API endpoints:
    • `https://sms.vpixelpro.com/services/send.php`: For sending messages.
    • `https://sms.vpixelpro.com/services/read-messages.php`: For retrieving messages.
    • `https://sms.vpixelpro.com/services/resend.php`: For resending messages.
    • `https://sms.vpixelpro.com/services/manage-contacts.php`: For managing contacts.
    • `https://sms.vpixelpro.com/services/send-ussd-request.php`: For sending USSD requests.
    • `https://sms.vpixelpro.com/services/read-ussd-requests.php`: For retrieving USSD requests.
    • `https://sms.vpixelpro.com/services/get-devices.php`: For getting device information.
  3. HTTP Methods: The API primarily uses POST requests to send data and GET requests to retrieve data.
  4. Data Format: Data is typically sent and received in JSON format.

Make.com

To use the V Pixel Pro SMS API in Make.com, follow these steps:

  1. Use the “HTTP” module to make API calls.
  2. Construct the complete API request URL in the “URL” field of the HTTP module. Include the endpoint, your API key, and any required parameters as query parameters.
  3. Example (Sending a message):
    https://sms.vpixelpro.com/services/send.php?key=YOUR_API_KEY&number=+11234567890&message=Hello from Make.com!

Pabbly Connect

To use the V Pixel Pro SMS API in Pabbly Connect, follow these steps:

  1. Choose a trigger that initiates the workflow (e.g., a new order in your e-commerce platform).
  2. Select the “HTTP” action to make API calls.
  3. Configure the action:
    • URL: Enter the API endpoint URL. All API requests, including sending single messages, bulk messages, and messages to contact lists, use `https://sms.vpixelpro.com/services/send.php`.
    • Method: Choose POST.
    • Headers: Add `key: YOUR_API_KEY`.
    • Body: Provide the required data in `key=value` pairs format. Remember to replace placeholders like `{{order.customer.phone}}` with the actual data from the trigger.
  4. Example (Sending a message when a new order is created):
    https://sms.vpixelpro.com/services/send.php?key=YOUR_API_KEY&number={{order.customer.phone}}&message=Your+order+%28{{order.id}}%29+has+been+placed!

Zapier

To use the V Pixel Pro SMS API in Zapier, follow these steps:

  1. Select a trigger that starts the Zap (e.g., a new form submission).
  2. Choose the “Webhooks by Zapier” action to make API calls.
  3. Configure the action:
    • Method: Select POST.
    • URL: Construct the complete API request URL, including the endpoint, your API key, and any required parameters as query parameters. All API requests, including sending single messages, bulk messages, and messages to contact lists, use `https://sms.vpixelpro.com/services/send.php`.
    • Headers: Add `key: YOUR_API_KEY`.
    • Body: Provide the required data in `key=value` pairs format in the request body.
  4. Example (Adding a contact to a list when a form is submitted):
    https://sms.vpixelpro.com/services/manage-contacts.php?key=YOUR_API_KEY&listID=1&number={{form.phone}}&name={{form.name}}