Criar um Grupo

POST

/groups

Com este comando você cria uma lista de mailing SMS que é armazenada em nosso sistema para você. Uma lista de mailing tem um nome, uma descrição e cinco colunas adicionais que você pode adicionar além do número de telefone.

Authorizations

token

Request Body^required

The new groups resource

application/json

Phone’s group

object

name

required

Nome do grupo

string

>= 1 characters <= 50 characters

description

Descrição do grupo

string | null

<= 255 characters

name_a

Nome da coluna

string | null

<= 50 characters

name_b

Nome da coluna

string | null

<= 50 characters

name_c

Nome da coluna

string | null

<= 50 characters

name_d

Nome da coluna

string | null

<= 50 characters

name_e

Nome da coluna

string | null

<= 50 characters

phones

Array<object>

Phones list by group

object

phone

required

Número de telefone

string

<= 30 characters

Dados da coluna do telefone

string | null

<= 1530 characters

Dados da coluna do telefone

string | null

<= 1530 characters

Dados da coluna do telefone

string | null

<= 1530 characters

Dados da coluna do telefone

string | null

<= 1530 characters

Dados da coluna do telefone

string | null

<= 1530 characters

callback_data

String which will be send back to your endpoint. E.g. it can be usable to pass your system message id.

string | null

<= 36 characters

Example ^generated

{
  "name": "example",
  "description": "example",
  "name_a": "example",
  "name_b": "example",
  "name_c": "example",
  "name_d": "example",
  "name_e": "example",
  "phones": [
    {
      "phone": "example",
      "a": "example",
      "b": "example",
      "c": "example",
      "d": "example",
      "e": "example",
      "callback_data": "example"
    }
  ]
}

Responses

201

Groups resource created

Phone’s group

object

@context

One of:

string
object

string

@id

JSON-LD ID

string

@type

JSON-LD type

string

ID do grupo

integer

>= 1

name

required

Nome do grupo

string

>= 1 characters <= 50 characters

description

Descrição do grupo

string | null

<= 255 characters

name_a

Nome da coluna

string | null

<= 50 characters

name_b

Nome da coluna

string | null

<= 50 characters

name_c

Nome da coluna

string | null

<= 50 characters

name_d

Nome da coluna

string | null

<= 50 characters

name_e

Nome da coluna

string | null

<= 50 characters

count_items

Contagem de itens no grupo

integer

deleted_at

Data e hora em que o grupo será excluído

string | null format: date-time

Example

{
  "@context": {
    "hydra": "http://www.w3.org/ns/hydra/core#"
  }
}

Phone’s group

object

ID do grupo

integer

>= 1

name

required

Nome do grupo

string

>= 1 characters <= 50 characters

description

Descrição do grupo

string | null

<= 255 characters

name_a

Nome da coluna

string | null

<= 50 characters

name_b

Nome da coluna

string | null

<= 50 characters

name_c

Nome da coluna

string | null

<= 50 characters

name_d

Nome da coluna

string | null

<= 50 characters

name_e

Nome da coluna

string | null

<= 50 characters

count_items

Contagem de itens no grupo

integer

deleted_at

Data e hora em que o grupo será excluído

string | null format: date-time

Example ^generated

{
  "id": 1,
  "name": "example",
  "description": "example",
  "name_a": "example",
  "name_b": "example",
  "name_c": "example",
  "name_d": "example",
  "name_e": "example",
  "deleted_at": "2026-04-15T12:00:00Z"
}

400

Invalid input

401

Client ID or API key isn’t active or invalid!

403

Account isn’t activated. Please wait or contact to support!

422

The request was well-formed but was unable to be followed due to semantic errors

429

O endereço IP foi bloqueado temporariamente, pois durante um curto período de tempo foram enviadas várias solicitações com credenciais inválidas. Aguarde e tente mais tarde.

Code Samples

