h1. REST API

{{>toc}}

h2. Server interface

Server interface - is API, which Smartswitch presents to a client.
The API strictly follows recommendations of the "JSON API Specification":https://jsonapi.org/.
Access to the interface occurs on URLs that have the following format:

https://your.server.name/api/interface

Available *server interfaces*:

|*name*|*description*|
|[[HTTP API active_calls|active_calls]]|returns a list of currently active calls that are received on internal phones for this account|
|[[HTTP API amocrm_settings|amocrm_settings]]|saves settings for integration with AmoCRM for this account|
|[[HTTP API call|call]]|initiates 2 calls, and connects them together|
|[[HTTP API cdr|cdr]]|returns a list of CDR for the account|
|[[HTTP API dlr|dlr]]|sends message Delivery Receipt|
|[[HTTP API hlr|hlr]]|performs [[HLR dipping]] and returns the result|
|[[HTTP API lnp_mnp|lnp_mnp]]|performs [[LNP/MNP dipping]] and returns the result|
|[[HTTP API message|message]]|sends message|
|[[HTTP API recordings|recordings]]|returns the URL of the audio recording of the call|

h2. Client interface

Client interface - is API, which client presents to the Smartswitch.
This interface could be used by Smartswitch to deliver events to a client.
To access the interface, client provides URL.
This URL must be configured in peer settings on Smartswitch side.

Available *client interfaces*:

* [[HTTP API deliver delivery receipt|Deliver delivery receipt]]

See also:

* [[ICE API]]
* [[AMI API]]

[[Интерфейс приложений HTTP|Русский перевод]]