SMSbrána SMS Connect

https://www.smsbrana.cz/dokumentace
Admin
SMSbrána SMS Connect is an HTTP API service that enables applications to send and receive SMS...
Tokens:11,762
Snippets:55
Trust Score:7.5
Update:3 weeks ago
Show doc for...
Tokens:
Raw
### GET /smsconnect/ - credit_info Action

Source: https://www.smsbrana.cz/dokumentace

Action to retrieve credit information for the account.

```APIDOC
## [GET] /smsconnect/

### Description
Retrieves the remaining credit for the SMS Connect account.

### Method
GET

### Endpoint
https://api.smsbrana.cz/smsconnect/

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be set to `credit_info`.
- **login** (string) - Required - Username for authentication.
- **password** (string) - Required for simple authentication - Password for authentication.
- **time** (string) - Required for advanced authentication - Timestamp in format YYYYMMDDTHHMMSS.
- **salt** (string) - Required for advanced authentication - Unique random string.
- **auth** (string) - Required for advanced authentication - MD5 hash of password+time+salt.

### Request Example
https://api.smsbrana.cz/smsconnect/?action=credit_info&login=your_login&password=your_password

### Response
#### Success Response (200)
- **credit** (number) - Remaining credit.

#### Response Example
{
  "credit": 123.45
}
```

--------------------------------

### Příklad požadavku na vyvolání akce credit_info

Source: https://www.smsbrana.cz/dokumentace

Příklad GET požadavku pro zjištění kreditu. Obsahuje povinné parametry login, password a action=credit_info.

```http
GET http://api.smsbrana.cz/smsconnect/?login=<váš_login>&password=<vaše_heslo>&action=credit_info
```

--------------------------------

### GET credit_info

Source: https://www.smsbrana.cz/dokumentace

Retrieves the current remaining credit amount for the account.

```APIDOC
## GET credit_info

### Description
Retrieves the current remaining credit amount for the account.

### Method
GET

### Endpoint
http://api.smsbrana.cz/smsconnect/?login=<login>&password=<password>&action=credit_info

### Parameters
#### Query Parameters
- **login** (string) - Required - Your login.
- **password** (string) - Required - Your password.
- **action** (string) - Required - Must be set to `credit_info`.

### Request Example
GET http://api.smsbrana.cz/smsconnect/?login=<váš_login>&password=<vaše_heslo>&action=credit_info

### Response
#### Success Response (200)
- **credit** (number) - Remaining credit amount.

#### Response Example
<result> <credit>1523.32</credit> </result>
```

--------------------------------

### GET /smsconnect/ - xml_queue Action

Source: https://www.smsbrana.cz/dokumentace

Action to send multiple SMS messages via XML queue.

```APIDOC
## [GET] /smsconnect/

### Description
Sends multiple SMS messages in a batch using an XML queue.

### Method
GET

### Endpoint
https://api.smsbrana.cz/smsconnect/

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be set to `xml_queue`.
- **login** (string) - Required - Username for authentication.
- **password** (string) - Required for simple authentication - Password for authentication.
- **time** (string) - Required for advanced authentication - Timestamp in format YYYYMMDDTHHMMSS.
- **salt** (string) - Required for advanced authentication - Unique random string.
- **auth** (string) - Required for advanced authentication - MD5 hash of password+time+salt.
- **xml** (string) - Required - XML data containing the SMS messages to send.

### Request Example
https://api.smsbrana.cz/smsconnect/?action=xml_queue&login=your_login&password=your_password&xml=<messages><message><number>420777123456</number><text>Hello</text></message></messages>

### Response
#### Success Response (200)
- **status** (string) - Status of the request.
- **queue_id** (string) - Identifier of the queue.

#### Response Example
{
  "status": "OK",
  "queue_id": "queue123"
}
```

--------------------------------

### GET /smsconnect/ - Simple Authentication

Source: https://www.smsbrana.cz/dokumentace

Authentication method where the password is sent in plain text. Suitable for testing and quick integration.

