🔻 API Documentation

This section provides code samples, example requests and responses for the hepic API

Base URLs

Authentication

API Key (ApiKeyAuth)
- Parameter Name: Auth-Token, in: header.
API Key (JWT)
- Parameter Name: Authorization, in: header.

Admin API

ListProfiles

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/admin/profiles', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/admin/profiles',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /admin/profiles

Returns data from server

Example responses

201 Response

{
  "create_date": "2020-10-20T21:15:45+02:00",
  "guid": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "hep_alias": "SIP",
  "hepid": 1,
  "mapping": {},
  "profile": "call",
  "version": 1603221345489
}

Status	Meaning	Description	Schema
201	Created	HepsubSchema	HepsubSchema
400	Bad Request	FailureResponse	FailureResponse

tablesList

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/configdb/tables/list', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/configdb/tables/list',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /configdb/tables/list

Returns the list of tables

Example responses

201 Response

{
  "count": 0,
  "data": [
    "alias",
    "users",
    "global_settings"
  ]
}

Status	Meaning	Description	Schema
201	Created	AdminTables	AdminTables
400	Bad Request	FailureResponse	FailureResponse

tablesResync

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/configdb/tables/resync', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/configdb/tables/resync',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /configdb/tables/resync

Returns the list of tables

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

ListAdvancedSettings

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/advanced', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/advanced',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /advanced

Returns advanced setting of user

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "category": "string",
      "create_date": "2019-08-24T14:15:22Z",
      "data": {},
      "guid": "string",
      "param": "string",
      "partid": 0,
      "setting": {},
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	GlobalSettingsStructList	GlobalSettingsStructList
400	Bad Request	FailureResponse	FailureResponse

AddAdvanced

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/advanced', headers = headers)

print(r.json())

const inputBody = '{
  "category": "string",
  "create_date": "2019-08-24T14:15:22Z",
  "data": {},
  "guid": "string",
  "param": "string",
  "partid": 0,
  "setting": {},
  "version": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/advanced',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /advanced

Returns data based upon filtered json

Body parameter

{
  "category": "string",
  "create_date": "2019-08-24T14:15:22Z",
  "data": {},
  "guid": "string",
  "param": "string",
  "partid": 0,
  "setting": {},
  "version": 0
}

Name	In	Type	Required	Description
body	body	GlobalSettingsStruct	true	GlobalSettingsStruct parameters

Example responses

201 Response

{
  "data": "af72057b-2745-0a1b-b674-56586aadec57",
  "message": "successfully created GlobalSetting"
}

Status	Meaning	Description	Schema
201	Created	GlobalSettingsCreateSuccessfulResponse	GlobalSettingsCreateSuccessfulResponse
400	Bad Request	FailureResponse	FailureResponse

AdvancedAgainstUUID

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/advanced/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/advanced/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /advanced/{uuid}

Get mapping against id and profile

Name	In	Type	Required	Description
uuid	path	string	true	UUID of mapping

Example responses

201 Response

{
  "category": "string",
  "create_date": "2019-08-24T14:15:22Z",
  "data": {},
  "guid": "string",
  "param": "string",
  "partid": 0,
  "setting": {},
  "version": 0
}

Status	Meaning	Description	Schema
201	Created	GlobalSettingsStruct	GlobalSettingsStruct
400	Bad Request	FailureResponse	FailureResponse

updateAdvanced

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('https://api.hepic/api/v3/advanced/{uuid}', headers = headers)

print(r.json())

