Elixir Batch Messaging Integration

The Elixir Batch Messaging endpoint accepts HTTP POST requests with form-encoded parameters matching the Elixir SMS platform's API format. It allows sending batch SMS messages to multiple recipients in a single request.

Endpoint

POST https://{host}/api/elixir/batchmessage.aspx

Content-Type

Content-Type: application/x-www-form-urlencoded

Authentication

Authentication is handled via the Password form parameter, which should contain your SMSDESK API key. The User parameter is accepted but not validated — it is used only for logging purposes.

Getting Your API Key

1. Log in to the SMSDESK Portal
2. Navigate to your SMS Channel settings
3. Copy your existing API key or generate a new one

Parameters

All parameters are sent as form-encoded fields in the POST body.

Response Format

The endpoint returns a plain text response (not JSON). The response is a comma-separated list of results, one per recipient:

{sms_id}:{recipient}:{status},{sms_id}:{recipient}:{status},...

Response Fields

Success Response Example

12345:264811234567:PENDING,12346:264812345678:PENDING

Error Response Examples

0:264811234567:ERROR,12346:264812345678:PENDING

The first recipient failed (sms_id=0, status=ERROR) while the second succeeded.

Error: invalid set of parameters. Expecting [User, Password, Message, Numbers]

Returned when one or more required parameters are missing.

Code Examples

cURL

curl -X POST https://{host}/api/elixir/batchmessage.aspx \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "User=myaccount&Password=your-api-key&Message=Hello from Elixir&Numbers=264811234567,264812345678"

Python

import requests

url = "https://{host}/api/elixir/batchmessage.aspx"
data = {
    "User": "myaccount",
    "Password": "your-api-key",
    "Message": "Hello from Python!",
    "Numbers": "264811234567,264812345678"
}

response = requests.post(url, data=data)
print(response.text)
# Output: 12345:264811234567:PENDING,12346:264812345678:PENDING

PHP

<?php
$url = "https://{host}/api/elixir/batchmessage.aspx";
$data = http_build_query([
    "User" => "myaccount",
    "Password" => "your-api-key",
    "Message" => "Hello from PHP!",
    "Numbers" => "264811234567,264812345678"
]);

$ch = curl_init($url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $data);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);

$response = curl_exec($ch);
curl_close($ch);

echo $response;
// Output: 12345:264811234567:PENDING,12346:264812345678:PENDING
?>

C# (.NET)

using System.Net.Http;
using System.Collections.Generic;

var client = new HttpClient();
var data = new FormUrlEncodedContent(new Dictionary<string, string>
{
    {"User", "myaccount"},
    {"Password", "your-api-key"},
    {"Message", "Hello from C#!"},
    {"Numbers", "264811234567,264812345678"}
});

var response = await client.PostAsync(
    "https://{host}/api/elixir/batchmessage.aspx", data);
var result = await response.Content.ReadAsStringAsync();
Console.WriteLine(result);
// Output: 12345:264811234567:PENDING,12346:264812345678:PENDING

JavaScript (Node.js)

const axios = require('axios');
const querystring = require('querystring');

const url = 'https://{host}/api/elixir/batchmessage.aspx';
const data = querystring.stringify({
    User: 'myaccount',
    Password: 'your-api-key',
    Message: 'Hello from Node.js!',
    Numbers: '264811234567,264812345678'
});

const response = await axios.post(url, data, {
    headers: { 'Content-Type': 'application/x-www-form-urlencoded' }
});
console.log(response.data);
// Output: 12345:264811234567:PENDING,12346:264812345678:PENDING

Troubleshooting

← Back to Custom Integrations