Skip to content

REST API SmsManager (v1)

API pro správu účtů a dalších zdrojů SmsManageru.

Download OpenAPI description
Languages
Servers
Mock server

https://api-ref.smsmanager.com/_mock/openapi/cs/rest/restapi_v1/

Odpoví s daty vašeho požadavku

https://rest-api.smsmngr.com/v1/

API klíč

Pro správu API klíčů použijte následující koncové body.

Operations

Získat informace o aktuálním API klíči

Request

Security
x-api-key
curl -i -X GET \
  https://api-ref.smsmanager.com/_mock/openapi/cs/rest/restapi_v1/apikey/me \
  -H 'x-api-key: YOUR_API_KEY_HERE'

Responses

Informace o API klíči

Bodyapplication/json
successboolean

Stav úspěchu.

Example: true
meobject

Informace o API klíči.

Response
application/json
{ "success": true, "me": { "note": "string", "default_callback_url": "string", "account": "prepaid" } }

Vytvořit nový API klíč

Request

Security
x-api-key
Bodyapplication/jsonrequired
sharedboolean

Pokud je true, nový API klíč bude sdílet váš kreditní limit. Pokud je false, nový API klíč bude mít vlastní kredit.

currencystring

Měna pro API klíč. Pokud je nový API klíč sdílený, měna musí být stejná jako u rodičovského API klíče(!)

Default "CZK"
Enum"EUR""CZK"
curl -i -X POST \
  https://api-ref.smsmanager.com/_mock/openapi/cs/rest/restapi_v1/apikey/add \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "shared": true,
    "currency": "EUR"
  }'

Responses

Nový API klíč

Bodyapplication/json
successboolean

Stav úspěchu.

Example: true
apikeystring

Nový API klíč.

Example: "1234567890"
Response
application/json
{ "success": true, "apikey": "1234567890" }

Aktualizovat API klíč

Request

Security
x-api-key
Bodyapplication/jsonrequired
default_callback_urlstring

Výchozí URL pro zpětné volání pro tento API klíč. Tato URL bude použita pro příchozí zprávy bez vazby na odchozí zprávy.

notestring

Poznámka k API klíči.

curl -i -X POST \
  https://api-ref.smsmanager.com/_mock/openapi/cs/rest/restapi_v1/apikey/update \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "default_callback_url": "string",
    "note": "string"
  }'

Responses

Aktualizovaný API klíč

Bodyapplication/json
successboolean

Stav úspěchu.

Example: true
Response
application/json
{ "success": true }

Stav

Pro čtení stavu odeslaných zpráv použijte následující koncové body.

Operations

Inbox

For reading inbox messages use the following endpoints.

Operations

Credit

For reading credit balance or pricelist info use the following endpoints.

Operations