```APIDOC
## [GET] /smsconnect/

### Description
Simple authentication for the SMS Connect API. The password is transmitted in plain text.

### Method
GET

### Endpoint
https://api.smsbrana.cz/smsconnect/

### Parameters
#### Query Parameters
- **login** (string) - Required - Username for the SMS Connect service.
- **password** (string) - Required - Password for the SMS Connect service.

### Request Example
https://api.smsbrana.cz/smsconnect/?login=your_login&password=your_password&action=credit_info

### Response
#### Success Response (200)
- **credit** (number) - Remaining credit.

#### Response Example
{
  "credit": 123.45
}
```

--------------------------------

### Příklad odpovědi na GET požadavek akce credit_info

Source: https://www.smsbrana.cz/dokumentace

Příklad XML odpovědi na požadavek credit_info. Obsahuje element credit s výší zbývajícího kreditu.

```xml
<result> <credit>1523.32</credit> </result>
```

--------------------------------

### GET send_sms

Source: https://www.smsbrana.cz/dokumentace

Sends a single SMS message via an HTTP GET request. Supports optional parameters for scheduling, delivery reports, sender identification, custom user IDs, encoding, and email notifications.

```APIDOC
## GET send_sms

### Description
Sends a single SMS message via an HTTP GET request. Supports optional parameters for scheduling, delivery reports, sender identification, custom user IDs, encoding, and email notifications.

### Method
GET

### Endpoint
http://api.smsbrana.cz/smsconnect/?login=<login>&password=<password>&action=send_sms

### Parameters
#### Query Parameters
- **login** (string) - Required - Your login.
- **password** (string) - Required - Your password.
- **action** (string) - Required - Must be set to `send_sms`.
- **number** (string) - Required - Recipient phone number in national (e.g., 789123456) or international format (+420789123456). International numbers must always be in international format.
- **message** (string) - Required - Message text without diacritics (7-bit). Length limits: 1 SMS up to 160 characters, 2 SMS up to 306 characters, 3 SMS up to 459 characters.
- **when** (string) - Optional - Scheduled sending time in format YYYYMMDDTHHMMSS.
- **delivery_report** (integer) - Optional - 1 = with delivery report (default), 0 = without delivery report.
- **sender_id** (string) - Optional - Sender name (SenderID). Found in Settings > SenderID. If both sender_id and sender_phone are provided, sender_phone takes precedence.
- **sender_phone** (string) - Optional - Sender phone number (SenderID). Must be in your authorized numbers list. If both sender_id and sender_phone are provided, sender_phone takes precedence.
- **user_id** (string) - Optional - Custom message identifier (varchar(50)). System accepts only one SMS with a given user_id. Not a 100% protection against multi-send.
- **data_code** (string) - Optional - Encoding: `7bit` (standard, 160 chars, default) or `ucs2` (unicode with diacritics/special chars, 70 chars).
- **answer_mail** (string) - Optional - Email address for forwarding reply SMS.
- **delivery_mail** (string) - Optional - Email address for sending delivery reports.

### Request Example
GET http://api.smsbrana.cz/smsconnect/?login=Váš Login&password=Vaše_Heslo&action=send_sms&number=774884136&message=test

### Response
#### Success Response (200)
- **err** (integer) - Result code, 0-12 (0 = no error).
- **price** (number) - Price for the sent SMS in account currency.
- **sms_count** (integer) - Number of sent SMS.
- **credit** (number) - Remaining credit.
- **sms_id** (integer) - Unique ID of the sent message for delivery report pairing.

#### Response Example
<result> <err>0</err> <price>1.1</price> <sms_count>1</sms_count> <credit>1523.32</credit> <sms_id>377351</sms_id> </result>
```

--------------------------------

### GET /smsconnect/ - send_sms Action

Source: https://www.smsbrana.cz/dokumentace

Action to send an SMS message. Requires authentication and the action parameter set to send_sms.

```APIDOC
## [GET] /smsconnect/

### Description
Sends an SMS message using the SMS Connect API.

### Method
GET

### Endpoint
https://api.smsbrana.cz/smsconnect/

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be set to `send_sms`.
- **login** (string) - Required - Username for authentication.
- **password** (string) - Required for simple authentication - Password for authentication.
- **time** (string) - Required for advanced authentication - Timestamp in format YYYYMMDDTHHMMSS.
- **salt** (string) - Required for advanced authentication - Unique random string.
- **auth** (string) - Required for advanced authentication - MD5 hash of password+time+salt.
- **number** (string) - Required - Recipient phone number.
- **message** (string) - Required - Text of the SMS message.

### Request Example
https://api.smsbrana.cz/smsconnect/?action=send_sms&login=your_login&password=your_password&number=420777123456&message=Hello%20world

### Response
#### Success Response (200)
- **status** (string) - Status of the request (e.g., OK).
- **sms_id** (string) - Identifier of the sent SMS.

#### Response Example
{
  "status": "OK",
  "sms_id": "123456789"
}
```

