API documentation
Company
Subscription
Recorder
Media
Session
Streaming
User
Contact
Authentication
Show/hide
List Operations
Expand Operations
Company
/api/v2/company
POST
/api/v2/company
Create company
Documentation
Sandbox
Parameters
Parameter
Type
Required?
Format
Description
pcompany_id
string
true
Parent company ID
name
string
true
Name of company
extref
string
false
External reference
media_lifetime
integer
false
Set to automatically delete media (lifetime in days)
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/company/{company_id}
DELETE
/api/v2/company/{company_id}
Delete company
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
company_id
string
Company ID
Status Codes
Status Code
Description
204
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
GET
/api/v2/company/{company_id}
Get company
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
company_id
string
Company ID
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
PATCH
/api/v2/company/{company_id}
Update company
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
company_id
string
Company ID
Parameters
Parameter
Type
Required?
Format
Description
pcompany_id
string
false
Parent company ID
name
string
false
Name of company
extref
string
false
External reference
media_lifetime
integer
false
Set to automatically delete media (lifetime in days)
Status Codes
Status Code
Description
204
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
PUT
/api/v2/company/{company_id}
Update company
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
company_id
string
Company ID
Parameters
Parameter
Type
Required?
Format
Description
name
string
true
Name of company
extref
string
false
External reference
media_lifetime
integer
false
Set to automatically delete media (lifetime in days)
Status Codes
Status Code
Description
204
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/company/{company_id}/trialrestart
POST
/api/v2/company/{company_id}/trialrestart
Restart company trial period
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
company_id
string
Company ID
Status Codes
Status Code
Description
204
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/company/{company_id}/billingdata
GET
/api/v2/company/{company_id}/billingdata
Get company billing data
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
company_id
string
Company ID
Parameters
Parameter
Type
Required?
Format
Description
year
integer
false
Year
month
integer
false
Month
format
string
false
Output format: json (default), html, pdf
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/company/{company_id}/childlist
GET
/api/v2/company/{company_id}/childlist
Get child companies
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
company_id
string
Company ID
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/company/{company_id}/parentlist
GET
/api/v2/company/{company_id}/parentlist
Get parent companies
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
company_id
string
Company ID
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/company/{company_id}/recorderlist
GET
/api/v2/company/{company_id}/recorderlist
Get company recorders
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
company_id
string
Company ID
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/company/{company_id}/recordinglog
GET
/api/v2/company/{company_id}/recordinglog
Get company recording log
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
company_id
string
Company ID
Parameters
Parameter
Type
Required?
Format
Description
from
date
false
From date
limit
integer
false
Maximum number of records
offset
integer
false
Offset
accumulate
string
false
Accumulate recording seconds by 'month' or 'recorder-month'
sub
boolean
false
Include log entries from sub companies
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/company/{company_id}/storagelog
GET
/api/v2/company/{company_id}/storagelog
Get company storage log
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
company_id
string
Company ID
Parameters
Parameter
Type
Required?
Format
Description
from
integer
false
From year
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/company/{company_id}/streamlog
GET
/api/v2/company/{company_id}/streamlog
Get company streaming log
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
company_id
string
Company ID
Parameters
Parameter
Type
Required?
Format
Description
from
date
false
From date
limit
integer
false
Maximum number of records
offset
integer
false
Offset
accumulate
string
false
Accumulate streaming seconds by 'month' or 'recorder-month'
sub
boolean
false
Include log entries from sub companies
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/company/{company_id}/subscriptionlist
GET
/api/v2/company/{company_id}/subscriptionlist
Get company subscriptions
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
company_id
string
Company ID
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/company/{company_id}/userlist
GET
/api/v2/company/{company_id}/userlist
Get company users
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
company_id
string
Company ID
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/companylist
GET
/api/v2/companylist
Search companies
Documentation
Sandbox
Parameters
Parameter
Type
Required?
Format
Description
search
string
false
Search by name
limit
integer
false
Maximum number of records
offset
integer
false
Offset
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
500
Internal server error
503
Service Unavailable
Input
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
Show/hide
List Operations
Expand Operations
Subscription
/api/v2/productlist
GET
/api/v2/productlist
Get available subscriber products
Documentation
Sandbox
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/subscription
POST
/api/v2/subscription
Create subscription
Documentation
Sandbox
Parameters
Parameter
Type
Required?
Format
Description
company_id
string
true
Company ID
product_id
string
true
Product ID
start
date
true
Start date (format: YYYY-MM-01)
end
date
false
End date (format (YYYY-MM-01)
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/subscription/{subscription_id}
GET
/api/v2/subscription/{subscription_id}
Get subscription
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
subscription_id
string
Subscription ID
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/subscription/{subscription_id}/cancel
PATCH
/api/v2/subscription/{subscription_id}/cancel
Cancel subscription
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
subscription_id
string
Subscription ID
Status Codes
Status Code
Description
204
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
Show/hide
List Operations
Expand Operations
Recorder
/api/v2/videolayoutlist
GET
/api/v2/videolayoutlist
Get available recorder video layouts
Documentation
Sandbox
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/recorder
POST
/api/v2/recorder
Create recorder
Documentation
Sandbox
Parameters
Parameter
Type
Required?
Format
Description
pop_id
string
true
Recorder location (ash, osl)
company_id
string
true
Owner company ID
storage_id
string
false
Storage type (local (default), ftp)
videolayout_id
string
false
Video layout (default STD)
user_id
string
false
If set, assign this recorder to user
production
boolean
false
Set for non-trial recorders (default false)
media_lifetime
integer
false
Set to automatically delete media (lifetime in days)
enabled
boolean
false
Recorder enabled (default true)
uri
string
true
SIP URI of recorder
registrar
string
false
SIP registrar
proxy
string
false
SIP proxy
username
string
false
SIP username
password
string
false
SIP password
name
string
true
Name of recorder
bfcp
boolean
false
Set to enable BFCP/duo-video (defult false)
storage_username
string
false
External storage username
storage_password
string
false
External storage password
storage_url
string
false
External storage URL
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/recorder/{recorder_id}
DELETE
/api/v2/recorder/{recorder_id}
Delete recorder
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
recorder_id
string
Recorder ID
Status Codes
Status Code
Description
204
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
GET
/api/v2/recorder/{recorder_id}
Get recorder
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
recorder_id
string
Recorder ID
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
PATCH
/api/v2/recorder/{recorder_id}
Update recorder
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
recorder_id
string
Recorder ID
Parameters
Parameter
Type
Required?
Format
Description
company_id
string
false
Owner company ID
videolayout_id
string
false
Video layout
stream_id
string
false
Default Stream ID
production
boolean
false
Set for non-trial recorders (default false)
media_lifetime
integer
false
Set to automatically delete media (lifetime in days)
enabled
boolean
false
Recorder enabled (default true)
uri
string
false
SIP URI of recorder
registrar
string
false
SIP registrar
proxy
string
false
SIP proxy
username
string
false
SIP username
password
string
false
SIP password
name
string
false
Name of recorder
bfcp
boolean
false
Set to enable BFCP/duo-video (defult false)
storage_username
string
false
External storage username
storage_password
string
false
External storage password
storage_url
string
false
External storage URL
Status Codes
Status Code
Description
204
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
PUT
/api/v2/recorder/{recorder_id}
Update recorder
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
recorder_id
string
Recorder ID
Parameters
Parameter
Type
Required?
Format
Description
company_id
string
true
Owner company ID
videolayout_id
string
false
Video layout
stream_id
string
false
Default Stream ID
production
boolean
false
Set for non-trial recorders (default false)
media_lifetime
integer
false
Set to automatically delete media (lifetime in days)
enabled
boolean
false
Recorder enabled (default true)
uri
string
true
SIP URI of recorder
registrar
string
false
SIP registrar
proxy
string
false
SIP proxy
username
string
false
SIP username
password
string
false
SIP password
name
string
true
Name of recorder
bfcp
boolean
false
Set to enable BFCP/duo-video (defult false)
storage_username
string
false
External storage username
storage_password
string
false
External storage password
storage_url
string
false
External storage URL
Status Codes
Status Code
Description
204
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/recorderlist
GET
/api/v2/recorderlist
Search recorders
Documentation
Sandbox
Parameters
Parameter
Type
Required?
Format
Description
search
string
false
Search by recorder name
limit
integer
false
Maximum number of records
offset
integer
false
Offset
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
500
Internal server error
503
Service Unavailable
Input
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
Show/hide
List Operations
Expand Operations
Media
/api/v2/media
GET
/api/v2/media
Get recorded media
Documentation
Sandbox
Parameters
Parameter
Type
Required?
Format
Description
secid
string
true
Shareable, secure identifier
key
string
false
Password needed to access shared media
type
string
false
Media type: meta (default), video or image
mode
string
false
Fetch mode: play (default) or download
name
string
false
Download filename (optional)
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/media/{media_id}
DELETE
/api/v2/media/{media_id}
Delete recorded media
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
media_id
string
Media ID
Status Codes
Status Code
Description
204
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
GET
/api/v2/media/{media_id}
Get recorded media
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
media_id
string
Media ID
Parameters
Parameter
Type
Required?
Format
Description
type
string
false
Media type: meta (default), video or image
mode
string
false
Fetch mode: play (default) or download
name
string
false
Download filename (optional)
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
PATCH
/api/v2/media/{media_id}
Modify recorded media
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
media_id
string
Media ID
Parameters
Parameter
Type
Required?
Format
Description
comment
string
false
Comment
tags
json
false
Array of tags
participants
json
false
Array of participants
description
string
false
Description
Status Codes
Status Code
Description
204
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/media/{media_id}/cut
POST
/api/v2/media/{media_id}/cut
Trim recorded media
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
media_id
string
Media ID
Parameters
Parameter
Type
Required?
Format
Description
start
string
true
Cut start timestamp
duration
string
true
Cut duration (relative to start timestamp)
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/media/{media_id}/share
POST
/api/v2/media/{media_id}/share
Create shareable media link
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
media_id
string
Media ID
Parameters
Parameter
Type
Required?
Format
Description
expires
integer
false
Expires Unix timestamp of shareable link
lifetime
integer
false
Lifetime of shareable link in seconds (default 1 week)
key
string
false
Password needed to open shareable link
mailto
string
false
Recipient address for e-mail with shareable link
downloadable
boolean
false
Enable downloadable media link in e-mail
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/recorder/{recorder_id}/medialist
GET
/api/v2/recorder/{recorder_id}/medialist
Get list of recorded media
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
recorder_id
string
Recorder ID
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
Show/hide
List Operations
Expand Operations
Session
/api/v2/recorder/{recorder_id}/session
POST
/api/v2/recorder/{recorder_id}/session
Start recording session
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
recorder_id
string
Recorder ID
Parameters
Parameter
Type
Required?
Format
Description
uri
string
true
SIP URI to dial
stream_id
string
false
Stream ID for real-time streaming (optional)
dtmf
string
false
DTMF pin code (optional)
dtmf_delay
integer
false
Delay in seconds before sending DTMF pin code
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/recorder/{recorder_id}/session/{session_id}
DELETE
/api/v2/recorder/{recorder_id}/session/{session_id}
Stop recording session
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
recorder_id
string
Recorder ID
session_id
string
Session ID
Status Codes
Status Code
Description
204
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
PATCH
/api/v2/recorder/{recorder_id}/session/{session_id}
Modify recording session
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
recorder_id
string
Recorder ID
session_id
string
Session ID
Parameters
Parameter
Type
Required?
Format
Description
pause
boolean
false
True to pause session, false to resume
Status Codes
Status Code
Description
204
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/recorder/{recorder_id}/sessionstatus
GET
/api/v2/recorder/{recorder_id}/sessionstatus
Get recorder session status
Documentation
Sandbox
Documentation
Get list of active recorder sessions and most recent timestamp of recorded media.
Requirements
Name
Requirement
Type
Description
recorder_id
string
Recorder ID
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
Show/hide
List Operations
Expand Operations
Streaming
/api/v2/recorder/{recorder_id}/stream
POST
/api/v2/recorder/{recorder_id}/stream
Create recorder stream
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
recorder_id
string
Recorder ID
Parameters
Parameter
Type
Required?
Format
Description
title
string
true
Stream title
uri
string
false
RTMP URI (only set for external streaming)
default
boolean
false
Set as default stream on recorder
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/recorder/stream
GET
/api/v2/recorder/stream
Get recorder stream
Documentation
Sandbox
Parameters
Parameter
Type
Required?
Format
Description
secid
string
true
Shareable, secure identifier
key
string
false
Password needed to access shared stream
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/recorder/stream/{stream_id}
DELETE
/api/v2/recorder/stream/{stream_id}
Delete recorder stream
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
stream_id
string
Stream ID
Status Codes
Status Code
Description
204
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
GET
/api/v2/recorder/stream/{stream_id}
Get recorder stream
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
stream_id
string
Stream ID
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
PATCH
/api/v2/recorder/stream/{stream_id}
Modify recorder stream
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
stream_id
string
Stream ID
Parameters
Parameter
Type
Required?
Format
Description
title
string
false
Stream title
uri
string
false
RTMP URI (only set for external streaming)
default
boolean
false
Set as default stream on recorder
Status Codes
Status Code
Description
204
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/recorder/stream/{stream_id}/log
GET
/api/v2/recorder/stream/{stream_id}/log
Get stream viewer log
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
stream_id
string
Stream ID
Parameters
Parameter
Type
Required?
Format
Description
from
date
false
From date
limit
integer
false
Maximum number of records
offset
integer
false
Offset
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/recorder/stream/{stream_id}/status
GET
/api/v2/recorder/stream/{stream_id}/status
Get stream viewer status
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
stream_id
string
Stream ID
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/recorder/stream/{stream_id}/share
POST
/api/v2/recorder/stream/{stream_id}/share
Create shareable stream link
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
stream_id
string
Stream ID
Parameters
Parameter
Type
Required?
Format
Description
expires
integer
false
Expires Unix timestamp of shareable link
lifetime
integer
false
Lifetime of shareable link in seconds (default 1 week)
key
string
false
Password needed to open shareable link
mailto
string
false
Recipient address for e-mail with shareable link
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/recorder/{recorder_id}/streamlist
GET
/api/v2/recorder/{recorder_id}/streamlist
Get recorder streams
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
recorder_id
string
Recorder ID
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
Show/hide
List Operations
Expand Operations
User
/api/v2/user
GET
/api/v2/user
Get authenticated user
Documentation
Sandbox
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
POST
/api/v2/user
Create user
Documentation
Sandbox
Parameters
Parameter
Type
Required?
Format
Description
company_id
string
true
User's company id
recorder_id
string
false
User's recorder id
fname
string
true
First name
lname
string
true
Last name
email
string
true
Email
password
string
true
Password
enabled
boolean
false
Set if user is enabled (default true)
streaming
boolean
false
Streaming allowed
roles
json
false
Array of user roles. Supported: ROLE_USER, ROLE_READ_ADMIN, ROLE_ADMIN, ROLE_SUPER_ADMIN, ROLE_SUBSCRIPTION. Default: ROLE_USER. Example input: '["ROLE_USER", "ROLE_ADMIN"]'
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/user/{user_id}
DELETE
/api/v2/user/{user_id}
Delete user
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
user_id
string
User ID
Status Codes
Status Code
Description
204
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
GET
/api/v2/user/{user_id}
Get user
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
user_id
string
User ID
Status Codes
Status Code
Description
200
Successful
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
PATCH
/api/v2/user/{user_id}
Update user
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
user_id
string
User ID
Parameters
Parameter
Type
Required?
Format
Description
company_id
string
false
User's company id
recorder_id
string
false
User's recorder id
fname
string
false
First name
lname
string
false
Last name
email
string
false
Email
password
string
false
Password
enabled
boolean
false
Set if user is enabled (defult false)
streaming
boolean
false
Streaming allowed
roles
json
false
Array of user roles
Status Codes
Status Code
Description
204
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
PUT
/api/v2/user/{user_id}
Update user
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
user_id
string
User ID
Parameters
Parameter
Type
Required?
Format
Description
company_id
string
true
User's company id
recorder_id
string
false
User's recorder id
fname
string
true
First name
lname
string
true
Last name
email
string
true
Email
password
string
false
Password
enabled
boolean
false
Set if user is enabled (defult false)
streaming
boolean
false
Streaming allowed
roles
json
false
Array of user roles
Status Codes
Status Code
Description
204
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/user/forgotpassword
POST
/api/v2/user/forgotpassword
Send email with reset password link
Documentation
Sandbox
Parameters
Parameter
Type
Required?
Format
Description
email
string
true
User email
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
500
Internal server error
503
Service Unavailable
Input
Parameters
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/user/resetpassword
POST
/api/v2/user/resetpassword
Reset user password
Documentation
Sandbox
Parameters
Parameter
Type
Required?
Format
Description
token
string
true
Token from the reset email
password
string
true
New password
conf_password
string
true
Confirmation password
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
500
Internal server error
503
Service Unavailable
Input
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/userlist
GET
/api/v2/userlist
Search users
Documentation
Sandbox
Parameters
Parameter
Type
Required?
Format
Description
search
string
false
Search by first name or last name or email
limit
integer
false
Maximum number of records
offset
integer
false
Offset
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
500
Internal server error
503
Service Unavailable
Input
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
Show/hide
List Operations
Expand Operations
Contact
/api/v2/user/{user_id}/contact/{uri}
PATCH
/api/v2/user/{user_id}/contact/{uri}
Update contact
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
user_id
string
User ID
uri
string
Contact uri
Parameters
Parameter
Type
Required?
Format
Description
name
string
false
Contact name
favorite
boolean
false
Set contact as favorite (default false)
dtmf
string
false
DTMF pin code
dtmf_delay
integer
false
Delay in seconds before sending DTMF
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
POST
/api/v2/user/{user_id}/contact/{uri}
Create or update contact
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
user_id
string
User ID
uri
string
Contact uri
Parameters
Parameter
Type
Required?
Format
Description
name
string
false
Contact name
favorite
boolean
false
Set contact as favorite (default false)
dtmf
string
false
DTMF pin code
dtmf_delay
integer
false
Delay in seconds before sending DTMF
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
/api/v2/user/{user_id}/contactlist
GET
/api/v2/user/{user_id}/contactlist
Search contacts
Documentation
Sandbox
Requirements
Name
Requirement
Type
Description
user_id
string
User ID
Parameters
Parameter
Type
Required?
Format
Description
search
string
false
Search by url or name
limit
integer
false
Maximum number of records
offset
integer
false
Offset
favorite
boolean
false
If true - return favorites only
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Requirements
=
-
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line
Show/hide
List Operations
Expand Operations
Authentication
/api/v2/token
POST
/api/v2/token
Create bearer based authentication token
Documentation
Sandbox
Parameters
Parameter
Type
Required?
Format
Description
username
string
true
Authentication username (email address)
expires
string
true
Expires in UNIX timestamp seconds, typical value: now + 3600
signature
string
true
signature = HmacSHA256(username + expires, key); key = MD5({username}:this-is-realm:{password});
Status Codes
Status Code
Description
200
Successful
400
Required parameters are not set correctly
401
User is not authenticated
403
Access denied
404
Resource not found
500
Internal server error
503
Service Unavailable
Input
Parameters
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
=
Type
String
Boolean
File
Textarea
-
New parameter
Headers
=
-
New header
Content
=
Set header
Replaces header if set
Request URL
Request body
Response Headers
[
Expand
]
[
Profiler
]
Response Body
[
Raw
]
Curl Command Line