Send SMS
curl --request POST \
--url http://api.gu1.ai/marketplace/messaging/send-sms \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to": "<string>",
"senderIndex": 123,
"templateParams": {},
"templateId": {},
"body": "<string>"
}
'import requests
url = "http://api.gu1.ai/marketplace/messaging/send-sms"
payload = {
"to": "<string>",
"senderIndex": 123,
"templateParams": {},
"templateId": {},
"body": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to: '<string>',
senderIndex: 123,
templateParams: {},
templateId: {},
body: JSON.stringify('<string>')
})
};
fetch('http://api.gu1.ai/marketplace/messaging/send-sms', 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 => "http://api.gu1.ai/marketplace/messaging/send-sms",
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([
'to' => '<string>',
'senderIndex' => 123,
'templateParams' => [
],
'templateId' => [
],
'body' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "http://api.gu1.ai/marketplace/messaging/send-sms"
payload := strings.NewReader("{\n \"to\": \"<string>\",\n \"senderIndex\": 123,\n \"templateParams\": {},\n \"templateId\": {},\n \"body\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://api.gu1.ai/marketplace/messaging/send-sms")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": \"<string>\",\n \"senderIndex\": 123,\n \"templateParams\": {},\n \"templateId\": {},\n \"body\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.gu1.ai/marketplace/messaging/send-sms")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": \"<string>\",\n \"senderIndex\": 123,\n \"templateParams\": {},\n \"templateId\": {},\n \"body\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodyAPI Reference
Send SMS
POST /marketplace/messaging/send-sms — transactional SMS with optional template or inline body — through the gu1 messaging API for customer communications.
POST
/
marketplace
/
messaging
/
send-sms
Send SMS
curl --request POST \
--url http://api.gu1.ai/marketplace/messaging/send-sms \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"to": "<string>",
"senderIndex": 123,
"templateParams": {},
"templateId": {},
"body": "<string>"
}
'import requests
url = "http://api.gu1.ai/marketplace/messaging/send-sms"
payload = {
"to": "<string>",
"senderIndex": 123,
"templateParams": {},
"templateId": {},
"body": "<string>"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
to: '<string>',
senderIndex: 123,
templateParams: {},
templateId: {},
body: JSON.stringify('<string>')
})
};
fetch('http://api.gu1.ai/marketplace/messaging/send-sms', 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 => "http://api.gu1.ai/marketplace/messaging/send-sms",
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([
'to' => '<string>',
'senderIndex' => 123,
'templateParams' => [
],
'templateId' => [
],
'body' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "http://api.gu1.ai/marketplace/messaging/send-sms"
payload := strings.NewReader("{\n \"to\": \"<string>\",\n \"senderIndex\": 123,\n \"templateParams\": {},\n \"templateId\": {},\n \"body\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://api.gu1.ai/marketplace/messaging/send-sms")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"to\": \"<string>\",\n \"senderIndex\": 123,\n \"templateParams\": {},\n \"templateId\": {},\n \"body\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.gu1.ai/marketplace/messaging/send-sms")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"to\": \"<string>\",\n \"senderIndex\": 123,\n \"templateParams\": {},\n \"templateId\": {},\n \"body\": \"<string>\"\n}"
response = http.request(request)
puts response.read_bodySends a single transactional SMS for the authenticated organization. Requires the SMS marketplace integration and a configured messaging provider. See Messaging overview for prerequisites and billing.
Do not send
Endpoint
POST https://api.gu1.ai/marketplace/messaging/send-sms
Headers
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
X-Organization-ID: <uuid> # optional; multi-org session users
Request body
Common
string
required
Destination phone number (E.164 recommended, e.g.
+5491112345678). Length limits apply (validated server-side).integer
Optional index for the org’s Twilio SMS sender list in integration config (
-1 or omit for platform default behavior, depending on provider). Same semantics as other SMS features in the app.object
Replacements for
{{placeholders}} in the template or inline body. Default {}.Mode A — Stored template
string (UUID)
required
Message template with channel sms.
body in this mode.
Mode B — Inline body
Do not sendtemplateId.
string
required
SMS text. Max ~4,000 characters. May include
{{variables}} replaced via templateParams.Example — template
curl -X POST https://api.gu1.ai/marketplace/messaging/send-sms \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"to": "+5491112345678",
"templateId": "550e8400-e29b-41d4-a716-446655440000",
"templateParams": { "token": "482910" }
}'
Example — inline with placeholders
curl -X POST https://api.gu1.ai/marketplace/messaging/send-sms \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"to": "+5491112345678",
"body": "Your code is {{token}}",
"templateParams": { "token": "482910" }
}'
Success response
{
"success": true,
"messageId": "provider-message-id"
}
Common errors (400)
- SMS integration not active or provider not configured
- Insufficient balance / no pack execution when the integration has a cost
templateIdandbodyboth sent- Template not found or channel is not
sms - Body empty after rendering
error field when success is false.Was this page helpful?