--------------------------------

### GET /smsconnect/ - inbox Action

Source: https://www.smsbrana.cz/dokumentace

Action to retrieve incoming SMS messages.

```APIDOC
## [GET] /smsconnect/

### Description
Retrieves incoming SMS messages from the inbox.

### Method
GET

### Endpoint
https://api.smsbrana.cz/smsconnect/

### Parameters
#### Query Parameters
- **action** (string) - Required - Must be set to `inbox`.
- **login** (string) - Required - Username for authentication.
- **password** (string) - Required for simple authentication - Password for authentication.
- **time** (string) - Required for advanced authentication - Timestamp in format YYYYMMDDTHHMMSS.
- **salt** (string) - Required for advanced authentication - Unique random string.
- **auth** (string) - Required for advanced authentication - MD5 hash of password+time+salt.

### Request Example
https://api.smsbrana.cz/smsconnect/?action=inbox&login=your_login&password=your_password

### Response
#### Success Response (200)
- **messages** (array) - List of incoming messages.
  - **id** (string) - Message ID.
  - **from** (string) - Sender number.
  - **text** (string) - Message text.
  - **timestamp** (string) - Time of receipt.

#### Response Example
{
  "messages": [
    {
      "id": "1",
      "from": "420777123456",
      "text": "Hello",
      "timestamp": "2026-10-01T22:27:20"
    }
  ]
}
```

--------------------------------

### GET /smsconnect/ - Advanced Authentication

Source: https://www.smsbrana.cz/dokumentace

Advanced authentication method using MD5 hash for security. The password is not sent directly but as part of a hash with time and salt.

```APIDOC
## [GET] /smsconnect/

### Description
Advanced authentication for the SMS Connect API. The password is not sent directly; instead, an MD5 hash of password+time+salt is sent.

### Method
GET

### Endpoint
https://api.smsbrana.cz/smsconnect/

### Parameters
#### Query Parameters
- **login** (string) - Required - Username for the SMS Connect service.
- **time** (string) - Required - Timestamp in format YYYYMMDDTHHMMSS. Example: 20261001T222720
- **salt** (string) - Required - Unique random string (max 50 characters). Each combination of salt and time can be used only once per calendar day.
- **auth** (string) - Required - MD5 hash generated from the string: password + time + salt.

### Request Example
https://api.smsbrana.cz/smsconnect/?login=your_login&time=20261001T222720&salt=random_salt&auth=md5_hash&action=credit_info

### Response
#### Success Response (200)
- **credit** (number) - Remaining credit.

#### Response Example
{
  "credit": 123.45
}
```

--------------------------------

### Příklad požadavku na vyvolání akce inbox

Source: https://www.smsbrana.cz/dokumentace

Příklad GET požadavku pro stažení příchozích SMS a doručenek. Používá parametry login, password a action=inbox.

```http
GET http://api.smsbrana.cz/smsconnect/?login=<váš_login>&password=<vaše_heslo>&action=inbox
```

--------------------------------

### POST xml_queue - Send multiple SMS in one request

Source: https://www.smsbrana.cz/dokumentace

Sends multiple SMS messages in a single request using XML format passed via RAW POST. Authentication and action name are provided via GET parameters.

```APIDOC
## POST xml_queue

### Description
Sends multiple SMS messages in a single request using XML format passed via RAW POST. Authentication and action name are provided via GET parameters.

### Method
POST

### Endpoint
http://api.smsbrana.cz/smsconnect/?login=<your_login>&password=<your_password>&action=xml_queue

### Parameters
#### Query Parameters
- **login** (string) - Required - Your login.
- **password** (string) - Required - Your password.
- **action** (string) - Required - Must be `xml_queue`.

#### Request Body
XML structure with `<queue>` containing one or more `<sms>` elements. Each `<sms>` element contains:
- **number** (string) - Required - Recipient phone number.
- **message** (string) - Required - SMS text.
- **when** (string) - Optional - Scheduled time (empty for immediate).
- **sender_id** (string) - Optional - Sender ID.
- **delivery_report** (string) - Optional - Delivery report flag.

### Request Example
```xml
<queue>
  <sms>
    <number>774884136</number>
    <message>test</message>
    <when></when>
    <sender_id></sender_id>
    <delivery_report></delivery_report>
  </sms>
  <sms>
    <number>+420733781178</number>
    <message>test</message>
    <when></when>
    <sender_id></sender_id>
    <delivery_report></delivery_report>
  </sms>
