# LOX24 API Documentation

> Official documentation for the LOX24 SMS and messaging REST API v2 at https://api.lox24.eu: sending SMS, bulk campaigns, verify codes, blocked numbers, fraud checks, short links, notifications and accounting. Every endpoint authenticates with the `X-LOX24-AUTH-TOKEN` and `X-LOX24-CLIENT-ID` HTTP headers.

The documentation exists in English, German, Spanish and Portuguese with the same content. The machine readable OpenAPI 3 description is published as JSON for each language.

## Getting started

- [Documentation overview](https://doc.lox24.eu/): Entry point with quick start steps and links to every guide.
- [SMS guide](https://doc.lox24.eu/info/sms/): Sending a single SMS, request fields, dry run, status polling, stopping a delayed message and deleting a message.
- [Encoding and count of characters](https://doc.lox24.eu/info/encoding-and-number-of-characters/): GSM 03.38 and UCS-2 encoding, the `is_unicode` field and message concatenation.
- [SMS status codes](https://doc.lox24.eu/info/sms-status-codes/): Meaning of the `status_code` property.
- [SMS delivery report codes (DLR)](https://doc.lox24.eu/info/sms-delivery-report-codes-dlr/): Meaning of delivery report codes and how to receive DLRs.
- [Collection filters](https://doc.lox24.eu/info/collection-filters/): Search, range and order filters plus pagination for collection endpoints.

## API reference

- [API reference](https://doc.lox24.eu/api/): Every endpoint with parameters, schemas and code samples in bash, C#, Go, Java, JavaScript, PHP and Python.
- [OpenAPI JSON, English, compact](https://doc.lox24.eu/openapi-en.min.json): Minified OpenAPI 3 description for tooling and code generation.
- [OpenAPI JSON, English, formatted](https://doc.lox24.eu/openapi-en.json)
- [API reference, German](https://doc.lox24.eu/de/api/)
- [API reference, Spanish](https://doc.lox24.eu/es/api/)
- [API reference, Portuguese](https://doc.lox24.eu/pt/api/)

## Guides

- [Bulk SMS](https://doc.lox24.eu/info/bulks/): Sending a bulk to phone numbers or groups, dry run, status polling and stopping a running bulk.
- [Groups](https://doc.lox24.eu/info/groups/): Creating, reading, deleting and exporting mailing lists.
- [Incoming SMS](https://doc.lox24.eu/info/incomings/): Retrieving inbound messages over the API instead of receiving them as push.
- [Inbound SMS and reply SMS](https://doc.lox24.eu/info/inbound-and-reply-sms/): Receiving mobile originated messages and replies on an inbound number.
- [Notifications](https://doc.lox24.eu/info/notifications/): Event webhooks delivered over HTTP or email, event object structure and the list of events.
- [Verify codes](https://doc.lox24.eu/info/verify-codes/): One time codes over Telegram, voice or SMS with automatic fallback between channels.
- [Fraud detection](https://doc.lox24.eu/info/fraud-detection/): Risk score from 0 to 100 for phone numbers, email addresses, IP addresses and postal addresses.
- [Blocked numbers](https://doc.lox24.eu/info/blocked-numbers/): Maintaining the list of phone numbers that must not receive messages.
- [Campaigns](https://doc.lox24.eu/info/campaigns/): Creating and managing short link campaigns.
- [Short links](https://doc.lox24.eu/info/links/): Querying the short links of one or all campaigns.
- [Send a link](https://doc.lox24.eu/info/send-link/): Sending an SMS with a tracked short link on the l24.pw domain.
- [Click rate](https://doc.lox24.eu/info/click-rate/): Click statistics for sent short links.
- [Requests](https://doc.lox24.eu/info/requests/): Per recipient click results of a short link campaign.
- [Account information](https://doc.lox24.eu/info/user/): Balance, credit line and profile data.
- [Price list](https://doc.lox24.eu/info/pricelist/): SMS and text to speech rates per country in XLSX or CSV, public and without authentication.

## Accounting

- [Invoices](https://doc.lox24.eu/info/invoices/): Retrieving invoices and credit notes with filters.
- [Credit notes](https://doc.lox24.eu/info/creditnotes/): Credit note status, amounts and PDF download links.
- [Payments](https://doc.lox24.eu/info/payments/): Creating payments and checking their status.

## Optional

- [Email to SMS](https://doc.lox24.eu/info/email-to-sms/): Sending a single SMS or a group SMS by email.
- [SSML and language detection](https://doc.lox24.eu/info/ssml-language-detection/): Sender ID and language handling for voice messages.
- [Kannel API emulation](https://doc.lox24.eu/info/kannel/): Connecting the SMS API as an additional SMSC module in Kannel.
- [Release notes](https://doc.lox24.eu/info/release-notes/): API changes per version.
- [German documentation](https://doc.lox24.eu/de/)
- [Spanish documentation](https://doc.lox24.eu/es/)
- [Portuguese documentation](https://doc.lox24.eu/pt/)