const inputBody = '{
  "category": "string",
  "create_date": "2019-08-24T14:15:22Z",
  "data": {},
  "guid": "string",
  "param": "string",
  "partid": 0,
  "setting": {},
  "version": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/advanced/{uuid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /advanced/{uuid}

Get mapping against id and profile

Body parameter

{
  "category": "string",
  "create_date": "2019-08-24T14:15:22Z",
  "data": {},
  "guid": "string",
  "param": "string",
  "partid": 0,
  "setting": {},
  "version": 0
}

Name	In	Type	Required	Description
uuid	path	string	true	UUID of mapping
body	body	GlobalSettingsStruct	true	GlobalSettingsStruct parameters

Example responses

201 Response

{
  "data": "af72057b-2745-0a1b-b674-56586aadec57",
  "message": "successfully updated GlobalSetting"
}

Status	Meaning	Description	Schema
201	Created	GlobalSettingsUpdateSuccessfulResponse	GlobalSettingsUpdateSuccessfulResponse
400	Bad Request	FailureResponse	FailureResponse

DeleteSettings

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('https://api.hepic/api/v3/advanced/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/advanced/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /advanced/{uuid}

Get mapping against id and profile

Name	In	Type	Required	Description
uuid	path	string	true	UUID of mapping

Example responses

201 Response

{
  "data": "af72057b-2745-0a1b-b674-56586aadec57",
  "message": "successfully deleted GlobalSetting"
}

Status	Meaning	Description	Schema
201	Created	GlobalSettingsDeleteSuccessfulResponse	GlobalSettingsDeleteSuccessfulResponse
400	Bad Request	FailureResponse	FailureResponse

GetAgentSearchByTypeAndUUID

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/agent/search/{guid}/{type}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/agent/search/{guid}/{type}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /agent/search/{guid}/{type}

Get agent by guid and type

Name	In	Type	Required	Description
guid	path	string	true	guid of agent
type	path	string	true	type of agent

Example responses

201 Response

{
  "Data": [
    {
      "active": true,
      "create_date": "2019-08-24T14:15:22Z",
      "expire_date": "2019-08-24T14:15:22Z",
      "gid": 0,
      "host": "string",
      "node": "string",
      "path": "string",
      "port": 0,
      "protocol": "string",
      "ttl": 0,
      "type": "string",
      "uuid": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	AgentsLocationList	AgentsLocationList
400	Bad Request	FailureResponse	FailureResponse

ListAgents

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/agent/subscribe', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/agent/subscribe',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /agent/subscribe

Get agent

Example responses

201 Response

{
  "Data": [
    {
      "active": true,
      "create_date": "2019-08-24T14:15:22Z",
      "expire_date": "2019-08-24T14:15:22Z",
      "gid": 0,
      "host": "string",
      "node": "string",
      "path": "string",
      "port": 0,
      "protocol": "string",
      "ttl": 0,
      "type": "string",
      "uuid": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	AgentsLocationList	AgentsLocationList
400	Bad Request	FailureResponse	FailureResponse

UpdateAgent

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/agent/subscribe/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/agent/subscribe/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /agent/subscribe/{uuid}

Returns data from server

Example responses

201 Response

{
  "Data": [
    {
      "active": true,
      "create_date": "2019-08-24T14:15:22Z",
      "expire_date": "2019-08-24T14:15:22Z",
      "gid": 0,
      "host": "string",
      "node": "string",
      "path": "string",
      "port": 0,
      "protocol": "string",
      "ttl": 0,
      "type": "string",
      "uuid": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	AgentsLocationList	AgentsLocationList
400	Bad Request	FailureResponse	FailureResponse

agentsSubUpdateAgentsubAgainstGUID

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('https://api.hepic/api/v3/agent/subscribe/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/agent/subscribe/{uuid}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /agent/subscribe/{uuid}

Update Agent by uuid

Name	In	Type	Required	Description
uuid	path	string	true	guid of agent

Example responses

201 Response

{
  "data": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "message": "successfully updated AgentLocation settings"
}

Status	Meaning	Description	Schema
201	Created	AgentLocationUpdateSuccessResponse	AgentLocationUpdateSuccessResponse
400	Bad Request	FailureResponse	FailureResponse

DeleteAgent

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('https://api.hepic/api/v3/agent/subscribe/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/agent/subscribe/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /agent/subscribe/{uuid}

Returns data from server

Name	In	Type	Required	Description
type of agent	path	string	true	UUID of agent

Example responses

201 Response

{
  "data": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "message": "successfully deleted AgentLocation settings"
}

Status	Meaning	Description	Schema
201	Created	AgentLocationDeleteSuccessResponse	AgentLocationDeleteSuccessResponse
400	Bad Request	FailureResponse	FailureResponse

GetAgentByType

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/agent/type/{type}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/agent/type/{type}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /agent/type/{type}

Get agent

Name	In	Type	Required	Description
type of agent	path	string	true	type of agent

Example responses

201 Response

{
  "Data": [
    {
      "active": true,
      "create_date": "2019-08-24T14:15:22Z",
      "expire_date": "2019-08-24T14:15:22Z",
      "gid": 0,
      "host": "string",
      "node": "string",
      "path": "string",
      "port": 0,
      "protocol": "string",
      "ttl": 0,
      "type": "string",
      "uuid": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	AgentsLocationList	AgentsLocationList
400	Bad Request	FailureResponse	FailureResponse

AddAgentsub

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/agentsub/protocol', headers = headers)

print(r.json())

const inputBody = '{
  "active": true,
  "create_date": "2019-08-24T14:15:22Z",
  "expire_date": "2019-08-24T14:15:22Z",
  "gid": 0,
  "host": "string",
  "node": "string",
  "path": "string",
  "port": 0,
  "protocol": "string",
  "ttl": 0,
  "type": "string",
  "uuid": "string",
  "version": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/agentsub/protocol',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /agentsub/protocol

Returns data from server

Body parameter

{
  "active": true,
  "create_date": "2019-08-24T14:15:22Z",
  "expire_date": "2019-08-24T14:15:22Z",
  "gid": 0,
  "host": "string",
  "node": "string",
  "path": "string",
  "port": 0,
  "protocol": "string",
  "ttl": 0,
  "type": "string",
  "uuid": "string",
  "version": 0
}

Name	In	Type	Required	Description
body	body	AgentsLocation	true	AgentsLocation parameters

Example responses

201 Response

{
  "data": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "message": "successfully created AgentLocation settings"
}

Status	Meaning	Description	Schema
201	Created	AgentLocationCreateSuccessResponse	AgentLocationCreateSuccessResponse
400	Bad Request	FailureResponse	FailureResponse

userLogin

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/auth', headers = headers)

print(r.json())

const inputBody = '{
  "password": "sipcapture",
  "type": "internal",
  "username": "admin"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/auth',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /auth

Returns a JWT Token and UUID attached to user

Body parameter

{
  "password": "sipcapture",
  "type": "internal",
  "username": "admin"
}

Name	In	Type	Required	Description
body	body	UserLogin	true	UserLogin parameters

Example responses

201 Response

{
  "scope": "b9f6q23a-0bde-41ce-cd36-da3dbc17ea12",
  "token": "JWT Token",
  "user": {
    "admin": true,
    "force_password": true
  }
}

Status	Meaning	Description	Schema
201	Created	UserLoginSuccessResponse	UserLoginSuccessResponse
400	Bad Request	FailureResponse	FailureResponse

SuccessResponse

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/auth/type/list', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/auth/type/list',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /auth/type/list

Returns data from server

Example responses

200 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
200	OK	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

CreateUserStruct

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/users', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/users',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /users

Returns data from server in array

Example responses

201 Response

{
  "count": 13,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	TableUserList	TableUserList
400	Bad Request	FailureResponse	FailureResponse

CreateUser

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/users', headers = headers)

print(r.json())

const inputBody = '{
  "department": "NOC",
  "email": "string",
  "firstname": "string",
  "guid": "string",
  "lastname": "string",
  "params": {},
  "partid": 10,
  "password": "string",
  "usergroup": "admin",
  "username": "string",
  "version": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/users',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /users

Create a New user

Body parameter

{
  "department": "NOC",
  "email": "string",
  "firstname": "string",
  "guid": "string",
  "lastname": "string",
  "params": {},
  "partid": 10,
  "password": "string",
  "usergroup": "admin",
  "username": "string",
  "version": 0
}

Name	In	Type	Required	Description
body	body	CreateUserStruct	true	CreateUserStruct parameters

Example responses

201 Response

{
  "data": "af72057b-2745-0a1b-b674-56586aadec57",
  "message": "successfully created user"
}

Status	Meaning	Description	Schema
201	Created	UserSuccessResponse	UserSuccessResponse
400	Bad Request	FailureResponse	FailureResponse

ListUsers

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/users/export', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/users/export',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /users/export

Returns data from server

Example responses

Status	Meaning	Description	Schema
201	Created	UserFileResponse	None

groups

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/users/groups', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/users/groups',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /users/groups

Returns the list of groups

Example responses

201 Response

{
  "count": 13,
  "data": [
    "admin",
    "user"
  ]
}

Status	Meaning	Description	Schema
201	Created	UserGroupList	UserGroupList
400	Bad Request	FailureResponse	FailureResponse

UserFileResponse

Code samples

import requests
headers = {
  'Content-Type': 'application/x-www-form-urlencoded',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/users/import/replace', headers = headers)

print(r.json())

const inputBody = '{
  "File": "string"
}';
const headers = {
  'Content-Type':'application/x-www-form-urlencoded',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/users/import/replace',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /users/import/replace

Upload

Body parameter

File: string

Name	In	Type	Required	Description
file	undefined	UserFileUpload	false	The file to upload.
body	body	object	false	none
» File	body	string(binary)	false	none

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse

UpdateUserPassword

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('https://api.hepic/api/v3/users/update/password/{uuid}', headers = headers)

print(r.json())

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/users/update/password/{uuid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /users/update/password/{uuid}

Update a user's password

Body parameter

null

Name	In	Type	Required	Description
userUUID	path	string	true	uuid of the user to update
body	body	any	true	area parameters

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

UpdateUser

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('https://api.hepic/api/v3/users/{uuid}', headers = headers)

print(r.json())

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/users/{uuid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /users/{uuid}

Update an existing user

Body parameter

null

Name	In	Type	Required	Description
userUUID	path	string	true	uuid of the user to update
body	body	any	true	UserStruct parameters

Example responses

201 Response

{
  "data": "af72057b-2745-0a1b-b674-56586aadec57",
  "message": "successfully updated user"
}

Status	Meaning	Description	Schema
201	Created	UserUpdateSuccessResponse	UserUpdateSuccessResponse
400	Bad Request	FailureResponse	FailureResponse

DeleteUser

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('https://api.hepic/api/v3/users/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/users/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /users/{uuid}

Delete an existing User

Name	In	Type	Required	Description
userUUID	path	string	true	uuid of the user to update

Example responses

201 Response

{
  "data": "af72057b-2745-0a1b-b674-56586aadec57",
  "message": "successfully deleted user"
}

Status	Meaning	Description	Schema
201	Created	UserDeleteSuccessResponse	UserDeleteSuccessResponse
400	Bad Request	FailureResponse	FailureResponse

GetRecordingData

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/call/recording/data', headers = headers)

print(r.json())

const inputBody = '{
  "data": [
    {
      "aliasDst": "string",
      "aliasSrc": "string",
      "create_date": 0,
      "destination": 0,
      "dstHost": "string",
      "dstId": "string",
      "dstIp": "string",
      "dstPort": 0.1,
      "id": 0.1,
      "method": "string",
      "method_text": "string",
      "micro_ts": 0,
      "msg_color": "string",
      "prot": 0.1,
      "protocol": 0.1,
      "ruri_user": "string",
      "sid": "string",
      "srcHost": "string",
      "srcId": "string",
      "srcIp": "string",
      "srcPort": 0.1,
      "table": "string"
    }
  ],
  "keys": [
    "callid",
    "srcIp",
    "srcPort"
  ],
  "total": 45
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/call/recording/data',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /call/recording/data

Returns data based upon filtered json

Body parameter

{
  "data": [
    {
      "aliasDst": "string",
      "aliasSrc": "string",
      "create_date": 0,
      "destination": 0,
      "dstHost": "string",
      "dstId": "string",
      "dstIp": "string",
      "dstPort": 0.1,
      "id": 0.1,
      "method": "string",
      "method_text": "string",
      "micro_ts": 0,
      "msg_color": "string",
      "prot": 0.1,
      "protocol": 0.1,
      "ruri_user": "string",
      "sid": "string",
      "srcHost": "string",
      "srcId": "string",
      "srcIp": "string",
      "srcPort": 0.1,
      "table": "string"
    }
  ],
  "keys": [
    "callid",
    "srcIp",
    "srcPort"
  ],
  "total": 45
}

Name	In	Type	Required	Description
body	body	SearchCallData	true	SearchObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

GetRecordingPlayDataByType

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/call/recording/play/{uuid}', headers = headers)

print(r.json())

const inputBody = '{
  "data": [
    {
      "aliasDst": "string",
      "aliasSrc": "string",
      "create_date": 0,
      "destination": 0,
      "dstHost": "string",
      "dstId": "string",
      "dstIp": "string",
      "dstPort": 0.1,
      "id": 0.1,
      "method": "string",
      "method_text": "string",
      "micro_ts": 0,
      "msg_color": "string",
      "prot": 0.1,
      "protocol": 0.1,
      "ruri_user": "string",
      "sid": "string",
      "srcHost": "string",
      "srcId": "string",
      "srcIp": "string",
      "srcPort": 0.1,
      "table": "string"
    }
  ],
  "keys": [
    "callid",
    "srcIp",
    "srcPort"
  ],
  "total": 45
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/call/recording/play/{uuid}',
{
  method: 'GET',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /call/recording/play/{uuid}

Returns data based upon filtered json

Body parameter

{
  "data": [
    {
      "aliasDst": "string",
      "aliasSrc": "string",
      "create_date": 0,
      "destination": 0,
      "dstHost": "string",
      "dstId": "string",
      "dstIp": "string",
      "dstPort": 0.1,
      "id": 0.1,
      "method": "string",
      "method_text": "string",
      "micro_ts": 0,
      "msg_color": "string",
      "prot": 0.1,
      "protocol": 0.1,
      "ruri_user": "string",
      "sid": "string",
      "srcHost": "string",
      "srcId": "string",
      "srcIp": "string",
      "srcPort": 0.1,
      "table": "string"
    }
  ],
  "keys": [
    "callid",
    "srcIp",
    "srcPort"
  ],
  "total": 45
}

Name	In	Type	Required	Description
body	body	SearchCallData	true	SearchObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

GetRecordingInfoDataByType

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/call/recording/info/{uuid}', headers = headers)

print(r.json())

const inputBody = '{
  "data": [
    {
      "aliasDst": "string",
      "aliasSrc": "string",
      "create_date": 0,
      "destination": 0,
      "dstHost": "string",
      "dstId": "string",
      "dstIp": "string",
      "dstPort": 0.1,
      "id": 0.1,
      "method": "string",
      "method_text": "string",
      "micro_ts": 0,
      "msg_color": "string",
      "prot": 0.1,
      "protocol": 0.1,
      "ruri_user": "string",
      "sid": "string",
      "srcHost": "string",
      "srcId": "string",
      "srcIp": "string",
      "srcPort": 0.1,
      "table": "string"
    }
  ],
  "keys": [
    "callid",
    "srcIp",
    "srcPort"
  ],
  "total": 45
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/call/recording/info/{uuid}',
{
  method: 'GET',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /call/recording/info/{uuid}

Returns data based upon filtered json

Body parameter

{
  "data": [
    {
      "aliasDst": "string",
      "aliasSrc": "string",
      "create_date": 0,
      "destination": 0,
      "dstHost": "string",
      "dstId": "string",
      "dstIp": "string",
      "dstPort": 0.1,
      "id": 0.1,
      "method": "string",
      "method_text": "string",
      "micro_ts": 0,
      "msg_color": "string",
      "prot": 0.1,
      "protocol": 0.1,
      "ruri_user": "string",
      "sid": "string",
      "srcHost": "string",
      "srcId": "string",
      "srcIp": "string",
      "srcPort": 0.1,
      "table": "string"
    }
  ],
  "keys": [
    "callid",
    "srcIp",
    "srcPort"
  ],
  "total": 45
}

Name	In	Type	Required	Description
body	body	SearchCallData	true	SearchObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

AddRtpRecordFromAgent

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/interception/add/rtprecord', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/interception/add/rtprecord',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /interception/add/rtprecord

Returns data from server

Example responses

201 Response

{
  "create_date": "2019-08-24T14:15:22Z",
  "delivery": {},
  "description": "string",
  "gid": 0,
  "liid": 0,
  "modify_date": "2019-08-24T14:15:22Z",
  "search_callee": "string",
  "search_caller": "string",
  "search_ip": "string",
  "start_date": "2019-08-24T14:15:22Z",
  "status": true,
  "stop_date": "2019-08-24T14:15:22Z",
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664",
  "version": 0
}

Status	Meaning	Description	Schema
201	Created	InterceptionsStruct	InterceptionsStruct

ListInterceptions

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/interceptions', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/interceptions',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /interceptions

Returns data from server

Example responses

201 Response

{
  "create_date": "2019-08-24T14:15:22Z",
  "delivery": {},
  "description": "string",
  "gid": 0,
  "liid": 0,
  "modify_date": "2019-08-24T14:15:22Z",
  "search_callee": "string",
  "search_caller": "string",
  "search_ip": "string",
  "start_date": "2019-08-24T14:15:22Z",
  "status": true,
  "stop_date": "2019-08-24T14:15:22Z",
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664",
  "version": 0
}

Status	Meaning	Description	Schema
201	Created	InterceptionsStruct	InterceptionsStruct

AddInterceptions

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/interceptions', headers = headers)

print(r.json())

const inputBody = '{
  "create_date": "2019-08-24T14:15:22Z",
  "delivery": {},
  "description": "string",
  "gid": 0,
  "liid": 0,
  "modify_date": "2019-08-24T14:15:22Z",
  "search_callee": "string",
  "search_caller": "string",
  "search_ip": "string",
  "start_date": "2019-08-24T14:15:22Z",
  "status": true,
  "stop_date": "2019-08-24T14:15:22Z",
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664",
  "version": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/interceptions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /interceptions

Adds interceptions to system

Body parameter

{
  "create_date": "2019-08-24T14:15:22Z",
  "delivery": {},
  "description": "string",
  "gid": 0,
  "liid": 0,
  "modify_date": "2019-08-24T14:15:22Z",
  "search_callee": "string",
  "search_caller": "string",
  "search_ip": "string",
  "start_date": "2019-08-24T14:15:22Z",
  "status": true,
  "stop_date": "2019-08-24T14:15:22Z",
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664",
  "version": 0
}

Name	In	Type	Required	Description
body	body	InterceptionsStruct	true	InterceptionsStruct parameters

Example responses

201 Response

{
  "scope": "b9f6q23a-0bde-41ce-cd36-da3dbc17ea12",
  "token": "JWT Token",
  "user": {
    "admin": true,
    "force_password": true
  }
}

Status	Meaning	Description	Schema
201	Created	UserLoginSuccessResponse	UserLoginSuccessResponse
401	Unauthorized	FailureResponse	FailureResponse

UpdateInterceptions

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('https://api.hepic/api/v3/interceptions/{uuid}', headers = headers)

print(r.json())

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/interceptions/{uuid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /interceptions/{uuid}

Update an existing user

Body parameter

null

Name	In	Type	Required	Description
uuid	path	string	true	uuid of the interceptions to update
body	body	any	true	area parameters

Example responses

201 Response

{
  "create_date": "2019-08-24T14:15:22Z",
  "delivery": {},
  "description": "string",
  "gid": 0,
  "liid": 0,
  "modify_date": "2019-08-24T14:15:22Z",
  "search_callee": "string",
  "search_caller": "string",
  "search_ip": "string",
  "start_date": "2019-08-24T14:15:22Z",
  "status": true,
  "stop_date": "2019-08-24T14:15:22Z",
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664",
  "version": 0
}

Status	Meaning	Description	Schema
201	Created	InterceptionsStruct	InterceptionsStruct

DeleteInterceptions

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('https://api.hepic/api/v3/interceptions/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/interceptions/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /interceptions/{uuid}

Update an existing user

Name	In	Type	Required	Description
uuid	path	string	true	uuid of the interceptions to delete

Example responses

201 Response

{
  "create_date": "2019-08-24T14:15:22Z",
  "delivery": {},
  "description": "string",
  "gid": 0,
  "liid": 0,
  "modify_date": "2019-08-24T14:15:22Z",
  "search_callee": "string",
  "search_caller": "string",
  "search_ip": "string",
  "start_date": "2019-08-24T14:15:22Z",
  "status": true,
  "stop_date": "2019-08-24T14:15:22Z",
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664",
  "version": 0
}

Status	Meaning	Description	Schema
201	Created	InterceptionsStruct	InterceptionsStruct

GetTransactionDTMF

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/call/report/dtmf', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/call/report/dtmf',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /call/report/dtmf

Returns log data based upon filtered json

Body parameter

{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Name	In	Type	Required	Description
body	body	SearchObject	true	SearchObject parameters

Example responses

400 Response

{
  "error": "string",
  "message": "string",
  "statuscode": 0
}

Status	Meaning	Description	Schema
201	Created	DTMFResponse	None
400	Bad Request	FailureResponse	FailureResponse

GetTransactionLog

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/call/report/log', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/call/report/log',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /call/report/log

Returns log data based upon filtered json

Body parameter

{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Name	In	Type	Required	Description
body	body	SearchObject	true	SearchObject parameters

Example responses

400 Response

{
  "error": "string",
  "message": "string",
  "statuscode": 0
}

Status	Meaning	Description	Schema
201	Created	LOGResponse	None
400	Bad Request	FailureResponse	FailureResponse

GetTransactionQos

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/call/report/qos', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/call/report/qos',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /call/report/qos

Returns qos data based upon filtered json

Body parameter

{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Name	In	Type	Required	Description
body	body	SearchObject	true	SearchObject parameters

Example responses

201 Response

{
  "rtcp": {
    "data": [
      {
        "captureId": "2001",
        "capturePass": "myHep",
        "correlation_id": "wvn6zg@127.0.0.1",
        "create_date": "021-10-04T19:16:22.699Z",
        "dbnode": "localnode",
        "dstIp": "127.0.0.1",
        "dstPort": 5060,
        "id": 1030,
        "node": [
          "2001",
          "localnode"
        ],
        "payloadType": 100,
        "profile": "string",
        "proto": "log",
        "protocol": 17,
        "protocolFamily": 2,
        "raw": "string",
        "sid": "wvn6zg@127.0.0.1",
        "srcIp": "127.0.0.1",
        "srcPort": 5080,
        "timeSeconds": 1633374982,
        "timeUseconds": 699000
      }
    ]
  },
  "rtp": {
    "data": [
      {
        "captureId": "2001",
        "capturePass": "myHep",
        "correlation_id": "wvn6zg@127.0.0.1",
        "create_date": "021-10-04T19:16:22.699Z",
        "dbnode": "localnode",
        "dstIp": "127.0.0.1",
        "dstPort": 5060,
        "id": 1030,
        "node": [
          "2001",
          "localnode"
        ],
        "payloadType": 100,
        "profile": "string",
        "proto": "log",
        "protocol": 17,
        "protocolFamily": 2,
        "raw": "string",
        "sid": "wvn6zg@127.0.0.1",
        "srcIp": "127.0.0.1",
        "srcPort": 5080,
        "timeSeconds": 1633374982,
        "timeUseconds": 699000
      }
    ]
  }
}

Status	Meaning	Description	Schema
201	Created	SearchTransactionQos	SearchTransactionQos
400	Bad Request	FailureResponse	FailureResponse

GetTransaction

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/call/transaction', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/call/transaction',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /call/transaction

Returns data based upon filtered json

Body parameter

{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Name	In	Type	Required	Description
body	body	SearchObject	true	SearchObject parameters

Example responses

201 Response

{
  "Data": [
    {
      "Hostinfo": {
        "property1": {
          "alias": "string",
          "color": {
            "background": "string",
            "border": "string",
            "font": "string"
          },
          "custom_params": {
            "origin": "string",
            "team": "string"
          },
          "group": "string",
          "image": "string",
          "ip": "string",
          "ipv6": true,
          "isLinkImg": true,
          "mask": 0,
          "port": 0,
          "servertype": "string",
          "shardid": "string",
          "status": true,
          "type": 0
        },
        "property2": {
          "alias": "string",
          "color": {
            "background": "string",
            "border": "string",
            "font": "string"
          },
          "custom_params": {
            "origin": "string",
            "team": "string"
          },
          "group": "string",
          "image": "string",
          "ip": "string",
          "ipv6": true,
          "isLinkImg": true,
          "mask": 0,
          "port": 0,
          "servertype": "string",
          "shardid": "string",
          "status": true,
          "type": 0
        }
      },
      "alias": {
        "property1": "string",
        "property2": "string"
      },
      "calldata": [
        {
          "aliasDst": "string",
          "aliasSrc": "string",
          "create_date": 0,
          "destination": 0,
          "dstHost": "string",
          "dstId": "string",
          "dstIp": "string",
          "dstPort": 0.1,
          "id": 0.1,
          "method": "string",
          "method_text": "string",
          "micro_ts": 0,
          "msg_color": "string",
          "prot": 0.1,
          "protocol": 0.1,
          "ruri_user": "string",
          "sid": "string",
          "srcHost": "string",
          "srcId": "string",
          "srcIp": "string",
          "srcPort": 0.1,
          "table": "string"
        }
      ],
      "callid": [
        "string"
      ],
      "data": {
        "uac": {
          "property1": {
            "agent": "string",
            "alias": "string",
            "dns": "string",
            "image": "string"
          },
          "property2": {
            "agent": "string",
            "alias": "string",
            "dns": "string",
            "image": "string"
          }
        }
      },
      "hosts": {
        "property1": {
          "host": [
            "string"
          ],
          "position": 0
        },
        "property2": {
          "host": [
            "string"
          ],
          "position": 0
        }
      },
      "messages": [
        {
          "aliasDst": "string",
          "aliasSrc": "string",
          "callid": "string",
          "captid": 0,
          "captureId": 0,
          "capture_ip": "string",
          "correlation_id": "string",
          "create_date": 0,
          "create_ts": 0,
          "cseqm": "string",
          "cseqnum": 0,
          "data": "string",
          "dstIp": "string",
          "dstPort": 0,
          "from_domain": "string",
          "from_user": "string",
          "hepproto": 0,
          "id": 0,
          "ip_tos": 0,
          "method": "string",
          "micro_ts": 0,
          "milliTimeseconds": 0,
          "node": "string",
          "proto": 0,
          "protocol": 0,
          "pty": 0,
          "queue": 0,
          "raw": "string",
          "region_id": "string",
          "respc": 0,
          "ruri_user": "string",
          "sdp": true,
          "sid": "string",
          "srcIp": "string",
          "srcPort": 0,
          "table": "string",
          "tcpflag": 0,
          "timeSeconds": 0,
          "timeUseconds": 0,
          "to_domain": "string",
          "to_user": "string",
          "tss": 0,
          "tsu": 0,
          "uuid": "string",
          "vlan": 0
        }
      ],
      "sdp": {
        "property1": {
          "property1": {
            "audioCodec": 0,
            "destinationSipIP": "string",
            "gid": 0,
            "mediaIpAudio": "string",
            "mediaIpVideo": "string",
            "mediaPortAudio": 0,
            "mediaPortVideo": 0,
            "micro_ts": 0,
            "protocol": 0,
            "request": true,
            "sdpOrigin": "string",
            "sdpSessionID": 0,
            "sipId": 0,
            "sourceSipIP": "string",
            "type": 0,
            "videoCodec": 0
          },
          "property2": {
            "audioCodec": 0,
            "destinationSipIP": "string",
            "gid": 0,
            "mediaIpAudio": "string",
            "mediaIpVideo": "string",
            "mediaPortAudio": 0,
            "mediaPortVideo": 0,
            "micro_ts": 0,
            "protocol": 0,
            "request": true,
            "sdpOrigin": "string",
            "sdpSessionID": 0,
            "sipId": 0,
            "sourceSipIP": "string",
            "type": 0,
            "videoCodec": 0
          }
        },
        "property2": {
          "property1": {
            "audioCodec": 0,
            "destinationSipIP": "string",
            "gid": 0,
            "mediaIpAudio": "string",
            "mediaIpVideo": "string",
            "mediaPortAudio": 0,
            "mediaPortVideo": 0,
            "micro_ts": 0,
            "protocol": 0,
            "request": true,
            "sdpOrigin": "string",
            "sdpSessionID": 0,
            "sipId": 0,
            "sourceSipIP": "string",
            "type": 0,
            "videoCodec": 0
          },
          "property2": {
            "audioCodec": 0,
            "destinationSipIP": "string",
            "gid": 0,
            "mediaIpAudio": "string",
            "mediaIpVideo": "string",
            "mediaPortAudio": 0,
            "mediaPortVideo": 0,
            "micro_ts": 0,
            "protocol": 0,
            "request": true,
            "sdpOrigin": "string",
            "sdpSessionID": 0,
            "sipId": 0,
            "sourceSipIP": "string",
            "type": 0,
            "videoCodec": 0
          }
        }
      },
      "transaction": [
        {
          "Codecs": [
            {}
          ],
          "Correlations": [
            {}
          ],
          "CustomString->Key": [
            {}
          ],
          "CustomString->Value": [
            {}
          ],
          "CustomUInt->Key": [
            {}
          ],
          "CustomUInt->Value": [
            {}
          ],
          "IPs": [
            "string"
          ],
          "Methods->Key": [
            "string"
          ],
          "Methods->Value": [
            0
          ],
          "Metrics->Key": [
            "string"
          ],
          "Metrics->Value": [
            0
          ],
          "aliasDst": "string",
          "aliasSrc": "string",
          "anumber_ext": "string",
          "archive": true,
          "auth_user": "string",
          "bnumber_ext": "string",
          "callid": "string",
          "captid": 0,
          "cdr_connect": 0,
          "cdr_progress": 0,
          "cdr_ringing": 0,
          "cdr_start": 0,
          "cdr_stop": 0,
          "codia": 0,
          "contact_user": "string",
          "correlation_id": "string",
          "create_date": 0,
          "custom_1": "string",
          "custom_2": "string",
          "custom_3": "string",
          "custom_4": "string",
          "custom_5": "string",
          "custom_6": "string",
          "data": "string",
          "dest_cc": "string",
          "destcc": "string",
          "destination_ip": "string",
          "destination_port": 0,
          "destlan": 0.1,
          "destlat": 0.1,
          "did": "string",
          "diversion_user": "string",
          "duration": 0,
          "event": 0,
          "family": 0,
          "from_domain": "string",
          "from_user": "string",
          "geo_cc": "string",
          "geocc": "string",
          "geolan": 0,
          "geolat": 0,
          "ipgroup_in": "string",
          "ipgroup_out": "string",
          "jitter": 0,
          "mos": 0,
          "msg_info": "string",
          "one_way_audio": true,
          "pdd": 0,
          "pid_user": "string",
          "pl": 0,
          "proto": 0,
          "pty": 0,
          "queue": 0,
          "reason": 0,
          "region_id": "string",
          "rtp_stat_a": "string",
          "rtp_stat_b": "string",
          "ruri_user": "string",
          "sdpap": 0,
          "sdpap_b": 0,
          "sdpip": 0,
          "sdpip_b": 0,
          "sdpmedhost": "string",
          "sdpmedpr": "string",
          "sdpsid": 0,
          "sdpsver": 0,
          "sdpvp": 0,
          "sdpvp_b": 0,
          "server_type_in": "string",
          "server_type_out": "string",
          "sid": "string",
          "source_ip": "string",
          "source_port": 0,
          "sourcecc": "string",
          "sourcelan": 0.1,
          "sourcelat": 0.1,
          "srd": 0,
          "sss": 0,
          "status": 0,
          "table": "string",
          "termcode": 0,
          "termdir": 0,
          "to_domain": "string",
          "to_user": "string",
          "uas": "string",
          "update_ts": 0,
          "updcounter": 0,
          "usergroup": "string",
          "uuid": "string",
          "vlan": 0,
          "vqr_a": "string",
          "vqr_b": "string",
          "vst": 0,
          "xgroup": "string"
        }
      ]
    }
  ],
  "keys": [
    "string"
  ],
  "total": 0
}

Status	Meaning	Description	Schema
201	Created	SearchTransactionResponse	SearchTransactionResponse
400	Bad Request	FailureResponse	FailureResponse

SearchData

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/search/call/data', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/search/call/data',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /search/call/data

Returns data based upon filtered json

Body parameter

{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Name	In	Type	Required	Description
body	body	SearchObject	true	SearchObject parameters

Example responses

201 Response

{
  "data": [
    {
      "aliasDst": "string",
      "aliasSrc": "string",
      "create_date": 0,
      "destination": 0,
      "dstHost": "string",
      "dstId": "string",
      "dstIp": "string",
      "dstPort": 0.1,
      "id": 0.1,
      "method": "string",
      "method_text": "string",
      "micro_ts": 0,
      "msg_color": "string",
      "prot": 0.1,
      "protocol": 0.1,
      "ruri_user": "string",
      "sid": "string",
      "srcHost": "string",
      "srcId": "string",
      "srcIp": "string",
      "srcPort": 0.1,
      "table": "string"
    }
  ],
  "keys": [
    "callid",
    "srcIp",
    "srcPort"
  ],
  "total": 45
}

Status	Meaning	Description	Schema
201	Created	SearchCallData	SearchCallData
400	Bad Request	FailureResponse	FailureResponse

callDecodeMessage

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/search/call/decode/message', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/search/call/decode/message',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /search/call/decode/message

Returns data based upon filtered json

Body parameter

{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Name	In	Type	Required	Description
body	body	SearchObject	true	SearchObject parameters

Example responses

201 Response

{
  "data": [
    {
      "decoded": [
        {
          "_source": {
            "_layers": {
              "eth": {
                "eth.dst": "06:3d:20:12:10:20",
                "eth.dst_tree": {
                  "eth.addr": "06:3d:20:12:10:20",
                  "eth.addr_resolved": "06:3d:20:12:10:20",
                  "eth.dst_resolved": "06:3d:20:12:10:20",
                  "eth.ig": "0",
                  "eth.lg": "1"
                },
                "eth.src": "02:5d:69:74:20:12",
                "eth.src_tree": {
                  "eth.addr": "02:5d:69:74:20:12",
                  "eth.addr_resolved": "02:5d:69:74:20:12",
                  "eth.ig": "0",
                  "eth.lg": "1",
                  "src_resolved": "02:5d:69:74:20:12"
                },
                "eth.type": "\"0x00000800\""
              },
              "frame": {
                "frame.cap_len": "1058",
                "frame.encap_type": "1",
                "frame.ignored": "0",
                "frame.interface_id": "0",
                "frame.interface_id_tree": {
                  "frame.interface_name": "-"
                },
                "frame.len": "1058",
                "frame.marked": "0",
                "frame.number": "1",
                "frame.offset_shift": "0.000000000",
                "frame.protocols": "eth:ethertype:ip:udp:sip:sdp",
                "frame.time": "Sep 30, 2021 07:06:10.950000000 UTC",
                "frame.time_delta": "0.000000000",
                "frame.time_delta_displayed": "0.000000000",
                "frame.time_epoch": "1632985570.950000000",
                "frame.time_relative": "0.000000000"
              },
              "ip": {
                "ip.checksum": "0x0000ffa5",
                "ip.checksum.status": "2",
                "ip.dsfield": "0x0000ffa5",
                "ip.dsfield_tree": {
                  "ip.dsfield_tree.dscp": "0",
                  "ip.dsfield_tree.ecn": "0"
                },
                "ip.dst": "127.0.0.1",
                "ip.dst_host": "127.0.0.1",
                "ip.flags": "0x00000000",
                "ip.flags_tree": {
                  "ip.flags_tree.df": "0",
                  "ip.flags_tree.mf": "0",
                  "ip.flags_tree.rb": "0"
                },
                "ip.frag_offset": "0",
                "ip.hdr_len": "20",
                "ip.host": "127.0.0.1",
                "ip.id": "0x00000000",
                "ip.len": "1044",
                "ip.proto": "17",
                "ip.src": "127.0.0.1",
                "ip.src_host": "127.0.0.1",
                "ip.ttl": "54",
                "ip.version": "4"
              },
              "sip": {
                "sip.Request-line": "INVITE sip:196@example.com;user=phone SIP/2.0",
                "sip.Request-line_tree": {
                  "sip.Method": "INVITE",
                  "sip.Request-line_tree": {
                    "sip.r-uri.host": "example.com",
                    "sip.r-uri.user": "196"
                  },
                  "sip.r-uri": "sip:196@example.com;user=phone",
                  "sip.resend": "0"
                },
                "sip.msg_body": {
                  "sdp.connection_info": "\"IN IP4 192.168.10.193\"",
                  "sdp.media": "audio 5004 RTP/AVP 0 8 9 18 101",
                  "sdp.media_attr": "fmtp:101 0-15",
                  "sdp.media_attr_tree": {
                    "sdp.fmtp.parameter": "0-15",
                    "sdp.media.format": "101",
                    "sdp.media_attribute.field": "fmtp"
                  },
                  "sdp.media_tree": {
                    "sdp.media.format": "DynamicRTP-Type-101",
                    "sdp.media.media": "audio",
                    "sdp.media.port": "5004",
                    "sdp.media.port_string": "5004",
                    "sdp.media.proto": "RTP/AVP"
                  },
                  "sdp.owner": "hepgenjs 8000 8000 IN IP4 192.168.10.193",
                  "sdp.owner_tree": {
                    "sdp.owner.address": "192.168.10.193",
                    "sdp.owner.address_type": "IP4",
                    "sdp.owner.network_type": "IN",
                    "sdp.owner.sessionid": "8000",
                    "sdp.owner.username": "hepgenjs",
                    "sdp.owner.version": "8000"
                  },
                  "sdp.session_name": "\"SIP Call\"",
                  "sdp.time": "\"0 0\"",
                  "sdp.time_tree": {
                    "sdp.time.start": "0",
                    "sdp.time.stop": "0"
                  },
                  "sdp.version": "0",
                  "sip.connection_info_tree": {
                    "sdp.connection_info.address": "192.168.10.193",
                    "sdp.connection_info.address_type": "IP4",
                    "sdp.connection_info.network_type": "IN"
                  }
                },
                "sip.msg_hdr": "\"Via: SIP/2.0/UDP 192.168.10.193:5064;branch=z9hG4bK923381359;rport\\r\\nFrom: <sip:hepgenjs@example.com;user=phone>;tag=415746302\\r\\nTo: <sip:196@example.com;user=phone>\\r\\nCall-ID: a6xh18@127.0.0.1\\r\\nCSeq: 440 INVITE\\r\\nContact: <sip:hepgenjs@192.168.10.193:5064;user=phone>\\r\\nMax-Forwards: 70\\r\\nUser-Agent: HEPGEN.JS@example.com\\r\\nPrivacy: none\\r\\nP-Preferred-Identity: <sip:hepgenjs@example.com;user=phone>\\r\\nSupported: replaces, path, timer, eventlist\\r\\nAllow: INVITE, ACK, OPTIONS, CANCEL, BYE, SUBSCRIBE, NOTIFY, INFO, REFER, UPDATE, MESSAGE\\r\\nContent-Type: application/sdp\\r\\nAccept: application/sdp, application/dtmf-relay\\r\\nContent-Length:   313\\r\\n\\r\\nv=0\\r\\no=hepgenjs 8000 8000 IN IP4 192.168.10.193\\r\\ns=SIP Call\\r\\nc=IN IP4 192.168.10.193\\r\\nt=0 0\\r\\nm=audio 5004 RTP/AVP 0 8 9 18 101\\r\\na=sendrecv\\r\\na=rtpmap:0 PCMU/8000\\r\\na=ptime:20\\r\\na=rtpmap:8 PCMA/8000\\r\\na=rtpmap:9 G722/8000\\r\\na=rtpmap:18 G729/8000\\r\\na=fmtp:18 annexb=no\\r\\na=rtpmap:101 telephone-event/8000\\r\\na=fmtp:101 0-15\\r\\n\\r\\n\\r\\n\"",
                "sip.msg_hdr_tree": {}
              },
              "udp": {
                "udp.checksum": "0x0000ffa5",
                "udp.checksum.status": "2",
                "udp.dstport": "5060",
                "udp.length": "1024",
                "udp.port": "5060",
                "udp.srcport": "5060",
                "udp.stream": "0"
              }
            }
          },
          "_type": "pcap_file"
        }
      ]
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	MessageDecoded	MessageDecoded
400	Bad Request	FailureResponse	FailureResponse

callMessage

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/search/call/message', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/search/call/message',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /search/call/message

Returns message data based upon filtered json

Body parameter

{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Name	In	Type	Required	Description
body	body	SearchObject	true	SearchObject parameters

Example responses

201 Response

{
  "data": [
    {
      "aliasDst": "string",
      "aliasSrc": "string",
      "create_date": 0,
      "destination": 0,
      "dstHost": "string",
      "dstId": "string",
      "dstIp": "string",
      "dstPort": 0.1,
      "id": 0.1,
      "method": "string",
      "method_text": "string",
      "micro_ts": 0,
      "msg_color": "string",
      "prot": 0.1,
      "protocol": 0.1,
      "ruri_user": "string",
      "sid": "string",
      "srcHost": "string",
      "srcId": "string",
      "srcIp": "string",
      "srcPort": 0.1,
      "table": "string"
    }
  ],
  "keys": [
    "callid",
    "srcIp",
    "srcPort"
  ],
  "total": 45
}

Status	Meaning	Description	Schema
201	Created	SearchCallData	SearchCallData
400	Bad Request	FailureResponse	FailureResponse

GetTypeTransaction

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/search/transaction/type', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/search/transaction/type',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /search/transaction/type

Returns data based upon filtered json

Body parameter

{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Name	In	Type	Required	Description
body	body	SearchObject	true	SearchObject parameters

Example responses

400 Response

{
  "error": "string",
  "message": "string",
  "statuscode": 0
}

Status	Meaning	Description	Schema
201	Created	string	None
400	Bad Request	FailureResponse	FailureResponse

rawSearchData

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/clickhouse/query/raw', headers = headers)

print(r.json())

const inputBody = '{
  "query": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/clickhouse/query/raw',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /clickhouse/query/raw

Returns data based upon filtered json

Body parameter

{
  "query": "string"
}

Name	In	Type	Required	Description
body	body	ClickhouseObject	true	ClickhouseObject parameters

Example responses

201 Response

{
  "data": {
    "property1": {
      "name": "string",
      "type": "string"
    },
    "property2": {
      "name": "string",
      "type": "string"
    }
  },
  "total": 0
}

Status	Meaning	Description	Schema
201	Created	ClickhouseRawQuery	ClickhouseRawQuery
400	Bad Request	FailureResponse	FailureResponse

ListDashboard

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/dashboard/reset', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/dashboard/reset',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /dashboard/reset

Get Dashbroad list

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

GetDashboard

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/dashboard/store/{dashboardId}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/dashboard/store/{dashboardId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /dashboard/store/{dashboardId}

Get Dashboard Against a GUID

Name	In	Type	Required	Description
Dashboard id	path	string	true	param of dashboard

Example responses

400 Response

{
  "error": "string",
  "message": "string",
  "statuscode": 0
}

Status	Meaning	Description	Schema
201	Created	DashboardElement	None
400	Bad Request	FailureResponse	FailureResponse

UpdateDashboard

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('https://api.hepic/api/v3/dashboard/store/{dashboardId}', headers = headers)

print(r.json())

const inputBody = '{
  "data": {},
  "guid": "string",
  "params": "string",
  "protocol_id": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/dashboard/store/{dashboardId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /dashboard/store/{dashboardId}

Add new dashboard

Body parameter

{
  "data": {},
  "guid": "string",
  "params": "string",
  "protocol_id": "string"
}

Name	In	Type	Required	Description
dashboardid	path	string	true	the param of dashboard
body	body	UserSettings	true	json of dashboard

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

CreateDashboard

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/dashboard/store/{dashboardId}', headers = headers)

print(r.json())

const inputBody = '{
  "data": {},
  "guid": "string",
  "params": "string",
  "protocol_id": "string"
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/dashboard/store/{dashboardId}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /dashboard/store/{dashboardId}

Add new dashboard

Body parameter

{
  "data": {},
  "guid": "string",
  "params": "string",
  "protocol_id": "string"
}

Name	In	Type	Required	Description
dashboardid	path	string	true	the param of dashboard
body	body	UserSettings	true	json of dashboard

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

DeleteDashboard

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('https://api.hepic/api/v3/dashboard/store/{dashboardId}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/dashboard/store/{dashboardId}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /dashboard/store/{dashboardId}

Delete a dashboard

Name	In	Type	Required	Description
param	path	string	true	the param of dashboard

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

GroupListMapping

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/database/group/list', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/database/group/list',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /database/group/list

Returns group of nodes from server

Example responses

201 Response

{
  "count": 1,
  "data": [
    {
      "arhive": false,
      "db_archive": "hepic_archive",
      "db_name": "hepic_data",
      "host": "148.251.238.121",
      "name": "DE7 Node",
      "node": "\"\"",
      "online": true,
      "primary": false,
      "table_prefix": "string",
      "value": "de7node"
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	NodeList	NodeList
400	Bad Request	FailureResponse	FailureResponse

NodeListMapping

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/database/node/list', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/database/node/list',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /database/node/list

Returns data from server

Example responses

201 Response

{
  "count": 1,
  "data": [
    {
      "arhive": false,
      "db_archive": "hepic_archive",
      "db_name": "hepic_data",
      "host": "148.251.238.121",
      "name": "DE7 Node",
      "node": "\"\"",
      "online": true,
      "primary": false,
      "table_prefix": "string",
      "value": "de7node"
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	NodeList	NodeList
400	Bad Request	FailureResponse	FailureResponse

ListMapping

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/database/webnode/list', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/database/webnode/list',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /database/webnode/list

Returns data from server

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

actionActive

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/export/action/active', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/export/action/active',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /export/action/active

Returns log data based upon filtered json

Example responses

400 Response

{
  "error": "string",
  "message": "string",
  "statuscode": 0
}

Status	Meaning	Description	Schema
201	Created	ExportAction	None
400	Bad Request	FailureResponse	FailureResponse

hepicapp

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/export/action/hepicapp', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/export/action/hepicapp',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /export/action/hepicapp

Returns log data based upon filtered json

Example responses

201 Response

{
  "data": {
    "message": "The backup has been created!"
  },
  "total": 1
}

Status	Meaning	Description	Schema
201	Created	ExportActionRTPagent	ExportActionRTPagent
400	Bad Request	FailureResponse	FailureResponse

hepicapplog

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/export/action/logs', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/export/action/logs',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /export/action/logs

Returns log data based upon filtered json

Example responses

201 Response

{
  "data": {
    "message": "The backup has been created!"
  },
  "total": 1
}

Status	Meaning	Description	Schema
201	Created	ExportActionRTPagent	ExportActionRTPagent
400	Bad Request	FailureResponse	FailureResponse

picserver

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/export/action/picserver', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/export/action/picserver',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /export/action/picserver

Returns log data based upon filtered json

Example responses

201 Response

{
  "data": {
    "message": "The backup has been created!"
  },
  "total": 1
}

Status	Meaning	Description	Schema
201	Created	ExportActionRTPagent	ExportActionRTPagent
400	Bad Request	FailureResponse	FailureResponse

rtpagetn

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/export/action/rtpagent', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/export/action/rtpagent',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /export/action/rtpagent

Returns log data based upon filtered json

Example responses

201 Response

{
  "data": {
    "message": "The backup has been created!"
  },
  "total": 1
}

Status	Meaning	Description	Schema
201	Created	ExportActionRTPagent	ExportActionRTPagent
400	Bad Request	FailureResponse	FailureResponse

GetMessagesAsPCap

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/export/call/messages/pcap', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/export/call/messages/pcap',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /export/call/messages/pcap

Returns pcap data based upon filtered json

Body parameter

{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Name	In	Type	Required	Description
body	body	SearchObject	true	SearchObject parameters

Example responses

200 Response

{
  "File": {}
}

Status	Meaning	Description	Schema
200	OK	PCAPResponse	PCAPResponse
400	Bad Request	FailureResponse	FailureResponse

GetMessagesAsSIPP

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/export/call/messages/sipp', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/export/call/messages/sipp',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /export/call/messages/sipp

Returns text data based upon filtered json

Body parameter

{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Name	In	Type	Required	Description
body	body	SearchObject	true	SearchObject parameters

Example responses

201 Response

{
  "File": {}
}

Status	Meaning	Description	Schema
201	Created	SIPPResponse	SIPPResponse
400	Bad Request	FailureResponse	FailureResponse

GetMessagesAsText

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/export/call/messages/text', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/export/call/messages/text',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /export/call/messages/text

Returns text data based upon filtered json

Body parameter

{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Name	In	Type	Required	Description
body	body	SearchObject	true	SearchObject parameters

Example responses

201 Response

{
  "File": {}
}

Status	Meaning	Description	Schema
201	Created	TextResponse	TextResponse
400	Bad Request	FailureResponse	FailureResponse

GetDataFromStenographer

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/export/call/stenographer', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/export/call/stenographer',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /export/call/stenographer

Returns pcap data based upon filtered json

Body parameter

{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Name	In	Type	Required	Description
body	body	SearchObject	false	SearchObject parameters

Example responses

201 Response

{
  "File": {}
}

Status	Meaning	Description	Schema
201	Created	StenographerResponse	StenographerResponse
400	Bad Request	FailureResponse	FailureResponse

saveToArchive

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/export/call/transaction/archive', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/export/call/transaction/archive',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /export/call/transaction/archive

Save transaction data to Archive

Body parameter

{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Name	In	Type	Required	Description
body	body	SearchObject	true	SearchObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

GetTransactionLink

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/export/call/transaction/link', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/export/call/transaction/link',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /export/call/transaction/link

Returns text data based upon filtered json

Body parameter

{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Name	In	Type	Required	Description
body	body	SearchObject	true	SearchObject parameters

Example responses

201 Response

{
  "data": {
    "url": "http://example.com/share/#",
    "uuid": "4141a255-d382-46ef-974e-62dc830acc8f"
  }
}

Status	Meaning	Description	Schema
201	Created	LinkResponse	LinkResponse
400	Bad Request	FailureResponse	FailureResponse

exportCallTransactionReport

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/export/call/transaction/report', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/export/call/transaction/report',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /export/call/transaction/report

Returns transaction data based upon filtered json

Body parameter

{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Name	In	Type	Required	Description
body	body	SearchObject	false	SearchObject parameters

Example responses

400 Response

{
  "error": "string",
  "message": "string",
  "statuscode": 0
}

Status	Meaning	Description	Schema
201	Created	ReportResponse	None
400	Bad Request	FailureResponse	FailureResponse

GetHepSubAgainstUUID

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/hepsub/protocol', headers = headers)

print(r.json())

const inputBody = '{
  "create_date": "2020-10-20T21:15:45+02:00",
  "guid": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "hep_alias": "SIP",
  "hepid": 1,
  "mapping": {},
  "profile": "call",
  "version": 1603221345489
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/hepsub/protocol',
{
  method: 'GET',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /hepsub/protocol

Add new Hepsub information

Body parameter

{
  "create_date": "2020-10-20T21:15:45+02:00",
  "guid": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "hep_alias": "SIP",
  "hepid": 1,
  "mapping": {},
  "profile": "call",
  "version": 1603221345489
}

Name	In	Type	Required	Description
body	body	HepsubSchema	true	HepsubSchema parameters

Example responses

201 Response

{
  "create_date": "2020-10-20T21:15:45+02:00",
  "guid": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "hep_alias": "SIP",
  "hepid": 1,
  "mapping": {},
  "profile": "call",
  "version": 1603221345489
}

Status	Meaning	Description	Schema
201	Created	HepsubSchema	HepsubSchema
400	Bad Request	FailureResponse	FailureResponse

AddHepSub

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/hepsub/protocol', headers = headers)

print(r.json())

const inputBody = '{
  "create_date": "2020-10-20T21:15:45+02:00",
  "guid": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "hep_alias": "SIP",
  "hepid": 1,
  "mapping": {},
  "profile": "call",
  "version": 1603221345489
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/hepsub/protocol',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /hepsub/protocol

Add new Hepsub information

Body parameter

{
  "create_date": "2020-10-20T21:15:45+02:00",
  "guid": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "hep_alias": "SIP",
  "hepid": 1,
  "mapping": {},
  "profile": "call",
  "version": 1603221345489
}

Name	In	Type	Required	Description
body	body	HepsubSchema	true	HepsubSchema parameters

Example responses

201 Response

{
  "data": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "message": "successfully created hepsub settings"
}

Status	Meaning	Description	Schema
201	Created	HepsubCreateSuccessResponse	HepsubCreateSuccessResponse
400	Bad Request	FailureResponse	FailureResponse

UpdateHepSubAgainstUUID

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('https://api.hepic/api/v3/hepsub/protocol/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/hepsub/protocol/{uuid}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /hepsub/protocol/{uuid}

Delete hepsub by guid

Name	In	Type	Required	Description
guid	path	string	true	guid of hepsub item

Example responses

201 Response

{
  "data": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "message": "successfully updated hepsub settings"
}

Status	Meaning	Description	Schema
201	Created	HepsubUpdateSuccessResponse	HepsubUpdateSuccessResponse
400	Bad Request	FailureResponse	FailureResponse

hepSubDeleteHepSubAgainstUUID

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('https://api.hepic/api/v3/hepsub/protocol/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/hepsub/protocol/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /hepsub/protocol/{uuid}

Delete hepsub by guid

Name	In	Type	Required	Description
guid	path	string	true	guid of hepsub item

Example responses

201 Response

{
  "data": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "message": "successfully deleted hepsub settings"
}

Status	Meaning	Description	Schema
201	Created	HepsubDeleteSuccessResponse	HepsubDeleteSuccessResponse
400	Bad Request	FailureResponse	FailureResponse

AddHepsubsearch

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/hepsub/search', headers = headers)

print(r.json())

const inputBody = '{
  "create_date": "2020-10-20T21:15:45+02:00",
  "guid": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "hep_alias": "SIP",
  "hepid": 1,
  "mapping": {},
  "profile": "call",
  "version": 1603221345489
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/hepsub/search',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /hepsub/search

Returns data from server

Body parameter

{
  "create_date": "2020-10-20T21:15:45+02:00",
  "guid": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "hep_alias": "SIP",
  "hepid": 1,
  "mapping": {},
  "profile": "call",
  "version": 1603221345489
}

Name	In	Type	Required	Description
body	body	HepsubSchema	true	HepsubSchema parameters

Example responses

201 Response

{
  "data": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "message": "successfully created hepsub settings"
}

Status	Meaning	Description	Schema
201	Created	HepsubCreateSuccessResponse	HepsubCreateSuccessResponse
400	Bad Request	FailureResponse	FailureResponse

GetMessagesAsPCap

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/import/data/pcap', headers = headers)

print(r.json())

const inputBody = 'false';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/import/data/pcap',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /import/data/pcap

Returns pcap data based upon filtered json

Body parameter

false

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

GetMessagesAsPCapNow

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/import/data/pcap/now', headers = headers)

print(r.json())

const inputBody = 'false';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/import/data/pcap/now',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /import/data/pcap/now

Returns pcap data based upon filtered json

Body parameter

false

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

GetAllLookupIP

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/ipalias', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/ipalias',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /ipalias

Returns the list of aliases

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

ipAliasLookup

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/ipalias', headers = headers)

print(r.json())

const inputBody = '{
  "alias": "mediaServer",
  "group": "Peering",
  "ip": "192.168.10.20",
  "ipobject": {
    "alias": "mediaServer",
    "color": {
      "background": "#c8c8c8",
      "border": "#000000",
      "font": "#000000"
    },
    "group": "Peering",
    "image": "./img/gateways/phone.png",
    "ip": "192.168.10.20",
    "ipv6": false,
    "mask": 32,
    "port": 5060,
    "servertype": "Sansay-Peering",
    "shardid": "allports",
    "status": true,
    "type": 0
  },
  "ipv6": false,
  "mask": 32,
  "port": 5060,
  "servertype": "Sansay-Peering",
  "shardid": "allports",
  "status": true,
  "type": 0,
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664",
  "version": 1611662524002
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/ipalias',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /ipalias

Adds LookupIP to system

Body parameter

{
  "alias": "mediaServer",
  "group": "Peering",
  "ip": "192.168.10.20",
  "ipobject": {
    "alias": "mediaServer",
    "color": {
      "background": "#c8c8c8",
      "border": "#000000",
      "font": "#000000"
    },
    "group": "Peering",
    "image": "./img/gateways/phone.png",
    "ip": "192.168.10.20",
    "ipv6": false,
    "mask": 32,
    "port": 5060,
    "servertype": "Sansay-Peering",
    "shardid": "allports",
    "status": true,
    "type": 0
  },
  "ipv6": false,
  "mask": 32,
  "port": 5060,
  "servertype": "Sansay-Peering",
  "shardid": "allports",
  "status": true,
  "type": 0,
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664",
  "version": 1611662524002
}

Name	In	Type	Required	Description
body	body	AliasSwaggerStruct	true	AliasSwaggerStruct parameters

Example responses

201 Response

{
  "alias": "mediaServer",
  "group": "Peering",
  "ip": "192.168.10.20",
  "ipobject": {
    "alias": "mediaServer",
    "color": {
      "background": "#c8c8c8",
      "border": "#000000",
      "font": "#000000"
    },
    "group": "Peering",
    "image": "./img/gateways/phone.png",
    "ip": "192.168.10.20",
    "ipv6": false,
    "mask": 32,
    "port": 5060,
    "servertype": "Sansay-Peering",
    "shardid": "allports",
    "status": true,
    "type": 0
  },
  "ipv6": false,
  "mask": 32,
  "port": 5060,
  "servertype": "Sansay-Peering",
  "shardid": "allports",
  "status": true,
  "type": 0,
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664",
  "version": 1611662524002
}

Status	Meaning	Description	Schema
201	Created	AliasSwaggerStruct	AliasSwaggerStruct
401	Unauthorized	FailureResponse	FailureResponse

DeleteLookupIP

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('https://api.hepic/api/v3/ipalias/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/ipalias/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /ipalias/{uuid}

delete an alias based upon uuid

Name	In	Type	Required	Description
uuid	path	string	true	uuid of the LookupIP to delete

Example responses

Status	Meaning	Description	Schema
201	Created	LookupIPStruct	None

FileDownload

Code samples

import requests
headers = {
  'Accept': 'application/octet-stream'
}

r = requests.get('https://api.hepic/api/v3/ipalias/export', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/octet-stream'
};

fetch('https://api.hepic/api/v3/ipalias/export',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /ipalias/export

Returns a csv file of the aliases

Example responses

201 Response

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

IPAliasFileResponse

Code samples

import requests
headers = {
  'Content-Type': 'multipart/form-data',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/ipalias/import/replace', headers = headers)

print(r.json())

const inputBody = '{
  "File": "string"
}';
const headers = {
  'Content-Type':'multipart/form-data',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/ipalias/import/replace',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /ipalias/import/replace

Import a csv file of aliases into system

Body parameter

File: string

Name	In	Type	Required	Description
file	undefined	IPAliasFileUpload	false	The file to upload.
body	body	object	false	none
» File	body	string(binary)	false	none

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

UpdateLookupIP

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('https://api.hepic/api/v3/lookupip/{uuid}', headers = headers)

print(r.json())

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/lookupip/{uuid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /lookupip/{uuid}

Update an existing alias based upon the lookup

Body parameter

null

Name	In	Type	Required	Description
uuid	path	string	true	uuid of the LookupIP to update
body	body	any	true	LookupIPStruct parameters

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse

ListProfiles

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/mapping/protocol', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/mapping/protocol',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /mapping/protocol

Returns data from server

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

AddMapping

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/mapping/protocol', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/mapping/protocol',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /mapping/protocol

Returns data from server

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

resetProtocols

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/mapping/protocol/reset', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/mapping/protocol/reset',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /mapping/protocol/reset

Get mapping against id and profile

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

ResetMapping

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/mapping/protocol/reset/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/mapping/protocol/reset/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /mapping/protocol/reset/{uuid}

Get mapping against id and profile

Name	In	Type	Required	Description
id	path	string	true	uuid of mapping

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

GetProtocolMapping

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/mapping/protocol/{id}/{transaction}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/mapping/protocol/{id}/{transaction}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /mapping/protocol/{id}/{transaction}

Get mapping against id and profile

Name	In	Type	Required	Description
uuid	path	undefined	true	hepid
transaction	path	string	true	profile

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

getMapping

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/mapping/protocol/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/mapping/protocol/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /mapping/protocol/{uuid}

Get mapping against id and profile

Name	In	Type	Required	Description
uuid	path	string	true	uuid of mapping

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

DeleteMapping

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('https://api.hepic/api/v3/mapping/protocol/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/mapping/protocol/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /mapping/protocol/{uuid}

Get mapping against id and profile

Name	In	Type	Required	Description
id	path	string	true	uuid of mapping

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

ListMapping

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/mapping/protocols', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/mapping/protocols',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /mapping/protocols

Returns data from server

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

prometheusData

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/prometheus/data', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "limit": 0,
    "metrics": [
      "string"
    ],
    "precision": 0,
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/prometheus/data',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /prometheus/data

Returns data based upon filtered json

Body parameter

{
  "param": {
    "limit": 0,
    "metrics": [
      "string"
    ],
    "precision": 0,
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}

Name	In	Type	Required	Description
body	body	PrometheusObject	true	PrometheusObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

prometheusUserLabel

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/prometheus/label/{userlabel}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/prometheus/label/{userlabel}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /prometheus/label/{userlabel}

Returns data based upon filtered json

Example responses

400 Response

{
  "error": "string",
  "message": "string",
  "statuscode": 0
}

Status	Meaning	Description	Schema
201	Created	ListLabels	None
400	Bad Request	FailureResponse	FailureResponse

prometheusLabels

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/prometheus/labels', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/prometheus/labels',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /prometheus/labels

Returns data based upon filtered json

Example responses

400 Response

{
  "error": "string",
  "message": "string",
  "statuscode": 0
}

Status	Meaning	Description	Schema
201	Created	ListLabels	None
400	Bad Request	FailureResponse	FailureResponse

prometheusValue

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/prometheus/value', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "limit": 0,
    "metrics": [
      "string"
    ],
    "precision": 0,
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/prometheus/value',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /prometheus/value

Returns data based upon filtered json

Body parameter

{
  "param": {
    "limit": 0,
    "metrics": [
      "string"
    ],
    "precision": 0,
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}

Name	In	Type	Required	Description
body	body	PrometheusObject	true	PrometheusObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

ListSettings

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/protocol/search/{id}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/protocol/search/{id}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /protocol/search/{id}

Returns the list of settings

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

AddProtocol

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/protocol/{id}', headers = headers)

print(r.json())

const inputBody = 'false';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/protocol/{id}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /protocol/{id}

Adds alias to system

Body parameter

false

Example responses

201 Response

{
  "scope": "b9f6q23a-0bde-41ce-cd36-da3dbc17ea12",
  "token": "JWT Token",
  "user": {
    "admin": true,
    "force_password": true
  }
}

Status	Meaning	Description	Schema
201	Created	UserLoginSuccessResponse	UserLoginSuccessResponse
401	Unauthorized	FailureResponse	FailureResponse

UpdateAlias

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('https://api.hepic/api/v3/protocol/{uuid}', headers = headers)

print(r.json())

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/protocol/{uuid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /protocol/{uuid}

Update an existing user

Body parameter

null

Name	In	Type	Required	Description
uuid	path	string	true	uuid of the alias to update
body	body	any	true	area parameters

Example responses

201 Response

{
  "alias": "mediaServer",
  "group": "Peering",
  "ip": "192.168.10.20",
  "ipobject": "string",
  "ipv6": false,
  "mask": 32,
  "port": 5060,
  "servertype": "Sansay-Peering",
  "shardid": "allports",
  "status": true,
  "type": 0,
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664",
  "version": 1611662524002
}

Status	Meaning	Description	Schema
201	Created	AliasStruct	AliasStruct

DeleteProtocol

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('https://api.hepic/api/v3/protocol/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/protocol/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /protocol/{uuid}

Update an existing user

Name	In	Type	Required	Description
uuid	path	string	true	uuid of the alias to delete

Example responses

201 Response

{
  "alias": "mediaServer",
  "group": "Peering",
  "ip": "192.168.10.20",
  "ipobject": "string",
  "ipv6": false,
  "mask": 32,
  "port": 5060,
  "servertype": "Sansay-Peering",
  "shardid": "allports",
  "status": true,
  "type": 0,
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664",
  "version": 1611662524002
}

Status	Meaning	Description	Schema
201	Created	AliasStruct	AliasStruct

grafanaDashboard

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/proxy/grafana/dashboards/uid/{uid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/proxy/grafana/dashboards/uid/{uid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /proxy/grafana/dashboards/uid/{uid}

Returns data based upon filtered json

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

grafanaFolders

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/proxy/grafana/folders', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/proxy/grafana/folders',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /proxy/grafana/folders

Returns data based upon filtered json

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

grafanaOrg

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/proxy/grafana/org', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/proxy/grafana/org',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /proxy/grafana/org

Returns data based upon filtered json

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

grafanaRequest

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/proxy/grafana/request/d/{uid}/{param}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/proxy/grafana/request/d/{uid}/{param}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /proxy/grafana/request/d/{uid}/{param}

Returns data based upon filtered json

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

grafanaSearch

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/proxy/grafana/search/{uid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/proxy/grafana/search/{uid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /proxy/grafana/search/{uid}

Returns data based upon filtered json

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

grafana

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/proxy/grafana/status', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/proxy/grafana/status',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /proxy/grafana/status

Returns data based upon filtered json

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

grafanaUrl

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/proxy/grafana/url', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/proxy/grafana/url',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /proxy/grafana/url

Returns data based upon filtered json

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

ListScriptData

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/script', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/script',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /script

Returns data from server

Example responses

201 Response

{
  "data": "verizon",
  "hep_alias": "string",
  "hepid": 0,
  "partid": 0,
  "profile": "string",
  "status": true,
  "type": "javascript / lua",
  "uuid": "string",
  "version": 0
}

Status	Meaning	Description	Schema
201	Created	ScriptDataStruct	ScriptDataStruct

AddScriptData

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/script', headers = headers)

print(r.json())

const inputBody = '{
  "data": "verizon",
  "hep_alias": "string",
  "hepid": 0,
  "partid": 0,
  "profile": "string",
  "status": true,
  "type": "javascript / lua",
  "uuid": "string",
  "version": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/script',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /script

Adds Scripts to system

Body parameter

{
  "data": "verizon",
  "hep_alias": "string",
  "hepid": 0,
  "partid": 0,
  "profile": "string",
  "status": true,
  "type": "javascript / lua",
  "uuid": "string",
  "version": 0
}

Name	In	Type	Required	Description
body	body	ScriptDataStruct	true	ScriptDataStruct parameters

Example responses

201 Response

{
  "scope": "b9f6q23a-0bde-41ce-cd36-da3dbc17ea12",
  "token": "JWT Token",
  "user": {
    "admin": true,
    "force_password": true
  }
}

Status	Meaning	Description	Schema
201	Created	UserLoginSuccessResponse	UserLoginSuccessResponse
401	Unauthorized	FailureResponse	FailureResponse

UpdateScriptData

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('https://api.hepic/api/v3/script/{uuid}', headers = headers)

print(r.json())

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/script/{uuid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /script/{uuid}

Update an existing user

Body parameter

null

Name	In	Type	Required	Description
uuid	path	string	true	uuid of the Scripts to update
body	body	any	true	area parameters

Example responses

201 Response

{
  "data": "verizon",
  "hep_alias": "string",
  "hepid": 0,
  "partid": 0,
  "profile": "string",
  "status": true,
  "type": "javascript / lua",
  "uuid": "string",
  "version": 0
}

Status	Meaning	Description	Schema
201	Created	ScriptDataStruct	ScriptDataStruct

DeleteScriptData

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('https://api.hepic/api/v3/script/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/script/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /script/{uuid}

Update an existing user

Name	In	Type	Required	Description
uuid	path	string	true	uuid of the Scripts to delete

Example responses

201 Response

{
  "data": "verizon",
  "hep_alias": "string",
  "hepid": 0,
  "partid": 0,
  "profile": "string",
  "status": true,
  "type": "javascript / lua",
  "uuid": "string",
  "version": 0
}

Status	Meaning	Description	Schema
201	Created	ScriptDataStruct	ScriptDataStruct

remoteData

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/search/remote/data', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "limit": 0,
    "search": "string",
    "server": "string",
    "timezone": {}
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/search/remote/data',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /search/remote/data

Returns data based upon filtered json

Body parameter

{
  "param": {
    "limit": 0,
    "search": "string",
    "server": "string",
    "timezone": {}
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}

Name	In	Type	Required	Description
body	body	RemoteObject	true	RemoteObject parameters

Example responses

200 Response

{
  "Data": [
    {
      "custom_1": "string",
      "custom_2": "{\"duration\":\"0\",\"from_user\":\"1201\",\"ruri_user\":\"102110112384797001\",status\":\"8\",\"type\":\"call\"}",
      "id": 1,
      "micro_ts": 1634081796154
    }
  ]
}

Status	Meaning	Description	Schema
200	OK	RemoteResponseData	RemoteResponseData
400	Bad Request	FailureResponse	FailureResponse

remoteLabel

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/search/remote/label', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/search/remote/label',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /search/remote/label

Returns data based upon filtered json

Example responses

201 Response

[
  "string"
]

Status	Meaning	Description	Schema
201	Created	RemoteLabels	RemoteLabels
400	Bad Request	FailureResponse	FailureResponse

remoteStatus

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/search/remote/status', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/search/remote/status',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /search/remote/status

Returns data based upon filtered json

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

remoteValues

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/search/remote/values', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/search/remote/values',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /search/remote/values

Returns data based upon filtered json

Example responses

201 Response

[
  "string"
]

Status	Meaning	Description	Schema
201	Created	RemoteValues	RemoteValues
400	Bad Request	FailureResponse	FailureResponse

searchCallReportDtmf

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Auth-Token': undefined
}

r = requests.post('https://api.hepic/api/v3/share/call/report/dtmf/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json',
  'Auth-Token':undefined
};

fetch('https://api.hepic/api/v3/share/call/report/dtmf/{uuid}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /share/call/report/dtmf/{uuid}

Returns log data based upon filtered json

Name	In	Type	Required	Description
Auth-Token	header	undefined	true	SearchObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

searchCallReportLogs

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Auth-Token': undefined
}

r = requests.post('https://api.hepic/api/v3/share/call/report/log/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json',
  'Auth-Token':undefined
};

fetch('https://api.hepic/api/v3/share/call/report/log/{uuid}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /share/call/report/log/{uuid}

Returns log data based upon filtered json

Name	In	Type	Required	Description
Auth-Token	header	undefined	true	SearchObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

searchCallTransaction

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Auth-Token': undefined
}

r = requests.post('https://api.hepic/api/v3/share/call/transaction/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json',
  'Auth-Token':undefined
};

fetch('https://api.hepic/api/v3/share/call/transaction/{uuid}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /share/call/transaction/{uuid}

Returns transaction data based upon filtered json

Name	In	Type	Required	Description
Auth-Token	header	undefined	true	SearchObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

searchCallMessagesPcap

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Auth-Token': undefined
}

r = requests.post('https://api.hepic/api/v3/share/export/call/messages/pcap/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json',
  'Auth-Token':undefined
};

fetch('https://api.hepic/api/v3/share/export/call/messages/pcap/{uuid}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /share/export/call/messages/pcap/{uuid}

Returns pcap data based upon filtered json

Name	In	Type	Required	Description
Auth-Token	header	undefined	true	SearchObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

searchMessagesText

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Auth-Token': undefined
}

r = requests.post('https://api.hepic/api/v3/share/export/call/messages/text/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json',
  'Auth-Token':undefined
};

fetch('https://api.hepic/api/v3/share/export/call/messages/text/{uuid}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /share/export/call/messages/text/{uuid}

Returns text data based upon filtered json

Name	In	Type	Required	Description
Auth-Token	header	undefined	true	SearchObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

ipAliasLookup

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/share/ipalias/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/share/ipalias/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /share/ipalias/{uuid}

Returns data from server

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse

searchMappingProtocol

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/share/mapping/protocol/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/share/mapping/protocol/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /share/mapping/protocol/{uuid}

Returns data from server

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

searchCalMessageByUuuid

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Auth-Token': undefined
}

r = requests.post('https://api.hepic/api/v3/share/search/call/message/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json',
  'Auth-Token':undefined
};

fetch('https://api.hepic/api/v3/share/search/call/message/{uuid}',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /share/search/call/message/{uuid}

Returns data based upon filtered json

Name	In	Type	Required	Description
Auth-Token	header	undefined	true	SearchObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

statsDB

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/statistic/_db', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/statistic/_db',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /statistic/_db

Returns data based upon filtered json

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

statsMeasurement

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/statistic/_measurements/{dbid}', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "Search": {
      "database": "string"
    },
    "bfrom": 0,
    "limit": 0,
    "precision": 0,
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/statistic/_measurements/{dbid}',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /statistic/_measurements/{dbid}

Returns data based upon filtered json

Body parameter

{
  "param": {
    "Search": {
      "database": "string"
    },
    "bfrom": 0,
    "limit": 0,
    "precision": 0,
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}

Name	In	Type	Required	Description
body	body	StatisticSearchObject	true	StatisticSearchObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

statsMetrics

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/statistic/_metrics', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "bfrom": 0,
    "limit": 0,
    "precision": 0,
    "query": [
      {
        "database": "string",
        "main": "string",
        "rawquery": "string",
        "retention": "string",
        "tag": [
          "string"
        ],
        "type": [
          "string"
        ]
      }
    ],
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/statistic/_metrics',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /statistic/_metrics

Returns data based upon filtered json

Body parameter

{
  "param": {
    "bfrom": 0,
    "limit": 0,
    "precision": 0,
    "query": [
      {
        "database": "string",
        "main": "string",
        "rawquery": "string",
        "retention": "string",
        "tag": [
          "string"
        ],
        "type": [
          "string"
        ]
      }
    ],
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}

Name	In	Type	Required	Description
body	body	StatisticObject	true	StatisticObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

statsRetention

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/statistic/_retentions', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "Search": {
      "database": "string"
    },
    "bfrom": 0,
    "limit": 0,
    "precision": 0,
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/statistic/_retentions',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /statistic/_retentions

Returns data based upon filtered json

Body parameter

{
  "param": {
    "Search": {
      "database": "string"
    },
    "bfrom": 0,
    "limit": 0,
    "precision": 0,
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}

Name	In	Type	Required	Description
body	body	StatisticSearchObject	true	StatisticSearchObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

statsTags

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/statistic/_tags', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "bfrom": 0,
    "limit": 0,
    "precision": 0,
    "query": [
      {
        "database": "string",
        "main": "string",
        "rawquery": "string",
        "retention": "string",
        "tag": [
          "string"
        ],
        "type": [
          "string"
        ]
      }
    ],
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/statistic/_tags',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /statistic/_tags

Returns data based upon filtered json

Body parameter

{
  "param": {
    "bfrom": 0,
    "limit": 0,
    "precision": 0,
    "query": [
      {
        "database": "string",
        "main": "string",
        "rawquery": "string",
        "retention": "string",
        "tag": [
          "string"
        ],
        "type": [
          "string"
        ]
      }
    ],
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}

Name	In	Type	Required	Description
body	body	StatisticObject	true	StatisticObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

infoDatabase

Code samples

import requests
headers = {
  'Accept': 'application/json',
  'Auth-Token': undefined
}

r = requests.post('https://api.hepic/api/v3/statistic/database/info', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json',
  'Auth-Token':undefined
};

fetch('https://api.hepic/api/v3/statistic/database/info',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /statistic/database/info

Returns log data based upon filtered json

Name	In	Type	Required	Description
Auth-Token	header	undefined	true	SearchObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

dataSearch

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/statistic/data', headers = headers)

print(r.json())

const inputBody = '{
  "param": {
    "bfrom": 0,
    "limit": 0,
    "precision": 0,
    "query": [
      {
        "database": "string",
        "main": "string",
        "rawquery": "string",
        "retention": "string",
        "tag": [
          "string"
        ],
        "type": [
          "string"
        ]
      }
    ],
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/statistic/data',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /statistic/data

Returns data based upon filtered json

Body parameter

{
  "param": {
    "bfrom": 0,
    "limit": 0,
    "precision": 0,
    "query": [
      {
        "database": "string",
        "main": "string",
        "rawquery": "string",
        "retention": "string",
        "tag": [
          "string"
        ],
        "type": [
          "string"
        ]
      }
    ],
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}

Name	In	Type	Required	Description
body	body	StatisticObject	true	StatisticObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

GetToken

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/token/auth', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/token/auth',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /token/auth

Returns data from server

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

AddAuthToken

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/token/auth', headers = headers)

print(r.json())

const inputBody = '{
  "active": true,
  "create_date": "2019-08-24T14:15:22Z",
  "creator_guid": "string",
  "expire_date": "2019-08-24T14:15:22Z",
  "guid": "string",
  "ip_address": "string",
  "lastusage_date": "2019-08-24T14:15:22Z",
  "limit_calls": 0,
  "name": "string",
  "usage_calls": 0,
  "user_object": {},
  "usergroup": "string",
  "version": 0
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/token/auth',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /token/auth

Returns data from server

Body parameter

{
  "active": true,
  "create_date": "2019-08-24T14:15:22Z",
  "creator_guid": "string",
  "expire_date": "2019-08-24T14:15:22Z",
  "guid": "string",
  "ip_address": "string",
  "lastusage_date": "2019-08-24T14:15:22Z",
  "limit_calls": 0,
  "name": "string",
  "usage_calls": 0,
  "user_object": {},
  "usergroup": "string",
  "version": 0
}

Name	In	Type	Required	Description
body	body	TableAuthToken	true	TableAuthToken parameters

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

GetTokenAgainstUUID

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/token/auth/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/token/auth/{uuid}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /token/auth/{uuid}

Returns data from server

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

UpdateToken

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.put('https://api.hepic/api/v3/token/auth/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/token/auth/{uuid}',
{
  method: 'PUT',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /token/auth/{uuid}

Returns data from server

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

DeleteToken

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('https://api.hepic/api/v3/token/auth/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/token/auth/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /token/auth/{uuid}

Returns data from server

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

DoActionForLog

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/troubleshooting/log/:type/:action', headers = headers)

print(r.json())

const inputBody = '{
  "data": [
    {
      "aliasDst": "string",
      "aliasSrc": "string",
      "create_date": 0,
      "destination": 0,
      "dstHost": "string",
      "dstId": "string",
      "dstIp": "string",
      "dstPort": 0.1,
      "id": 0.1,
      "method": "string",
      "method_text": "string",
      "micro_ts": 0,
      "msg_color": "string",
      "prot": 0.1,
      "protocol": 0.1,
      "ruri_user": "string",
      "sid": "string",
      "srcHost": "string",
      "srcId": "string",
      "srcIp": "string",
      "srcPort": 0.1,
      "table": "string"
    }
  ],
  "keys": [
    "callid",
    "srcIp",
    "srcPort"
  ],
  "total": 45
}';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/troubleshooting/log/:type/:action',
{
  method: 'GET',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /troubleshooting/log/:type/:action

Returns data based upon filtered json

Body parameter

{
  "data": [
    {
      "aliasDst": "string",
      "aliasSrc": "string",
      "create_date": 0,
      "destination": 0,
      "dstHost": "string",
      "dstId": "string",
      "dstIp": "string",
      "dstPort": 0.1,
      "id": 0.1,
      "method": "string",
      "method_text": "string",
      "micro_ts": 0,
      "msg_color": "string",
      "prot": 0.1,
      "protocol": 0.1,
      "ruri_user": "string",
      "sid": "string",
      "srcHost": "string",
      "srcId": "string",
      "srcIp": "string",
      "srcPort": 0.1,
      "table": "string"
    }
  ],
  "keys": [
    "callid",
    "srcIp",
    "srcPort"
  ],
  "total": 45
}

Name	In	Type	Required	Description
body	body	SearchCallData	true	SearchObject parameters

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

ListSettings

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/user/settings/{category}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/user/settings/{category}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /user/settings/{category}

Returns the list of settings

Example responses

201 Response

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Status	Meaning	Description	Schema
201	Created	ListUsers	ListUsers
400	Bad Request	FailureResponse	FailureResponse

AddUserSettings

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.post('https://api.hepic/api/v3/user/settings', headers = headers)

print(r.json())

const inputBody = 'false';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/user/settings',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

POST /user/settings

Adds user settings to system

Body parameter

false

Example responses

201 Response

{
  "scope": "b9f6q23a-0bde-41ce-cd36-da3dbc17ea12",
  "token": "JWT Token",
  "user": {
    "admin": true,
    "force_password": true
  }
}

Status	Meaning	Description	Schema
201	Created	UserLoginSuccessResponse	UserLoginSuccessResponse
401	Unauthorized	FailureResponse	FailureResponse

UpdateSettings

Code samples

import requests
headers = {
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

r = requests.put('https://api.hepic/api/v3/user/settings/{uuid}', headers = headers)

print(r.json())

const inputBody = 'null';
const headers = {
  'Content-Type':'application/json',
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/user/settings/{uuid}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

PUT /user/settings/{uuid}

Update an existing user

Body parameter

null

Name	In	Type	Required	Description
uuid	path	string	true	uuid of the alias to update
body	body	any	true	area parameters

Example responses

201 Response

{
  "alias": "mediaServer",
  "group": "Peering",
  "ip": "192.168.10.20",
  "ipobject": "string",
  "ipv6": false,
  "mask": 32,
  "port": 5060,
  "servertype": "Sansay-Peering",
  "shardid": "allports",
  "status": true,
  "type": 0,
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664",
  "version": 1611662524002
}

Status	Meaning	Description	Schema
201	Created	AliasStruct	AliasStruct

DeleteSettings

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.delete('https://api.hepic/api/v3/user/settings/{uuid}', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/user/settings/{uuid}',
{
  method: 'DELETE',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

DELETE /user/settings/{uuid}

Update an existing user

Name	In	Type	Required	Description
uuid	path	string	true	uuid of the alias to delete

Example responses

201 Response

{
  "alias": "mediaServer",
  "group": "Peering",
  "ip": "192.168.10.20",
  "ipobject": "string",
  "ipv6": false,
  "mask": 32,
  "port": 5060,
  "servertype": "Sansay-Peering",
  "shardid": "allports",
  "status": true,
  "type": 0,
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664",
  "version": 1611662524002
}

Status	Meaning	Description	Schema
201	Created	AliasStruct	AliasStruct

ListMapping

Code samples

import requests
headers = {
  'Accept': 'application/json'
}

r = requests.get('https://api.hepic/api/v3/version/ui/info', headers = headers)

print(r.json())

const headers = {
  'Accept':'application/json'
};

fetch('https://api.hepic/api/v3/version/ui/info',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

GET /version/ui/info

Returns data from server

Example responses

201 Response

{
  "count": 0,
  "data": {},
  "message": "string"
}

Status	Meaning	Description	Schema
201	Created	SuccessResponse	SuccessResponse
400	Bad Request	FailureResponse	FailureResponse

Schemas

{
  "count": 0,
  "data": [
    "alias",
    "users",
    "global_settings"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer(int64)	false	none	exmaple: 7
data	[string]	false	none	none

{
  "data": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "message": "successfully created AgentLocation settings"
}

Properties

Name	Type	Required	Restrictions	Description
data	string	false	none	none
message	string	false	none	none

{
  "data": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "message": "successfully deleted AgentLocation settings"
}

Properties

Name	Type	Required	Restrictions	Description
data	string	false	none	none
message	string	false	none	none

{
  "data": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "message": "successfully updated AgentLocation settings"
}

Properties

Name	Type	Required	Restrictions	Description
data	string	false	none	none
message	string	false	none	none

{
  "active": true,
  "create_date": "2019-08-24T14:15:22Z",
  "expire_date": "2019-08-24T14:15:22Z",
  "gid": 0,
  "host": "string",
  "node": "string",
  "path": "string",
  "port": 0,
  "protocol": "string",
  "ttl": 0,
  "type": "string",
  "uuid": "string",
  "version": 0
}

Properties

Name	Type	Required	Restrictions	Description
active	boolean	false	none	none
create_date	string(date-time)	false	none	none
expire_date	string(date-time)	false	none	none
gid	integer(uint32)	false	none	none
host	string	false	none	none
node	string	false	none	none
path	string	false	none	none
port	integer(uint16)	false	none	none
protocol	string	false	none	none
ttl	integer(uint32)	false	none	none
type	string	false	none	none
uuid	string	false	none	none
version	integer(uint64)	false	none	none

{
  "Data": [
    {
      "active": true,
      "create_date": "2019-08-24T14:15:22Z",
      "expire_date": "2019-08-24T14:15:22Z",
      "gid": 0,
      "host": "string",
      "node": "string",
      "path": "string",
      "port": 0,
      "protocol": "string",
      "ttl": 0,
      "type": "string",
      "uuid": "string",
      "version": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[AgentsLocation]	false	none	none

{
  "alias": "0",
  "firstipv4": [
    0
  ],
  "firstipv6": [
    0
  ],
  "group": "string",
  "ip": "192.168.10.20",
  "ipobject": {},
  "ipv6": true,
  "lastbinaryipv4": 5060,
  "lastbinaryipv6": {},
  "lastipv4": [
    0
  ],
  "lastipv6": [
    0
  ],
  "mask": 32,
  "port": 5060,
  "servertype": "string",
  "type": 0
}

Properties

Name	Type	Required	Restrictions	Description
alias	string	true	none	none
firstipv4	IP	true	none	Note that in this documentation, referring to anIP address as an IPv4 address or an IPv6 addressis a semantic property of the address, not just thelength of the byte slice: a 16-byte slice can stillbe an IPv4 address.
firstipv6	IP	true	none	Note that in this documentation, referring to anIP address as an IPv4 address or an IPv6 addressis a semantic property of the address, not just thelength of the byte slice: a 16-byte slice can stillbe an IPv4 address.
group	string	false	none	none
ip	string	true	none	none
ipobject	JSONText	true	none	none
ipv6	boolean	false	none	none
lastbinaryipv4	integer(uint32)	true	none	none
lastbinaryipv6	Int	true	none	Operations always take pointer arguments (Int) ratherthan Int values, and each unique Int value requiresits own unique Int pointer. To "copy" an Int value,an existing (or newly allocated) Int must be set toa new value using the Int.Set method; shallow copiesof Ints are not supported and may lead to errors.
lastipv4	IP	true	none	Note that in this documentation, referring to anIP address as an IPv4 address or an IPv6 addressis a semantic property of the address, not just thelength of the byte slice: a 16-byte slice can stillbe an IPv4 address.
lastipv6	IP	true	none	Note that in this documentation, referring to anIP address as an IPv4 address or an IPv6 addressis a semantic property of the address, not just thelength of the byte slice: a 16-byte slice can stillbe an IPv4 address.
mask	integer(uint16)	true	none	none
port	integer(uint16)	true	none	none
servertype	string	false	none	server type
type	integer(uint32)	false	none	none

{
  "metadata_modification_time": 1614606829,
  "total_bytes": 0,
  "total_rows": 0
}

Properties

Name	Type	Required	Restrictions	Description
metadata_modification_time	integer(uint32)	false	none	none
total_bytes	integer(uint32)	false	none	none
total_rows	integer(uint32)	false	none	none

{
  "alias": "mediaServer",
  "group": "Peering",
  "ip": "192.168.10.20",
  "ipobject": "string",
  "ipv6": false,
  "mask": 32,
  "port": 5060,
  "servertype": "Sansay-Peering",
  "shardid": "allports",
  "status": true,
  "type": 0,
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664",
  "version": 1611662524002
}

Properties

Name	Type	Required	Restrictions	Description
alias	string	true	none	none
group	string	true	none	group this server belongs to
ip	string	true	none	none
ipobject	string(binary)	false	none	Ip object to be appended to data
ipv6	boolean	false	none	if entry is for ipv6
mask	integer(uint16)	true	none	none
port	integer(uint16)	true	none	none
servertype	string	true	none	servertype this server belongs to
shardid	string	false	none	ShardID
status	boolean	true	none	status of the alias
type	integer(uint32)	true	none	none
uuid	string	true	none	should be a unique value representing user
version	integer(uint64)	false	none	Version

{
  "alias": "mediaServer",
  "group": "Peering",
  "ip": "192.168.10.20",
  "ipobject": {
    "alias": "mediaServer",
    "color": {
      "background": "#c8c8c8",
      "border": "#000000",
      "font": "#000000"
    },
    "group": "Peering",
    "image": "./img/gateways/phone.png",
    "ip": "192.168.10.20",
    "ipv6": false,
    "mask": 32,
    "port": 5060,
    "servertype": "Sansay-Peering",
    "shardid": "allports",
    "status": true,
    "type": 0
  },
  "ipv6": false,
  "mask": 32,
  "port": 5060,
  "servertype": "Sansay-Peering",
  "shardid": "allports",
  "status": true,
  "type": 0,
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664",
  "version": 1611662524002
}

Properties

Name	Type	Required	Restrictions	Description
alias	string	true	none	an alias for the server
group	string	true	none	group this server belongs to
ip	string	true	none	none
ipobject	object	false	none	none
» alias	string	true	none	an alias for the server
» color	object	false	none	none
»» background	string	true	none	background color to choose
»» border	string	true	none	background color to choose
»» font	string	true	none	font to choose
» group	string	true	none	group this server belongs to
» image	string	true	none	image use to idenfity this server
» ip	string	true	none	none
» ipv6	boolean	false	none	if entry is for ipv6
» mask	integer(int64)	true	none	none
» port	integer(int64)	true	none	none
» servertype	string	true	none	servertype this server belongs to
» shardid	string	false	none	none
» status	boolean	true	none	status of the alias
» type	integer(int64)	true	none	none
ipv6	boolean	false	none	if entry is for ipv6
mask	integer(uint16)	true	none	none
port	integer(uint16)	true	none	none
servertype	string	true	none	servertype this server belongs to
shardid	string	false	none	ShardID
status	boolean	true	none	status of the alias
type	integer(uint32)	true	none	none
uuid	string	true	none	should be a unique value representing user
version	integer(uint64)	false	none	Version

{
  "File": {}
}

Properties

Name	Type	Required	Restrictions	Description
File	File	false	none	none

{
  "aliasDst": "string",
  "aliasSrc": "string",
  "create_date": 0,
  "destination": 0,
  "dstHost": "string",
  "dstId": "string",
  "dstIp": "string",
  "dstPort": 0.1,
  "id": 0.1,
  "method": "string",
  "method_text": "string",
  "micro_ts": 0,
  "msg_color": "string",
  "prot": 0.1,
  "protocol": 0.1,
  "ruri_user": "string",
  "sid": "string",
  "srcHost": "string",
  "srcId": "string",
  "srcIp": "string",
  "srcPort": 0.1,
  "table": "string"
}

Properties

Name	Type	Required	Restrictions	Description
aliasDst	string	false	none	none
aliasSrc	string	false	none	none
create_date	integer(int64)	false	none	none
destination	integer(int64)	false	none	none
dstHost	string	false	none	none
dstId	string	false	none	none
dstIp	string	false	none	none
dstPort	number(double)	false	none	none
id	number(double)	false	none	none
method	string	false	none	none
method_text	string	false	none	none
micro_ts	integer(int64)	false	none	none
msg_color	string	false	none	none
prot	number(double)	false	none	none
protocol	number(double)	false	none	none
ruri_user	string	false	none	none
sid	string	false	none	none
srcHost	string	false	none	none
srcId	string	false	none	none
srcIp	string	false	none	none
srcPort	number(double)	false	none	none
table	string	false	none	none

{
  "query": "string"
}

Properties

Name	Type	Required	Restrictions	Description
query	string	true	none	none

{
  "data": {
    "property1": {
      "name": "string",
      "type": "string"
    },
    "property2": {
      "name": "string",
      "type": "string"
    }
  },
  "total": 0
}

Properties

Name	Type	Required	Restrictions	Description
data	object	false	none	none
» additionalProperties	object	false	none	none
»» name	string	false	none	none
»» type	string	false	none	none
total	integer(int64)	false	none	none

{
  "department": "NOC",
  "email": "string",
  "firstname": "string",
  "guid": "string",
  "lastname": "string",
  "params": {},
  "partid": 10,
  "password": "string",
  "usergroup": "admin",
  "username": "string",
  "version": 0
}

Properties

Name	Type	Required	Restrictions	Description
department	string	true	none	none
email	string	true	none	none
firstname	string	true	none	none
guid	string	false	none	none
lastname	string	true	none	none
params	JSONText	false	none	none
partid	integer(uint16)	true	none	none
password	string	true	none	none
usergroup	string	true	none	none
username	string	false	none	none
version	integer(uint64)	true	none	none

{
  "critical": true,
  "error": "string",
  "time": "2019-08-24T14:15:22Z"
}

Properties

Name	Type	Required	Restrictions	Description
critical	boolean	false	none	none
error	string	false	none	none
time	string(date-time)	false	none	none

{
  "Idle": 0,
  "InUse": 0,
  "MaxIdleClosed": 0,
  "MaxIdleTimeClosed": 0,
  "MaxLifetimeClosed": 0,
  "MaxOpenConnections": 0,
  "OpenConnections": 0,
  "WaitCount": 0,
  "WaitDuration": 0
}

DBStats contains database statistics.

Properties

Name	Type	Required	Restrictions	Description
Idle	integer(int64)	false	none	none
InUse	integer(int64)	false	none	none
MaxIdleClosed	integer(int64)	false	none	none
MaxIdleTimeClosed	integer(int64)	false	none	none
MaxLifetimeClosed	integer(int64)	false	none	none
MaxOpenConnections	integer(int64)	false	none	none
OpenConnections	integer(int64)	false	none	Pool Status
WaitCount	integer(int64)	false	none	Counters
WaitDuration	Duration	false	none	A Duration represents the elapsed time between two instantsas an int64 nanosecond count. The representation limits thelargest representable duration to approximately 290 years.

{
  "auth": "ok",
  "data": [
    {
      "cssclass": "string",
      "href": "string",
      "id": "string",
      "name": "string",
      "owner": "string",
      "param": "string",
      "shared": true,
      "type": 0,
      "weight": 0.1
    }
  ],
  "status": "ok",
  "total": 1
}

Properties

Name	Type	Required	Restrictions	Description
auth	string	false	none	none
data	[DashboardElements]	false	none	none
status	string	false	none	none
total	integer(int64)	false	none	none

{
  "cssclass": "string",
  "href": "string",
  "id": "string",
  "name": "string",
  "owner": "string",
  "param": "string",
  "shared": true,
  "type": 0,
  "weight": 0.1
}

Properties

Name	Type	Required	Restrictions	Description
cssclass	string	false	none	none
href	string	false	none	none
id	string	false	none	none
name	string	false	none	none
owner	string	false	none	none
param	string	false	none	none
shared	boolean	false	none	none
type	integer(int64)	false	none	none
weight	number(double)	false	none	none

{
  "database_name": "string",
  "database_version": "string",
  "db_error_count": 0,
  "db_error_log": [
    {
      "critical": true,
      "error": "string",
      "time": "2019-08-24T14:15:22Z"
    }
  ],
  "db_stats": {
    "Idle": 0,
    "InUse": 0,
    "MaxIdleClosed": 0,
    "MaxIdleTimeClosed": 0,
    "MaxLifetimeClosed": 0,
    "MaxOpenConnections": 0,
    "OpenConnections": 0,
    "WaitCount": 0,
    "WaitDuration": 0
  },
  "last_check": "2019-08-24T14:15:22Z",
  "last_error": "string",
  "latency_avg": 0,
  "latency_max": 0,
  "latency_min": 0,
  "online": true,
  "primary": true
}

Properties

Name	Type	Required	Restrictions	Description
database_name	string	false	none	none
database_version	string	false	none	none
db_error_count	integer(int64)	false	none	none
db_error_log	[DBStatLog]	false	none	none
db_stats	DBStats	false	none	none
last_check	string(date-time)	false	none	none
last_error	string	false	none	none
latency_avg	integer(int64)	false	none	none
latency_max	integer(int64)	false	none	none
latency_min	integer(int64)	false	none	none
online	boolean	false	none	none
primary	boolean	false	none	none

A Duration represents the elapsed time between two instants as an int64 nanosecond count. The representation limits the largest representable duration to approximately 290 years.

Properties

Name	Type	Required	Restrictions	Description
anonymous	integer(int64)	false	none	A Duration represents the elapsed time between two instantsas an int64 nanosecond count. The representation limits thelargest representable duration to approximately 290 years.

{
  "data": {
    "active": true
  }
}

Properties

Name	Type	Required	Restrictions	Description
data	object	false	none	none
» active	boolean	false	none	none

{
  "data": {
    "message": "The backup has been created!"
  },
  "total": 1
}

Properties

Name	Type	Required	Restrictions	Description
data	object	false	none	none
» message	string	false	none	none
total	integer(int64)	false	none	none

{
  "param": {
    "limit": 200,
    "location": {
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": {
        "callid": [
          "437711663849803218062147"
        ],
        "id": [
          "437711663849803218062147"
        ],
        "uuid": []
      }
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Properties

Name	Type	Required	Restrictions	Description
param	object	true	none	none
» limit	integer(int64)	true	none	this controls the number of records to display
» location	object	false	none	location
»» node	[string]	false	none	node to search the recordstype: arrayitems:type: string
» orlogic	boolean	false	none	this control the type of search one can performtype: boolean
» search	object	true	none	this control the type of search one can performtype: string
»» 60_call_h20	object	false	none	table to be search from
»»» callid	[string]	true	none	callid of the message for the search from
»»» id	[string]	true	none	callid of the message to export
»»» uuid	[string]	true	none	uuid of the message
» timezone	object	false	none	timezone settingstype: object
»» name	string	false	none	none
»» value	integer(int64)	false	none	none
» transaction	object	false	none	none
» whitelist	[string]	false	none	ips to be removed from search
timestamp	object	false	none	this control the time range for used for search
» from	integer(int64)	true	none	current timestamp in milliseconds
» to	integer(int64)	true	none	current timestamp in milliseconds

{
  "error": "string",
  "message": "string",
  "statuscode": 0
}

Properties

Name	Type	Required	Restrictions	Description
error	string	false	none	errot
message	string	false	none	message
statuscode	integer(int64)	false	none	statuscode

{}

File represents an open file descriptor.

Properties

None

{
  "data": "af72057b-2745-0a1b-b674-56586aadec57",
  "message": "successfully created GlobalSetting"
}

Properties

Name	Type	Required	Restrictions	Description
data	string	false	none	none
message	string	false	none	none

{
  "data": "af72057b-2745-0a1b-b674-56586aadec57",
  "message": "successfully deleted GlobalSetting"
}

Properties

Name	Type	Required	Restrictions	Description
data	string	false	none	none
message	string	false	none	none

{
  "category": "string",
  "create_date": "2019-08-24T14:15:22Z",
  "data": {},
  "guid": "string",
  "param": "string",
  "partid": 0,
  "setting": {},
  "version": 0
}

Properties

Name	Type	Required	Restrictions	Description
category	string	false	none	none
create_date	string(date-time)	false	none	none
data	JSONText	false	none	none
guid	string	false	none	none
param	string	false	none	none
partid	integer(uint16)	false	none	none
setting	JSONText	false	none	none
version	integer(uint64)	false	none	none

{
  "count": 0,
  "data": [
    {
      "category": "string",
      "create_date": "2019-08-24T14:15:22Z",
      "data": {},
      "guid": "string",
      "param": "string",
      "partid": 0,
      "setting": {},
      "version": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer(int64)	false	none	none
data	[GlobalSettingsStruct]	false	none	none

{
  "data": "af72057b-2745-0a1b-b674-56586aadec57",
  "message": "successfully updated GlobalSetting"
}

Properties

Name	Type	Required	Restrictions	Description
data	string	false	none	none
message	string	false	none	none

{
  "data": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "message": "successfully created hepsub settings"
}

Properties

Name	Type	Required	Restrictions	Description
data	string	false	none	none
message	string	false	none	none

{
  "data": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "message": "successfully deleted hepsub settings"
}

Properties

Name	Type	Required	Restrictions	Description
data	string	false	none	none
message	string	false	none	none

{
  "create_date": "2020-10-20T21:15:45+02:00",
  "guid": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "hep_alias": "SIP",
  "hepid": 1,
  "mapping": {},
  "profile": "call",
  "version": 1603221345489
}

Properties

Name	Type	Required	Restrictions	Description
create_date	string(date-time)	false	none	none
guid	string	false	none	none
hep_alias	string	false	none	none
hepid	integer(uint16)	false	none	none
mapping	JSONText	false	none	none
profile	string	false	none	none
version	integer(uint64)	false	none	none

{
  "count": 0,
  "data": [
    {
      "create_date": "2020-10-20T21:15:45+02:00",
      "guid": "4b855914-ca3d-4562-8563-f2b660fe2636",
      "hep_alias": "SIP",
      "hepid": 1,
      "mapping": {},
      "profile": "call",
      "version": 1603221345489
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer(int64)	false	none	none
data	[HepsubSchema]	false	none	none

{
  "data": "4b855914-ca3d-4562-8563-f2b660fe2636",
  "message": "successfully updated hepsub settings"
}

Properties

Name	Type	Required	Restrictions	Description
data	string	false	none	none
message	string	false	none	none

[
  0
]

An IP is a single IP address, a slice of bytes. Functions in this package accept either 4-byte (IPv4) or 16-byte (IPv6) slices as input.

Properties

Name	Type	Required	Restrictions	Description
An IP is a single IP address, a slice of bytes.
Functions in this package accept either 4-byte (IPv4)
or 16-byte (IPv6) slices as input.	[integer]	false	none	Note that in this documentation, referring to anIP address as an IPv4 address or an IPv6 addressis a semantic property of the address, not just thelength of the byte slice: a 16-byte slice can stillbe an IPv4 address.

{
  "File": {}
}

Properties

Name	Type	Required	Restrictions	Description
File	File	false	none	none

{
  "File": {}
}

Properties

Name	Type	Required	Restrictions	Description
File	File	false	none	none

{}

An Int represents a signed multi-precision integer. The zero value for an Int represents the value 0.

Properties

None

{
  "LIID": 0,
  "deleted": true,
  "description": "string",
  "gid": 0,
  "number": "string",
  "reseller_id": 0,
  "search_callee": "string",
  "search_caller": "string",
  "search_ip": "string",
  "sip_domain": "string",
  "sip_username": "string",
  "ts_create": 0,
  "ts_modify": 0,
  "ts_start": 0,
  "ts_stop": 0,
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664"
}

Properties

Name	Type	Required	Restrictions	Description
LIID	integer(uint32)	false	none	LIID
deleted	boolean	false	none	deleted
description	string	false	none	description
gid	integer(uint32)	false	none	gid
number	string	false	none	Number
reseller_id	integer(uint32)	false	none	reseller
search_callee	string	false	none	Callee
search_caller	string	false	none	Callee
search_ip	string	false	none	Callee
sip_domain	string	false	none	SIP Domain
sip_username	string	false	none	SIP Username
ts_create	integer(int64)	true	none	none
ts_modify	integer(int64)	true	none	none
ts_start	integer(int64)	true	none	none
ts_stop	integer(int64)	true	none	none
uuid	string	true	none	should be a unique value representing user

{
  "create_date": "2019-08-24T14:15:22Z",
  "delivery": {},
  "description": "string",
  "gid": 0,
  "liid": 0,
  "modify_date": "2019-08-24T14:15:22Z",
  "search_callee": "string",
  "search_caller": "string",
  "search_ip": "string",
  "start_date": "2019-08-24T14:15:22Z",
  "status": true,
  "stop_date": "2019-08-24T14:15:22Z",
  "uuid": "e71771a2-1ea0-498f-8d27-391713e10664",
  "version": 0
}

Properties

Name	Type	Required	Restrictions	Description
create_date	string(date-time)	true	none	none
delivery	JSONText	true	none	none
description	string	false	none	description
gid	integer(uint32)	false	none	gid
liid	integer(uint32)	false	none	LIID
modify_date	string(date-time)	false	none	required:
search_callee	string	false	none	Callee
search_caller	string	false	none	Callee
search_ip	string	false	none	Callee
start_date	string(date-time)	false	none	required:
status	boolean	false	none	none
stop_date	string(date-time)	false	none	required:
uuid	string	true	none	should be a unique value representing user
version	integer(uint64)	false	none	Version

{}

Properties

None

{
  "entries": [
    {
      "entries": [],
      "labels": {}
    }
  ],
  "labels": {}
}

Properties

Name	Type	Required	Restrictions	Description
entries	[LabelData]	false	none	none
labels	object	false	none	none

{
  "Group": "string",
  "IP": "192.168.10.20",
  "IPBits": 32,
  "Port": 5060,
  "ServerType": "string",
  "ShardID": "string",
  "Type": 0,
  "ipobject": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Group	string	false	none	none
IP	string	true	none	none
IPBits	integer(uint16)	true	none	none
Port	integer(uint16)	true	none	none
ServerType	string	false	none	none
ShardID	string	false	none	ShardID
Type	integer(uint32)	true	none	none
ipobject	string	false	none	none

{
  "data": {
    "url": "http://example.com/share/#",
    "uuid": "4141a255-d382-46ef-974e-62dc830acc8f"
  }
}

Properties

Name	Type	Required	Restrictions	Description
data	object	false	none	none
» url	string	false	none	none
» uuid	string	false	none	none

{
  "count": 0,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer(int64)	false	none	count
data	[CreateUserStruct]	false	none	the data

{
  "apply_ttl_all": true,
  "correlation_mapping": {},
  "create_date": "2019-08-24T14:15:22Z",
  "create_index": {},
  "create_table": "string",
  "fields_mapping": {},
  "fields_settings": {},
  "guid": "string",
  "hep_alias": "string",
  "hepid": 0,
  "partid": 0,
  "partition_step": 0,
  "profile": "string",
  "retention": 0,
  "schema_mapping": {},
  "schema_settings": {},
  "table_name": "string",
  "user_mapping": {},
  "version": 0
}

Properties

Name	Type	Required	Restrictions	Description
apply_ttl_all	boolean	false	none	none
correlation_mapping	JSONText	false	none	none
create_date	string(date-time)	false	none	none
create_index	JSONText	false	none	none
create_table	string	false	none	none
fields_mapping	JSONText	false	none	none
fields_settings	JSONText	false	none	none
guid	string	false	none	none
hep_alias	string	false	none	none
hepid	integer(uint16)	false	none	none
partid	integer(uint16)	false	none	none
partition_step	integer(uint16)	false	none	none
profile	string	false	none	none
retention	integer(uint16)	false	none	none
schema_mapping	JSONText	false	none	none
schema_settings	JSONText	false	none	none
table_name	string	false	none	none
user_mapping	JSONText	false	none	none
version	integer(uint64)	false	none	none

{
  "data": [
    {
      "decoded": [
        {
          "_source": {
            "_layers": {
              "eth": {
                "eth.dst": "06:3d:20:12:10:20",
                "eth.dst_tree": {
                  "eth.addr": "06:3d:20:12:10:20",
                  "eth.addr_resolved": "06:3d:20:12:10:20",
                  "eth.dst_resolved": "06:3d:20:12:10:20",
                  "eth.ig": "0",
                  "eth.lg": "1"
                },
                "eth.src": "02:5d:69:74:20:12",
                "eth.src_tree": {
                  "eth.addr": "02:5d:69:74:20:12",
                  "eth.addr_resolved": "02:5d:69:74:20:12",
                  "eth.ig": "0",
                  "eth.lg": "1",
                  "src_resolved": "02:5d:69:74:20:12"
                },
                "eth.type": "\"0x00000800\""
              },
              "frame": {
                "frame.cap_len": "1058",
                "frame.encap_type": "1",
                "frame.ignored": "0",
                "frame.interface_id": "0",
                "frame.interface_id_tree": {
                  "frame.interface_name": "-"
                },
                "frame.len": "1058",
                "frame.marked": "0",
                "frame.number": "1",
                "frame.offset_shift": "0.000000000",
                "frame.protocols": "eth:ethertype:ip:udp:sip:sdp",
                "frame.time": "Sep 30, 2021 07:06:10.950000000 UTC",
                "frame.time_delta": "0.000000000",
                "frame.time_delta_displayed": "0.000000000",
                "frame.time_epoch": "1632985570.950000000",
                "frame.time_relative": "0.000000000"
              },
              "ip": {
                "ip.checksum": "0x0000ffa5",
                "ip.checksum.status": "2",
                "ip.dsfield": "0x0000ffa5",
                "ip.dsfield_tree": {
                  "ip.dsfield_tree.dscp": "0",
                  "ip.dsfield_tree.ecn": "0"
                },
                "ip.dst": "127.0.0.1",
                "ip.dst_host": "127.0.0.1",
                "ip.flags": "0x00000000",
                "ip.flags_tree": {
                  "ip.flags_tree.df": "0",
                  "ip.flags_tree.mf": "0",
                  "ip.flags_tree.rb": "0"
                },
                "ip.frag_offset": "0",
                "ip.hdr_len": "20",
                "ip.host": "127.0.0.1",
                "ip.id": "0x00000000",
                "ip.len": "1044",
                "ip.proto": "17",
                "ip.src": "127.0.0.1",
                "ip.src_host": "127.0.0.1",
                "ip.ttl": "54",
                "ip.version": "4"
              },
              "sip": {
                "sip.Request-line": "INVITE sip:196@example.com;user=phone SIP/2.0",
                "sip.Request-line_tree": {
                  "sip.Method": "INVITE",
                  "sip.Request-line_tree": {
                    "sip.r-uri.host": "example.com",
                    "sip.r-uri.user": "196"
                  },
                  "sip.r-uri": "sip:196@example.com;user=phone",
                  "sip.resend": "0"
                },
                "sip.msg_body": {
                  "sdp.connection_info": "\"IN IP4 192.168.10.193\"",
                  "sdp.media": "audio 5004 RTP/AVP 0 8 9 18 101",
                  "sdp.media_attr": "fmtp:101 0-15",
                  "sdp.media_attr_tree": {
                    "sdp.fmtp.parameter": "0-15",
                    "sdp.media.format": "101",
                    "sdp.media_attribute.field": "fmtp"
                  },
                  "sdp.media_tree": {
                    "sdp.media.format": "DynamicRTP-Type-101",
                    "sdp.media.media": "audio",
                    "sdp.media.port": "5004",
                    "sdp.media.port_string": "5004",
                    "sdp.media.proto": "RTP/AVP"
                  },
                  "sdp.owner": "hepgenjs 8000 8000 IN IP4 192.168.10.193",
                  "sdp.owner_tree": {
                    "sdp.owner.address": "192.168.10.193",
                    "sdp.owner.address_type": "IP4",
                    "sdp.owner.network_type": "IN",
                    "sdp.owner.sessionid": "8000",
                    "sdp.owner.username": "hepgenjs",
                    "sdp.owner.version": "8000"
                  },
                  "sdp.session_name": "\"SIP Call\"",
                  "sdp.time": "\"0 0\"",
                  "sdp.time_tree": {
                    "sdp.time.start": "0",
                    "sdp.time.stop": "0"
                  },
                  "sdp.version": "0",
                  "sip.connection_info_tree": {
                    "sdp.connection_info.address": "192.168.10.193",
                    "sdp.connection_info.address_type": "IP4",
                    "sdp.connection_info.network_type": "IN"
                  }
                },
                "sip.msg_hdr": "\"Via: SIP/2.0/UDP 192.168.10.193:5064;branch=z9hG4bK923381359;rport\\r\\nFrom: <sip:hepgenjs@example.com;user=phone>;tag=415746302\\r\\nTo: <sip:196@example.com;user=phone>\\r\\nCall-ID: a6xh18@127.0.0.1\\r\\nCSeq: 440 INVITE\\r\\nContact: <sip:hepgenjs@192.168.10.193:5064;user=phone>\\r\\nMax-Forwards: 70\\r\\nUser-Agent: HEPGEN.JS@example.com\\r\\nPrivacy: none\\r\\nP-Preferred-Identity: <sip:hepgenjs@example.com;user=phone>\\r\\nSupported: replaces, path, timer, eventlist\\r\\nAllow: INVITE, ACK, OPTIONS, CANCEL, BYE, SUBSCRIBE, NOTIFY, INFO, REFER, UPDATE, MESSAGE\\r\\nContent-Type: application/sdp\\r\\nAccept: application/sdp, application/dtmf-relay\\r\\nContent-Length:   313\\r\\n\\r\\nv=0\\r\\no=hepgenjs 8000 8000 IN IP4 192.168.10.193\\r\\ns=SIP Call\\r\\nc=IN IP4 192.168.10.193\\r\\nt=0 0\\r\\nm=audio 5004 RTP/AVP 0 8 9 18 101\\r\\na=sendrecv\\r\\na=rtpmap:0 PCMU/8000\\r\\na=ptime:20\\r\\na=rtpmap:8 PCMA/8000\\r\\na=rtpmap:9 G722/8000\\r\\na=rtpmap:18 G729/8000\\r\\na=fmtp:18 annexb=no\\r\\na=rtpmap:101 telephone-event/8000\\r\\na=fmtp:101 0-15\\r\\n\\r\\n\\r\\n\"",
                "sip.msg_hdr_tree": {}
              },
              "udp": {
                "udp.checksum": "0x0000ffa5",
                "udp.checksum.status": "2",
                "udp.dstport": "5060",
                "udp.length": "1024",
                "udp.port": "5060",
                "udp.srcport": "5060",
                "udp.stream": "0"
              }
            }
          },
          "_type": "pcap_file"
        }
      ]
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
data	[object]	false	none	none
» decoded	[object]	false	none	none
»» _source	object	false	none	none
»»» _layers	object	false	none	none
»»»» eth	object	false	none	none
»»»»» eth.dst	string	false	none	none
»»»»» eth.dst_tree	object	false	none	none
»»»»»» eth.addr	string	false	none	none
»»»»»» eth.addr_resolved	string	false	none	none
»»»»»» eth.dst_resolved	string	false	none	none
»»»»»» eth.ig	string	false	none	none
»»»»»» eth.lg	string	false	none	none
»»»»» eth.src	string	false	none	none
»»»»» eth.src_tree	object	false	none	none
»»»»»» eth.addr	string	false	none	none
»»»»»» eth.addr_resolved	string	false	none	none
»»»»»» eth.ig	string	false	none	none
»»»»»» eth.lg	string	false	none	none
»»»»»» src_resolved	string	false	none	none
»»»»» eth.type	string	false	none	none
»»»» frame	object	false	none	none
»»»»» frame.cap_len	string	false	none	none
»»»»» frame.encap_type	string	false	none	none
»»»»» frame.ignored	string	false	none	none
»»»»» frame.interface_id	string	false	none	none
»»»»» frame.interface_id_tree	object	false	none	none
»»»»»» frame.interface_name	string	false	none	none
»»»»» frame.len	string	false	none	none
»»»»» frame.marked	string	false	none	none
»»»»» frame.number	string	false	none	none
»»»»» frame.offset_shift	string	false	none	none
»»»»» frame.protocols	string	false	none	none
»»»»» frame.time	string	false	none	none
»»»»» frame.time_delta	string	false	none	none
»»»»» frame.time_delta_displayed	string	false	none	none
»»»»» frame.time_epoch	string	false	none	none
»»»»» frame.time_relative	string	false	none	none
»»»» ip	object	false	none	none
»»»»» ip.checksum	string	false	none	none
»»»»» ip.checksum.status	string	false	none	none
»»»»» ip.dsfield	string	false	none	none
»»»»» ip.dsfield_tree	object	false	none	none
»»»»»» ip.dsfield_tree.dscp	string	false	none	none
»»»»»» ip.dsfield_tree.ecn	string	false	none	none
»»»»» ip.dst	string	false	none	none
»»»»» ip.dst_host	string	false	none	none
»»»»» ip.flags	string	false	none	none
»»»»» ip.flags_tree	object	false	none	none
»»»»»» ip.flags_tree.df	string	false	none	none
»»»»»» ip.flags_tree.mf	string	false	none	none
»»»»»» ip.flags_tree.rb	string	false	none	none
»»»»» ip.frag_offset	string	false	none	none
»»»»» ip.hdr_len	string	false	none	none
»»»»» ip.host	string	false	none	none
»»»»» ip.id	string	false	none	none
»»»»» ip.len	string	false	none	none
»»»»» ip.proto	string	false	none	none
»»»»» ip.src	string	false	none	none
»»»»» ip.src_host	string	false	none	none
»»»»» ip.ttl	string	false	none	none
»»»»» ip.version	string	false	none	none
»»»» sip	object	false	none	none
»»»»» sip.Request-line	string	false	none	none
»»»»» sip.Request-line_tree	object	false	none	none
»»»»»» sip.Method	string	false	none	none
»»»»»» sip.Request-line_tree	object	false	none	none
»»»»»»» sip.r-uri.host	string	false	none	none
»»»»»»» sip.r-uri.user	string	false	none	none
»»»»»» sip.r-uri	string	false	none	none
»»»»»» sip.resend	string	false	none	none
»»»»» sip.msg_body	object	false	none	none
»»»»»» sdp.connection_info	string	false	none	none
»»»»»» sdp.media	string	false	none	none
»»»»»» sdp.media_attr	string	false	none	none
»»»»»» sdp.media_attr_tree	object	false	none	none
»»»»»»» sdp.fmtp.parameter	string	false	none	none
»»»»»»» sdp.media.format	string	false	none	none
»»»»»»» sdp.media_attribute.field	string	false	none	none
»»»»»» sdp.media_tree	object	false	none	none
»»»»»»» sdp.media.format	string	false	none	none
»»»»»»» sdp.media.media	string	false	none	none
»»»»»»» sdp.media.port	string	false	none	none
»»»»»»» sdp.media.port_string	string	false	none	none
»»»»»»» sdp.media.proto	string	false	none	none
»»»»»» sdp.owner	string	false	none	none
»»»»»» sdp.owner_tree	object	false	none	none
»»»»»»» sdp.owner.address	string	false	none	none
»»»»»»» sdp.owner.address_type	string	false	none	none
»»»»»»» sdp.owner.network_type	string	false	none	none
»»»»»»» sdp.owner.sessionid	string	false	none	none
»»»»»»» sdp.owner.username	string	false	none	none
»»»»»»» sdp.owner.version	string	false	none	none
»»»»»» sdp.session_name	string	false	none	none
»»»»»» sdp.time	string	false	none	none
»»»»»» sdp.time_tree	object	false	none	none
»»»»»»» sdp.time.start	string	false	none	none
»»»»»»» sdp.time.stop	string	false	none	none
»»»»»» sdp.version	string	false	none	none
»»»»»» sip.connection_info_tree	object	false	none	none
»»»»»»» sdp.connection_info.address	string	false	none	none
»»»»»»» sdp.connection_info.address_type	string	false	none	none
»»»»»»» sdp.connection_info.network_type	string	false	none	none
»»»»» sip.msg_hdr	string	false	none	none
»»»»» sip.msg_hdr_tree	object	false	none	none
»»»» udp	object	false	none	none
»»»»» udp.checksum	string	false	none	none
»»»»» udp.checksum.status	string	false	none	none
»»»»» udp.dstport	string	false	none	none
»»»»» udp.length	string	false	none	none
»»»»» udp.port	string	false	none	none
»»»»» udp.srcport	string	false	none	none
»»»»» udp.stream	string	false	none	none
»» _type	string	false	none	none

{
  "arhive": false,
  "db_archive": "hepic_archive",
  "db_name": "hepic_data",
  "host": "148.251.238.121",
  "name": "DE7 Node",
  "node": "\"\"",
  "online": true,
  "primary": false,
  "table_prefix": "string",
  "value": "de7node"
}

Properties

Name	Type	Required	Restrictions	Description
arhive	boolean	false	none	none
db_archive	string	false	none	none
db_name	string	false	none	none
host	string	false	none	none
name	string	false	none	none
node	string	false	none	none
online	boolean	false	none	none
primary	boolean	false	none	none
table_prefix	string	false	none	none
value	string	false	none	none

{
  "count": 1,
  "data": [
    {
      "arhive": false,
      "db_archive": "hepic_archive",
      "db_name": "hepic_data",
      "host": "148.251.238.121",
      "name": "DE7 Node",
      "node": "\"\"",
      "online": true,
      "primary": false,
      "table_prefix": "string",
      "value": "de7node"
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer(int64)	false	none	none
data	[Node]	false	none	none

{
  "Arguments": [
    {}
  ],
  "CreateDate": "2019-08-24T14:15:22Z",
  "DataMaps": [
    [
      {}
    ]
  ],
  "Db": "string",
  "ManualResync": true,
  "Node": "string",
  "Query": "string",
  "Status": true,
  "Table": "string",
  "Type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Arguments	[object]	false	none	none
CreateDate	string(date-time)	false	none	none
DataMaps	[array]	false	none	none
Db	string	false	none	none
ManualResync	boolean	false	none	none
Node	string	false	none	none
Query	string	false	none	none
Status	boolean	false	none	none
Table	string	false	none	none
Type	string	false	none	none

{
  "File": {}
}

Properties

Name	Type	Required	Restrictions	Description
File	File	false	none	none

{
  "param": {
    "limit": 0,
    "metrics": [
      "string"
    ],
    "precision": 0,
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
param	object	false	none	none
» limit	integer(int64)	false	none	none
» metrics	[string]	false	none	none
» precision	integer(int64)	false	none	none
» total	boolean	false	none	none
timestamp	object	false	none	none
» from	integer(int64)	false	none	none
» to	integer(int64)	false	none	none

{
  "active": true,
  "correlation_id": "string",
  "create_date": 0,
  "date": "string",
  "direction": 0,
  "dst_ip": "string",
  "dst_port": 0,
  "filename": "string",
  "liid": 0,
  "node": "string",
  "proto": 0,
  "record_datetime": "2019-08-24T14:15:22Z",
  "sid": 0,
  "src_ip": "string",
  "src_port": 0,
  "ssrc": 0,
  "storedir": "string",
  "time_sec": 0,
  "time_usec": 0,
  "type": "string",
  "uuid": "string"
}

Properties

Name	Type	Required	Restrictions	Description
active	boolean	false	none	status
correlation_id	string	false	none	Correlation ID
create_date	integer(uint32)	true	none	none
date	string	true	none	none
direction	integer(uint8)	false	none	UINT
dst_ip	string	false	none	destination_ip
dst_port	integer(uint16)	false	none	destination_port
filename	string	false	none	filename
liid	integer(uint32)	false	none	liid
node	string	false	none	node
proto	integer(uint8)	false	none	TimeUsec
record_datetime	string(date-time)	true	none	none
sid	integer(uint32)	false	none	sid
src_ip	string	false	none	source_ip
src_port	integer(uint16)	false	none	source_port
ssrc	integer(uint32)	false	none	Ssrc
storedir	string	false	none	Storedir
time_sec	integer(uint32)	false	none	Timesec
time_usec	integer(uint32)	false	none	TimeUsec
type	string	false	none	type
uuid	string	true	none	none

{
  "active": true,
  "correlation_id": "string",
  "create_date": 0,
  "date": "string",
  "dst_ip": "string",
  "dst_port": 0,
  "filename": "string",
  "liid": 0,
  "node": "string",
  "proto": 0,
  "record_datetime": "2019-08-24T14:15:22Z",
  "sid": 0,
  "src_ip": "string",
  "src_port": 0,
  "storedir": "string",
  "time_sec": 0,
  "time_usec": 0,
  "type": "string",
  "uuid": "string"
}

Properties

Name	Type	Required	Restrictions	Description
active	boolean	false	none	status
correlation_id	string	false	none	Correlation ID
create_date	integer(uint32)	true	none	none
date	string	true	none	none
dst_ip	string	false	none	destination_ip
dst_port	integer(uint16)	false	none	destination_port
filename	string	false	none	filename
liid	integer(uint32)	false	none	liid
node	string	false	none	node
proto	integer(uint8)	false	none	TimeUsec
record_datetime	string(date-time)	true	none	none
sid	integer(uint32)	false	none	sid
src_ip	string	false	none	source_ip
src_port	integer(uint16)	false	none	source_port
storedir	string	false	none	Storedir
time_sec	integer(uint32)	false	none	Timesec
time_usec	integer(uint32)	false	none	TimeUsec
type	string	false	none	type
uuid	string	true	none	none

[
  "string"
]

Properties

None

{
  "param": {
    "limit": 0,
    "search": "string",
    "server": "string",
    "timezone": {}
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
param	object	false	none	none
» limit	integer(int64)	false	none	none
» search	string	false	none	none
» server	string	false	none	none
» timezone	object	false	none	none
timestamp	object	false	none	none
» from	integer(int64)	false	none	none
» to	integer(int64)	false	none	none

{
  "Data": [
    {
      "custom_1": "string",
      "custom_2": "{\"duration\":\"0\",\"from_user\":\"1201\",\"ruri_user\":\"102110112384797001\",status\":\"8\",\"type\":\"call\"}",
      "id": 1,
      "micro_ts": 1634081796154
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
Data	[object]	false	none	none
» custom_1	string	false	none	none
» custom_2	string	false	none	none
» id	integer(int64)	false	none	none
» micro_ts	integer(int64)	false	none	none

[
  "string"
]

Properties

None

{
  "File": {}
}

Properties

Name	Type	Required	Restrictions	Description
File	File	false	none	none

{
  "data": "verizon",
  "hep_alias": "string",
  "hepid": 0,
  "partid": 0,
  "profile": "string",
  "status": true,
  "type": "javascript / lua",
  "uuid": "string",
  "version": 0
}

Properties

Name	Type	Required	Restrictions	Description
data	string	true	none	data name
hep_alias	string	false	none	none
hepid	integer(uint16)	false	none	none
partid	integer(uint16)	false	none	none
profile	string	false	none	Profile
status	boolean	true	none	none
type	string	true	none	none
uuid	string	false	none	ShardID
version	integer(uint64)	false	none	Version

{
  "data": [
    {
      "aliasDst": "string",
      "aliasSrc": "string",
      "create_date": 0,
      "destination": 0,
      "dstHost": "string",
      "dstId": "string",
      "dstIp": "string",
      "dstPort": 0.1,
      "id": 0.1,
      "method": "string",
      "method_text": "string",
      "micro_ts": 0,
      "msg_color": "string",
      "prot": 0.1,
      "protocol": 0.1,
      "ruri_user": "string",
      "sid": "string",
      "srcHost": "string",
      "srcId": "string",
      "srcIp": "string",
      "srcPort": 0.1,
      "table": "string"
    }
  ],
  "keys": [
    "callid",
    "srcIp",
    "srcPort"
  ],
  "total": 45
}

Properties

Name	Type	Required	Restrictions	Description
data	[CallElement]	false	none	none
keys	[string]	false	none	none
total	integer(int64)	false	none	none

{
  "param": {
    "archive": false,
    "limit": 200,
    "location": {
      "group": [
        "local"
      ],
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": []
    },
    "timezone": null,
    "transaction": {},
    "whitelist": [
      "192.1698.10.20"
    ]
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Properties

Name	Type	Required	Restrictions	Description
param	object	true	none	none
» archive	boolean	false	none	this control the type of search archivetype: boolean
» limit	integer(int64)	true	none	this controls the number of records to display
» location	object	false	none	location
»» group	[string]	false	none	group of nodes to search the recordstype: arrayitems:type: string
»» node	[string]	false	none	node to search the recordstype: arrayitems:type: string
» orlogic	boolean	false	none	this control the type of search one can performtype: boolean
» search	object	true	none	this control the type of search one can performtype: string
» timezone	object	false	none	timezone settingstype: object
»» name	string	false	none	none
»» value	integer(int64)	false	none	none
» transaction	object	false	none	none
» whitelist	[string]	false	none	ips to be removed from search
timestamp	object	false	none	this control the time range for used for search
» from	integer(int64)	true	none	current timestamp in milliseconds
» to	integer(int64)	true	none	current timestamp in milliseconds

{
  "param": {
    "limit": 200,
    "location": {
      "node": [
        "local"
      ]
    },
    "orlogic": false,
    "search": {
      "60_call_h20": {
        "callid": [
          "437711663849803218062147"
        ],
        "uuid": []
      }
    },
    "timezone": null,
    "transaction": {
      "call": true,
      "registration": false,
      "rest": false
    },
    "whitelist": []
  },
  "timestamp": {
    "from": 1581793200000,
    "to": 1581879599000
  }
}

Properties

Name	Type	Required	Restrictions	Description
param	object	true	none	none
» limit	integer(int64)	true	none	this controls the number of records to display
» location	object	false	none	location
»» node	[string]	false	none	node to search the recordstype: arrayitems:type: string
» orlogic	boolean	false	none	this control the type of search one can performtype: boolean
» search	object	true	none	this control the type of search one can performtype: string
»» 60_call_h20	object	false	none	table to be search from
»»» callid	[string]	true	none	callid of the message for the search from
»»» uuid	[string]	true	none	uuid of the message
» timezone	object	false	none	timezone settingstype: object
»» name	string	false	none	none
»» value	integer(int64)	false	none	none
» transaction	object	false	none	type: object
»» call	boolean	false	none	none
»» registration	boolean	false	none	none
»» rest	boolean	false	none	none
» whitelist	[string]	false	none	ips to be removed from search
timestamp	object	false	none	this control the time range for used for search
» from	integer(int64)	true	none	current timestamp in milliseconds
» to	integer(int64)	true	none	current timestamp in milliseconds

{
  "rtcp": {
    "data": [
      {
        "captureId": "2001",
        "capturePass": "myHep",
        "correlation_id": "wvn6zg@127.0.0.1",
        "create_date": "021-10-04T19:16:22.699Z",
        "dbnode": "localnode",
        "dstIp": "127.0.0.1",
        "dstPort": 5060,
        "id": 1030,
        "node": [
          "2001",
          "localnode"
        ],
        "payloadType": 100,
        "profile": "string",
        "proto": "log",
        "protocol": 17,
        "protocolFamily": 2,
        "raw": "string",
        "sid": "wvn6zg@127.0.0.1",
        "srcIp": "127.0.0.1",
        "srcPort": 5080,
        "timeSeconds": 1633374982,
        "timeUseconds": 699000
      }
    ]
  },
  "rtp": {
    "data": [
      {
        "captureId": "2001",
        "capturePass": "myHep",
        "correlation_id": "wvn6zg@127.0.0.1",
        "create_date": "021-10-04T19:16:22.699Z",
        "dbnode": "localnode",
        "dstIp": "127.0.0.1",
        "dstPort": 5060,
        "id": 1030,
        "node": [
          "2001",
          "localnode"
        ],
        "payloadType": 100,
        "profile": "string",
        "proto": "log",
        "protocol": 17,
        "protocolFamily": 2,
        "raw": "string",
        "sid": "wvn6zg@127.0.0.1",
        "srcIp": "127.0.0.1",
        "srcPort": 5080,
        "timeSeconds": 1633374982,
        "timeUseconds": 699000
      }
    ]
  }
}

Properties

Name	Type	Required	Restrictions	Description
rtcp	SearchTransactionRtpList	false	none	none
rtp	SearchTransactionRtpList	false	none	none

{
  "Data": [
    {
      "Hostinfo": {
        "property1": {
          "alias": "string",
          "color": {
            "background": "string",
            "border": "string",
            "font": "string"
          },
          "custom_params": {
            "origin": "string",
            "team": "string"
          },
          "group": "string",
          "image": "string",
          "ip": "string",
          "ipv6": true,
          "isLinkImg": true,
          "mask": 0,
          "port": 0,
          "servertype": "string",
          "shardid": "string",
          "status": true,
          "type": 0
        },
        "property2": {
          "alias": "string",
          "color": {
            "background": "string",
            "border": "string",
            "font": "string"
          },
          "custom_params": {
            "origin": "string",
            "team": "string"
          },
          "group": "string",
          "image": "string",
          "ip": "string",
          "ipv6": true,
          "isLinkImg": true,
          "mask": 0,
          "port": 0,
          "servertype": "string",
          "shardid": "string",
          "status": true,
          "type": 0
        }
      },
      "alias": {
        "property1": "string",
        "property2": "string"
      },
      "calldata": [
        {
          "aliasDst": "string",
          "aliasSrc": "string",
          "create_date": 0,
          "destination": 0,
          "dstHost": "string",
          "dstId": "string",
          "dstIp": "string",
          "dstPort": 0.1,
          "id": 0.1,
          "method": "string",
          "method_text": "string",
          "micro_ts": 0,
          "msg_color": "string",
          "prot": 0.1,
          "protocol": 0.1,
          "ruri_user": "string",
          "sid": "string",
          "srcHost": "string",
          "srcId": "string",
          "srcIp": "string",
          "srcPort": 0.1,
          "table": "string"
        }
      ],
      "callid": [
        "string"
      ],
      "data": {
        "uac": {
          "property1": {
            "agent": "string",
            "alias": "string",
            "dns": "string",
            "image": "string"
          },
          "property2": {
            "agent": "string",
            "alias": "string",
            "dns": "string",
            "image": "string"
          }
        }
      },
      "hosts": {
        "property1": {
          "host": [
            "string"
          ],
          "position": 0
        },
        "property2": {
          "host": [
            "string"
          ],
          "position": 0
        }
      },
      "messages": [
        {
          "aliasDst": "string",
          "aliasSrc": "string",
          "callid": "string",
          "captid": 0,
          "captureId": 0,
          "capture_ip": "string",
          "correlation_id": "string",
          "create_date": 0,
          "create_ts": 0,
          "cseqm": "string",
          "cseqnum": 0,
          "data": "string",
          "dstIp": "string",
          "dstPort": 0,
          "from_domain": "string",
          "from_user": "string",
          "hepproto": 0,
          "id": 0,
          "ip_tos": 0,
          "method": "string",
          "micro_ts": 0,
          "milliTimeseconds": 0,
          "node": "string",
          "proto": 0,
          "protocol": 0,
          "pty": 0,
          "queue": 0,
          "raw": "string",
          "region_id": "string",
          "respc": 0,
          "ruri_user": "string",
          "sdp": true,
          "sid": "string",
          "srcIp": "string",
          "srcPort": 0,
          "table": "string",
          "tcpflag": 0,
          "timeSeconds": 0,
          "timeUseconds": 0,
          "to_domain": "string",
          "to_user": "string",
          "tss": 0,
          "tsu": 0,
          "uuid": "string",
          "vlan": 0
        }
      ],
      "sdp": {
        "property1": {
          "property1": {
            "audioCodec": 0,
            "destinationSipIP": "string",
            "gid": 0,
            "mediaIpAudio": "string",
            "mediaIpVideo": "string",
            "mediaPortAudio": 0,
            "mediaPortVideo": 0,
            "micro_ts": 0,
            "protocol": 0,
            "request": true,
            "sdpOrigin": "string",
            "sdpSessionID": 0,
            "sipId": 0,
            "sourceSipIP": "string",
            "type": 0,
            "videoCodec": 0
          },
          "property2": {
            "audioCodec": 0,
            "destinationSipIP": "string",
            "gid": 0,
            "mediaIpAudio": "string",
            "mediaIpVideo": "string",
            "mediaPortAudio": 0,
            "mediaPortVideo": 0,
            "micro_ts": 0,
            "protocol": 0,
            "request": true,
            "sdpOrigin": "string",
            "sdpSessionID": 0,
            "sipId": 0,
            "sourceSipIP": "string",
            "type": 0,
            "videoCodec": 0
          }
        },
        "property2": {
          "property1": {
            "audioCodec": 0,
            "destinationSipIP": "string",
            "gid": 0,
            "mediaIpAudio": "string",
            "mediaIpVideo": "string",
            "mediaPortAudio": 0,
            "mediaPortVideo": 0,
            "micro_ts": 0,
            "protocol": 0,
            "request": true,
            "sdpOrigin": "string",
            "sdpSessionID": 0,
            "sipId": 0,
            "sourceSipIP": "string",
            "type": 0,
            "videoCodec": 0
          },
          "property2": {
            "audioCodec": 0,
            "destinationSipIP": "string",
            "gid": 0,
            "mediaIpAudio": "string",
            "mediaIpVideo": "string",
            "mediaPortAudio": 0,
            "mediaPortVideo": 0,
            "micro_ts": 0,
            "protocol": 0,
            "request": true,
            "sdpOrigin": "string",
            "sdpSessionID": 0,
            "sipId": 0,
            "sourceSipIP": "string",
            "type": 0,
            "videoCodec": 0
          }
        }
      },
      "transaction": [
        {
          "Codecs": [
            {}
          ],
          "Correlations": [
            {}
          ],
          "CustomString->Key": [
            {}
          ],
          "CustomString->Value": [
            {}
          ],
          "CustomUInt->Key": [
            {}
          ],
          "CustomUInt->Value": [
            {}
          ],
          "IPs": [
            "string"
          ],
          "Methods->Key": [
            "string"
          ],
          "Methods->Value": [
            0
          ],
          "Metrics->Key": [
            "string"
          ],
          "Metrics->Value": [
            0
          ],
          "aliasDst": "string",
          "aliasSrc": "string",
          "anumber_ext": "string",
          "archive": true,
          "auth_user": "string",
          "bnumber_ext": "string",
          "callid": "string",
          "captid": 0,
          "cdr_connect": 0,
          "cdr_progress": 0,
          "cdr_ringing": 0,
          "cdr_start": 0,
          "cdr_stop": 0,
          "codia": 0,
          "contact_user": "string",
          "correlation_id": "string",
          "create_date": 0,
          "custom_1": "string",
          "custom_2": "string",
          "custom_3": "string",
          "custom_4": "string",
          "custom_5": "string",
          "custom_6": "string",
          "data": "string",
          "dest_cc": "string",
          "destcc": "string",
          "destination_ip": "string",
          "destination_port": 0,
          "destlan": 0.1,
          "destlat": 0.1,
          "did": "string",
          "diversion_user": "string",
          "duration": 0,
          "event": 0,
          "family": 0,
          "from_domain": "string",
          "from_user": "string",
          "geo_cc": "string",
          "geocc": "string",
          "geolan": 0,
          "geolat": 0,
          "ipgroup_in": "string",
          "ipgroup_out": "string",
          "jitter": 0,
          "mos": 0,
          "msg_info": "string",
          "one_way_audio": true,
          "pdd": 0,
          "pid_user": "string",
          "pl": 0,
          "proto": 0,
          "pty": 0,
          "queue": 0,
          "reason": 0,
          "region_id": "string",
          "rtp_stat_a": "string",
          "rtp_stat_b": "string",
          "ruri_user": "string",
          "sdpap": 0,
          "sdpap_b": 0,
          "sdpip": 0,
          "sdpip_b": 0,
          "sdpmedhost": "string",
          "sdpmedpr": "string",
          "sdpsid": 0,
          "sdpsver": 0,
          "sdpvp": 0,
          "sdpvp_b": 0,
          "server_type_in": "string",
          "server_type_out": "string",
          "sid": "string",
          "source_ip": "string",
          "source_port": 0,
          "sourcecc": "string",
          "sourcelan": 0.1,
          "sourcelat": 0.1,
          "srd": 0,
          "sss": 0,
          "status": 0,
          "table": "string",
          "termcode": 0,
          "termdir": 0,
          "to_domain": "string",
          "to_user": "string",
          "uas": "string",
          "update_ts": 0,
          "updcounter": 0,
          "usergroup": "string",
          "uuid": "string",
          "vlan": 0,
          "vqr_a": "string",
          "vqr_b": "string",
          "vst": 0,
          "xgroup": "string"
        }
      ]
    }
  ],
  "keys": [
    "string"
  ],
  "total": 0
}

Properties

Name	Type	Required	Restrictions	Description
Data	[object]	false	none	none
» Hostinfo	object	false	none	none
»» additionalProperties	object	false	none	none
»»» alias	string	false	none	none
»»» color	object	false	none	none
»»»» background	string	false	none	none
»»»» border	string	false	none	none
»»»» font	string	false	none	none
»»» custom_params	object	false	none	none
»»»» origin	string	false	none	none
»»»» team	string	false	none	none
»»» group	string	false	none	none
»»» image	string	false	none	none
»»» ip	string	false	none	none
»»» ipv6	boolean	false	none	none
»»» isLinkImg	boolean	false	none	none
»»» mask	integer(int64)	false	none	none
»»» port	integer(int64)	false	none	none
»»» servertype	string	false	none	none
»»» shardid	string	false	none	none
»»» status	boolean	false	none	none
»»» type	integer(int64)	false	none	none
» alias	object	false	none	none
»» additionalProperties	string	false	none	none
» calldata	[CallElement]	false	none	none
» callid	[string]	false	none	none
» data	object	false	none	none
»» uac	object	false	none	none
»»» additionalProperties	object	false	none	none
»»»» agent	string	false	none	none
»»»» alias	string	false	none	none
»»»» dns	string	false	none	none
»»»» image	string	false	none	none
» hosts	object	false	none	none
»» additionalProperties	object	false	none	none
»»» host	[string]	false	none	none
»»» position	integer(int64)	false	none	none
» messages	[object]	false	none	none
»» aliasDst	string	false	none	none
»» aliasSrc	string	false	none	none
»» callid	string	false	none	none
»» captid	integer(int64)	false	none	none
»» captureId	integer(int64)	false	none	none
»» capture_ip	string	false	none	none
»» correlation_id	string	false	none	none
»» create_date	integer(int64)	false	none	none
»» create_ts	integer(int64)	false	none	none
»» cseqm	string	false	none	none
»» cseqnum	integer(int64)	false	none	none
»» data	string	false	none	none
»» dstIp	string	false	none	none
»» dstPort	integer(int64)	false	none	none
»» from_domain	string	false	none	none
»» from_user	string	false	none	none
»» hepproto	integer(int64)	false	none	none
»» id	integer(int64)	false	none	none
»» ip_tos	integer(int64)	false	none	none
»» method	string	false	none	none
»» micro_ts	integer(int64)	false	none	none
»» milliTimeseconds	integer(int64)	false	none	none
»» node	string	false	none	none
»» proto	integer(int64)	false	none	none
»» protocol	integer(int64)	false	none	none
»» pty	integer(int64)	false	none	none
»» queue	integer(int64)	false	none	none
»» raw	string	false	none	none
»» region_id	string	false	none	none
»» respc	integer(int64)	false	none	none
»» ruri_user	string	false	none	none
»» sdp	boolean	false	none	none
»» sid	string	false	none	none
»» srcIp	string	false	none	none
»» srcPort	integer(int64)	false	none	none
»» table	string	false	none	none
»» tcpflag	integer(int64)	false	none	none
»» timeSeconds	integer(int64)	false	none	none
»» timeUseconds	integer(int64)	false	none	none
»» to_domain	string	false	none	none
»» to_user	string	false	none	none
»» tss	integer(int64)	false	none	none
»» tsu	integer(int64)	false	none	none
»» uuid	string	false	none	none
»» vlan	integer(int64)	false	none	none
» sdp	object	false	none	none
»» additionalProperties	object	false	none	none
»»» additionalProperties	object	false	none	none
»»»» audioCodec	integer(int64)	false	none	none
»»»» destinationSipIP	string	false	none	none
»»»» gid	integer(int64)	false	none	none
»»»» mediaIpAudio	string	false	none	none
»»»» mediaIpVideo	string	false	none	none
»»»» mediaPortAudio	integer(int64)	false	none	none
»»»» mediaPortVideo	integer(int64)	false	none	none
»»»» micro_ts	integer(int64)	false	none	none
»»»» protocol	integer(int64)	false	none	none
»»»» request	boolean	false	none	none
»»»» sdpOrigin	string	false	none	none
»»»» sdpSessionID	integer(int64)	false	none	none
»»»» sipId	integer(int64)	false	none	none
»»»» sourceSipIP	string	false	none	none
»»»» type	integer(int64)	false	none	none
»»»» videoCodec	integer(int64)	false	none	none
» transaction	[object]	false	none	none
»» Codecs	[object]	false	none	none
»» Correlations	[object]	false	none	none
»» CustomString->Key	[object]	false	none	none
»» CustomString->Value	[object]	false	none	none
»» CustomUInt->Key	[object]	false	none	none
»» CustomUInt->Value	[object]	false	none	none
»» IPs	[string]	false	none	none
»» Methods->Key	[string]	false	none	none
»» Methods->Value	[integer]	false	none	none
»» Metrics->Key	[string]	false	none	none
»» Metrics->Value	[integer]	false	none	none
»» aliasDst	string	false	none	none
»» aliasSrc	string	false	none	none
»» anumber_ext	string	false	none	none
»» archive	boolean	false	none	none
»» auth_user	string	false	none	none
»» bnumber_ext	string	false	none	none
»» callid	string	false	none	none
»» captid	integer(int64)	false	none	none
»» cdr_connect	integer(int64)	false	none	none
»» cdr_progress	integer(int64)	false	none	none
»» cdr_ringing	integer(int64)	false	none	none
»» cdr_start	integer(int64)	false	none	none
»» cdr_stop	integer(int64)	false	none	none
»» codia	integer(int64)	false	none	none
»» contact_user	string	false	none	none
»» correlation_id	string	false	none	none
»» create_date	integer(int64)	false	none	none
»» custom_1	string	false	none	none
»» custom_2	string	false	none	none
»» custom_3	string	false	none	none
»» custom_4	string	false	none	none
»» custom_5	string	false	none	none
»» custom_6	string	false	none	none
»» data	string	false	none	none
»» dest_cc	string	false	none	none
»» destcc	string	false	none	none
»» destination_ip	string	false	none	none
»» destination_port	integer(int64)	false	none	none
»» destlan	number(double)	false	none	none
»» destlat	number(double)	false	none	none
»» did	string	false	none	none
»» diversion_user	string	false	none	none
»» duration	integer(int64)	false	none	none
»» event	integer(int64)	false	none	none
»» family	integer(int64)	false	none	none
»» from_domain	string	false	none	none
»» from_user	string	false	none	none
»» geo_cc	string	false	none	none
»» geocc	string	false	none	none
»» geolan	integer(int64)	false	none	none
»» geolat	integer(int64)	false	none	none
»» ipgroup_in	string	false	none	none
»» ipgroup_out	string	false	none	none
»» jitter	integer(int64)	false	none	none
»» mos	integer(int64)	false	none	none
»» msg_info	string	false	none	none
»» one_way_audio	boolean	false	none	none
»» pdd	integer(int64)	false	none	none
»» pid_user	string	false	none	none
»» pl	integer(int64)	false	none	none
»» proto	integer(int64)	false	none	none
»» pty	integer(int64)	false	none	none
»» queue	integer(int64)	false	none	none
»» reason	integer(int64)	false	none	none
»» region_id	string	false	none	none
»» rtp_stat_a	string	false	none	none
»» rtp_stat_b	string	false	none	none
»» ruri_user	string	false	none	none
»» sdpap	integer(int64)	false	none	none
»» sdpap_b	integer(int64)	false	none	none
»» sdpip	integer(int64)	false	none	none
»» sdpip_b	integer(int64)	false	none	none
»» sdpmedhost	string	false	none	none
»» sdpmedpr	string	false	none	none
»» sdpsid	integer(int64)	false	none	none
»» sdpsver	integer(int64)	false	none	none
»» sdpvp	integer(int64)	false	none	none
»» sdpvp_b	integer(int64)	false	none	none
»» server_type_in	string	false	none	none
»» server_type_out	string	false	none	none
»» sid	string	false	none	none
»» source_ip	string	false	none	none
»» source_port	integer(int64)	false	none	none
»» sourcecc	string	false	none	none
»» sourcelan	number(double)	false	none	none
»» sourcelat	number(double)	false	none	none
»» srd	integer(int64)	false	none	none
»» sss	integer(int64)	false	none	none
»» status	integer(int64)	false	none	none
»» table	string	false	none	none
»» termcode	integer(int64)	false	none	none
»» termdir	integer(int64)	false	none	none
»» to_domain	string	false	none	none
»» to_user	string	false	none	none
»» uas	string	false	none	none
»» update_ts	integer(int64)	false	none	none
»» updcounter	integer(int64)	false	none	none
»» usergroup	string	false	none	none
»» uuid	string	false	none	none
»» vlan	integer(int64)	false	none	none
»» vqr_a	string	false	none	none
»» vqr_b	string	false	none	none
»» vst	integer(int64)	false	none	none
»» xgroup	string	false	none	none
keys	[string]	false	none	none
total	integer(int64)	false	none	none

{
  "captureId": "\"2001\"",
  "capturePass": "myHep",
  "correlation_id": "wvn6zg@127.0.0.1",
  "create_date": "021-10-04T19:16:22.699Z",
  "dbnode": "localnode",
  "dstIp": "127.0.0.1",
  "dstPort": 5060,
  "id": 1030,
  "node": [
    "2001",
    "localnode"
  ],
  "payloadType": 100,
  "profile": "string",
  "proto": "log",
  "protocol": 17,
  "protocolFamily": 2,
  "raw": "string",
  "sid": "wvn6zg@127.0.0.1",
  "srcIp": "127.0.0.1",
  "srcPort": 5080,
  "timeSeconds": 1633374982,
  "timeUseconds": 699000
}

Properties

Name	Type	Required	Restrictions	Description
captureId	string	false	none	none
capturePass	string	false	none	none
correlation_id	string	false	none	none
create_date	string	false	none	none
dbnode	string	false	none	none
dstIp	string	false	none	none
dstPort	number(double)	false	none	none
id	number(double)	false	none	none
node	[string]	false	none	none
payloadType	integer(int64)	false	none	none
profile	string	false	none	none
proto	string	false	none	none
protocol	integer(int64)	false	none	none
protocolFamily	integer(int64)	false	none	none
raw	string	false	none	none
sid	string	false	none	none
srcIp	string	false	none	none
srcPort	number(double)	false	none	none
timeSeconds	integer(int64)	false	none	none
timeUseconds	integer(int64)	false	none	none

{
  "captureId": "2001",
  "capturePass": "myHep",
  "correlation_id": "wvn6zg@127.0.0.1",
  "create_date": "021-10-04T19:16:22.699Z",
  "dbnode": "localnode",
  "dstIp": "127.0.0.1",
  "dstPort": 5060,
  "id": 1030,
  "node": [
    "2001",
    "localnode"
  ],
  "payloadType": 100,
  "profile": "string",
  "proto": "log",
  "protocol": 17,
  "protocolFamily": 2,
  "raw": "string",
  "sid": "wvn6zg@127.0.0.1",
  "srcIp": "127.0.0.1",
  "srcPort": 5080,
  "timeSeconds": 1633374982,
  "timeUseconds": 699000
}

Properties

Name	Type	Required	Restrictions	Description
captureId	string	false	none	none
capturePass	string	false	none	none
correlation_id	string	false	none	none
create_date	string	false	none	none
dbnode	string	false	none	none
dstIp	string	false	none	none
dstPort	number(double)	false	none	none
id	number(double)	false	none	none
node	[string]	false	none	none
payloadType	integer(int64)	false	none	none
profile	string	false	none	none
proto	string	false	none	none
protocol	integer(int64)	false	none	none
protocolFamily	integer(int64)	false	none	none
raw	string	false	none	none
sid	string	false	none	none
srcIp	string	false	none	none
srcPort	number(double)	false	none	none
timeSeconds	integer(int64)	false	none	none
timeUseconds	integer(int64)	false	none	none

{
  "data": [
    {
      "captureId": "2001",
      "capturePass": "myHep",
      "correlation_id": "wvn6zg@127.0.0.1",
      "create_date": "021-10-04T19:16:22.699Z",
      "dbnode": "localnode",
      "dstIp": "127.0.0.1",
      "dstPort": 5060,
      "id": 1030,
      "node": [
        "2001",
        "localnode"
      ],
      "payloadType": 100,
      "profile": "string",
      "proto": "log",
      "protocol": 17,
      "protocolFamily": 2,
      "raw": "string",
      "sid": "wvn6zg@127.0.0.1",
      "srcIp": "127.0.0.1",
      "srcPort": 5080,
      "timeSeconds": 1633374982,
      "timeUseconds": 699000
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
data	[SearchTransactionRtp]	false	none	none

{
  "param": {
    "bfrom": 0,
    "limit": 0,
    "precision": 0,
    "query": [
      {
        "database": "string",
        "main": "string",
        "rawquery": "string",
        "retention": "string",
        "tag": [
          "string"
        ],
        "type": [
          "string"
        ]
      }
    ],
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
param	object	false	none	none
» bfrom	integer(int64)	false	none	none
» limit	integer(int64)	false	none	none
» precision	integer(int64)	false	none	none
» query	[object]	false	none	none
»» database	string	false	none	none
»» main	string	false	none	none
»» rawquery	string	false	none	none
»» retention	string	false	none	none
»» tag	[string]	false	none	none
»» type	[string]	false	none	none
» total	boolean	false	none	none
timestamp	object	false	none	none
» from	integer(int64)	false	none	none
» to	integer(int64)	false	none	none

{
  "param": {
    "Search": {
      "database": "string"
    },
    "bfrom": 0,
    "limit": 0,
    "precision": 0,
    "total": true
  },
  "timestamp": {
    "from": 0,
    "to": 0
  }
}

Properties

Name	Type	Required	Restrictions	Description
param	object	false	none	none
» Search	object	false	none	none
»» database	string	false	none	none
» bfrom	integer(int64)	false	none	none
» limit	integer(int64)	false	none	none
» precision	integer(int64)	false	none	none
» total	boolean	false	none	none
timestamp	object	false	none	none
» from	integer(int64)	false	none	none
» to	integer(int64)	false	none	none

{
  "File": {}
}

Properties

Name	Type	Required	Restrictions	Description
File	File	false	none	none

{
  "count": 0,
  "data": {},
  "message": "string"
}

Properties

Name	Type	Required	Restrictions	Description
count	integer(int64)	true	none	count elements in data
data	JSONText	true	none	none
message	string	true	none	the message for user

{
  "active": true,
  "create_date": "2019-08-24T14:15:22Z",
  "creator_guid": "string",
  "expire_date": "2019-08-24T14:15:22Z",
  "guid": "string",
  "ip_address": "string",
  "lastusage_date": "2019-08-24T14:15:22Z",
  "limit_calls": 0,
  "name": "string",
  "usage_calls": 0,
  "user_object": {},
  "usergroup": "string",
  "version": 0
}

Properties

Name	Type	Required	Restrictions	Description
active	boolean	false	none	none
create_date	string(date-time)	false	none	none
creator_guid	string	false	none	none
expire_date	string(date-time)	false	none	none
guid	string	false	none	none
ip_address	string	false	none	none
lastusage_date	string(date-time)	false	none	none
limit_calls	integer(uint32)	false	none	none
name	string	false	none	none
usage_calls	integer(uint32)	false	none	none
user_object	JSONText	false	none	none
usergroup	string	false	none	none
version	integer(uint64)	false	none	none

{
  "callid": "string",
  "captid": 0,
  "capture_ip": "string",
  "create_ts": 0,
  "data": "string",
  "destination_ip": "string",
  "destination_port": 0,
  "event": "string",
  "guid": "string",
  "message": "string",
  "node": "string",
  "proto": 0,
  "source_ip": "string",
  "source_port": 0,
  "type": "string",
  "vlan": 0
}

Properties

Name	Type	Required	Restrictions	Description
callid	string	false	none	callid
captid	integer(uint32)	false	none	captid
capture_ip	string	false	none	capture_ip
create_ts	integer(uint64)	false	none	create_ts
data	string	false	none	data
destination_ip	string	false	none	destination_ip
destination_port	integer(uint16)	false	none	destination_port
event	string	false	none	event
guid	string	false	none	UUID
message	string	false	none	data
node	string	false	none	node
proto	integer(uint16)	false	none	proto
source_ip	string	false	none	source_ip
source_port	integer(uint16)	false	none	source_port
type	string	false	none	type
vlan	integer(uint8)	false	none	vlan

{
  "callid": "string",
  "captid": 0,
  "capture_ip": "string",
  "create_ts": 0,
  "data": "string",
  "destination_ip": "string",
  "destination_port": 0,
  "event": "string",
  "frame_protocols": "string",
  "guid": "string",
  "message": "string",
  "node": "string",
  "proto": 0,
  "raw": "string",
  "source_ip": "string",
  "source_port": 0,
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
callid	string	false	none	callid
captid	integer(uint32)	false	none	captid
capture_ip	string	false	none	capture_ip
create_ts	integer(uint64)	false	none	create_ts
data	string	false	none	data
destination_ip	string	false	none	destination_ip
destination_port	integer(uint16)	false	none	destination_port
event	string	false	none	event
frame_protocols	string	false	none	frame
guid	string	false	none	UUID
message	string	false	none	data
node	string	false	none	node
proto	integer(uint16)	false	none	proto
raw	string	false	none	data
source_ip	string	false	none	source_ip
source_port	integer(uint16)	false	none	source_port
type	string	false	none	type

{
  "callid": "string",
  "captid": 0,
  "capture_ip": "string",
  "create_ts": 0,
  "data": "string",
  "destination_ip": "string",
  "destination_port": 0,
  "event": "string",
  "guid": "string",
  "message": "string",
  "node": "string",
  "proto": 0,
  "region_id": "string",
  "source_ip": "string",
  "source_port": 0,
  "vlan": 0
}

Properties

Name	Type	Required	Restrictions	Description
callid	string	false	none	callid
captid	integer(uint32)	false	none	captid
capture_ip	string	false	none	capture_ip
create_ts	integer(uint64)	false	none	create_ts
data	string	false	none	data
destination_ip	string	false	none	destination_ip
destination_port	integer(uint16)	false	none	destination_port
event	string	false	none	event
guid	string	false	none	UUID
message	string	false	none	data
node	string	false	none	node
proto	integer(uint16)	false	none	proto
region_id	string	false	none	region_id
source_ip	string	false	none	source_ip
source_port	integer(uint16)	false	none	source_port
vlan	integer(uint8)	false	none	vlan

{
  "callid": "string",
  "captid": 0,
  "capture_ip": "string",
  "create_ts": 0,
  "data": "string",
  "destination_ip": "string",
  "destination_port": 0,
  "event": "string",
  "guid": "string",
  "message": "string",
  "node": "string",
  "proto": 0,
  "region_id": "string",
  "source_ip": "string",
  "source_port": 0,
  "vlan": 0
}

Properties

Name	Type	Required	Restrictions	Description
callid	string	false	none	callid
captid	integer(uint32)	false	none	captid
capture_ip	string	false	none	capture_ip
create_ts	integer(uint64)	false	none	create_ts
data	string	false	none	data
destination_ip	string	false	none	destination_ip
destination_port	integer(uint16)	false	none	destination_port
event	string	false	none	event
guid	string	false	none	UUID
message	string	false	none	data
node	string	false	none	node
proto	integer(uint16)	false	none	proto
region_id	string	false	none	region_id
source_ip	string	false	none	source_ip
source_port	integer(uint16)	false	none	source_port
vlan	integer(uint8)	false	none	vlan

{
  "auth_user": "string",
  "callid": "string",
  "captid": 0,
  "cdr_failed": 0,
  "cdr_start": 0,
  "cdr_stop": 0,
  "contact_user": "string",
  "correlations": [
    "string"
  ],
  "cseq": 0,
  "custom_1": "string",
  "custom_2": "string",
  "custom_3": "string",
  "custom_4": "string",
  "custom_5": "string",
  "custom_6": "string",
  "customstring_key": [
    "string"
  ],
  "customstring_value": [
    "string"
  ],
  "customuint_key": [
    "string"
  ],
  "customuint_value": [
    0
  ],
  "data": "string",
  "destination_ip": "string",
  "destination_port": 0,
  "event": 0,
  "expire_rep": 0,
  "expire_req": 0,
  "family": 0,
  "from_user": "string",
  "geo_cc": "string",
  "guid": "string",
  "ipgroup_in": "string",
  "ipgroup_out": "string",
  "ips": [
    "string"
  ],
  "methods_key": [
    "string"
  ],
  "methods_value": [
    0
  ],
  "metrics_key": [
    "string"
  ],
  "metrics_value": [
    0.1
  ],
  "realm": "string",
  "region_id": "string",
  "rrd": 0,
  "ruri_user": "string",
  "server_type_in": "string",
  "server_type_out": "string",
  "source_ip": "string",
  "source_port": 0,
  "srd": 0,
  "status": 0,
  "termcode": 0,
  "to_user": "string",
  "uas": "string",
  "update_ts": 0,
  "usergroup": "string",
  "vlan": 0,
  "xgroup": "string"
}

Properties

Name	Type	Required	Restrictions	Description
auth_user	string	false	none	auth_user
callid	string	false	none	callid
captid	integer(uint32)	false	none	captid
cdr_failed	integer(uint64)	false	none	cdr_failed
cdr_start	integer(uint64)	false	none	cdr_start
cdr_stop	integer(uint64)	false	none	cdr_stop
contact_user	string	false	none	contact_user
correlations	[string]	false	none	Correlations
cseq	integer(uint16)	false	none	cseq
custom_1	string	false	none	custom_1
custom_2	string	false	none	custom_2
custom_3	string	false	none	custom_3
custom_4	string	false	none	custom_4
custom_5	string	false	none	custom_5
custom_6	string	false	none	custom_6
customstring_key	[string]	false	none	CustomString.Key
customstring_value	[string]	false	none	CustomString.Value
customuint_key	[string]	false	none	CustomUInt.Key
customuint_value	[integer]	false	none	CustomUInt.Value
data	string	false	none	data
destination_ip	string	false	none	destination_ip
destination_port	integer(uint16)	false	none	destination_port
event	integer(uint16)	false	none	event
expire_rep	integer(uint16)	false	none	expire_rep
expire_req	integer(uint16)	false	none	expire_req
family	integer(uint8)	false	none	family
from_user	string	false	none	from_user
geo_cc	string	false	none	geo_cc
guid	string	false	none	UUID
ipgroup_in	string	false	none	ipgroup_in
ipgroup_out	string	false	none	ipgroup_out
ips	[string]	false	none	IPs
methods_key	[string]	false	none	Methods.Key
methods_value	[integer]	false	none	Methods.Value
metrics_key	[string]	false	none	Metrics.Key
metrics_value	[number]	false	none	Methods.Value
realm	string	false	none	cdr_stop
region_id	string	false	none	region_id
rrd	integer(uint16)	false	none	rrd
ruri_user	string	false	none	ruri_user
server_type_in	string	false	none	server_type_in
server_type_out	string	false	none	xgroup
source_ip	string	false	none	source_ip
source_port	integer(uint16)	false	none	source_port
srd	integer(uint16)	false	none	srd
status	integer(uint8)	false	none	status
termcode	integer(uint16)	false	none	termcode
to_user	string	false	none	to_user
uas	string	false	none	UAS
update_ts	integer(uint64)	false	none	update_ts
usergroup	string	false	none	usergroup
vlan	integer(uint8)	false	none	vlan
xgroup	string	false	none	xgroup

{
  "count": 13,
  "data": [
    {
      "department": "NOC",
      "email": "string",
      "firstname": "string",
      "guid": "string",
      "lastname": "string",
      "params": {},
      "partid": 10,
      "password": "string",
      "usergroup": "admin",
      "username": "string",
      "version": 0
    }
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer(int64)	false	none	none
data	[CreateUserStruct]	false	none	none

{
  "callid": "string",
  "captid": 0,
  "capture_ip": "string",
  "create_ts": 0,
  "data": "string",
  "destination_ip": "string",
  "destination_port": 0,
  "event": "string",
  "guid": "string",
  "message": "string",
  "mos": 0,
  "node": "string",
  "proto": 0,
  "source_ip": "string",
  "source_port": 0,
  "type": "string",
  "vlan": 0
}

Properties

Name	Type	Required	Restrictions	Description
callid	string	false	none	callid
captid	integer(uint32)	false	none	captid
capture_ip	string	false	none	capture_ip
create_ts	integer(uint64)	false	none	create_ts
data	string	false	none	data
destination_ip	string	false	none	destination_ip
destination_port	integer(uint16)	false	none	destination_port
event	string	false	none	event
guid	string	false	none	UUID
message	string	false	none	data
mos	integer(uint16)	false	none	mos
node	string	false	none	node
proto	integer(uint16)	false	none	proto
source_ip	string	false	none	source_ip
source_port	integer(uint16)	false	none	source_port
type	string	false	none	type
vlan	integer(uint8)	false	none	vlan

{
  "File": {}
}

Properties

Name	Type	Required	Restrictions	Description
File	File	false	none	none

{
  "data": "af72057b-2745-0a1b-b674-56586aadec57",
  "message": "successfully deleted user"
}

Properties

Name	Type	Required	Restrictions	Description
data	string	false	none	none
message	string	false	none	none

{
  "user": {
    "admin": true,
    "force_password": true,
    "usergroup": "string",
    "username": "string"
  }
}

Properties

Name	Type	Required	Restrictions	Description
user	object	false	none	the uuid
» admin	boolean	false	none	none
» force_password	boolean	false	none	none
» usergroup	string	false	none	none
» username	string	false	none	none

{
  "File": {}
}

Properties

Name	Type	Required	Restrictions	Description
File	File	false	none	none

{
  "File": {}
}

Properties

Name	Type	Required	Restrictions	Description
File	File	false	none	none

{
  "count": 13,
  "data": [
    "admin",
    "user"
  ]
}

Properties

Name	Type	Required	Restrictions	Description
count	integer(int64)	false	none	none
data	[string]	false	none	none

{
  "Department": "NOC",
  "Email": "string",
  "FirstName": "string",
  "LastName": "string",
  "Params": "string",
  "PartID": 0,
  "Password": "string",
  "PasswordHash": "admin",
  "UserGroup": "admin",
  "UserName": "string"
}

Properties

Name	Type	Required	Restrictions	Description
Department	string	true	none	none
Email	string	true	none	none
FirstName	string	true	none	none
LastName	string	true	none	none
Params	string	false	none	example {}
PartID	integer(uint16)	true	none	none
Password	string	true	none	none
PasswordHash	string	false	none	none
UserGroup	string	false	none	none
UserName	string	false	none	none

{
  "password": "sipcapture",
  "type": "internal",
  "username": "admin"
}

Properties

Name	Type	Required	Restrictions	Description
password	string	true	none	none
type	string	false	none	the type of the auth one would like to perform, internal/ldap
username	string	true	none	none

{
  "scope": "b9f6q23a-0bde-41ce-cd36-da3dbc17ea12",
  "token": "JWT Token",
  "user": {
    "admin": true,
    "force_password": true
  }
}

Properties

Name	Type	Required	Restrictions	Description
scope	string	false	none	the uuid
token	string	false	none	the token
user	object	false	none	none
» admin	boolean	false	none	none
» force_password	boolean	false	none	none

{
  "data": {},
  "guid": "string",
  "params": "string",
  "protocol_id": "string"
}

Properties

Name	Type	Required	Restrictions	Description
data	JSONText	false	none	none
guid	string	false	none	none
params	string	false	none	none
protocol_id	string	false	none	none

{
  "data": "af72057b-2745-0a1b-b674-56586aadec57",
  "message": "successfully created user"
}

Properties

Name	Type	Required	Restrictions	Description
data	string	true	none	data in JSON format
message	string	true	none	the message for user

{
  "data": "af72057b-2745-0a1b-b674-56586aadec57",
  "message": "successfully updated user"
}

Properties

Name	Type	Required	Restrictions	Description
data	string	false	none	none
message	string	false	none	none

{}

file is the real representation of *File.

Properties

None

ON THIS PAGE

🔻 API Documentation#

Base URLs#

Authentication#

Admin API#

ListProfiles#

tablesList#

tablesResync#

ListAdvancedSettings#

AddAdvanced#

AdvancedAgainstUUID#

updateAdvanced#

DeleteSettings#

GetAgentSearchByTypeAndUUID#

ListAgents#

UpdateAgent#

agentsSubUpdateAgentsubAgainstGUID#

DeleteAgent#

GetAgentByType#

AddAgentsub#

userLogin#

SuccessResponse#

CreateUserStruct#

CreateUser#

ListUsers#

groups#

UserFileResponse#

UpdateUserPassword#

UpdateUser#

DeleteUser#

GetRecordingData#

GetRecordingPlayDataByType#

GetRecordingInfoDataByType#

AddRtpRecordFromAgent#

ListInterceptions#

AddInterceptions#

UpdateInterceptions#

DeleteInterceptions#

GetTransactionDTMF#

GetTransactionLog#

GetTransactionQos#

GetTransaction#

SearchData#

callDecodeMessage#

callMessage#

GetTypeTransaction#

rawSearchData#

ListDashboard#

GetDashboard#

UpdateDashboard#

CreateDashboard#

DeleteDashboard#

GroupListMapping#

NodeListMapping#

ListMapping#

actionActive#

hepicapp#

hepicapplog#

picserver#

rtpagetn#

GetMessagesAsPCap#

GetMessagesAsSIPP#

GetMessagesAsText#

GetDataFromStenographer#

saveToArchive#

GetTransactionLink#

exportCallTransactionReport#

GetHepSubAgainstUUID#

AddHepSub#

UpdateHepSubAgainstUUID#

hepSubDeleteHepSubAgainstUUID#

AddHepsubsearch#

GetMessagesAsPCap#

GetMessagesAsPCapNow#

GetAllLookupIP#

ipAliasLookup#

DeleteLookupIP#

FileDownload#

IPAliasFileResponse#

UpdateLookupIP#

ListProfiles#

🔻 API Documentation

Base URLs

Authentication

Admin API

ListProfiles

tablesList

tablesResync

ListAdvancedSettings

AddAdvanced

AdvancedAgainstUUID

updateAdvanced

DeleteSettings

GetAgentSearchByTypeAndUUID

ListAgents

UpdateAgent

agentsSubUpdateAgentsubAgainstGUID

DeleteAgent

GetAgentByType

AddAgentsub

userLogin

SuccessResponse

CreateUserStruct

CreateUser

ListUsers

groups

UserFileResponse

UpdateUserPassword

UpdateUser

DeleteUser

GetRecordingData

GetRecordingPlayDataByType

GetRecordingInfoDataByType

AddRtpRecordFromAgent

ListInterceptions

AddInterceptions

UpdateInterceptions

DeleteInterceptions

GetTransactionDTMF

GetTransactionLog

GetTransactionQos

GetTransaction

SearchData

callDecodeMessage

callMessage

GetTypeTransaction

rawSearchData

ListDashboard

GetDashboard

UpdateDashboard

CreateDashboard

DeleteDashboard

GroupListMapping

NodeListMapping

ListMapping

actionActive

hepicapp

hepicapplog

picserver

rtpagetn

GetMessagesAsPCap

GetMessagesAsSIPP

GetMessagesAsText

GetDataFromStenographer

saveToArchive

GetTransactionLink

exportCallTransactionReport

GetHepSubAgainstUUID

AddHepSub

UpdateHepSubAgainstUUID

hepSubDeleteHepSubAgainstUUID

AddHepsubsearch

GetMessagesAsPCap

GetMessagesAsPCapNow

GetAllLookupIP

ipAliasLookup

DeleteLookupIP

FileDownload

IPAliasFileResponse

UpdateLookupIP

ListProfiles