Create and launch a campaign
curl --request POST \
--url https://ecsend.paysgator.com/campaigns \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"name": "Summer Promo",
"text": "Get 20% off this summer!",
"senderId": "ECSEND",
"recipients": [
"+25884000001",
"+25884000002"
],
"rawReceivers": "+25884000001,+25884000002",
"contactBookName": "My Contacts"
}
'import requests
url = "https://ecsend.paysgator.com/campaigns"
payload = {
"name": "Summer Promo",
"text": "Get 20% off this summer!",
"senderId": "ECSEND",
"recipients": ["+25884000001", "+25884000002"],
"rawReceivers": "+25884000001,+25884000002",
"contactBookName": "My Contacts"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Summer Promo',
text: 'Get 20% off this summer!',
senderId: 'ECSEND',
recipients: ['+25884000001', '+25884000002'],
rawReceivers: '+25884000001,+25884000002',
contactBookName: 'My Contacts'
})
};
fetch('https://ecsend.paysgator.com/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ecsend.paysgator.com/campaigns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Summer Promo',
'text' => 'Get 20% off this summer!',
'senderId' => 'ECSEND',
'recipients' => [
'+25884000001',
'+25884000002'
],
'rawReceivers' => '+25884000001,+25884000002',
'contactBookName' => 'My Contacts'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ecsend.paysgator.com/campaigns"
payload := strings.NewReader("{\n \"name\": \"Summer Promo\",\n \"text\": \"Get 20% off this summer!\",\n \"senderId\": \"ECSEND\",\n \"recipients\": [\n \"+25884000001\",\n \"+25884000002\"\n ],\n \"rawReceivers\": \"+25884000001,+25884000002\",\n \"contactBookName\": \"My Contacts\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://ecsend.paysgator.com/campaigns")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Summer Promo\",\n \"text\": \"Get 20% off this summer!\",\n \"senderId\": \"ECSEND\",\n \"recipients\": [\n \"+25884000001\",\n \"+25884000002\"\n ],\n \"rawReceivers\": \"+25884000001,+25884000002\",\n \"contactBookName\": \"My Contacts\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ecsend.paysgator.com/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Summer Promo\",\n \"text\": \"Get 20% off this summer!\",\n \"senderId\": \"ECSEND\",\n \"recipients\": [\n \"+25884000001\",\n \"+25884000002\"\n ],\n \"rawReceivers\": \"+25884000001,+25884000002\",\n \"contactBookName\": \"My Contacts\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"campaignId": "clx456def",
"status": "COMPLETED",
"recipientCount": 100
}{
"error": "Unauthorized. Invalid or missing X-Api-Key."
}{
"error": "Unauthorized. Invalid or missing X-Api-Key."
}{
"error": "Unauthorized. Invalid or missing X-Api-Key."
}{
"error": "Unauthorized. Invalid or missing X-Api-Key."
}{
"error": "Unauthorized. Invalid or missing X-Api-Key."
}Campaigns
Create and Launch Campaign
Creates a new SMS campaign and sends messages to all recipients. Recipients can be provided as an array, raw text, or from an existing contact book.
POST
/
campaigns
Create and launch a campaign
curl --request POST \
--url https://ecsend.paysgator.com/campaigns \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"name": "Summer Promo",
"text": "Get 20% off this summer!",
"senderId": "ECSEND",
"recipients": [
"+25884000001",
"+25884000002"
],
"rawReceivers": "+25884000001,+25884000002",
"contactBookName": "My Contacts"
}
'import requests
url = "https://ecsend.paysgator.com/campaigns"
payload = {
"name": "Summer Promo",
"text": "Get 20% off this summer!",
"senderId": "ECSEND",
"recipients": ["+25884000001", "+25884000002"],
"rawReceivers": "+25884000001,+25884000002",
"contactBookName": "My Contacts"
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: 'Summer Promo',
text: 'Get 20% off this summer!',
senderId: 'ECSEND',
recipients: ['+25884000001', '+25884000002'],
rawReceivers: '+25884000001,+25884000002',
contactBookName: 'My Contacts'
})
};
fetch('https://ecsend.paysgator.com/campaigns', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://ecsend.paysgator.com/campaigns",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Summer Promo',
'text' => 'Get 20% off this summer!',
'senderId' => 'ECSEND',
'recipients' => [
'+25884000001',
'+25884000002'
],
'rawReceivers' => '+25884000001,+25884000002',
'contactBookName' => 'My Contacts'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Api-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://ecsend.paysgator.com/campaigns"
payload := strings.NewReader("{\n \"name\": \"Summer Promo\",\n \"text\": \"Get 20% off this summer!\",\n \"senderId\": \"ECSEND\",\n \"recipients\": [\n \"+25884000001\",\n \"+25884000002\"\n ],\n \"rawReceivers\": \"+25884000001,+25884000002\",\n \"contactBookName\": \"My Contacts\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Api-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://ecsend.paysgator.com/campaigns")
.header("X-Api-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Summer Promo\",\n \"text\": \"Get 20% off this summer!\",\n \"senderId\": \"ECSEND\",\n \"recipients\": [\n \"+25884000001\",\n \"+25884000002\"\n ],\n \"rawReceivers\": \"+25884000001,+25884000002\",\n \"contactBookName\": \"My Contacts\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://ecsend.paysgator.com/campaigns")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Summer Promo\",\n \"text\": \"Get 20% off this summer!\",\n \"senderId\": \"ECSEND\",\n \"recipients\": [\n \"+25884000001\",\n \"+25884000002\"\n ],\n \"rawReceivers\": \"+25884000001,+25884000002\",\n \"contactBookName\": \"My Contacts\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"campaignId": "clx456def",
"status": "COMPLETED",
"recipientCount": 100
}{
"error": "Unauthorized. Invalid or missing X-Api-Key."
}{
"error": "Unauthorized. Invalid or missing X-Api-Key."
}{
"error": "Unauthorized. Invalid or missing X-Api-Key."
}{
"error": "Unauthorized. Invalid or missing X-Api-Key."
}{
"error": "Unauthorized. Invalid or missing X-Api-Key."
}Authorizations
Body
application/json
Campaign name
Example:
"Summer Promo"
Message content
Example:
"Get 20% off this summer!"
Sender ID
Example:
"ECSEND"
Array of phone numbers
Example:
["+25884000001", "+25884000002"]
Comma or newline separated phone numbers
Example:
"+25884000001,+25884000002"
Name of existing contact book to use
Example:
"My Contacts"
⌘I