</queue>
```

### Response
#### Success Response (200)
- **err** (integer) - Overall result, 0-9 (0 = no error).
- **price** (float) - Total price for the batch in account currency.
- **sms_count** (integer) - Number of sent SMS.
- **credit** (float) - Remaining credit in account currency.
- **result_sms** (array) - Information about each SMS.
  - **item** (object) - Per-SMS result.
    - **err** (integer) - Result for the SMS, values 0, 10, 11, 12 (0 = no error).
    - **number** (string) - Recipient number in international format.
    - **sms_id** (integer) - Unique ID of the sent message.
    - **item_price** (float) - Price for the specific SMS.

#### Response Example
```xml
<result>
  <err>0</err>
  <price>2.2</price>
  <sms_count>2</sms_count>
  <credit>1501.32</credit>
  <result_sms>
    <item>
      <err>0</err>
      <number>+420774884136</number>
      <sms_id>377450</sms_id>
      <item_price>1.08</item_price>
    </item>
    <item>
      <err>10</err>
      <number>+420774123456</number>
    </item>
    <item>
      <err>0</err>
      <number>+420733781178</number>
      <sms_id>377451</sms_id>
      <item_price>1.08</item_price>
    </item>
  </result_sms>
</result>
```
```

--------------------------------

### Příklad odpovědi na GET požadavek akce send_sms

Source: https://www.smsbrana.cz/dokumentace

Příklad XML odpovědi na požadavek send_sms. Obsahuje elementy err, price, sms_count, credit a sms_id.

```xml
<result> <err>0</err> <price>1.1</price> <sms_count>1</sms_count> <credit>1523.32</credit> <sms_id>377351</sms_id> </result>
```

--------------------------------

### Příklad požadavku na vyvolání akce send_sms

Source: https://www.smsbrana.cz/dokumentace

Příklad GET požadavku pro odeslání SMS. Obsahuje povinné parametry login, password, action, number a message.

```http
GET http://api.smsbrana.cz/smsconnect/?login=Váš Login&password=Vaše_Heslo&action=send_sms&number=774884136&message=test
```

--------------------------------

### Příklad odpovědi na GET požadavek akce inbox

Source: https://www.smsbrana.cz/dokumentace

Příklad odpovědi na požadavek inbox. Obsahuje doručené SMS a doručenky s detaily jako číslo, čas, status a ID zprávy.

```xml
<result> <inbox> <delivery_sms> <item> <number>+420774884136</number> <time>20091020T164508</time> <message>test</message> </item> </delivery_sms> <delivery_report> <item> <idsms>377339</idsms> <number>+420774884136</number> <time>20091020T132528</time> <status>1</status> </item> <item> <idsms>377340</idsms> <number>+420774884136</number> <time>20091020T181102</time> <status>1</status> </item> </delivery_report> </inbox> </result>
```

--------------------------------

### GET inbox - Retrieve incoming SMS and delivery reports

Source: https://www.smsbrana.cz/dokumentace

Retrieves incoming SMS and delivery reports for sent messages. Optionally deletes already displayed messages from the inbox by including the delete parameter.

