Skip to content
LOX24 API Docs

Overview

LOX24 API Specification (EN) (2.24)

Section titled “LOX24 API Specification (EN) (2.24)”

Introduction

On these pages you will find our documentation for transmitting messages using the LOX24 SMS Gateway. The documentation helps you to integrate our SMS API into your own applications and therefore to send and receive SMS messages. You can find our SMS API at api.lox24.eu. You access the individual functions accordingly with a /function. E.g. api.lox24.eu/me for querying your customer account and api.lox24.eu/sms to send an SMS. All endpoints require authentication by HTTP Header.

Highlights

  • Use HTTPS, for fully SSL encrypted messages
  • Send concatenated sms, appearing as a single SMS on the handset
  • Send messages with text in GSM 03.38 charset or Unicode
  • Transmit any sender ID with up to 15 digits or 11 characters
  • Send a mass SMS to your complete mailing list with just one request
  • Receive replies to your sent messages via HTTP, HTTPS or SMTP
  • Receive or check the delivery status of outbound messages
  • Receive inbound messages from your (optional) inbound number

Request Content-Type

The Content-Type for POST and PUT requests can be set to application/json or multipart/form-data (on endpoints with file uploads).

Response Headers

Each API response includes a unique request identifier in the X-LOX24-REQUEST-ID header. This 32-character alphanumeric identifier is generated for every request and can be used for support purposes when reporting issues or tracking specific API calls.

Datetime properties

Most of the datetime requests/responses objects are unix timestamps (integer).

IP blocking

If more than three requests are received from an IP address with incorrect authentication data within one minute, all subsequent requests from this IP will receive a response with the 429 status (Too Many Requests) within the next ten minutes.

Authentication

All endpoints require you to be authenticated. To become authenticated you will need to create an API token from your web-account (http://account.lox24.eu “Settings” and “API-Settings”). Once you have your API Key you can pass it as an HTTP header like this:

curl -X GET https://api.lox24.eu/me \
  -H 'Host: api.lox24.eu' \
  -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx'
curl -X POST https://api.lox24.eu/groups/7116/phones \
  -H 'Content-Type: application/json' \
  -H 'Host: api.lox24.eu' \
  -H 'X-LOX24-AUTH-TOKEN: 1234567:e3f3a759b6677959b6ebfcxxxxxxxxxx' \
  -d '{
    "phone": "+4917663804817",
    "a": "o2"
}'

Legacy authentication method

We also continue to support the old version of authentication with two headers ‘X-LOX24-CLIENT-ID’ and ’ X-LOX24-AUTH-TOKEN’

curl -X GET https://api.lox24.eu/me \
  -H 'Host: api.lox24.eu' \
  -H 'X-LOX24-AUTH-TOKEN: e3f3a759b6677959b6ebfcxxxxxxxxxx' \
  -H 'X-LOX24-CLIENT-ID: 1234567'

Important!

Never share your secret keys. Keep them guarded and secure. If a key is unintentionally published, you can deactivate or delete it at any time in your web account (https://account.lox24.eu) in the “Settings” and “API settings”.

Authentication

Section titled “ Authentication ”

token

Section titled “token ”

After logging in to your web account, you can create, deactivate or delete one or more API keys in the “Settings” under “API Settings” (please select a v2 Key).

Security scheme type: apiKey

Header parameter name: X-LOX24-AUTH-TOKEN