#!/usr/bin/env bash
curl -X POST https://api.lox24.eu/groups \
  -H 'Content-Type: application/json' \
  -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \
  -d '{
      "name": "My Clients",
      "description": "Best clients",
      "name_a": "prefix",
      "name_b": "name",
      "name_c": "datetime",
      "name_d": "price",
      "name_e": "something_else"
}'

using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System;
using System.IO;
using System.Net;
using System.Text;

namespace Lox24.Api
{
    class client
    {
        static void Main()
        {
            string key = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx";
            string url = "https://api.lox24.eu/groups";


            var data = new {
                name = "My Clients",
                description = "Best clients",
                name_a = "prefix",
                name_b = "name",
                name_c = "datetime",
                name_d = "price",
                name_e = "something_else"
            };

            string postdata = JsonConvert.SerializeObject(data);

            Console.WriteLine("Post data: {0}", postdata);

            var httpWebRequest = (HttpWebRequest)WebRequest.Create(url);
            httpWebRequest.ReadWriteTimeout = 100000;
            httpWebRequest.ContentType = "application/json; charset=utf-8";
            httpWebRequest.Accept = "application/json"; // or application/ld+json
            httpWebRequest.Method = "POST";
            httpWebRequest.KeepAlive = true;
            httpWebRequest.Headers.Add("X-LOX24-AUTH-TOKEN", key);
            httpWebRequest.Credentials = CredentialCache.DefaultNetworkCredentials;

            using (var streamWriter = new StreamWriter(httpWebRequest.GetRequestStream()))
            {
                streamWriter.Write(postdata);
                streamWriter.Flush();
                streamWriter.Close();
            }
            try
            {
                using (HttpWebResponse resp = (HttpWebResponse)httpWebRequest.GetResponse())
                {

                    if(resp.StatusCode == HttpStatusCode.Created) {
                        Console.WriteLine("Success:{0} {1}", (int)resp.StatusCode, "group resource created");
                    } else {
                        Console.WriteLine("Error: wrong response code {0} on create group", (int)resp.StatusCode);
                    }

                    Stream respStream = resp.GetResponseStream();
                    using (StreamReader sr = new StreamReader(respStream, Encoding.UTF8))
                    {
                        string responseText = sr.ReadToEnd();
                        Console.WriteLine("responseText : {0}", responseText);
                    }
                }

            }
            catch (System.Net.WebException ex)
            {
                var webResponse = ex.Response as System.Net.HttpWebResponse;
                Console.WriteLine("Error:{0}", webResponse.StatusCode);

                switch (webResponse.StatusCode)
                {
                    case HttpStatusCode.BadRequest: // 400
                        Console.WriteLine("Error:400 Invalid input");
                        break;
                    case HttpStatusCode.Unauthorized: // 401
                        Console.WriteLine("Error:401 Client ID or API key isn't active or invalid!");
                        break;
                    case HttpStatusCode.Forbidden: // 403
                        Console.WriteLine("Error:403 Account isn't activated. Please wait or contact to support!");
                        break;
                    case HttpStatusCode.InternalServerError: // 500
                    case HttpStatusCode.BadGateway: //502
                    case HttpStatusCode.ServiceUnavailable: // 503
                    case HttpStatusCode.GatewayTimeout: // 504
                        Console.WriteLine("System error! Please contact to LOX24 support!");
                        break;
                }
            }
        }
    }

package main

import (
  "bytes"
  "encoding/json"
  "fmt"
  "io/ioutil"
  "log"
  "net/http"
)

func main() {

  const Method = "POST"
  const URL = "https://api.lox24.eu/groups"
  const Token = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx"

  payload := map[string]interface{}{
    "name": "My Clients",
    "description": "Best clients",
    "name_a": "prefix",
    "name_b": "name",
    "name_c": "datetime",
    "name_d": "price",
    "name_e": "something_else",
  }

  jsonPayload, _ := json.Marshal(payload)

  client := &http.Client{}

  req, err := http.NewRequest(Method, URL, bytes.NewBuffer(jsonPayload))
  if err != nil {
    log.Fatal(err)
  }

  req.Header.Add("X-LOX24-AUTH-TOKEN", Token)
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    log.Fatal(err)
  }