```APIDOC
## GET inbox

### Description
Retrieves incoming SMS and delivery reports for sent messages. Optionally deletes already displayed messages from the inbox by including the delete parameter.

### Method
GET

### Endpoint
http://api.smsbrana.cz/smsconnect/?login=<your_login>&password=<your_password>&action=inbox

### Parameters
#### Query Parameters
- **login** (string) - Required - Your login.
- **password** (string) - Required - Your password.
- **action** (string) - Required - Must be `inbox`.
- **delete** (integer) - Optional - If present, deletes already displayed messages from the inbox. Example: `delete=1`.

### Request Example
```
GET http://api.smsbrana.cz/smsconnect/?login=<your_login>&password=<your_password>&action=inbox
```

### Response
#### Success Response (200)
- **inbox** (object) - Contains incoming SMS and delivery reports.
  - **delivery_sms** (array) - Incoming SMS messages.
    - **item** (object) - Each incoming SMS.
      - **number** (string) - Number from which the SMS was delivered.
      - **time** (string) - Time of delivery.
      - **message** (string) - Text of the received SMS.
  - **delivery_report** (array) - Delivery reports.
    - **item** (object) - Each delivery report.
      - **idsms** (integer) - Identifier of the SMS message received when sending.
      - **number** (string) - Number to which the SMS was delivered.
      - **time** (string) - Time of delivery.
      - **status** (integer) - Delivery status: 0 = sent, 1 = delivered, 2 = stored at operator, 3 = not delivered, 5 = expired, 6 = rejected.
      - **user_id** (string) - Optional - Custom identifier if provided when sending.

#### Response Example
```xml
<result>
  <inbox>
    <delivery_sms>
      <item>
        <number>+420774884136</number>
        <time>20091020T164508</time>
        <message>test</message>
      </item>
    </delivery_sms>
    <delivery_report>
      <item>
        <idsms>377339</idsms>
        <number>+420774884136</number>
        <time>20091020T132528</time>
        <status>1</status>
      </item>
      <item>
        <idsms>377340</idsms>
        <number>+420774884136</number>
        <time>20091020T181102</time>
        <status>1</status>
      </item>
    </delivery_report>
  </inbox>
</result>
```
```

--------------------------------

### Příklad XML kódu pro akci xml_queue - odpověď na požadavek SMS

Source: https://www.smsbrana.cz/dokumentace

Příklad odpovědi na požadavek odeslání SMS. Obsahuje výsledek akce, cenu, počet SMS, zůstatek kreditu a detailní informace o jednotlivých SMS.

```xml
<result> <err>0</err> <price>2.2</price> <sms_count>2</sms_count> <credit>1501.32</credit> <result_sms> <item> <err>0</err> <number>+420774884136</number> <sms_id>377450</sms_id> <item_price>1.08</item_price> </item> <item> <err>10</err> <number>+420774123456</number> </item> <item> <err>0</err> <number>+420733781178</number> <sms_id>377451</sms_id> <item_price>1.08</item_price> </item> </result_sms> </result>
```

--------------------------------

### Příklad XML kódu pro akci xml_queue - odeslání SMS

Source: https://www.smsbrana.cz/dokumentace

Příklad XML struktury pro hromadné odeslání SMS. Dávka je definována mezi tagy <queue></queue>, každá SMS mezi <sms></sms>. Obsahuje ukázku chybné SMS.

```xml
<queue> <sms> <number>774884136</number> <message>test</message> <when></when> <sender_id></sender_id> <delivery_report></delivery_report> </sms> <sms> {ukázka chybné sms} <number>1234</number> <message>test</message> <when></when> <sender_id></sender_id> <delivery_report></delivery_report> </sms> <sms> <number>+420733781178</number> <message>test</message> <when></when> <sender_id></sender_id> <delivery_report></delivery_report> </sms> </queue>
```

--------------------------------

### Příklad přijatého XML

Source: https://www.smsbrana.cz/dokumentace

Ukázka XML struktury pro doručenky a příchozí SMS v rámci PUSH notifikace. Obsahuje položky income_id, number, status, time, sms_id a receiver.

```xml
<?xml version="1.0" encoding="UTF-8"?>
<inbox>
  <delivery_report>
    <item>
      <income_id>11</income_id>
      <number>+420737602602</number>
      <status>1</status>
      <time>2014-10-10 21:28:23</time>
      <sms_id>101002641</sms_id>
    </item>
    <item>
      <income_id>15</income_id>
      <number>+420790542000</number>
      <status>1</status>
      <time>2014-10-10 21:37:20</time>
      <sms_id>101002657</sms_id>
    </item>
  </delivery_report>
  <delivery_sms>
    <item>
      <income_id>16</income_id>
      <number>+420774884136</number>
      <message>test</message>
      <time>2014-10-10 21:42:08</time>
      <receiver>6633</receiver>
    </item>
  </delivery_sms>
</inbox>
```
Tokens:
Raw