Skip to content

Application Programming Interface

Disclaimer§

For SmartPTT PLUS, regional and other limitations may apply to the feature. Any of those limitations are beyond the responsibility of Elcomplus Inc.

Overview§

SmartPTT values Customer demands in quality, security, and functionality. To satisfy all those demands, we offer an Application Programming Interface (API). With it, our partners can implement unique customer cases, such as integration with external systems. Having API makes SmartPTT applicable beyond our initial expectations and encourages us to make it even better.

Question

Application Programming Interface (API) is a method of interaction of different software products and/or components of products. Its written description is usually named “protocol” or (rarely) “language”.

Examples of World-known APIs are Google Cloud API and Structured Query Language (SQL) (if considered from the perspective of interaction with Database Management Services).

Modules§

  • Server Objects API
    Provides a list of groups, subscribers, and radio resources.

  • Call API
    Provides the ability to receive and send voice calls. Might be used for voice recording.

    Important

    The API does not provide tools to interface with audio devices. It only supports RTP streams manipulations.

  • Emergency API
    Provides the ability to receive Emergency Alarm notifications and clear Emergencies.

  • Commands API
    Provides the ability to decode and encode radio commands, such as Call Alert, Radio Check, Radio Disable, Radio Enable, and Remote Monitor.
  • GPS Location API
    Provides the ability to receive location updates for allowed subscribers.
  • Text Message API
    Provides the ability to decode and encode text messages to groups and subscribers.
  • Audit Log API
    Provides the ability to request audit log data.

Benefits§

  • Platform Independence
    The API might be used to develop apps and services for Windows, Linux, and Mac operating systems. Web-based services and smartphone applications might be developed as well.
  • Technology Agnostic
    Applications and services that useSmartPTT API can be written in any programming language. We do not require to to reuse our specific libraries or create excessive middlewares.
  • Async Communications
    SmartPTT executes API requests asynchronously. Developers do not need to manage a queue of requests and use other “old-school” techniques.

Terms§

The API is a licensed functionality of the product. Each license unlocks one account to be used in an API application.

API description is a confidential, non-public part of SmartPTT documentation. It may be provided upon request from the SmartPTT Support Center.

The Support Center preserves the right to refuse API description provision without explanations.

Changelog§

SmartPTT 9.14.§

Added Audit Log API.

SmartPTT 9.9§

Added Text API version 1.

SmartPTT 9.5§

Added Emergency API.

SmartPTT 9.1§

Introduced.

See Also§