Send Message to group

Send a message to all contacts of a contact group in one request. The response contains a messageid for the group send, which you can use to track the send afterwards via Get message by ID (GET /v1/message/{messageid}).

Base URL:

POST: https://api.smsgatewayapi.com/v1/message/send

Parameter	Input	Description
client_id	API client ID	Developer › API & Webhooks › API credentials	Required
client_secret	API client secret	A `cs_` credential, shown once when you create it under Developer › API & Webhooks › API credentials	Required
type	type	Required to be "group"	Required
message	message	the message to be sent. Not required when `template` is given; when both are sent, the template wins	Partial
template	message template ID	The ID of one of your message templates, preferably the public ID (tpl_...); the numeric ID is accepted too. The text of the template is used as the message and personalisation placeholders such as [FIRSTNAME] are filled in. When message is sent as well it is ignored and the response contains a warnings entry. An unknown ID, or a template that is not yours, returns error 150. Team users need the message templates permission	Optional
to	group ID	The ID of the group that will receive the message. Both the numeric ID and the public ID (gid_...) are accepted	Required
sender	sender	The number or name of the sender. A number can't be longer than 14 characters.A name can't be longer than 11 characters and can't contain special characters	Required
date	Date and time the message will be sent	Format: yyyy-MM-dd HH:mm. If not provided, the message will be sent as soon as possible	Optional
reference	custom reference	String of max. 255 characters	Optional
test	true/false	The system will check all parameters but will not send an SMS message (no credits used).	Optional
subid	id of a subaccount	If specified, the message will be sent from the subaccount.	Optional

<?php
	//PHP - cURL
	$ch = curl_init();
	$url = "https://api.smsgatewayapi.com/v1/message/send";
	$client_id = "XXX"; // Your API client ID (required)
	$client_secret = "YYY"; // Your API client secret (required)
	$data = [
		'type' => "group" //(required)
		'message' => "Hello World", //Message (required)
		'to' => {ID}, //Group ID (required)

	];
	curl_setopt($ch, CURLOPT_URL, "$url");
	curl_setopt($ch, CURLOPT_POST, true);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
	curl_setopt($ch, CURLOPT_VERBOSE, true);
	curl_setopt($ch, CURLOPT_HTTPHEADER, [
		"X-Client-Id: $client_id",
		"X-Client-Secret: $client_secret",
		"Content-Type: application/json",
	]);
	curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
	$response = curl_exec($ch);
?>

//NodeJs - HTTP request			
const https = require("https");
const client_id = "XXX"; // Your API client ID (required)
const client_secret = "YYY"; // Your API client secret (required)
const data = JSON.stringify({
	type: 'group'
    message: 'Hello World', //Message (required)
    to: {ID}, //Group ID (required)
	    sender: 'YourName', //Sender (required)
	

});
const options = {
    hostname: "api.smsgatewayapi.com",
    port: 443,
    path: "/v1/message/send",
    method: "POST",
    headers: {
        "X-Client-Id": client_id,
        "X-Client-Secret": client_secret,
		"Content-Type": "application/json",
		"Content-Length": data.length,
    },
};
const req = https.request(options, (res) => {
    console.log(`statusCode: ${res.statusCode}`);
    res.on("data", (d) => {
        process.stdout.write(d);
    });
});
req.write(data);
req.end();

//Ruby - Net::HTTP			
require "uri"
require "net/http"

url = URI("https://api.smsgatewayapi.com/v1/message/send")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = "XXX" // Your API key
request["X-Client-Secret"] = "YYY" // Your API secret
request["Content-Type"] = "application/json"
form_data = [
	['type', "group"], //(required)
	['message', "Hello World"], //Message (required)
	['to', {ID}] //Group ID (required)


]
request.set_form form_data, 'multipart/form-data'
response = https.request(request)
puts response.read_body

//Python - Requests			
import requests
url = "https://api.smsgatewayapi.com/v1/message/send"
payload={
	'type' : 'group' #(required)
	'message' : 'Hello World', #Message (required)
	'to' : '{ID}', #Group ID (required)
	'sender' : 'YourName' #Sender (required)
}
headers = {
	'X-Client-Id': 'XXX', #Your API key
	'X-Client-Secret': 'YYY', #Your API secret
	'Content-Type': 'application/json'
}
response = requests.request(
	"POST",
	url,
	headers=headers,
	json=payload
)
print(response.text)

//PowerShell - RestMethod
$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("X-Client-Id", "XXX") // Your API key
$headers.Add("X-Client-Secret", "YYY") // Your API secret

$body = '{
	"to": "{ID}", //Group ID (required)
	"type": "group", //(required)
	"message": "Hello World", //Receiver (required)
	"sender": "YourName" //Sender (required)


}'

$response = Invoke-RestMethod 'https://api.smsgatewayapi.com/v1/message/send' -Method 'POST' -Headers $headers -Body $body -ContentType “application/json; charset=utf-8”
$response | ConvertTo-Json

//Shell - wget
wget --no-check-certificate --quiet \
  --method POST \
  --timeout=0 \
  --header 'X-Client-Id: XXX' \ // Your API key
  --header 'X-Client-Secret: YYY' \ // Your API secret
  --header 'Content-Type: application/json' \
  --body-data '{
	"type" : "group" //(required)
	"message" : "Hello World", //Message (required)
	"to" : "{ID}", //Group ID (required)
	"sender" : "YourName" #Sender (required)


}' \
   'https://api.smsgatewayapi.com/v1/message/send'

Example request:

{
	"message": "Hello World",
	"to": "{groupid}",
	"date":"2024-10-15 15:30",
	"sender": "YourName"
}

Example response:

{
	"messageid": "h2md1ewkyzjkuyn9ak7pryw1evtyw3x"
}

Exceptions:

Our system processes the messages in UTF8 and generates this in GSM unicode. There are 9 characters that are counted as 2 characters in GSM unicode. If you use one of these characters in your message, your message will be longer. Example: If you have a message of 160 characters and you used a €-characters then the message real length is 161 characters long

Symbol	Name	Symbol	Name	Symbol	Name
€	Euro symbol	\	Backslash	}	Right brace
[	Open bracket	^	Caret	~	Tilde
]	Close bracket	{	Left brace	\|	Vertical bar

API

Guides

Messages

Voice

WhatsApp Business

Groups

Contacts

Outbox

Account

Sender IDs

Teammate/Subaccount

Conversations

Message Templates

Birthday Message

Opt-out

Other

Webhooks (v2)

Send Message to group

SMS API

STARTE KOSTENLOS

Entdecken sie

Unser Team beantwortet gerne Ihre Fragen zu Produkten, Funktionen und Integration.

Allgemeine Fragen

Verkaufsfragen

Support-Fragen

Unser Team beantwortet gerne Ihre Fragen zu Produkten, Funktionen und Integration.

Allgemeine Fragen

Verkaufsfragen

Support-Fragen

BLOG