Difference between revisions of "MOR API drop active calls"

From Kolmisoft Wiki
Jump to navigationJump to search
(Created page with "=Description= The drop active calls API allows you to initiate a call drop by call ID or drop all calls.<br/> '''Availability:''' This API is available from '''MOR X18''' onwards. =Usage= This API does not follow standard MOR API usage and must be configured manually. Global MOR API settings do not apply to this API service.")
 
Line 1: Line 1:
=Description=
=Description=


The drop active calls API allows you to initiate a call drop by call ID or drop all calls.<br/>
The Drop Active calls API allows you to initiate a call drop by call ID or drop all calls.<br/>


'''Availability:''' This API is available from '''MOR X18''' onwards.
'''Availability:''' This API is available from '''MOR X18''' onwards.
Line 8: Line 8:


This API does not follow standard MOR API usage and must be configured manually. Global MOR API settings do not apply to this API service.
This API does not follow standard MOR API usage and must be configured manually. Global MOR API settings do not apply to this API service.
=API=
The Drop Active Calls API accepts parameters in JSON format. Responses are also returned in JSON format.
There are 2 endpoints related to Drop Active Calls:
* '''/active_calls/:id''' - Hangs up Active Call by provided id.
* '''/active_calls'''  - Hangs up all Active Calls.
==Authentication==
The Drop Active Calls API requires user authentication - basic authentication (username/password) and JWT token authentication.
===Basic authentication===
Basic authentication uses the User's username and password to access API endpoints.
Username and password must be provided in HTTP '''Authorization''' header, "username:password" string encoded in Base64. For example:
POST http://x.x.x.x/billing/api/flash_calls/call HTTP/1.1
Authorization: Basic cmljYXJkYxM6OWtBWFpadT9yak1iayRSaA==
=== JWT authentication===
JWT authentication uses a token (generated by MOR) with each request to endpoints. The API client must obtain a JWT token by calling the '''/authentication/login''' endpoint and then use this token in other endpoints for authentication until the token expires. Once the token has expired, a new token must be obtained from '''/authentication/login''' endpoint.
JWT token must be provided in HTTP Authorization header when requesting /active_calls/:id or /active_calls/ endpoints. For example:
POST http://x.x.x.x/billing/api/flash_calls/call HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhc3NpZ25lZF9kZXZpY2VzIjoiMiw4LDEwLDEyLDE4LDI2LDM2IiwiZXhwIjoxNzUyNTU1Njk4LCJpYXQiOjE3NTI0NjkyOTgsImlzcyI6IkZsYXNoIENhbGxzIEFQSSIsInN1YiI6InJpY2FyZGFzIn0.I3Sy1zrJx0mAsTLthitY8dyZfythsWzJ4V1CVfNJmYU

Revision as of 11:32, 2 December 2025

Description

The Drop Active calls API allows you to initiate a call drop by call ID or drop all calls.

Availability: This API is available from MOR X18 onwards.

Usage

This API does not follow standard MOR API usage and must be configured manually. Global MOR API settings do not apply to this API service.

API

The Drop Active Calls API accepts parameters in JSON format. Responses are also returned in JSON format.

There are 2 endpoints related to Drop Active Calls:

  • /active_calls/:id - Hangs up Active Call by provided id.
  • /active_calls - Hangs up all Active Calls.

Authentication

The Drop Active Calls API requires user authentication - basic authentication (username/password) and JWT token authentication.

Basic authentication

Basic authentication uses the User's username and password to access API endpoints.

Username and password must be provided in HTTP Authorization header, "username:password" string encoded in Base64. For example: 

POST http://x.x.x.x/billing/api/flash_calls/call HTTP/1.1
Authorization: Basic cmljYXJkYxM6OWtBWFpadT9yak1iayRSaA==

JWT authentication

JWT authentication uses a token (generated by MOR) with each request to endpoints. The API client must obtain a JWT token by calling the /authentication/login endpoint and then use this token in other endpoints for authentication until the token expires. Once the token has expired, a new token must be obtained from /authentication/login endpoint.

JWT token must be provided in HTTP Authorization header when requesting /active_calls/:id or /active_calls/ endpoints. For example: 

POST http://x.x.x.x/billing/api/flash_calls/call HTTP/1.1
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJhc3NpZ25lZF9kZXZpY2VzIjoiMiw4LDEwLDEyLDE4LDI2LDM2IiwiZXhwIjoxNzUyNTU1Njk4LCJpYXQiOjE3NTI0NjkyOTgsImlzcyI6IkZsYXNoIENhbGxzIEFQSSIsInN1YiI6InJpY2FyZGFzIn0.I3Sy1zrJx0mAsTLthitY8dyZfythsWzJ4V1CVfNJmYU
Retrieved from "https://wiki.kolmisoft.com/index.php?title=MOR_API_drop_active_calls&oldid=30716"