  defer res.Body.Close()

  body, err := ioutil.ReadAll(res.Body)
  if err != nil {
    log.Fatal(err)
  }

  switch res.StatusCode {
  case 201:
    fmt.Println((string(body)))
  case 400:
    fmt.Println("Error: code = 400 - Invalid input")
  case 401:
    fmt.Println("Error: code = 401 - Client ID or API key isn't active or invalid!")
  case 403:
    fmt.Println("Error: code = 403 - Account isn't activated. Please wait or contact to support!")
  default:
    fmt.Printf("Error: code = %d\n", res.StatusCode)
  }
}

package eu.lox24.doc.group;

import org.json.JSONObject;

import java.io.IOException;
import java.net.HttpURLConnection;
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.time.Duration;

public class PostGroupCollection {

    public static void main(String[] args) {

        var key = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx";
        var url = "https://api.lox24.eu/groups";

        var json = new JSONObject();
        json.put("name", "My Clients");
        json.put("description", "Best clients");
        json.put("name_a", "prefix");
        json.put("name_b", "name");
        json.put("name_c", "datetime");
        json.put("name_d", "price");
        json.put("name_e", "something_else");

        var postData = json.toString();

        System.out.println("Post data: " + postData);

        var httpRequest = HttpRequest.newBuilder(URI.create(url))
                .timeout(Duration.ofMillis(100000))
                .setHeader("Content-Type", "application/json; charset=utf-8")
                .setHeader("Accept", "application/json") // or application/ld+json
                .setHeader("X-LOX24-AUTH-TOKEN", key)
                .POST(HttpRequest.BodyPublishers.ofString(postData))
                .build();

        var client = HttpClient.newBuilder()
                .version(HttpClient.Version.HTTP_1_1) // Http 1.1 clients are kept alive be default
                .build();

        try {
            var httpResponse = client.send(httpRequest, HttpResponse.BodyHandlers.ofString());

            if (httpResponse.statusCode() == HttpURLConnection.HTTP_CREATED) {
                System.out.println("Success:" + httpResponse.statusCode() + " " + "group resource created");
                System.out.println("Response text : \n" + httpResponse.body());

            } else {

                System.out.println("Error: wrong response code " + httpResponse.statusCode() + " on create group");

                switch (httpResponse.statusCode()) {

                    case HttpURLConnection.HTTP_BAD_REQUEST: // 400
                        System.out.println("Error:400 Invalid input");
                        break;
                    case HttpURLConnection.HTTP_UNAUTHORIZED: // 401
                        System.out.println("Error:401 Client ID or API key isn't active or invalid!");
                        break;
                    case HttpURLConnection.HTTP_FORBIDDEN: // 403
                        System.out.println("Error:403 Account isn't activated. Please wait or contact to support!");
                        break;
                    case HttpURLConnection.HTTP_INTERNAL_ERROR: // 500
                    case HttpURLConnection.HTTP_BAD_GATEWAY: //502
                    case HttpURLConnection.HTTP_UNAVAILABLE: // 503
                    case HttpURLConnection.HTTP_GATEWAY_TIMEOUT: // 504
                        System.out.println("System error! Please contact to LOX24 support!");
                        break;
                }

            }

        } catch (IOException | InterruptedException e) {
            e.printStackTrace();
        }
    }
}

const host = 'api.lox24.eu';
const token = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx";

var postObj = {
    sender_id: 'My Sender',
    text: 'Test message',
    service_code: 'direct',
    phone: '+49751234567',
    delivery_at: 1573724611,
    is_unicode: true
};

var postdata = JSON.stringify(postObj);

