JSON API

Send a synchronous JSON API request

One endpoint for every operation. The operation is selected by data[].type. Several operations may be sent in one request — data is an array. The response returns msg_id per message immediately.

post/api/json.php

Request

  • Base URL: https://api.alphasms.ua
  • URL: https://api.alphasms.ua/api/json.php
  • Auth: API key in header auth

Request body

authstring required

API key from the personal cabinet.

dataOperation[] required(unresolved $ref)

One or more operation objects.

Response

Always 200, including on failure. Check success at the top level, then success inside each data[] item.

successboolean

Whether the envelope itself was accepted. Note: this is a boolean, even though some documentation tables call it an integer.

errorstring

Present when the envelope was rejected, e.g. Access denied.

Changes

No recorded changes to this operation across all 1 revision of this API.