const https = require('https');
const options = {
    hostname: host,
    path: '/groups',
    method: 'POST',
    headers: {
        'Accept': 'application/json',
        'Content-Type': 'application/json',
        'Content-Length': postdata.length,
        'X-LOX24-AUTH-TOKEN': token
    }
}

const req = https.request(options, res => {
    if (res.statusCode == 201) {
        console.log("Success: code = 201 - group resource created");
        res.on('data', d => { process.stdout.write(d) })
    } else if (res.statusCode == 400) {
        console.log("Error: code = 400 - Invalid input");
    } else if (res.statusCode == 401) {
        console.log("Error: code = 401 - Client ID or API key isn't active or invalid!");
    } else if (res.statusCode == 402) {
        console.log("Error: code = 402 - There are not enough funds on your account!");
    } else if (res.statusCode == 403) {
        console.log("Error: code = 403 - Account isn't activated. Please wait or contact to support!");
    } else {
        console.log("Error: code = " + res.statusCode );
    }
})

req.on('error', error => {
    console.error(error)
})
req.write(postdata);
req.end();

<?php

$uri = 'https://api.lox24.eu/groups';

$token = '1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx';

$body = [
    "name" => "My Clients",
    "description" => "Best clients",
    "name_a" => "prefix",
    "name_b" => "name",
    "name_c" => "datetime",
    "name_d" => "price",
    "name_e" => "something_else",
];

if(!$body = json_encode($body)) {
    die('JSON encoding error!');
}

$curl = curl_init();

curl_setopt_array($curl, [
    CURLOPT_POST => true,
    CURLOPT_URL => $uri,
    CURLOPT_POSTFIELDS => $body,
    CURLOPT_HTTPHEADER => [
        "X-LOX24-AUTH-TOKEN: {$token}",
        'Accept: application/json', // or application/ld+json
        'Content-Type: application/json',
    ],
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_TIMEOUT => 20,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
]);

$response = curl_exec($curl);
$code = curl_getinfo($curl, CURLINFO_HTTP_CODE);
curl_close($curl);

$data = json_decode($response, JSON_OBJECT_AS_ARRAY);

if(201 === $code) {
    echo 'Success: response data = ' . var_export($data, true);
} else {
    echo "Error: code = {$code}, data = " . var_export($data, true);
}

import json
import requests


token = "1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx"

url = 'https://api.lox24.eu/groups'


data = {
    'name': 'My Clients',
    'description': 'Best clients',
    'name_a': 'prefix',
    'name_b': 'name',
    'name_c': 'datetime',
    'name_d': 'price',
    'name_e': 'something_else'
}

headers = {
    'Accept': 'application/json',
    'Content-Type': 'application/json',
    'X-LOX24-AUTH-TOKEN': token,
}

print("Post data : ", json.dumps(data, indent=4))

try:
    # timeout is 100 seconds, the payload is automatically converted to json format
    res = requests.post(url, headers=headers, json=data, timeout=100)
    if res.status_code != 201: # Created
        print("Error: Wrong response code on create group")
        res.raise_for_status()
    else:
        print(f'Success: code = {res.status_code} - group resource created')
        print("Response: ", json.dumps(res.json(), indent=4))

except requests.HTTPError:
    if res.status_code == 400:
        print("Error:400 Invalid input")
    elif res.status_code == 401:
        print("Error: code = 401 - Client ID or API key isn't active or invalid!")
    elif res.status_code == 402:
        print("Error:402 There are not enough funds on your account!")
    elif res.status_code == 403:
        print("Error: code = 403 - Account isn't activated. Please wait or contact to support!")
    elif res.status_code in (500, 502, 503, 504):
        print("System error! Please contact to LOX24 support!")
    else:
        print(f"Error: code {res.status_code}")
    print(json.dumps(res.json(), indent=4))

Criar um Grupo

Authorizations

Request Body required

Example generated

Responses

201

Example

Example generated

400

401

403

422

429

Code Samples

Request Body^required

Example ^generated

Example ^generated