TrueConf Server API

Integration with TrueConf Server 4.3.9+ — Documentation

Authorization

Authorization | Generate Token

Generate Authorization Token. For more Information see bshaffer.github.io.

post 
/oauth2/v1/token

Permission: users 

curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/oauth2/v1/token' \
    --data '{"grant_type":"password", "username": "user", "password":"123", "client_id": "trueconf_server_users"}'

Header

Field Type Description
Content-Type String

application/json

Parameter

Field Type Description
grant_type String

Authorization type.

Allowed values: "password", "refresh_token", "client_credentials", "authorization_code"

client_id optional String

Authorization client. Required for "password" and "client_credentials" grant types.
username optional String

User name. Required for "password" grant type.
password optional String

User password. Required for "password" grant type.
refresh_token optional String

Refresh token. Required for "refresh_token" grant type.
client_secret optional String

Client secret. Required for "client_credentials" grant type.
code optional String

Authorization code. Required for "authorization_code" grant type.

 
HTTP/1.1 200 OK
{
    "access_token": "f7dee810d964f02d54d7930d69e80c561d2a55b7",
    "expires_in": 604800,
    "token_type": "Bearer",
    "scope": "conferences conferences:read conferences:write conferences.invitations conferences.participants conferences.participants:read conferences.participants:write groups groups:read groups:write users users:read users:write users.avatar:read users.avatar:write users.addressbook users.addressbook:read users.addressbook:write templates.conferences:read templates.conferences:write logs.calls:read logs.calls.participants:read logs.calls.invites:read conferences.records conferences.records:read conferences.sessions:read conferences.sessions.participants:read conferences.sessions.podiums.participants:read conferences.sessions.podiums.participants:write",
    "refresh_token": "bb72bf7717be3414a0056f4aaf12e809dc037958"
}

Errors

Name Type Description
invalidRequest Object

Invalid request.
invalidCredentials Object

Invalid credentials.
userIsBanned Object

User is banned.

Authorization | Generate Token

Generate Authorization Token. For more Information see bshaffer.github.io.

post 
/oauth2/v1/token

Permission: users 

curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/oauth2/v1/token' \
    --data '{"grant_type":"password", "username": "user", "password":"123", "client_id": "trueconf_server_users"}'

Header

Field Type Description
Content-Type String

application/json

Parameter

Field Type Description
grant_type String

Authorization type.

Allowed values: "password", "refresh_token", "client_credentials", "authorization_code"

client_id optional String

Authorization client. Required for "password" and "client_credentials" grant types.
username optional String

User name. Required for "password" grant type.
password optional String

User password. Required for "password" grant type.
refresh_token optional String

Refresh token. Required for "refresh_token" grant type.
client_secret optional String

Client secret. Required for "client_credentials" grant type.
code optional String

Authorization code. Required for "authorization_code" grant type.

 
HTTP/1.1 200 OK
{
    "access_token": "f7dee810d964f02d54d7930d69e80c561d2a55b7",
    "expires_in": 604800,
    "token_type": "Bearer",
    "scope": "conferences conferences:read conferences:write conferences.invitations conferences.participants conferences.participants:read conferences.participants:write groups groups:read groups:write users users:read users:write users.avatar:read users.avatar:write users.addressbook users.addressbook:read users.addressbook:write templates.conferences:read templates.conferences:write logs.calls:read logs.calls.participants:read logs.calls.invites:read conferences.records conferences.records:read conferences.sessions:read conferences.sessions.participants:read conferences.sessions.podiums.participants:read conferences.sessions.podiums.participants:write",
    "refresh_token": "bb72bf7717be3414a0056f4aaf12e809dc037958"
}

Errors

Name Type Description
invalidRequest Object

Invalid request.
invalidCredentials Object

Invalid credentials.
userIsBanned Object

User is banned.

Authorization | Generate Token

Generate Authorization Token. For more Information see bshaffer.github.io.

post 
/oauth2/v1/token

Permission: users 

curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/oauth2/v1/token' \
    --data '{"grant_type":"password", "username": "user", "password":"123", "client_id": "trueconf_server_users"}'

Header

Field Type Description
Content-Type String

application/json

Parameter

Field Type Description
grant_type String

Authorization type.

Allowed values: "password", "refresh_token", "client_credentials", "authorization_code"

client_id optional String

Authorization client. Required for "password" and "client_credentials" grant types.
username optional String

User name. Required for "password" grant type.
password optional String

User password. Required for "password" grant type.
refresh_token optional String

Refresh token. Required for "refresh_token" grant type.
client_secret optional String

Client secret. Required for "client_credentials" grant type.
code optional String

Authorization code. Required for "authorization_code" grant type.

 
HTTP/1.1 200 OK
{
    "access_token": "f7dee810d964f02d54d7930d69e80c561d2a55b7",
    "expires_in": 604800,
    "token_type": "Bearer",
    "scope": "conferences conferences:read conferences:write conferences.invitations conferences.participants conferences.participants:read conferences.participants:write groups groups:read groups:write users users:read users:write users.avatar:read users.avatar:write users.addressbook users.addressbook:read users.addressbook:write templates.conferences:read templates.conferences:write logs.calls:read logs.calls.participants:read logs.calls.invites:read conferences.records conferences.records:read conferences.sessions:read conferences.sessions.participants:read conferences.sessions.podiums.participants:read conferences.sessions.podiums.participants:write",
    "refresh_token": "bb72bf7717be3414a0056f4aaf12e809dc037958"
}

Errors

Name Type Description
invalidRequest Object

Invalid request.
invalidCredentials Object

Invalid credentials.
userIsBanned Object

User is banned.

Authorization | Generate Token

Generate Authorization Token. The lifetime of the access token is 1 hour. The refresh token lifetime is 1 week. For more Information see bshaffer.github.io.

post 
/oauth2/v1/token

Permission: users 

curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/oauth2/v1/token' \
    --data '{"grant_type":"password", "username": "user", "password":"123", "client_id": "trueconf_server_users"}'

Header

Field Type Description
Content-Type String

application/json

Parameter

Field Type Description
grant_type String

Authorization type.

Allowed values: "password", "refresh_token", "client_credentials", "authorization_code"

client_id optional String

Authorization client. Required for "password" and "client_credentials" grant types.
username optional String

User name. Required for "password" grant type.
password optional String

User password. Required for "password" grant type.
refresh_token optional String

Refresh token. Required for "refresh_token" grant type.
client_secret optional String

Client secret. Required for "client_credentials" grant type.
code optional String

Authorization code. Required for "authorization_code" grant type.

 
HTTP/1.1 200 OK
{
    "access_token": "f7dee810d964f02d54d7930d69e80c561d2a55b7",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "conferences conferences:read conferences:write conferences.invitations conferences.participants conferences.participants:read conferences.participants:write groups groups:read groups:write users users:read users:write users.avatar:read users.avatar:write users.addressbook users.addressbook:read users.addressbook:write templates.conferences:read templates.conferences:write logs.calls:read logs.calls.participants:read logs.calls.invites:read conferences.records conferences.records:read conferences.sessions:read conferences.sessions.participants:read conferences.sessions.podiums.participants:read conferences.sessions.podiums.participants:write",
    "refresh_token": "bb72bf7717be3414a0056f4aaf12e809dc037958"
}

Errors

Name Type Description
invalidRequest Object

Invalid request.
invalidCredentials Object

Invalid credentials.
userIsBanned Object

User is banned.

Authorization | Generate Token

Generate Authorization Token. The lifetime of the access token is 1 hour. The refresh token lifetime is 1 week. For more Information see bshaffer.github.io.

post 
/oauth2/v1/token

Permission: users 

curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/oauth2/v1/token' \
    --data '{"grant_type":"password", "username": "user", "password":"123", "client_id": "trueconf_server_users"}'

Header

Field Type Description
Content-Type String

application/json

Parameter

Field Type Description
grant_type String

Authorization type.

Allowed values: "password", "refresh_token", "client_credentials", "authorization_code"

client_id optional String

Authorization client. Required for "password" and "client_credentials" grant types.
username optional String

User name. Required for "password" grant type.
password optional String

User password. Required for "password" grant type.
refresh_token optional String

Refresh token. Required for "refresh_token" grant type.
client_secret optional String

Client secret. Required for "client_credentials" grant type.
code optional String

Authorization code. Required for "authorization_code" grant type.

 
HTTP/1.1 200 OK
{
    "access_token": "f7dee810d964f02d54d7930d69e80c561d2a55b7",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "conferences conferences:read conferences:write conferences.invitations conferences.participants conferences.participants:read conferences.participants:write groups groups:read groups:write users users:read users:write users.avatar:read users.avatar:write users.addressbook users.addressbook:read users.addressbook:write templates.conferences:read templates.conferences:write logs.calls:read logs.calls.participants:read logs.calls.invites:read conferences.records conferences.records:read conferences.sessions:read conferences.sessions.participants:read conferences.sessions.podiums.participants:read conferences.sessions.podiums.participants:write",
    "refresh_token": "bb72bf7717be3414a0056f4aaf12e809dc037958"
}

Errors

Name Type Description
invalidRequest Object

Invalid request.
invalidCredentials Object

Invalid credentials.
userIsBanned Object

User is banned.

Authorization | Generate Token

Generate Authorization Token. The lifetime of the access token is 1 hour. The refresh token lifetime is 1 week. For more Information see bshaffer.github.io.

post 
/oauth2/v1/token

Permission: users 

curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/oauth2/v1/token' \
    --data '{"grant_type":"password", "username": "user", "password":"123", "client_id": "trueconf_server_users"}'

Header

Field Type Description
Content-Type String

application/json

Parameter

Field Type Description
grant_type String

Authorization type.

Allowed values: "password", "refresh_token", "client_credentials", "authorization_code"

client_id optional String

Authorization client. Required for "password" and "client_credentials" grant types.
username optional String

User name. Required for "password" grant type.
password optional String

User password. Required for "password" grant type.
refresh_token optional String

Refresh token. Required for "refresh_token" grant type.
client_secret optional String

Client secret. Required for "client_credentials" grant type.
code optional String

Authorization code. Required for "authorization_code" grant type.

 
HTTP/1.1 200 OK
{
    "access_token": "f7dee810d964f02d54d7930d69e80c561d2a55b7",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "conferences conferences:read conferences:write conferences.invitations conferences.participants conferences.participants:read conferences.participants:write groups groups:read groups:write users users:read users:write users.avatar:read users.avatar:write users.addressbook users.addressbook:read users.addressbook:write templates.conferences:read templates.conferences:write logs.calls:read logs.calls.participants:read logs.calls.invites:read conferences.records conferences.records:read conferences.sessions:read conferences.sessions.participants:read conferences.sessions.podiums.participants:read conferences.sessions.podiums.participants:write",
    "refresh_token": "bb72bf7717be3414a0056f4aaf12e809dc037958"
}

Errors

Name Type Description
invalidRequest Object

Invalid request.
invalidCredentials Object

Invalid credentials.
userIsBanned Object

User is banned.

Authorization | Generate Token

Generate Authorization Token. The lifetime of the access token is 1 hour. The refresh token lifetime is 1 week. For more Information see bshaffer.github.io.

post 
/oauth2/v1/token

Permission: users 

curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/oauth2/v1/token' \
    --data '{"grant_type":"password", "username": "user", "password":"123", "client_id": "trueconf_server_users"}'

Header

Field Type Description
Content-Type String

application/json

Parameter

Field Type Description
grant_type String

Authorization type.

Allowed values: "password", "refresh_token", "client_credentials", "authorization_code"

client_id optional String

Authorization client. Required for "password" and "client_credentials" grant types.
username optional String

User name. Required for "password" grant type.
password optional String

User password. Required for "password" grant type.
refresh_token optional String

Refresh token. Required for "refresh_token" grant type.
client_secret optional String

Client secret. Required for "client_credentials" grant type.
code optional String

Authorization code. Required for "authorization_code" grant type.

 
HTTP/1.1 200 OK
{
    "access_token": "f7dee810d964f02d54d7930d69e80c561d2a55b7",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "conferences conferences:read conferences:write conferences.invitations conferences.participants conferences.participants:read conferences.participants:write groups groups:read groups:write users users:read users:write users.avatar:read users.avatar:write users.addressbook users.addressbook:read users.addressbook:write templates.conferences:read templates.conferences:write logs.calls:read logs.calls.participants:read logs.calls.invites:read conferences.records conferences.records:read conferences.sessions:read conferences.sessions.participants:read conferences.sessions.podiums.participants:read conferences.sessions.podiums.participants:write",
    "refresh_token": "bb72bf7717be3414a0056f4aaf12e809dc037958"
}

Errors

Name Type Description
invalidRequest Object

Invalid request.
invalidCredentials Object

Invalid credentials.
userIsBanned Object

User is banned.

Authorization | Generate Token

Generate Authorization Token. The lifetime of the access token is 1 hour. The refresh token lifetime is 1 week. For more Information see bshaffer.github.io.

post 
/oauth2/v1/token

Permission: users 

curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/oauth2/v1/token' \
    --data '{"grant_type":"password", "username": "user", "password":"123", "client_id": "trueconf_server_users"}'

Header

Field Type Description
Content-Type String

application/json

Parameter

Field Type Description
grant_type String

Authorization type.

Allowed values: "password", "refresh_token", "client_credentials", "authorization_code"

client_id optional String

Authorization client. Required for "password" and "client_credentials" grant types.
username optional String

User name. Required for "password" grant type.
password optional String

User password. Required for "password" grant type.
refresh_token optional String

Refresh token. Required for "refresh_token" grant type.
client_secret optional String

Client secret. Required for "client_credentials" grant type.
code optional String

Authorization code. Required for "authorization_code" grant type.

 
HTTP/1.1 200 OK
{
    "access_token": "f7dee810d964f02d54d7930d69e80c561d2a55b7",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "conferences conferences:read conferences:write conferences.invitations conferences.participants conferences.participants:read conferences.participants:write groups groups:read groups:write users users:read users:write users.avatar:read users.avatar:write users.addressbook users.addressbook:read users.addressbook:write templates.conferences:read templates.conferences:write logs.calls:read logs.calls.participants:read logs.calls.invites:read conferences.records conferences.records:read conferences.sessions:read conferences.sessions.participants:read conferences.sessions.podiums.participants:read conferences.sessions.podiums.participants:write",
    "refresh_token": "bb72bf7717be3414a0056f4aaf12e809dc037958"
}

Errors

Name Type Description
invalidRequest Object

Invalid request.
invalidCredentials Object

Invalid credentials.
userIsBanned Object

User is banned.

Authorization | Generate Token

Generate Authorization Token. The lifetime of the access token is 1 hour. The refresh token lifetime is 1 week. For more Information see bshaffer.github.io.

post 
/oauth2/v1/token

Permission: users 

curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/oauth2/v1/token' \
    --data '{"grant_type":"password", "username": "user", "password":"123", "client_id": "trueconf_server_users"}'

Header

Field Type Description
Content-Type String

application/json

Parameter

Field Type Description
grant_type String

Authorization type.

Allowed values: "password", "refresh_token", "client_credentials", "authorization_code"

client_id optional String

Authorization client. Required for "password" and "client_credentials" grant types.
username optional String

User name. Required for "password" grant type.
password optional String

User password. Required for "password" grant type.
refresh_token optional String

Refresh token. Required for "refresh_token" grant type.
client_secret optional String

Client secret. Required for "client_credentials" grant type.
code optional String

Authorization code. Required for "authorization_code" grant type.

 
HTTP/1.1 200 OK
{
    "access_token": "f7dee810d964f02d54d7930d69e80c561d2a55b7",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "conferences conferences:read conferences:write conferences.invitations conferences.participants conferences.participants:read conferences.participants:write groups groups:read groups:write users users:read users:write users.avatar:read users.avatar:write users.addressbook users.addressbook:read users.addressbook:write templates.conferences:read templates.conferences:write logs.calls:read logs.calls.participants:read logs.calls.invites:read conferences.records conferences.records:read conferences.sessions:read conferences.sessions.participants:read conferences.sessions.podiums.participants:read conferences.sessions.podiums.participants:write",
    "refresh_token": "bb72bf7717be3414a0056f4aaf12e809dc037958"
}

Errors

Name Type Description
invalidRequest Object

Invalid request.
invalidCredentials Object

Invalid credentials.
userIsBanned Object

User is banned.

Authorization | Generate Token

Generate Authorization Token. The lifetime of the access token is 1 hour. The refresh token lifetime is 1 week. For more Information see bshaffer.github.io.

post 
/oauth2/v1/token

Permission: users 

curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/oauth2/v1/token' \
    --data '{"grant_type":"password", "username": "user", "password":"123", "client_id": "trueconf_server_users"}'

Header

Field Type Description
Content-Type String

application/json

Parameter

Field Type Description
grant_type String

Authorization type.

Allowed values: "password", "refresh_token", "client_credentials", "authorization_code"

client_id optional String

Authorization client. Required for "password" and "client_credentials" grant types.
username optional String

User name. Required for "password" grant type.
password optional String

User password. Required for "password" grant type.
refresh_token optional String

Refresh token. Required for "refresh_token" grant type.
client_secret optional String

Client secret. Required for "client_credentials" grant type.
code optional String

Authorization code. Required for "authorization_code" grant type.

 
HTTP/1.1 200 OK
{
    "access_token": "f7dee810d964f02d54d7930d69e80c561d2a55b7",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "conferences conferences:read conferences:write conferences.invitations conferences.participants conferences.participants:read conferences.participants:write groups groups:read groups:write users users:read users:write users.avatar:read users.avatar:write users.addressbook users.addressbook:read users.addressbook:write templates.conferences:read templates.conferences:write logs.calls:read logs.calls.participants:read logs.calls.invites:read conferences.records conferences.records:read conferences.sessions:read conferences.sessions.participants:read conferences.sessions.podiums.participants:read conferences.sessions.podiums.participants:write",
    "refresh_token": "bb72bf7717be3414a0056f4aaf12e809dc037958"
}

Errors

Name Type Description
invalidRequest Object

Invalid request.
invalidCredentials Object

Invalid credentials.
userIsBanned Object

User is banned.

Authorization | Generate Token

Generate Authorization Token. The lifetime of the access token is 1 hour. The refresh token lifetime is 1 week. For more Information see bshaffer.github.io.

post 
/oauth2/v1/token

Permission: users 

curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/oauth2/v1/token' \
    --data '{"grant_type":"password", "username": "user", "password":"123", "client_id": "trueconf_server_users"}'

Header

Field Type Description
Content-Type String

application/json

Parameter

Field Type Description
grant_type String

Authorization type.

Allowed values: "password", "refresh_token", "client_credentials", "authorization_code"

client_id optional String

Authorization client. Required for "password" and "client_credentials" grant types.
username optional String

User name. Required for "password" grant type.
password optional String

User password. Required for "password" grant type.
refresh_token optional String

Refresh token. Required for "refresh_token" grant type.
client_secret optional String

Client secret. Required for "client_credentials" grant type.
code optional String

Authorization code. Required for "authorization_code" grant type.

 
HTTP/1.1 200 OK
{
    "access_token": "f7dee810d964f02d54d7930d69e80c561d2a55b7",
    "expires_in": 3600,
    "token_type": "Bearer",
    "scope": "conferences conferences:read conferences:write conferences.invitations conferences.participants conferences.participants:read conferences.participants:write groups groups:read groups:write users users:read users:write users.avatar:read users.avatar:write users.addressbook users.addressbook:read users.addressbook:write templates.conferences:read templates.conferences:write logs.calls:read logs.calls.participants:read logs.calls.invites:read conferences.records conferences.records:read conferences.sessions:read conferences.sessions.participants:read conferences.sessions.podiums.participants:read conferences.sessions.podiums.participants:write",
    "refresh_token": "bb72bf7717be3414a0056f4aaf12e809dc037958"
}

Errors

Name Type Description
invalidRequest Object

Invalid request.
invalidCredentials Object

Invalid credentials.
userIsBanned Object

User is banned.

Objects

This section is devoted to API objects description.
The object represents structure in JSON format.

The tags used:
GET - this attribute is used as GET parameter.
POST - this attribute is used in POST request body.
PUT - this attribute is used in PUT request body.

Absence of tags means that this field is only available as a response to request (reading only).

Objects | Schedule

Schedule object

object 
Schedule

Structure

Field Type Description
type Integer

POST | PUT Conference schedule type:

  • -1 - without schedule
  • 0 - weekly
  • 1 - one-time

StructureOnce

Field Type Description
start_time Integer

POST | PUT Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected.
duration Integer

POST | PUT Conference duration.

StructureWeekly

Field Type Description
start_time Integer

The next conference start time in Unix Timestamp for weekly schedule .
duration Integer

POST | PUT Conference duration.
days String[]

POST | PUT Weekly conference launch days. Format ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]
time String

POST | PUT Weekly conference start time in hh:mm (24:00) format according to the server time zone.

time_offset Integer

Server time zone shown in minutes.

 
{
    "type": 1,
    "start_time": 1509464400,
    "duration": 600
}
{
    "type": 0,
    "start_time": 1509523200,
    "duration": 3600,
    "time": "11:30",
    "time_offset": 180,
    "days": [
        "monday",
        "tuesday",
        "wednesday"
    ]
}
{
    "type": -1
}

Objects | Schedule

Schedule object

object 
Schedule

Structure

Field Type Description
type Integer

POST | PUT Conference schedule type:

  • -1 - without schedule
  • 0 - weekly
  • 1 - one-time

StructureOnce

Field Type Description
start_time Integer

POST | PUT Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected.
duration Integer

POST | PUT Conference duration.

StructureWeekly

Field Type Description
start_time Integer

The next conference start time in Unix Timestamp for weekly schedule .
duration Integer

POST | PUT Conference duration.
days String[]

POST | PUT Weekly conference launch days. Format ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]
time String

POST | PUT Weekly conference start time in hh:mm (24:00) format according to the server time zone.

time_offset Integer

Server time zone shown in minutes.

 
{
    "type": 1,
    "start_time": 1509464400,
    "duration": 600
}
{
    "type": 0,
    "start_time": 1509523200,
    "duration": 3600,
    "time": "11:30",
    "time_offset": 180,
    "days": [
        "monday",
        "tuesday",
        "wednesday"
    ]
}
{
    "type": -1
}

Objects | Schedule

Schedule object

object 
Schedule

Structure

Field Type Description
type Integer

POST | PUT Conference schedule type:

  • -1 - without schedule
  • 0 - weekly
  • 1 - one-time

StructureOnce

Field Type Description
start_time Integer

POST | PUT Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected.
duration Integer

POST | PUT Conference duration.

StructureWeekly

Field Type Description
start_time Integer

The next conference start time in Unix Timestamp for weekly schedule .
duration Integer

POST | PUT Conference duration.
days String[]

POST | PUT Weekly conference launch days. Format ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]
time String

POST | PUT Weekly conference start time in hh:mm (24:00) format according to the server time zone.

time_offset Integer

Server time zone shown in minutes.

 
{
    "type": 1,
    "start_time": 1509464400,
    "duration": 600
}
{
    "type": 0,
    "start_time": 1509523200,
    "duration": 3600,
    "time": "11:30",
    "time_offset": 180,
    "days": [
        "monday",
        "tuesday",
        "wednesday"
    ]
}
{
    "type": -1
}

Objects | Schedule

Schedule object

object 
Schedule

Structure

Field Type Description
type Integer

POST | PUT Conference schedule type:

  • -1 - without schedule
  • 0 - weekly
  • 1 - one-time

StructureOnce

Field Type Description
start_time Integer

POST | PUT Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected.
duration Integer

POST | PUT Conference duration.

StructureWeekly

Field Type Description
start_time Integer

The next conference start time in Unix Timestamp for weekly schedule .
duration Integer

POST | PUT Conference duration.
days String[]

POST | PUT Weekly conference launch days. Format ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]
time String

POST | PUT Weekly conference start time in hh:mm (24:00) format according to the server time zone.

time_offset Integer

Server time zone shown in minutes.

 
{
    "type": 1,
    "start_time": 1509464400,
    "duration": 600
}
{
    "type": 0,
    "start_time": 1509523200,
    "duration": 3600,
    "time": "11:30",
    "time_offset": 180,
    "days": [
        "monday",
        "tuesday",
        "wednesday"
    ]
}
{
    "type": -1
}

Objects | Schedule

Schedule object

object 
Schedule

Structure

Field Type Description
type Integer

POST | PUT Conference schedule type:

  • -1 - without schedule
  • 0 - weekly
  • 1 - one-time

StructureOnce

Field Type Description
start_time Integer

POST | PUT Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected.
duration Integer

POST | PUT Conference duration.

StructureWeekly

Field Type Description
start_time Integer

The next conference start time in Unix Timestamp for weekly schedule .
duration Integer

POST | PUT Conference duration.
days String[]

POST | PUT Weekly conference launch days. Format ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]
time String

POST | PUT Weekly conference start time in hh:mm (24:00) format according to the server time zone.

time_offset Integer

Server time zone shown in minutes.

 
{
    "type": 1,
    "start_time": 1509464400,
    "duration": 600
}
{
    "type": 0,
    "start_time": 1509523200,
    "duration": 3600,
    "time": "11:30",
    "time_offset": 180,
    "days": [
        "monday",
        "tuesday",
        "wednesday"
    ]
}
{
    "type": -1
}

Objects | Schedule

Schedule object

object 
Schedule

Structure

Field Type Description
type Integer

POST | PUT Conference schedule type:

  • -1 - without schedule
  • 0 - weekly
  • 1 - one-time

StructureOnce

Field Type Description
start_time Integer

POST | PUT Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected.
duration Integer

POST | PUT Conference duration.

StructureWeekly

Field Type Description
start_time Integer

The next conference start time in Unix Timestamp for weekly schedule .
duration Integer

POST | PUT Conference duration.
days String[]

POST | PUT Weekly conference launch days. Format ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]
time String

POST | PUT Weekly conference start time in hh:mm (24:00) format according to the server time zone.

time_offset Integer

Server time zone shown in minutes.

 
{
    "type": 1,
    "start_time": 1509464400,
    "duration": 600
}
{
    "type": 0,
    "start_time": 1509523200,
    "duration": 3600,
    "time": "11:30",
    "time_offset": 180,
    "days": [
        "monday",
        "tuesday",
        "wednesday"
    ]
}
{
    "type": -1
}

Objects | Schedule

Schedule object

object 
Schedule

Structure

Field Type Description
type Integer

POST | PUT Conference schedule type:

  • -1 - without schedule
  • 0 - weekly
  • 1 - one-time

StructureOnce

Field Type Description
start_time Integer

POST | PUT Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected.
duration Integer

POST | PUT Conference duration.

StructureWeekly

Field Type Description
start_time Integer

The next conference start time in Unix Timestamp for weekly schedule .
duration Integer

POST | PUT Conference duration.
days String[]

POST | PUT Weekly conference launch days. Format ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]
time String

POST | PUT Weekly conference start time in hh:mm (24:00) format according to the server time zone.

time_offset Integer

Server time zone shown in minutes.

 
{
    "type": 1,
    "start_time": 1509464400,
    "duration": 600
}
{
    "type": 0,
    "start_time": 1509523200,
    "duration": 3600,
    "time": "11:30",
    "time_offset": 180,
    "days": [
        "monday",
        "tuesday",
        "wednesday"
    ]
}
{
    "type": -1
}

Objects | Schedule

Schedule object

object 
Schedule

Structure

Field Type Description
type Integer

POST | PUT Conference schedule type:

  • -1 - without schedule
  • 0 - weekly
  • 1 - one-time

StructureOnce

Field Type Description
start_time Integer

POST | PUT Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected.
duration Integer

POST | PUT Conference duration.

StructureWeekly

Field Type Description
start_time Integer

The next conference start time in Unix Timestamp for weekly schedule .
duration Integer

POST | PUT Conference duration.
days String[]

POST | PUT Weekly conference launch days. Format ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]
time String

POST | PUT Weekly conference start time in hh:mm (24:00) format according to the server time zone.

time_offset Integer

Server time zone shown in minutes.

 
{
    "type": 1,
    "start_time": 1509464400,
    "duration": 600
}
{
    "type": 0,
    "start_time": 1509523200,
    "duration": 3600,
    "time": "11:30",
    "time_offset": 180,
    "days": [
        "monday",
        "tuesday",
        "wednesday"
    ]
}
{
    "type": -1
}

Objects | Schedule

Schedule object

object 
Schedule

Structure

Field Type Description
type Integer

POST | PUT Conference schedule type:

  • -1 - without schedule
  • 0 - weekly
  • 1 - one-time

StructureOnce

Field Type Description
start_time Integer

POST | PUT Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected.
duration Integer

POST | PUT Conference duration.

StructureWeekly

Field Type Description
start_time Integer

The next conference start time in Unix Timestamp for weekly schedule .
duration Integer

POST | PUT Conference duration.
days String[]

POST | PUT Weekly conference launch days. Format ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]
time String

POST | PUT Weekly conference start time in hh:mm (24:00) format according to the server time zone.

time_offset Integer

Server time zone shown in minutes.

 
{
    "type": 1,
    "start_time": 1509464400,
    "duration": 600
}
{
    "type": 0,
    "start_time": 1509523200,
    "duration": 3600,
    "time": "11:30",
    "time_offset": 180,
    "days": [
        "monday",
        "tuesday",
        "wednesday"
    ]
}
{
    "type": -1
}

Objects | Schedule

Schedule object

object 
Schedule

Structure

Field Type Description
type Integer

POST | PUT Conference schedule type:

  • -1 - without schedule
  • 0 - weekly
  • 1 - one-time

StructureOnce

Field Type Description
start_time Integer

POST | PUT Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected.
duration Integer

POST | PUT Conference duration.

StructureWeekly

Field Type Description
start_time Integer

The next conference start time in Unix Timestamp for weekly schedule .
duration Integer

POST | PUT Conference duration.
days String[]

POST | PUT Weekly conference launch days. Format ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]
time String

POST | PUT Weekly conference start time in hh:mm (24:00) format according to the server time zone.

time_offset Integer

Server time zone shown in minutes.

 
{
    "type": 1,
    "start_time": 1509464400,
    "duration": 600
}
{
    "type": 0,
    "start_time": 1509523200,
    "duration": 3600,
    "time": "11:30",
    "time_offset": 180,
    "days": [
        "monday",
        "tuesday",
        "wednesday"
    ]
}
{
    "type": -1
}

Objects | Schedule

Schedule object

object 
Schedule

Structure

Field Type Description
type Integer

POST | PUT Conference schedule type:

  • -1 - without schedule
  • 0 - weekly
  • 1 - one-time

StructureOnce

Field Type Description
start_time Integer

POST | PUT Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected.
duration Integer

POST | PUT Conference duration.

StructureWeekly

Field Type Description
start_time Integer

The next conference start time in Unix Timestamp for weekly schedule .
duration Integer

POST | PUT Conference duration.
days String[]

POST | PUT Weekly conference launch days. Format ["monday", "tuesday", "wednesday", "thursday", "friday", "saturday", "sunday"]
time String

POST | PUT Weekly conference start time in hh:mm (24:00) format according to the server time zone.

time_offset Integer

Server time zone shown in minutes

 
{
    "type": 1,
    "start_time": 1509464400,
    "duration": 600
}
{
    "type": 0,
    "start_time": 1509523200,
    "duration": 3600,
    "time": "11:30",
    "time_offset": 180,
    "days": [
        "monday",
        "tuesday",
        "wednesday"
    ]
}
{
    "type": -1
}

Objects | Call invite

Call invite log object.

object 
CallInvite

Structure

Field Type Description
call_id String

Identifier of inviting call participant.
invited_call_id Integer

Identifier of invited call participant.
invite_time ObjectDataTime

Call sessions invite time. It can be null.
is_accepted Boolean

Flag signaling the fact of accepting an invitation.

 
{
    "call_id": "1@trueconf.com",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Call invite

Call invite log object.

object 
CallInvite

Structure

Field Type Description
call_id String

Identifier of inviting call participant.
invited_call_id Integer

Identifier of invited call participant.
invite_time ObjectDataTime

Call sessions invite time. It can be null.
is_accepted Boolean

Flag signaling the fact of accepting an invitation.

 
{
    "call_id": "1@trueconf.com",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Call invite

Call invite log object.

object 
CallInvite

Structure

Field Type Description
call_id String

Identifier of inviting call participant.
invited_call_id Integer

Identifier of invited call participant.
invite_time ObjectDataTime

Call sessions invite time. It can be null.
is_accepted Boolean

Flag signaling the fact of accepting an invitation.

 
{
    "call_id": "1@trueconf.com",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Call invite

Call invite log object.

object 
CallInvite

Structure

Field Type Description
call_id String

Identifier of inviting call participant.
invited_call_id Integer

Identifier of invited call participant.
invite_time ObjectDataTime

Call sessions invite time. It can be null.
is_accepted Boolean

Flag signaling the fact of accepting an invitation.

 
{
    "call_id": "1@trueconf.com",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Call invite

Call invite log object.

object 
CallInvite

Structure

Field Type Description
call_id String

Identifier of inviting call participant.
invited_call_id Integer

Identifier of invited call participant.
invite_time ObjectDataTime

Call sessions invite time. It can be null.
is_accepted Boolean

Flag signaling the fact of accepting an invitation.

 
{
    "call_id": "1@trueconf.com",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Call invite

Call invite log object.

object 
CallInvite

Structure

Field Type Description
call_id String

Identifier of inviting call participant.
invited_call_id Integer

Identifier of invited call participant.
invite_time ObjectDataTime

Call sessions invite time. It can be null.
is_accepted Boolean

Flag signaling the fact of accepting an invitation.

 
{
    "call_id": "1@trueconf.com",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Call invite

Call invite log object.

object 
CallInvite

Structure

Field Type Description
call_id String

Identifier of inviting call participant.
invited_call_id Integer

Identifier of invited call participant.
invite_time ObjectDataTime

Call sessions invite time. It can be null.
is_accepted Boolean

Flag signaling the fact of accepting an invitation.

 
{
    "call_id": "1@trueconf.com",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Call invite

Call invite log object.

object 
CallInvite

Structure

Field Type Description
call_id String

Identifier of inviting call participant.
invited_call_id Integer

Identifier of invited call participant.
invite_time ObjectDataTime

Call sessions invite time. It can be null.
is_accepted Boolean

Flag signaling the fact of accepting an invitation.

 
{
    "call_id": "1@trueconf.com",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Call invite

Call invite log object.

object 
CallInvite

Structure

Field Type Description
call_id String

Identifier of inviting call participant.
invited_call_id Integer

Identifier of invited call participant.
invite_time ObjectDataTime

Call sessions invite time. It can be null.
is_accepted Boolean

Flag signaling the fact of accepting an invitation.

 
{
    "call_id": "1@trueconf.com",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Call invite

Call invite log object.

object 
CallInvite

Structure

Field Type Description
call_id String

Identifier of inviting call participant.
invited_call_id Integer

Identifier of invited call participant.
invite_time ObjectDataTime

Call sessions invite time. It can be null.
is_accepted Boolean

Flag signaling the fact of accepting an invitation.

 
{
    "call_id": "1@trueconf.com",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Call participant

Call participant log object.
The object can contain information from ObjectUser.

object 
CallParticipant

Structure

Field Type Description
app_id String

Identifier of client application.
avg_cpu_load Integer

Average CPU load of call participant endpoint in percent during a call.
avg_sent_fps Integer

Average sent frames count per second of call participant endpoint.
bitrate_in Integer

Bit rate of incoming traffic to call participant endpoint.
bitrate_out Integer

Bit rate of outgoing traffic from call participant endpoint.
call_id String

Identifier of call participant.
display_name String

Display name of call participant.
duration Integer

Call sessions duration in Unix timestamp.
join_time ObjectDataTime

Call sessions join time. It can be null.
leave_reason Integer

Call sessions join time.
leave_time ObjectDataTime

Call sessions leave time. It can be null.
video_h Integer

Height of video frames from call participant camera during a call.
video_w Integer

Width of video frames from call participant camera during a call.

 
{
    "app_id": "3D0DE845F8B9E478A10FBFF2BF751F31",
    "avg_cpu_load": 0,
    "avg_sent_fps": 14.818181818182,
    "bitrate_in": 73,
    "bitrate_out": 52,
    "call_id": "#guest:edd36bd8@server.name",
    "display_name": "test#ds",
    "duration": 69,
    "join_time": {
        "date": "2018-04-12 10:27:09.227056",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "leave_reason": 1,
    "leave_time": {
        "date": "2018-04-12 10:28:18.243698",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "video_h": 360,
    "video_w": 640
}

Objects | Call participant

Call participant log object.
The object can contain information from ObjectUser.

object 
CallParticipant

Structure

Field Type Description
app_id String

Identifier of client application.
avg_cpu_load Integer

Average CPU load of call participant endpoint in percent during a call.
avg_sent_fps Integer

Average sent frames count per second of call participant endpoint.
bitrate_in Integer

Bit rate of incoming traffic to call participant endpoint.
bitrate_out Integer

Bit rate of outgoing traffic from call participant endpoint.
call_id String

Identifier of call participant.
display_name String

Display name of call participant.
duration Integer

Call sessions duration in Unix timestamp.
join_time ObjectDataTime

Call sessions join time. It can be null.
leave_reason Integer

Call sessions join time.
leave_time ObjectDataTime

Call sessions leave time. It can be null.
video_h Integer

Height of video frames from call participant camera during a call.
video_w Integer

Width of video frames from call participant camera during a call.

 
{
    "app_id": "3D0DE845F8B9E478A10FBFF2BF751F31",
    "avg_cpu_load": 0,
    "avg_sent_fps": 14.818181818182,
    "bitrate_in": 73,
    "bitrate_out": 52,
    "call_id": "#guest:edd36bd8@server.name",
    "display_name": "test#ds",
    "duration": 69,
    "join_time": {
        "date": "2018-04-12 10:27:09.227056",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "leave_reason": 1,
    "leave_time": {
        "date": "2018-04-12 10:28:18.243698",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "video_h": 360,
    "video_w": 640
}

Objects | Call participant

Call participant log object.
The object can contain information from ObjectUser.

object 
CallParticipant

Structure

Field Type Description
app_id String

Identifier of client application.
avg_cpu_load Integer

Average CPU load of call participant endpoint in percent during a call.
avg_sent_fps Integer

Average sent frames count per second of call participant endpoint.
bitrate_in Integer

Bit rate of incoming traffic to call participant endpoint.
bitrate_out Integer

Bit rate of outgoing traffic from call participant endpoint.
call_id String

Identifier of call participant.
display_name String

Display name of call participant.
duration Integer

Call sessions duration in Unix timestamp.
join_time ObjectDataTime

Call sessions join time. It can be null.
leave_reason Integer

Call sessions join time.
leave_time ObjectDataTime

Call sessions leave time. It can be null.
video_h Integer

Height of video frames from call participant camera during a call.
video_w Integer

Width of video frames from call participant camera during a call.

 
{
    "app_id": "3D0DE845F8B9E478A10FBFF2BF751F31",
    "avg_cpu_load": 0,
    "avg_sent_fps": 14.818181818182,
    "bitrate_in": 73,
    "bitrate_out": 52,
    "call_id": "#guest:edd36bd8@server.name",
    "display_name": "test#ds",
    "duration": 69,
    "join_time": {
        "date": "2018-04-12 10:27:09.227056",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "leave_reason": 1,
    "leave_time": {
        "date": "2018-04-12 10:28:18.243698",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "video_h": 360,
    "video_w": 640
}

Objects | Call participant

Call participant log object.
The object can contain information from ObjectUser.

object 
CallParticipant

Structure

Field Type Description
app_id String

Identifier of client application.
avg_cpu_load Integer

Average CPU load of call participant endpoint in percent during a call.
avg_sent_fps Integer

Average sent frames count per second of call participant endpoint.
bitrate_in Integer

Bit rate of incoming traffic to call participant endpoint.
bitrate_out Integer

Bit rate of outgoing traffic from call participant endpoint.
call_id String

Identifier of call participant.
display_name String

Display name of call participant.
duration Integer

Call sessions duration in Unix timestamp.
join_time ObjectDataTime

Call sessions join time. It can be null.
leave_reason Integer

Call sessions join time.
leave_time ObjectDataTime

Call sessions leave time. It can be null.
video_h Integer

Height of video frames from call participant camera during a call.
video_w Integer

Width of video frames from call participant camera during a call.

 
{
    "app_id": "3D0DE845F8B9E478A10FBFF2BF751F31",
    "avg_cpu_load": 0,
    "avg_sent_fps": 14.818181818182,
    "bitrate_in": 73,
    "bitrate_out": 52,
    "call_id": "#guest:edd36bd8@server.name",
    "display_name": "test#ds",
    "duration": 69,
    "join_time": {
        "date": "2018-04-12 10:27:09.227056",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "leave_reason": 1,
    "leave_time": {
        "date": "2018-04-12 10:28:18.243698",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "video_h": 360,
    "video_w": 640
}

Objects | Call participant

Call participant log object.
The object can contain information from ObjectUser.

object 
CallParticipant

Structure

Field Type Description
app_id String

Identifier of client application.
avg_cpu_load Integer

Average CPU load of call participant endpoint in percent during a call.
avg_sent_fps Integer

Average sent frames count per second of call participant endpoint.
bitrate_in Integer

Bit rate of incoming traffic to call participant endpoint.
bitrate_out Integer

Bit rate of outgoing traffic from call participant endpoint.
call_id String

Identifier of call participant.
display_name String

Display name of call participant.
duration Integer

Call sessions duration in Unix timestamp.
join_time ObjectDataTime

Call sessions join time. It can be null.
leave_reason Integer

Call sessions join time.
leave_time ObjectDataTime

Call sessions leave time. It can be null.
video_h Integer

Height of video frames from call participant camera during a call.
video_w Integer

Width of video frames from call participant camera during a call.

 
{
    "app_id": "3D0DE845F8B9E478A10FBFF2BF751F31",
    "avg_cpu_load": 0,
    "avg_sent_fps": 14.818181818182,
    "bitrate_in": 73,
    "bitrate_out": 52,
    "call_id": "#guest:edd36bd8@server.name",
    "display_name": "test#ds",
    "duration": 69,
    "join_time": {
        "date": "2018-04-12 10:27:09.227056",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "leave_reason": 1,
    "leave_time": {
        "date": "2018-04-12 10:28:18.243698",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "video_h": 360,
    "video_w": 640
}

Objects | Call participant

Call participant log object.
The object can contain information from ObjectUser.

object 
CallParticipant

Structure

Field Type Description
app_id String

Identifier of client application.
avg_cpu_load Integer

Average CPU load of call participant endpoint in percent during a call.
avg_sent_fps Integer

Average sent frames count per second of call participant endpoint.
bitrate_in Integer

Bit rate of incoming traffic to call participant endpoint.
bitrate_out Integer

Bit rate of outgoing traffic from call participant endpoint.
call_id String

Identifier of call participant.
display_name String

Display name of call participant.
duration Integer

Call sessions duration in Unix timestamp.
join_time ObjectDataTime

Call sessions join time. It can be null.
leave_reason Integer

Call sessions join time.
leave_time ObjectDataTime

Call sessions leave time. It can be null.
video_h Integer

Height of video frames from call participant camera during a call.
video_w Integer

Width of video frames from call participant camera during a call.

 
{
    "app_id": "3D0DE845F8B9E478A10FBFF2BF751F31",
    "avg_cpu_load": 0,
    "avg_sent_fps": 14.818181818182,
    "bitrate_in": 73,
    "bitrate_out": 52,
    "call_id": "#guest:edd36bd8@server.name",
    "display_name": "test#ds",
    "duration": 69,
    "join_time": {
        "date": "2018-04-12 10:27:09.227056",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "leave_reason": 1,
    "leave_time": {
        "date": "2018-04-12 10:28:18.243698",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "video_h": 360,
    "video_w": 640
}

Objects | Call participant

Call participant log object.
The object can contain information from ObjectUser.

object 
CallParticipant

Structure

Field Type Description
app_id String

Identifier of client application.
avg_cpu_load Integer

Average CPU load of call participant endpoint in percent during a call.
avg_sent_fps Integer

Average sent frames count per second of call participant endpoint.
bitrate_in Integer

Bit rate of incoming traffic to call participant endpoint.
bitrate_out Integer

Bit rate of outgoing traffic from call participant endpoint.
call_id String

Identifier of call participant.
display_name String

Display name of call participant.
duration Integer

Call sessions duration in Unix timestamp.
join_time ObjectDataTime

Call sessions join time. It can be null.
leave_reason Integer

Call sessions join time.
leave_time ObjectDataTime

Call sessions leave time. It can be null.
video_h Integer

Height of video frames from call participant camera during a call.
video_w Integer

Width of video frames from call participant camera during a call.

 
{
    "app_id": "3D0DE845F8B9E478A10FBFF2BF751F31",
    "avg_cpu_load": 0,
    "avg_sent_fps": 14.818181818182,
    "bitrate_in": 73,
    "bitrate_out": 52,
    "call_id": "#guest:edd36bd8@server.name",
    "display_name": "test#ds",
    "duration": 69,
    "join_time": {
        "date": "2018-04-12 10:27:09.227056",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "leave_reason": 1,
    "leave_time": {
        "date": "2018-04-12 10:28:18.243698",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "video_h": 360,
    "video_w": 640
}

Objects | Call participant

Call participant log object.
The object can contain information from ObjectUser.

object 
CallParticipant

Structure

Field Type Description
app_id String

Identifier of client application.
avg_cpu_load Integer

Average CPU load of call participant endpoint in percent during a call.
avg_sent_fps Integer

Average sent frames count per second of call participant endpoint.
bitrate_in Integer

Bit rate of incoming traffic to call participant endpoint.
bitrate_out Integer

Bit rate of outgoing traffic from call participant endpoint.
call_id String

Identifier of call participant.
display_name String

Display name of call participant.
duration Integer

Call sessions duration in Unix timestamp.
join_time ObjectDataTime

Call sessions join time. It can be null.
leave_reason Integer

Call sessions join time.
leave_time ObjectDataTime

Call sessions leave time. It can be null.
video_h Integer

Height of video frames from call participant camera during a call.
video_w Integer

Width of video frames from call participant camera during a call.

 
{
    "app_id": "3D0DE845F8B9E478A10FBFF2BF751F31",
    "avg_cpu_load": 0,
    "avg_sent_fps": 14.818181818182,
    "bitrate_in": 73,
    "bitrate_out": 52,
    "call_id": "#guest:edd36bd8@server.name",
    "display_name": "test#ds",
    "duration": 69,
    "join_time": {
        "date": "2018-04-12 10:27:09.227056",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "leave_reason": 1,
    "leave_time": {
        "date": "2018-04-12 10:28:18.243698",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "video_h": 360,
    "video_w": 640
}

Objects | Call participant

Call participant log object.
The object can contain information from ObjectUser.

object 
CallParticipant

Structure

Field Type Description
app_id String

Identifier of client application.
avg_cpu_load Integer

Average CPU load of call participant endpoint in percent during a call.
avg_sent_fps Integer

Average sent frames count per second of call participant endpoint.
bitrate_in Integer

Bit rate of incoming traffic to call participant endpoint.
bitrate_out Integer

Bit rate of outgoing traffic from call participant endpoint.
call_id String

Identifier of call participant.
display_name String

Display name of call participant.
duration Integer

Call sessions duration in Unix timestamp.
join_time ObjectDataTime

Call sessions join time. It can be null.
leave_reason Integer

Call sessions join time.
leave_time ObjectDataTime

Call sessions leave time. It can be null.
video_h Integer

Height of video frames from call participant camera during a call.
video_w Integer

Width of video frames from call participant camera during a call.

 
{
    "app_id": "3D0DE845F8B9E478A10FBFF2BF751F31",
    "avg_cpu_load": 0,
    "avg_sent_fps": 14.818181818182,
    "bitrate_in": 73,
    "bitrate_out": 52,
    "call_id": "#guest:edd36bd8@server.name",
    "display_name": "test#ds",
    "duration": 69,
    "join_time": {
        "date": "2018-04-12 10:27:09.227056",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "leave_reason": 1,
    "leave_time": {
        "date": "2018-04-12 10:28:18.243698",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "video_h": 360,
    "video_w": 640
}

Objects | Call participant

Call participant log object.
The object can contain information from ObjectUser.

object 
CallParticipant

Structure

Field Type Description
app_id String

Identifier of client application.
avg_cpu_load Integer

Average CPU load of call participant endpoint in percent during a call.
avg_sent_fps Integer

Average sent frames count per second of call participant endpoint.
bitrate_in Integer

Bit rate of incoming traffic to call participant endpoint.
bitrate_out Integer

Bit rate of outgoing traffic from call participant endpoint.
call_id String

Identifier of call participant.
display_name String

Display name of call participant.
duration Integer

Call sessions duration in Unix timestamp.
join_time ObjectDataTime

Call sessions join time. It can be null.
leave_reason Integer

Call sessions join time.
leave_time ObjectDataTime

Call sessions leave time. It can be null.
video_h Integer

Height of video frames from call participant camera during a call.
video_w Integer

Width of video frames from call participant camera during a call.

 
{
    "app_id": "3D0DE845F8B9E478A10FBFF2BF751F31",
    "avg_cpu_load": 0,
    "avg_sent_fps": 14.818181818182,
    "bitrate_in": 73,
    "bitrate_out": 52,
    "call_id": "#guest:edd36bd8@server.name",
    "display_name": "test#ds",
    "duration": 69,
    "join_time": {
        "date": "2018-04-12 10:27:09.227056",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "leave_reason": 1,
    "leave_time": {
        "date": "2018-04-12 10:28:18.243698",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "video_h": 360,
    "video_w": 640
}

Objects | Call record

Call recording object.
The object can contain information from ObjectCall.

object 
CallRecord

Structure

Field Type Description
conference_id String

Identifier of call session.
name String

Video file name.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
owner String

Owner of conference. GET
class Integer

Class of call session.
type Integer

Type of call session.
subtype Integer

Subtype of call session.
duration Integer

Duration of call session in seconds.
file_size String

Video file size in bytes.
start_time ObjectDataTime

Call session start time. It can be null.
end_time ObjectDataTime

Call session end time. It can be null.
is_public Boolean

Flag signaling the allowed public access to conference.
download_url String

Video file download link.
is_deleted Boolean

Flag signaling the the absence of file in current records directory. You can see records directory on page 'Recordings' of Web-configuration.

 
{
    "conference_id": "00000070@server.name#vcs",
    "name": "00000070_2018-04-10_16-17-59.mkv",
    "named_conf_id": "2270933573",
    "topic": "test",
    "owner": "1@server.name",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "duration": 16,
    "file_size": null,
    "start_time": {
        "date": "2018-04-10 13:17:59.565386",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "end_time": {
        "date": "2018-04-10 13:18:15.999945",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_public": false,
    "download_url": "https://localhost/api/v3.10/logs/records/:conference_id/download",
    "is_deleted": true
}

Objects | Call record

Call recording object.
The object can contain information from ObjectCall.

object 
CallRecord

Structure

Field Type Description
conference_id String

Identifier of call session.
name String

Video file name.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
owner String

Owner of conference. GET
class Integer

Class of call session.
type Integer

Type of call session.
subtype Integer

Subtype of call session.
duration Integer

Duration of call session in seconds.
file_size String

Video file size in bytes.
start_time ObjectDataTime

Call session start time. It can be null.
end_time ObjectDataTime

Call session end time. It can be null.
is_public Boolean

Flag signaling the allowed public access to conference.
download_url String

Video file download link.
is_deleted Boolean

Flag signaling the the absence of file in current records directory. You can see records directory on page 'Recordings' of Web-configuration.

 
{
    "conference_id": "00000070@server.name#vcs",
    "name": "00000070_2018-04-10_16-17-59.mkv",
    "named_conf_id": "2270933573",
    "topic": "test",
    "owner": "1@server.name",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "duration": 16,
    "file_size": null,
    "start_time": {
        "date": "2018-04-10 13:17:59.565386",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "end_time": {
        "date": "2018-04-10 13:18:15.999945",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_public": false,
    "download_url": "https://localhost/api/v3.9/logs/records/:conference_id/download",
    "is_deleted": true
}

Objects | Call record

Call recording object.
The object can contain information from ObjectCall.

object 
CallRecord

Structure

Field Type Description
conference_id String

Identifier of call session.
name String

Video file name.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
owner String

Owner of conference. GET
class Integer

Class of call session.
type Integer

Type of call session.
subtype Integer

Subtype of call session.
duration Integer

Duration of call session in seconds.
file_size String

Video file size in bytes.
start_time ObjectDataTime

Call session start time. It can be null.
end_time ObjectDataTime

Call session end time. It can be null.
is_public Boolean

Flag signaling the allowed public access to conference.
download_url String

Video file download link.
is_deleted Boolean

Flag signaling the the absence of file in current records directory. You can see records directory on page 'Recordings' of Web-configuration.

 
{
    "conference_id": "00000070@server.name#vcs",
    "name": "00000070_2018-04-10_16-17-59.mkv",
    "named_conf_id": "2270933573",
    "topic": "test",
    "owner": "1@server.name",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "duration": 16,
    "file_size": null,
    "start_time": {
        "date": "2018-04-10 13:17:59.565386",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "end_time": {
        "date": "2018-04-10 13:18:15.999945",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_public": false,
    "download_url": "https://localhost/api/v3.8/logs/records/:conference_id/download",
    "is_deleted": true
}

Objects | Call record

Call recording object.
The object can contain information from ObjectCall.

object 
CallRecord

Structure

Field Type Description
conference_id String

Identifier of call session.
name String

Video file name.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
owner String

Owner of conference. GET
class Integer

Class of call session.
type Integer

Type of call session.
subtype Integer

Subtype of call session.
duration Integer

Duration of call session in seconds.
file_size String

Video file size in bytes.
start_time ObjectDataTime

Call session start time. It can be null.
end_time ObjectDataTime

Call session end time. It can be null.
is_public Boolean

Flag signaling the allowed public access to conference.
download_url String

Video file download link.
is_deleted Boolean

Flag signaling the the absence of file in current records directory. You can see records directory on page 'Recordings' of Web-configuration.

 
{
    "conference_id": "00000070@server.name#vcs",
    "name": "00000070_2018-04-10_16-17-59.mkv",
    "named_conf_id": "2270933573",
    "topic": "test",
    "owner": "1@server.name",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "duration": 16,
    "file_size": null,
    "start_time": {
        "date": "2018-04-10 13:17:59.565386",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "end_time": {
        "date": "2018-04-10 13:18:15.999945",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_public": false,
    "download_url": "https://localhost/api/v3.7/logs/records/:conference_id/download",
    "is_deleted": true
}

Objects | Call record

Call recording object.
The object can contain information from ObjectCall.

object 
CallRecord

Structure

Field Type Description
conference_id String

Identifier of call session.
name String

Video file name.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
owner String

Owner of conference. GET
class Integer

Class of call session.
type Integer

Type of call session.
subtype Integer

Subtype of call session.
duration Integer

Duration of call session in seconds.
file_size String

Video file size in bytes.
start_time ObjectDataTime

Call session start time. It can be null.
end_time ObjectDataTime

Call session end time. It can be null.
is_public Boolean

Flag signaling the allowed public access to conference.
download_url String

Video file download link.
is_deleted Boolean

Flag signaling the the absence of file in current records directory. You can see records directory on page 'Recordings' of Web-configuration.

 
{
    "conference_id": "00000070@server.name#vcs",
    "name": "00000070_2018-04-10_16-17-59.mkv",
    "named_conf_id": "2270933573",
    "topic": "test",
    "owner": "1@server.name",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "duration": 16,
    "file_size": null,
    "start_time": {
        "date": "2018-04-10 13:17:59.565386",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "end_time": {
        "date": "2018-04-10 13:18:15.999945",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_public": false,
    "download_url": "https://localhost/api/v3.6/logs/records/:conference_id/download",
    "is_deleted": true
}

Objects | Call record

Call recording object.
The object can contain information from ObjectCall.

object 
CallRecord

Structure

Field Type Description
conference_id String

Identifier of call session.
name String

Video file name.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
owner String

Owner of conference. GET
class Integer

Class of call session.
type Integer

Type of call session.
subtype Integer

Subtype of call session.
duration Integer

Duration of call session in seconds.
file_size String

Video file size in bytes.
start_time ObjectDataTime

Call session start time. It can be null.
end_time ObjectDataTime

Call session end time. It can be null.
is_public Boolean

Flag signaling the allowed public access to conference.
download_url String

Video file download link.
is_deleted Boolean

Flag signaling the the absence of file in current records directory. You can see records directory on page 'Recordings' of Web-configuration.

 
{
    "conference_id": "00000070@server.name#vcs",
    "name": "00000070_2018-04-10_16-17-59.mkv",
    "named_conf_id": "2270933573",
    "topic": "test",
    "owner": "1@server.name",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "duration": 16,
    "file_size": null,
    "start_time": {
        "date": "2018-04-10 13:17:59.565386",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "end_time": {
        "date": "2018-04-10 13:18:15.999945",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_public": false,
    "download_url": "https://localhost/api/v3.5/logs/records/:conference_id/download",
    "is_deleted": true
}

Objects | Call record

Call recording object.
The object can contain information from ObjectCall.

object 
CallRecord

Structure

Field Type Description
conference_id String

Identifier of call session.
name String

Video file name.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
owner String

Owner of conference. GET
class Integer

Class of call session.
type Integer

Type of call session.
subtype Integer

Subtype of call session.
duration Integer

Duration of call session in seconds.
file_size String

Video file size in bytes.
start_time ObjectDataTime

Call session start time. It can be null.
end_time ObjectDataTime

Call session end time. It can be null.
is_public Boolean

Flag signaling the allowed public access to conference.
download_url String

Video file download link.
is_deleted Boolean

Flag signaling the the absence of file in current records directory. You can see records directory on page 'Recordings' of Web-configuration.

 
{
    "conference_id": "00000070@server.name#vcs",
    "name": "00000070_2018-04-10_16-17-59.mkv",
    "named_conf_id": "2270933573",
    "topic": "test",
    "owner": "1@server.name",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "duration": 16,
    "file_size": null,
    "start_time": {
        "date": "2018-04-10 13:17:59.565386",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "end_time": {
        "date": "2018-04-10 13:18:15.999945",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_public": false,
    "download_url": "https://localhost/api/v3.4/logs/records/:conference_id/download",
    "is_deleted": true
}

Objects | Call record

Call recording object.
The object can contain information from ObjectCall.

object 
CallRecord

Structure

Field Type Description
conference_id String

Identifier of call session.
name String

Video file name.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
owner String

Owner of conference. GET
class Integer

Class of call session.
type Integer

Type of call session.
subtype Integer

Subtype of call session.
duration Integer

Duration of call session in seconds.
file_size String

Video file size in bytes.
start_time ObjectDataTime

Call session start time. It can be null.
end_time ObjectDataTime

Call session end time. It can be null.
is_public Boolean

Flag signaling the allowed public access to conference.
download_url String

Video file download link.
is_deleted Boolean

Flag signaling the the absence of file in current records directory. You can see records directory on page 'Recordings' of Web-configuration.

 
{
    "conference_id": "00000070@server.name#vcs",
    "name": "00000070_2018-04-10_16-17-59.mkv",
    "named_conf_id": "2270933573",
    "topic": "test",
    "owner": "1@server.name",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "duration": 16,
    "file_size": null,
    "start_time": {
        "date": "2018-04-10 13:17:59.565386",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "end_time": {
        "date": "2018-04-10 13:18:15.999945",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_public": false,
    "download_url": "https://localhost/api/v3.3/logs/records/:conference_id/download",
    "is_deleted": true
}

Objects | Call record

Call recording object.
The object can contain information from ObjectCall.

object 
CallRecord

Structure

Field Type Description
conference_id String

Identifier of call session.
name String

Video file name.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
owner String

Owner of conference. GET
class Integer

Class of call session.
type Integer

Type of call session.
subtype Integer

Subtype of call session.
duration Integer

Duration of call session in seconds.
file_size String

Video file size in bytes.
start_time ObjectDataTime

Call session start time. It can be null.
end_time ObjectDataTime

Call session end time. It can be null.
is_public Boolean

Flag signaling the allowed public access to conference.
download_url String

Video file download link.
is_deleted Boolean

Flag signaling the the absence of file in current records directory. You can see records directory on page 'Recordings' of Web-configuration.

 
{
    "conference_id": "00000070@server.name#vcs",
    "name": "00000070_2018-04-10_16-17-59.mkv",
    "named_conf_id": "2270933573",
    "topic": "test",
    "owner": "1@server.name",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "duration": 16,
    "file_size": null,
    "start_time": {
        "date": "2018-04-10 13:17:59.565386",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "end_time": {
        "date": "2018-04-10 13:18:15.999945",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_public": false,
    "download_url": "https://localhost/api/v3.2/logs/records/:conference_id/download",
    "is_deleted": true
}

Objects | Call record

Call recording object.
The object can contain information from ObjectCall.

object 
CallRecord

Structure

Field Type Description
conference_id String

Identifier of call session.
name String

Video file name.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
owner String

Owner of conference. GET
class Integer

Class of call session.
type Integer

Type of call session.
subtype Integer

Subtype of call session.
duration Integer

Duration of call session in seconds.
file_size String

Video file size in bytes.
start_time ObjectDataTime

Call session start time. It can be null.
end_time ObjectDataTime

Call session end time. It can be null.
is_public Boolean

Flag signaling the allowed public access to conference.
download_url String

Video file download link.
is_deleted Boolean

Flag signaling the the absence of file in current records directory. You can see records directory on page 'Recordings' of Web-configuration.

 
{
    "conference_id": "00000070@server.name#vcs",
    "name": "00000070_2018-04-10_16-17-59.mkv",
    "named_conf_id": "2270933573",
    "topic": "test",
    "owner": "1@server.name",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "duration": 16,
    "file_size": null,
    "start_time": {
        "date": "2018-04-10 13:17:59.565386",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "end_time": {
        "date": "2018-04-10 13:18:15.999945",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_public": false,
    "download_url": "https://localhost/api/v3.1/logs/records/:conference_id/download",
    "is_deleted": true
}

Objects | Call

Call log object.
The object can contain information from ObjectConference.

object 
Call

Structure

Field Type Description
conference_id String

Identifier of call session.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
class Integer

Class of call.

Allowed values: 1, 10, 11, 12

type Integer

Type of call.

Allowed values: 0, 1, 5, 6

subtype Integer

Subtype of call.

Allowed values: 0..6

owner String

Owner of call. GET
participant_count Integer

Participant count of call.
start_time ObjectDataTime

Call sessions start time. It can be null.
duration String

Call sessions duration in Unix timestamp.
end_time String

Call sessions end time. It can be null.
term_reason Integer

Call termination reason.

  • 0 - unknown
  • 1 - all participants declined invitation
  • 2 - all participants left conference
  • 3 - conference was deleted
  • 4 - all participants declined invitation
  • 5 - ended according to schedule
  • 6 - server restarted
  • 10 - conference was ended by moderator
  • 15 - conference was ended by administrator
 
{
    "conference_id": "00000073@server.name#vcs",
    "named_conf_id": "1228671295",
    "topic": "312e12d12",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "owner": "23d23d23@server.name",
    "participant_count": 1,
    "start_time": {
        "date": "2018-04-11 15:17:43.649296",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "duration": 415,
    "end_time": {
        "date": "2018-04-11 15:24:39.122834",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "term_reason": 2
}

Objects | Call

Call log object.
The object can contain information from ObjectConference.

object 
Call

Structure

Field Type Description
conference_id String

Identifier of call session.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
class Integer

Class of call.

Allowed values: 1, 10, 11, 12

type Integer

Type of call.

Allowed values: 0, 1, 5, 6

subtype Integer

Subtype of call.

Allowed values: 0..6

owner String

Owner of call. GET
participant_count Integer

Participant count of call.
start_time ObjectDataTime

Call sessions start time. It can be null.
duration String

Call sessions duration in Unix timestamp.
end_time String

Call sessions end time. It can be null.
term_reason Integer

Call termination reason.

  • 0 - unknown
  • 1 - all participants declined invitation
  • 2 - all participants left conference
  • 3 - conference was deleted
  • 4 - all participants declined invitation
  • 5 - ended according to schedule
  • 6 - server restarted
  • 10 - conference was ended by moderator
  • 15 - conference was ended by administrator
 
{
    "conference_id": "00000073@server.name#vcs",
    "named_conf_id": "1228671295",
    "topic": "312e12d12",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "owner": "23d23d23@server.name",
    "participant_count": 1,
    "start_time": {
        "date": "2018-04-11 15:17:43.649296",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "duration": 415,
    "end_time": {
        "date": "2018-04-11 15:24:39.122834",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "term_reason": 2
}

Objects | Call

Call log object.
The object can contain information from ObjectConference.

object 
Call

Structure

Field Type Description
conference_id String

Identifier of call session.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
class Integer

Class of call.

Allowed values: 1, 10, 11, 12

type Integer

Type of call.

Allowed values: 0, 1, 5, 6

subtype Integer

Subtype of call.

Allowed values: 0..6

owner String

Owner of call. GET
participant_count Integer

Participant count of call.
start_time ObjectDataTime

Call sessions start time. It can be null.
duration String

Call sessions duration in Unix timestamp.
end_time String

Call sessions end time. It can be null.

 
{
    "conference_id": "00000073@server.name#vcs",
    "named_conf_id": "1228671295",
    "topic": "312e12d12",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "owner": "23d23d23@server.name",
    "participant_count": 1,
    "start_time": {
        "date": "2018-04-11 15:17:43.649296",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "duration": 415,
    "end_time": {
        "date": "2018-04-11 15:24:39.122834",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}

Objects | Call

Call log object.
The object can contain information from ObjectConference.

object 
Call

Structure

Field Type Description
conference_id String

Identifier of call session.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
class Integer

Class of call.

Allowed values: 1, 10, 11, 12

type Integer

Type of call.

Allowed values: 0, 1, 5, 6

subtype Integer

Subtype of call.

Allowed values: 0..6

owner String

Owner of call. GET
participant_count Integer

Participant count of call.
start_time ObjectDataTime

Call sessions start time. It can be null.
duration String

Call sessions duration in Unix timestamp.
end_time String

Call sessions end time. It can be null.

 
{
    "conference_id": "00000073@server.name#vcs",
    "named_conf_id": "1228671295",
    "topic": "312e12d12",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "owner": "23d23d23@server.name",
    "participant_count": 1,
    "start_time": {
        "date": "2018-04-11 15:17:43.649296",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "duration": 415,
    "end_time": {
        "date": "2018-04-11 15:24:39.122834",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}

Objects | Call

Call log object.
The object can contain information from ObjectConference.

object 
Call

Structure

Field Type Description
conference_id String

Identifier of call session.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
class Integer

Class of call.

Allowed values: 1, 10, 11, 12

type Integer

Type of call.

Allowed values: 0, 1, 5, 6

subtype Integer

Subtype of call.

Allowed values: 0..6

owner String

Owner of call. GET
participant_count Integer

Participant count of call.
start_time ObjectDataTime

Call sessions start time. It can be null.
duration String

Call sessions duration in Unix timestamp.
end_time String

Call sessions end time. It can be null.

 
{
    "conference_id": "00000073@server.name#vcs",
    "named_conf_id": "1228671295",
    "topic": "312e12d12",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "owner": "23d23d23@server.name",
    "participant_count": 1,
    "start_time": {
        "date": "2018-04-11 15:17:43.649296",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "duration": 415,
    "end_time": {
        "date": "2018-04-11 15:24:39.122834",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}

Objects | Call

Call log object.
The object can contain information from ObjectConference.

object 
Call

Structure

Field Type Description
conference_id String

Identifier of call session.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
class Integer

Class of call.

Allowed values: 1, 10, 11, 12

type Integer

Type of call.

Allowed values: 0, 1, 5, 6

subtype Integer

Subtype of call.

Allowed values: 0..6

owner String

Owner of call. GET
participant_count Integer

Participant count of call.
start_time ObjectDataTime

Call sessions start time. It can be null.
duration String

Call sessions duration in Unix timestamp.
end_time String

Call sessions end time. It can be null.

 
{
    "conference_id": "00000073@server.name#vcs",
    "named_conf_id": "1228671295",
    "topic": "312e12d12",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "owner": "23d23d23@server.name",
    "participant_count": 1,
    "start_time": {
        "date": "2018-04-11 15:17:43.649296",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "duration": 415,
    "end_time": {
        "date": "2018-04-11 15:24:39.122834",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}

Objects | Call

Call log object.
The object can contain information from ObjectConference.

object 
Call

Structure

Field Type Description
conference_id String

Identifier of call session.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
class Integer

Class of call.

Allowed values: 1, 10, 11, 12

type Integer

Type of call.

Allowed values: 0, 1, 5, 6

subtype Integer

Subtype of call.

Allowed values: 0..6

owner String

Owner of call. GET
participant_count Integer

Participant count of call.
start_time ObjectDataTime

Call sessions start time. It can be null.
duration String

Call sessions duration in Unix timestamp.
end_time String

Call sessions end time. It can be null.

 
{
    "conference_id": "00000073@server.name#vcs",
    "named_conf_id": "1228671295",
    "topic": "312e12d12",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "owner": "23d23d23@server.name",
    "participant_count": 1,
    "start_time": {
        "date": "2018-04-11 15:17:43.649296",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "duration": 415,
    "end_time": {
        "date": "2018-04-11 15:24:39.122834",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}

Objects | Call

Call log object.
The object can contain information from ObjectConference.

object 
Call

Structure

Field Type Description
conference_id String

Identifier of call session.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
class Integer

Class of call.

Allowed values: 1, 10, 11, 12

type Integer

Type of call.

Allowed values: 0, 1, 5, 6

subtype Integer

Subtype of call.

Allowed values: 0..6

owner String

Owner of call. GET
participant_count Integer

Participant count of call.
start_time ObjectDataTime

Call sessions start time. It can be null.
duration String

Call sessions duration in Unix timestamp.
end_time String

Call sessions end time. It can be null.

 
{
    "conference_id": "00000073@server.name#vcs",
    "named_conf_id": "1228671295",
    "topic": "312e12d12",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "owner": "23d23d23@server.name",
    "participant_count": 1,
    "start_time": {
        "date": "2018-04-11 15:17:43.649296",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "duration": 415,
    "end_time": {
        "date": "2018-04-11 15:24:39.122834",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}

Objects | Call

Call log object.
The object can contain information from ObjectConference.

object 
Call

Structure

Field Type Description
conference_id String

Identifier of call session.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
class Integer

Class of call.

Allowed values: 1, 10, 11, 12

type Integer

Type of call.

Allowed values: 0, 1, 5, 6

subtype Integer

Subtype of call.

Allowed values: 0..6

owner String

Owner of call. GET
participant_count Integer

Participant count of call.
start_time ObjectDataTime

Call sessions start time. It can be null.
duration String

Call sessions duration in Unix timestamp.
end_time String

Call sessions end time. It can be null.

 
{
    "conference_id": "00000073@server.name#vcs",
    "named_conf_id": "1228671295",
    "topic": "312e12d12",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "owner": "23d23d23@server.name",
    "participant_count": 1,
    "start_time": {
        "date": "2018-04-11 15:17:43.649296",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "duration": 415,
    "end_time": {
        "date": "2018-04-11 15:24:39.122834",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}

Objects | Call

Call log object.
The object can contain information from ObjectConference.

object 
Call

Structure

Field Type Description
conference_id String

Identifier of call session.
named_conf_id String

Identifier of conference. It can be null. GET
topic String

Topic of conference. It can be null.
class Integer

Class of call.

Allowed values: 1, 10, 11, 12

type Integer

Type of call.

Allowed values: 0, 1, 5, 6

subtype Integer

Subtype of call.

Allowed values: 0..6

owner String

Owner of call. GET
participant_count Integer

Participant count of call.
start_time ObjectDataTime

Call sessions start time. It can be null.
duration String

Call sessions duration in Unix timestamp.
end_time String

Call sessions end time. It can be null.

 
{
    "conference_id": "00000073@server.name#vcs",
    "named_conf_id": "1228671295",
    "topic": "312e12d12",
    "class": 10,
    "type": 5,
    "subtype": 0,
    "owner": "23d23d23@server.name",
    "participant_count": 1,
    "start_time": {
        "date": "2018-04-11 15:17:43.649296",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "duration": 415,
    "end_time": {
        "date": "2018-04-11 15:24:39.122834",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}

Objects | Chat message

Chat message log object.

object 
Message

Structure

Field Type Description
id String

Identifier of message.
time_stamp ObjectDataTime

Time of message sending.
conference_id String

Call sessions identifier.
from_call_id String

Identifier of message sender.
from_display_name String

Display name of message sender.
to_call_id String

Identifier of message recipient.
is_offline Boolean

Flag signaling the absence of a user on the network.
message String

Message text.

 
{
    "call_id": "1@server.name",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Chat message

Chat message log object.

object 
Message

Structure

Field Type Description
id String

Identifier of message.
time_stamp ObjectDataTime

Time of message sending.
conference_id String

Call sessions identifier.
from_call_id String

Identifier of message sender.
from_display_name String

Display name of message sender.
to_call_id String

Identifier of message recipient.
is_offline Boolean

Flag signaling the absence of a user on the network.
message String

Message text.

 
{
    "call_id": "1@server.name",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Chat message

Chat message log object.

object 
Message

Structure

Field Type Description
id String

Identifier of message.
time_stamp ObjectDataTime

Time of message sending.
conference_id String

Call sessions identifier.
from_call_id String

Identifier of message sender.
from_display_name String

Display name of message sender.
to_call_id String

Identifier of message recipient.
is_offline Boolean

Flag signaling the absence of a user on the network.
message String

Message text.

 
{
    "call_id": "1@server.name",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Chat message

Chat message log object.

object 
Message

Structure

Field Type Description
id String

Identifier of message.
time_stamp ObjectDataTime

Time of message sending.
conference_id String

Call sessions identifier.
from_call_id String

Identifier of message sender.
from_display_name String

Display name of message sender.
to_call_id String

Identifier of message recipient.
is_offline Boolean

Flag signaling the absence of a user on the network.
message String

Message text.

 
{
    "call_id": "1@server.name",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Chat message

Chat message log object.

object 
Message

Structure

Field Type Description
id String

Identifier of message.
time_stamp ObjectDataTime

Time of message sending.
conference_id String

Call sessions identifier.
from_call_id String

Identifier of message sender.
from_display_name String

Display name of message sender.
to_call_id String

Identifier of message recipient.
is_offline Boolean

Flag signaling the absence of a user on the network.
message String

Message text.

 
{
    "call_id": "1@server.name",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Chat message

Chat message log object.

object 
Message

Structure

Field Type Description
id String

Identifier of message.
time_stamp ObjectDataTime

Time of message sending.
conference_id String

Call sessions identifier.
from_call_id String

Identifier of message sender.
from_display_name String

Display name of message sender.
to_call_id String

Identifier of message recipient.
is_offline Boolean

Flag signaling the absence of a user on the network.
message String

Message text.

 
{
    "call_id": "1@server.name",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Chat message

Chat message log object.

object 
Message

Structure

Field Type Description
id String

Identifier of message.
time_stamp ObjectDataTime

Time of message sending.
conference_id String

Call sessions identifier.
from_call_id String

Identifier of message sender.
from_display_name String

Display name of message sender.
to_call_id String

Identifier of message recipient.
is_offline Boolean

Flag signaling the absence of a user on the network.
message String

Message text.

 
{
    "call_id": "1@server.name",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Chat message

Chat message log object.

object 
Message

Structure

Field Type Description
id String

Identifier of message.
time_stamp ObjectDataTime

Time of message sending.
conference_id String

Call sessions identifier.
from_call_id String

Identifier of message sender.
from_display_name String

Display name of message sender.
to_call_id String

Identifier of message recipient.
is_offline Boolean

Flag signaling the absence of a user on the network.
message String

Message text.

 
{
    "call_id": "1@server.name",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Chat message

Chat message log object.

object 
Message

Structure

Field Type Description
id String

Identifier of message.
time_stamp ObjectDataTime

Time of message sending.
conference_id String

Call sessions identifier.
from_call_id String

Identifier of message sender.
from_display_name String

Display name of message sender.
to_call_id String

Identifier of message recipient.
is_offline Boolean

Flag signaling the absence of a user on the network.
message String

Message text.

 
{
    "call_id": "1@server.name",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Chat message

Chat message log object.

object 
Message

Structure

Field Type Description
id String

Identifier of message.
time_stamp ObjectDataTime

Time of message sending.
conference_id String

Call sessions identifier.
from_call_id String

Identifier of message sender.
from_display_name String

Display name of message sender.
to_call_id String

Identifier of message recipient.
is_offline Boolean

Flag signaling the absence of a user on the network.
message String

Message text.

 
{
    "call_id": "1@server.name",
    "invited_call_id": "2@server.name",
    "invite_time": {
        "date": "2018-04-06 16:27:50.184141",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "is_accepted": true
}

Objects | Client rights

Client rights object

object 
ClientRights

Structure

Field Type Description
chat_send Boolean

POST | PUT A flag indicating that the client has permission to send messages to conference chat.
chat_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive messages from conference chat.
slide_show_send Boolean

POST | PUT A flag indicating that the client has permission to display slide show to other conference participants.
slide_show_rcv Boolean

POST | PUT A flag indicating that the client has permission to view slide show from other conference participants.
white_board_send Boolean

POST | PUT A flag indicating that the client has permission to edit white board of conference.
white_board_rcv Boolean

POST | PUT A flag indicating that the client has permission to view white board of conference.
file_transfer_send Boolean

POST | PUT A flag indicating that the client has permission to send files to other conference participants.
file_transfer_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive from other conference participants.
desktop_sharing Boolean

POST | PUT A flag indicating that the client has permission to display desktop to other conference participants.
recording Boolean

POST | PUT A flag indicating that the client has permission to view desktop from other conference participants.
audio_send Boolean

POST | PUT A flag indicating that the client has permission to send audio to other conference participants.
audio_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive audio to other conference participants.
video_send Boolean

POST | PUT A flag indicating that the client has permission to send video to other conference participants.
video_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive video to other conference participants.

 
{
    "chat_send": false,
    "chat_rcv": true,
    "slide_show_send": true,
    "slide_show_rcv": true,
    "white_board_send": true,
    "white_board_rcv": true,
    "file_transfer_send": true,
    "file_transfer_rcv": true,
    "desktop_sharing": true,
    "recording": true,
    "audio_send": true,
    "audio_rcv": true,
    "video_send": true,
    "video_rcv": true
}

Objects | Client rights

Client rights object

object 
ClientRights

Structure

Field Type Description
chat_send Boolean

POST | PUT A flag indicating that the client has permission to send messages to conference chat.
chat_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive messages from conference chat.
slide_show_send Boolean

POST | PUT A flag indicating that the client has permission to display slide show to other conference participants.
slide_show_rcv Boolean

POST | PUT A flag indicating that the client has permission to view slide show from other conference participants.
white_board_send Boolean

POST | PUT A flag indicating that the client has permission to edit white board of conference.
white_board_rcv Boolean

POST | PUT A flag indicating that the client has permission to view white board of conference.
file_transfer_send Boolean

POST | PUT A flag indicating that the client has permission to send files to other conference participants.
file_transfer_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive from other conference participants.
desktop_sharing Boolean

POST | PUT A flag indicating that the client has permission to display desktop to other conference participants.
recording Boolean

POST | PUT A flag indicating that the client has permission to view desktop from other conference participants.
audio_send Boolean

POST | PUT A flag indicating that the client has permission to send audio to other conference participants.
audio_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive audio to other conference participants.
video_send Boolean

POST | PUT A flag indicating that the client has permission to send video to other conference participants.
video_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive video to other conference participants.

 
{
    "chat_send": false,
    "chat_rcv": true,
    "slide_show_send": true,
    "slide_show_rcv": true,
    "white_board_send": true,
    "white_board_rcv": true,
    "file_transfer_send": true,
    "file_transfer_rcv": true,
    "desktop_sharing": true,
    "recording": true,
    "audio_send": true,
    "audio_rcv": true,
    "video_send": true,
    "video_rcv": true
}

Objects | Client rights

Client rights object

object 
ClientRights

Structure

Field Type Description
chat_send Boolean

POST | PUT A flag indicating that the client has permission to send messages to conference chat.
chat_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive messages from conference chat.
slide_show_send Boolean

POST | PUT A flag indicating that the client has permission to display slide show to other conference participants.
slide_show_rcv Boolean

POST | PUT A flag indicating that the client has permission to view slide show from other conference participants.
white_board_send Boolean

POST | PUT A flag indicating that the client has permission to edit white board of conference.
white_board_rcv Boolean

POST | PUT A flag indicating that the client has permission to view white board of conference.
file_transfer_send Boolean

POST | PUT A flag indicating that the client has permission to send files to other conference participants.
file_transfer_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive from other conference participants.
desktop_sharing Boolean

POST | PUT A flag indicating that the client has permission to display desktop to other conference participants.
recording Boolean

POST | PUT A flag indicating that the client has permission to view desktop from other conference participants.
audio_send Boolean

POST | PUT A flag indicating that the client has permission to send audio to other conference participants.
audio_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive audio to other conference participants.
video_send Boolean

POST | PUT A flag indicating that the client has permission to send video to other conference participants.
video_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive video to other conference participants.

 
{
    "chat_send": false,
    "chat_rcv": true,
    "slide_show_send": true,
    "slide_show_rcv": true,
    "white_board_send": true,
    "white_board_rcv": true,
    "file_transfer_send": true,
    "file_transfer_rcv": true,
    "desktop_sharing": true,
    "recording": true,
    "audio_send": true,
    "audio_rcv": true,
    "video_send": true,
    "video_rcv": true
}

Objects | Client rights

Client rights object

object 
ClientRights

Structure

Field Type Description
chat_send Boolean

POST | PUT A flag indicating that the client has permission to send messages to conference chat.
chat_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive messages from conference chat.
slide_show_send Boolean

POST | PUT A flag indicating that the client has permission to display slide show to other conference participants.
slide_show_rcv Boolean

POST | PUT A flag indicating that the client has permission to view slide show from other conference participants.
white_board_send Boolean

POST | PUT A flag indicating that the client has permission to edit white board of conference.
white_board_rcv Boolean

POST | PUT A flag indicating that the client has permission to view white board of conference.
file_transfer_send Boolean

POST | PUT A flag indicating that the client has permission to send files to other conference participants.
file_transfer_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive from other conference participants.
desktop_sharing Boolean

POST | PUT A flag indicating that the client has permission to display desktop to other conference participants.
recording Boolean

POST | PUT A flag indicating that the client has permission to view desktop from other conference participants.
audio_send Boolean

POST | PUT A flag indicating that the client has permission to send audio to other conference participants.
audio_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive audio to other conference participants.
video_send Boolean

POST | PUT A flag indicating that the client has permission to send video to other conference participants.
video_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive video to other conference participants.

 
{
    "chat_send": false,
    "chat_rcv": true,
    "slide_show_send": true,
    "slide_show_rcv": true,
    "white_board_send": true,
    "white_board_rcv": true,
    "file_transfer_send": true,
    "file_transfer_rcv": true,
    "desktop_sharing": true,
    "recording": true,
    "audio_send": true,
    "audio_rcv": true,
    "video_send": true,
    "video_rcv": true
}

Objects | Client rights

Client rights object

object 
ClientRights

Structure

Field Type Description
chat_send Boolean

POST | PUT A flag indicating that the client has permission to send messages to conference chat.
chat_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive messages from conference chat.
slide_show_send Boolean

POST | PUT A flag indicating that the client has permission to display slide show to other conference participants.
slide_show_rcv Boolean

POST | PUT A flag indicating that the client has permission to view slide show from other conference participants.
white_board_send Boolean

POST | PUT A flag indicating that the client has permission to edit white board of conference.
white_board_rcv Boolean

POST | PUT A flag indicating that the client has permission to view white board of conference.
file_transfer_send Boolean

POST | PUT A flag indicating that the client has permission to send files to other conference participants.
file_transfer_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive from other conference participants.
desktop_sharing Boolean

POST | PUT A flag indicating that the client has permission to display desktop to other conference participants.
recording Boolean

POST | PUT A flag indicating that the client has permission to view desktop from other conference participants.
audio_send Boolean

POST | PUT A flag indicating that the client has permission to send audio to other conference participants.
audio_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive audio to other conference participants.
video_send Boolean

POST | PUT A flag indicating that the client has permission to send video to other conference participants.
video_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive video to other conference participants.

 
{
    "chat_send": false,
    "chat_rcv": true,
    "slide_show_send": true,
    "slide_show_rcv": true,
    "white_board_send": true,
    "white_board_rcv": true,
    "file_transfer_send": true,
    "file_transfer_rcv": true,
    "desktop_sharing": true,
    "recording": true,
    "audio_send": true,
    "audio_rcv": true,
    "video_send": true,
    "video_rcv": true
}

Objects | Client rights

Client rights object

object 
ClientRights

Structure

Field Type Description
chat_send Boolean

POST | PUT A flag indicating that the client has permission to send messages to conference chat.
chat_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive messages from conference chat.
slide_show_send Boolean

POST | PUT A flag indicating that the client has permission to display slide show to other conference participants.
slide_show_rcv Boolean

POST | PUT A flag indicating that the client has permission to view slide show from other conference participants.
white_board_send Boolean

POST | PUT A flag indicating that the client has permission to edit white board of conference.
white_board_rcv Boolean

POST | PUT A flag indicating that the client has permission to view white board of conference.
file_transfer_send Boolean

POST | PUT A flag indicating that the client has permission to send files to other conference participants.
file_transfer_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive from other conference participants.
desktop_sharing Boolean

POST | PUT A flag indicating that the client has permission to display desktop to other conference participants.
recording Boolean

POST | PUT A flag indicating that the client has permission to view desktop from other conference participants.
audio_send Boolean

POST | PUT A flag indicating that the client has permission to send audio to other conference participants.
audio_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive audio to other conference participants.
video_send Boolean

POST | PUT A flag indicating that the client has permission to send video to other conference participants.
video_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive video to other conference participants.

 
{
    "chat_send": false,
    "chat_rcv": true,
    "slide_show_send": true,
    "slide_show_rcv": true,
    "white_board_send": true,
    "white_board_rcv": true,
    "file_transfer_send": true,
    "file_transfer_rcv": true,
    "desktop_sharing": true,
    "recording": true,
    "audio_send": true,
    "audio_rcv": true,
    "video_send": true,
    "video_rcv": true
}

Objects | Client rights

Client rights object

object 
ClientRights

Structure

Field Type Description
chat_send Boolean

POST | PUT A flag indicating that the client has permission to send messages to conference chat.
chat_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive messages from conference chat.
slide_show_send Boolean

POST | PUT A flag indicating that the client has permission to display slide show to other conference participants.
slide_show_rcv Boolean

POST | PUT A flag indicating that the client has permission to view slide show from other conference participants.
white_board_send Boolean

POST | PUT A flag indicating that the client has permission to edit white board of conference.
white_board_rcv Boolean

POST | PUT A flag indicating that the client has permission to view white board of conference.
file_transfer_send Boolean

POST | PUT A flag indicating that the client has permission to send files to other conference participants.
file_transfer_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive from other conference participants.
desktop_sharing Boolean

POST | PUT A flag indicating that the client has permission to display desktop to other conference participants.
recording Boolean

POST | PUT A flag indicating that the client has permission to view desktop from other conference participants.
audio_send Boolean

POST | PUT A flag indicating that the client has permission to send audio to other conference participants.
audio_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive audio to other conference participants.
video_send Boolean

POST | PUT A flag indicating that the client has permission to send video to other conference participants.
video_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive video to other conference participants.

 
{
    "chat_send": false,
    "chat_rcv": true,
    "slide_show_send": true,
    "slide_show_rcv": true,
    "white_board_send": true,
    "white_board_rcv": true,
    "file_transfer_send": true,
    "file_transfer_rcv": true,
    "desktop_sharing": true,
    "recording": true,
    "audio_send": true,
    "audio_rcv": true,
    "video_send": true,
    "video_rcv": true
}

Objects | Client rights

Client rights object

object 
ClientRights

Structure

Field Type Description
chat_send Boolean

POST | PUT A flag indicating that the client has permission to send messages to conference chat.
chat_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive messages from conference chat.
slide_show_send Boolean

POST | PUT A flag indicating that the client has permission to display slide show to other conference participants.
slide_show_rcv Boolean

POST | PUT A flag indicating that the client has permission to view slide show from other conference participants.
white_board_send Boolean

POST | PUT A flag indicating that the client has permission to edit white board of conference.
white_board_rcv Boolean

POST | PUT A flag indicating that the client has permission to view white board of conference.
file_transfer_send Boolean

POST | PUT A flag indicating that the client has permission to send files to other conference participants.
file_transfer_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive from other conference participants.
desktop_sharing Boolean

POST | PUT A flag indicating that the client has permission to display desktop to other conference participants.
recording Boolean

POST | PUT A flag indicating that the client has permission to view desktop from other conference participants.
audio_send Boolean

POST | PUT A flag indicating that the client has permission to send audio to other conference participants.
audio_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive audio to other conference participants.
video_send Boolean

POST | PUT A flag indicating that the client has permission to send video to other conference participants.
video_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive video to other conference participants.

 
{
    "chat_send": false,
    "chat_rcv": true,
    "slide_show_send": true,
    "slide_show_rcv": true,
    "white_board_send": true,
    "white_board_rcv": true,
    "file_transfer_send": true,
    "file_transfer_rcv": true,
    "desktop_sharing": true,
    "recording": true,
    "audio_send": true,
    "audio_rcv": true,
    "video_send": true,
    "video_rcv": true
}

Objects | Client rights

Client rights object

object 
ClientRights

Structure

Field Type Description
chat_send Boolean

POST | PUT A flag indicating that the client has permission to send messages to conference chat.
chat_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive messages from conference chat.
slide_show_send Boolean

POST | PUT A flag indicating that the client has permission to display slide show to other conference participants.
slide_show_rcv Boolean

POST | PUT A flag indicating that the client has permission to view slide show from other conference participants.
white_board_send Boolean

POST | PUT A flag indicating that the client has permission to edit white board of conference.
white_board_rcv Boolean

POST | PUT A flag indicating that the client has permission to view white board of conference.
file_transfer_send Boolean

POST | PUT A flag indicating that the client has permission to send files to other conference participants.
file_transfer_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive from other conference participants.
desktop_sharing Boolean

POST | PUT A flag indicating that the client has permission to display desktop to other conference participants.
recording Boolean

POST | PUT A flag indicating that the client has permission to view desktop from other conference participants.
audio_send Boolean

POST | PUT A flag indicating that the client has permission to send audio to other conference participants.
audio_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive audio to other conference participants.
video_send Boolean

POST | PUT A flag indicating that the client has permission to send video to other conference participants.
video_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive video to other conference participants.

 
{
    "chat_send": false,
    "chat_rcv": true,
    "slide_show_send": true,
    "slide_show_rcv": true,
    "white_board_send": true,
    "white_board_rcv": true,
    "file_transfer_send": true,
    "file_transfer_rcv": true,
    "desktop_sharing": true,
    "recording": true,
    "audio_send": true,
    "audio_rcv": true,
    "video_send": true,
    "video_rcv": true
}

Objects | Client rights

Client rights object

object 
ClientRights

Structure

Field Type Description
chat_send Boolean

POST | PUT A flag indicating that the client has permission to send messages to conference chat.
chat_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive messages from conference chat.
slide_show_send Boolean

POST | PUT A flag indicating that the client has permission to display slide show to other conference participants.
slide_show_rcv Boolean

POST | PUT A flag indicating that the client has permission to view slide show from other conference participants.
white_board_send Boolean

POST | PUT A flag indicating that the client has permission to edit white board of conference.
white_board_rcv Boolean

POST | PUT A flag indicating that the client has permission to view white board of conference.
file_transfer_send Boolean

POST | PUT A flag indicating that the client has permission to send files to other conference participants.
file_transfer_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive from other conference participants.
desktop_sharing Boolean

POST | PUT A flag indicating that the client has permission to display desktop to other conference participants.
recording Boolean

POST | PUT A flag indicating that the client has permission to view desktop from other conference participants.
audio_send Boolean

POST | PUT A flag indicating that the client has permission to send audio to other conference participants.
audio_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive audio to other conference participants.
video_send Boolean

POST | PUT A flag indicating that the client has permission to send video to other conference participants.
video_rcv Boolean

POST | PUT A flag indicating that the client has permission to receive video to other conference participants.

 
{
    "chat_send": false,
    "chat_rcv": true,
    "slide_show_send": true,
    "slide_show_rcv": true,
    "white_board_send": true,
    "white_board_rcv": true,
    "file_transfer_send": true,
    "file_transfer_rcv": true,
    "desktop_sharing": true,
    "recording": true,
    "audio_send": true,
    "audio_rcv": true,
    "video_send": true,
    "video_rcv": true
}

Objects | Conference Participant Restrictions Settings

Conference participant restrictions settings object.

object 
ConferenceParticipantRestrictionsSettings

Structure

Field Type Description
use_local_stream_config Boolean

Use the conference participant restrictions config instead of the global config.
video_quality String

Video quality.

Allowed values: "180p", "360p", "540p", "720p", "1080p"

framerate_video_limit Integer

Max framerate (video).

Allowed values: 10, 15, 30, 60

framerate_ds_limit Integer

Max framerate (content display).

Allowed values: 1, 3, 5, 10, 15, 30, 60 

{
     "use_local_stream_config": true,
     "video_quality": "720p",
     "framerate_video_limit": 15,
     "framerate_ds_limit": 15,
}

Objects | Conference Session Participant

Conference session participant object.
Both server users and guests can be conference participants.
The object can contain information from ObjectUser.

object 
ConferenceSessionParticipant

Structure

Field Type Description
participant_id String

Unique id of the conference session participant.

call_id String

Identifier of call participant.
display_name String

Display name of call participant.
join_time ObjectDataTime

Conference session participant join time. It can be null.
role Integer

Role of a participant.

  • -1 - unknown
  • 0 - regular user of an "all-on-screen" conference
  • 1 - role-based conference listener
  • 2 - conference host
  • 3, 4 - podium speaker
  • 5 - listener who sends audio without video
 
{
     "participant_id": "user@server.name",
     "call_id": "user@server.name",
     "display_name": "user123",
     "join_time": {
         "date": "2020-11-11 15:34:22.155004",
         "timezone_type": 3,
         "timezone": "Europe/London"
     }
     "role": 2
}

Objects | Conference Session Participant

Conference session participant object.
Both server users and guests can be conference participants.
The object can contain information from ObjectUser.

object 
ConferenceSessionParticipant

Structure

Field Type Description
participant_id String

Unique id of the conference session participant.

call_id String

Identifier of call participant.
display_name String

Display name of call participant.
join_time ObjectDataTime

Conference session participant join time. It can be null.
role Integer

Role of a participant.

  • -1 - unknown
  • 0 - regular user of an "all-on-screen" conference
  • 1 - role-based conference listener
  • 2 - conference host
  • 3, 4 - podium speaker
  • 5 - listener who sends audio without video
 
{
     "participant_id": "user@server.name",
     "call_id": "user@server.name",
     "display_name": "user123",
     "join_time": {
         "date": "2020-11-11 15:34:22.155004",
         "timezone_type": 3,
         "timezone": "Europe/London"
     }
     "role": 2
}

Objects | Conference Session Participant

Conference session participant object.
Both server users and guests can be conference participants.
The object can contain information from ObjectUser.

object 
ConferenceSessionParticipant

Structure

Field Type Description
participant_id String

Unique id of the conference session participant.

call_id String

Identifier of call participant.
display_name String

Display name of call participant.
join_time ObjectDataTime

Conference session participant join time. It can be null.
role Integer

Role of a participant.

  • -1 - unknown
  • 0 - regular user of an "all-on-screen" conference
  • 1 - role-based conference listener
  • 2 - conference host
  • 3, 4 - podium speaker
  • 5 - listener who sends audio without video
 
{
     "participant_id": "user@server.name",
     "call_id": "user@server.name",
     "display_name": "user123",
     "join_time": {
         "date": "2020-11-11 15:34:22.155004",
         "timezone_type": 3,
         "timezone": "Europe/London"
     }
     "role": 2
}

Objects | Conference Session Participant

Conference session participant object.
Both server users and guests can be conference participants.
The object can contain information from ObjectUser.

object 
ConferenceSessionParticipant

Structure

Field Type Description
participant_id String

Unique id of the conference session participant.

call_id String

Identifier of call participant.
display_name String

Display name of call participant.
join_time ObjectDataTime

Conference session participant join time. It can be null.
role Integer

Role of a participant.

  • -1 - unknown
  • 0 - regular user of an "all-on-screen" conference
  • 1 - role-based conference listener
  • 2 - conference host
  • 3, 4 - podium speaker
  • 5 - listener who sends audio without video
 
{
     "participant_id": "user@server.name",
     "call_id": "user@server.name",
     "display_name": "user123",
     "join_time": {
         "date": "2020-11-11 15:34:22.155004",
         "timezone_type": 3,
         "timezone": "Europe/London"
     }
     "role": 2
}

Objects | Conference Session Participant

Conference session participant object.
Both server users and guests can be conference participants.
The object can contain information from ObjectUser.

object 
ConferenceSessionParticipant

Structure

Field Type Description
participant_id String

Unique id of the conference session participant.

call_id String

Identifier of call participant.
display_name String

Display name of call participant.
join_time ObjectDataTime

Conference session participant join time. It can be null.
role Integer

Role of a participant.

  • -1 - unknown
  • 0 - regular user of an "all-on-screen" conference
  • 1 - role-based conference listener
  • 2 - conference host
  • 3, 4 - podium speaker
  • 5 - listener who sends audio without video
 
{
     "participant_id": "user@server.name",
     "call_id": "user@server.name",
     "display_name": "user123",
     "join_time": {
         "date": "2020-11-11 15:34:22.155004",
         "timezone_type": 3,
         "timezone": "Europe/London"
     }
     "role": 2
}

Objects | Conference Session Participant

Conference session participant object.
Both server users and guests can be conference participants.
The object can contain information from ObjectUser.

object 
ConferenceSessionParticipant

Structure

Field Type Description
participant_id String

Unique id of the conference session participant.

call_id String

Identifier of call participant.
display_name String

Display name of call participant.
join_time ObjectDataTime

Conference session participant join time. It can be null.
role Integer

Role of a participant.

  • -1 - unknown
  • 0 - regular user of an "all-on-screen" conference
  • 1 - role-based conference listener
  • 2 - conference host
  • 3, 4 - podium speaker
  • 5 - listener who sends audio without video
 
{
     "participant_id": "user@server.name",
     "call_id": "user@server.name",
     "display_name": "user123",
     "join_time": {
         "date": "2020-11-11 15:34:22.155004",
         "timezone_type": 3,
         "timezone": "Europe/London"
     }
     "role": 2
}

Objects | Conference Session Participant

Conference session participant object.
Both server users and guests can be conference participants.
The object can contain information from ObjectUser.

object 
ConferenceSessionParticipant

Structure

Field Type Description
participant_id String

Unique id of the conference session participant.

call_id String

Identifier of call participant.
display_name String

Display name of call participant.
join_time ObjectDataTime

Conference session participant join time. It can be null.
role Integer

Role of a participant.

  • -1 - unknown
  • 0 - regular user of an "all-on-screen" conference
  • 1 - role-based conference listener
  • 2 - conference host
  • 3, 4 - podium speaker
  • 5 - listener who sends audio without video
 
{
     "participant_id": "user@server.name",
     "call_id": "user@server.name",
     "display_name": "user123",
     "join_time": {
         "date": "2020-11-11 15:34:22.155004",
         "timezone_type": 3,
         "timezone": "Europe/London"
     }
     "role": 2
}

Objects | Conference Session Participant

Conference session participant object.
Both server users and guests can be conference participants.
The object can contain information from ObjectUser.

object 
ConferenceSessionParticipant

Structure

Field Type Description
participant_id String

Unique id of the conference session participant.

call_id String

Identifier of call participant.
display_name String

Display name of call participant.
join_time ObjectDataTime

Conference session participant join time. It can be null.
role Integer

Role of a participant.

  • -1 - unknown
  • 0 - regular user of an "all-on-screen" conference
  • 1 - role-based conference listener
  • 2 - conference host
  • 3, 4 - podium speaker
  • 5 - listener who sends audio without video
 
{
     "participant_id": "user@server.name",
     "call_id": "user@server.name",
     "display_name": "user123",
     "join_time": {
         "date": "2020-11-11 15:34:22.155004",
         "timezone_type": 3,
         "timezone": "Europe/London"
     }
     "role": 2
}

Objects | Conference session

Conference session object.

object 
ConferenceSession

Structure

Field Type Description
stream_id String

Conference session identifier.
conference_id String

Unique conference identifier.

Size range: 1..128
type Integer

Conference session type.

  • 0 — Point-to-point
  • 5 — Group conference (TCP)
  • 6 — Group conference (UDP)
mode Integer

Conference session mode.

  • 0 — All-on-screen
  • 1 — Video lecture
  • 3 — Role-based
GET
topic String

Conference subject. GET

Size range: 1..240
owner String

User identifier (user_id) of the conference owner. GET

Size range: 1..64
start_time Integer

Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected. GET

 
{
    "stream_id": "00000011ce5d6b56@example.trueconf.name#vcs",
    "conference_id": "0996007257",
    "type": 5,
    "mode": 0,
    "topic": "conf",
    "owner": "user@example.trueconf.name",
    "start_time": 1605108860
}

Objects | Conference session

Conference session object.

object 
ConferenceSession

Structure

Field Type Description
stream_id String

Conference session identifier.
conference_id String

Unique conference identifier.

Size range: 1..128
type Integer

Conference session type.

  • 0 — Point-to-point
  • 5 — Group conference (TCP)
  • 6 — Group conference (UDP)
mode Integer

Conference session mode.

  • 0 — All-on-screen
  • 1 — Video lecture
  • 3 — Role-based
GET
topic String

Conference subject. GET

Size range: 1..240
owner String

User identifier (user_id) of the conference owner. GET

Size range: 1..64
start_time Integer

Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected. GET

 
{
    "stream_id": "00000011ce5d6b56@example.trueconf.name#vcs",
    "conference_id": "0996007257",
    "type": 5,
    "mode": 0,
    "topic": "conf",
    "owner": "user@example.trueconf.name",
    "start_time": 1605108860
}

Objects | Conference session

Conference session object.

object 
ConferenceSession

Structure

Field Type Description
stream_id String

Conference session identifier.
conference_id String

Unique conference identifier.

Size range: 1..128
type Integer

Conference session type.

  • 0 — Point-to-point
  • 5 — Group conference (TCP)
  • 6 — Group conference (UDP)
mode Integer

Conference session mode.

  • 0 — All-on-screen
  • 1 — Video lecture
  • 3 — Role-based
GET
topic String

Conference subject. GET

Size range: 1..240
owner String

User identifier (user_id) of the conference owner. GET

Size range: 1..64
start_time Integer

Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected. GET

 
{
    "stream_id": "00000011ce5d6b56@example.trueconf.name#vcs",
    "conference_id": "0996007257",
    "type": 5,
    "mode": 0,
    "topic": "conf",
    "owner": "user@example.trueconf.name",
    "start_time": 1605108860
}

Objects | Conference session

Conference session object.

object 
ConferenceSession

Structure

Field Type Description
stream_id String

Conference session identifier.
conference_id String

Unique conference identifier.

Size range: 1..128
type Integer

Conference session type.

  • 0 — Point-to-point
  • 5 — Group conference (TCP)
  • 6 — Group conference (UDP)
mode Integer

Conference session mode.

  • 0 — All-on-screen
  • 1 — Video lecture
  • 3 — Role-based
GET
topic String

Conference subject. GET

Size range: 1..240
owner String

User identifier (user_id) of the conference owner. GET

Size range: 1..64
start_time Integer

Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected. GET

 
{
    "stream_id": "00000011ce5d6b56@example.trueconf.name#vcs",
    "conference_id": "0996007257",
    "type": 5,
    "mode": 0,
    "topic": "conf",
    "owner": "user@example.trueconf.name",
    "start_time": 1605108860
}

Objects | Conference session

Conference session object.

object 
ConferenceSession

Structure

Field Type Description
stream_id String

Conference session identifier.
conference_id String

Unique conference identifier.

Size range: 1..128
type Integer

Conference session type.

  • 0 — Point-to-point
  • 5 — Group conference (TCP)
  • 6 — Group conference (UDP)
mode Integer

Conference session mode.

  • 0 — All-on-screen
  • 1 — Video lecture
  • 3 — Role-based
GET
topic String

Conference subject. GET

Size range: 1..240
owner String

User identifier (user_id) of the conference owner. GET

Size range: 1..64
start_time Integer

Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected. GET

 
{
    "stream_id": "00000011ce5d6b56@example.trueconf.name#vcs",
    "conference_id": "0996007257",
    "type": 5,
    "mode": 0,
    "topic": "conf",
    "owner": "user@example.trueconf.name",
    "start_time": 1605108860
}

Objects | Conference session

Conference session object.

object 
ConferenceSession

Structure

Field Type Description
stream_id String

Conference session identifier.
conference_id String

Unique conference identifier.

Size range: 1..128
type Integer

Conference session type.

  • 0 — Point-to-point
  • 5 — Group conference (TCP)
  • 6 — Group conference (UDP)
mode Integer

Conference session mode.

  • 0 — All-on-screen
  • 1 — Video lecture
  • 3 — Role-based
GET
topic String

Conference subject. GET

Size range: 1..240
owner String

User identifier (user_id) of the conference owner. GET

Size range: 1..64
start_time Integer

Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected. GET

 
{
    "stream_id": "00000011ce5d6b56@example.trueconf.name#vcs",
    "conference_id": "0996007257",
    "type": 5,
    "mode": 0,
    "topic": "conf",
    "owner": "user@example.trueconf.name",
    "start_time": 1605108860
}

Objects | Conference session

Conference session object.

object 
ConferenceSession

Structure

Field Type Description
stream_id String

Conference session identifier.
conference_id String

Unique conference identifier.

Size range: 1..128
type Integer

Conference session type.

  • 0 — Point-to-point
  • 5 — Group conference (TCP)
  • 6 — Group conference (UDP)
mode Integer

Conference session mode.

  • 0 — All-on-screen
  • 1 — Video lecture
  • 3 — Role-based
GET
topic String

Conference subject. GET

Size range: 1..240
owner String

User identifier (user_id) of the conference owner. GET

Size range: 1..64
start_time Integer

Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected. GET

 
{
    "stream_id": "00000011ce5d6b56@example.trueconf.name#vcs",
    "conference_id": "0996007257",
    "type": 5,
    "mode": 0,
    "topic": "conf",
    "owner": "user@example.trueconf.name",
    "start_time": 1605108860
}

Objects | Conference session

Conference session object.

object 
ConferenceSession

Structure

Field Type Description
stream_id String

Conference session identifier.
conference_id String

Unique conference identifier.

Size range: 1..128
type Integer

Conference session type.

  • 0 — Point-to-point
  • 5 — Group conference (TCP)
  • 6 — Group conference (UDP)
mode Integer

Conference session mode.

  • 0 — All-on-screen
  • 1 — Video lecture
  • 3 — Role-based
GET
topic String

Conference subject. GET

Size range: 1..240
owner String

User identifier (user_id) of the conference owner. GET

Size range: 1..64
start_time Integer

Conference start time in Unix Timestamp. If specified value is -1, "now" will be automatically selected. GET

 
{
    "stream_id": "00000011ce5d6b56@example.trueconf.name#vcs",
    "conference_id": "0996007257",
    "type": 5,
    "mode": 0,
    "topic": "conf",
    "owner": "user@example.trueconf.name",
    "start_time": 1605108860
}

Objects | Conference template

Conference template object.

object 
ConferenceTemplate

Structure

Field Type Description
id String

Identifier of conference template.
name String

POST, PUT Name of conference template.
object ObjectConference

POST, PUT Object of conference from template.
created_at Integer

Conference template creation date in Unix Timestamp.
updated_at Integer

Conference template update date in Unix Timestamp.
creator_id String

Identifier of conference template creator.

 
{
     "id": "8b566f97",
     "name": "test",
     "created_at": 1523401234,
     "updated_at": 1523412345,
     "creator_id": null,
     "object": {ObjectConference}
 }

Objects | Conference template

Conference template object.

object 
ConferenceTemplate

Structure

Field Type Description
id String

Identifier of conference template.
name String

POST, PUT Name of conference template.
object ObjectConference

POST, PUT Object of conference from template.
created_at Integer

Conference template creation date in Unix Timestamp.
updated_at Integer

Conference template update date in Unix Timestamp.
creator_id String

Identifier of conference template creator.

 
{
     "id": "8b566f97",
     "name": "test",
     "created_at": 1523401234,
     "updated_at": 1523412345,
     "creator_id": null,
     "object": {ObjectConference}
 }

Objects | Conference template

Conference template object.

object 
ConferenceTemplate

Structure

Field Type Description
id String

Identifier of conference template.
name String

POST, PUT Name of conference template.
object ObjectConference

POST, PUT Object of conference from template.
created_at Integer

Conference template creation date in Unix Timestamp.
updated_at Integer

Conference template update date in Unix Timestamp.
creator_id String

Identifier of conference template creator.

 
{
     "id": "8b566f97",
     "name": "test",
     "created_at": 1523401234,
     "updated_at": 1523412345,
     "creator_id": null,
     "object": {ObjectConference}
 }

Objects | Conference template

Conference template object.

object 
ConferenceTemplate

Structure

Field Type Description
id String

Identifier of conference template.
name String

POST, PUT Name of conference template.
object ObjectConference

POST, PUT Object of conference from template.
created_at Integer

Conference template creation date in Unix Timestamp.
updated_at Integer

Conference template update date in Unix Timestamp.
creator_id String

Identifier of conference template creator.

 
{
     "id": "8b566f97",
     "name": "test",
     "created_at": 1523401234,
     "updated_at": 1523412345,
     "creator_id": null,
     "object": {ObjectConference}
 }

Objects | Conference template

Conference template object.

object 
ConferenceTemplate

Structure

Field Type Description
id String

Identifier of conference template.
name String

POST, PUT Name of conference template.
object ObjectConference

POST, PUT Object of conference from template.
created_at Integer

Conference template creation date in Unix Timestamp.
updated_at Integer

Conference template update date in Unix Timestamp.
creator_id String

Identifier of conference template creator.

 
{
     "id": "8b566f97",
     "name": "test",
     "created_at": 1523401234,
     "updated_at": 1523412345,
     "creator_id": null,
     "object": {ObjectConference}
 }

Objects | Conference template

Conference template object.

object 
ConferenceTemplate

Structure

Field Type Description
id String

Identifier of conference template.
name String

POST, PUT Name of conference template.
object ObjectConference

POST, PUT Object of conference from template.
created_at Integer

Conference template creation date in Unix Timestamp.
updated_at Integer

Conference template update date in Unix Timestamp.
creator_id String

Identifier of conference template creator.

 
{
     "id": "8b566f97",
     "name": "test",
     "created_at": 1523401234,
     "updated_at": 1523412345,
     "creator_id": null,
     "object": {ObjectConference}
 }

Objects | Conference template

Conference template object.

object 
ConferenceTemplate

Structure

Field Type Description
id String

Identifier of conference template.
name String

POST, PUT Name of conference template.
object ObjectConference

POST, PUT Object of conference from template.
created_at Integer

Conference template creation date in Unix Timestamp.
updated_at Integer

Conference template update date in Unix Timestamp.
creator_id String

Identifier of conference template creator.

 
{
     "id": "8b566f97",
     "name": "test",
     "created_at": 1523401234,
     "updated_at": 1523412345,
     "creator_id": null,
     "object": {ObjectConference}
 }

Objects | Conference template

Conference template object.

object 
ConferenceTemplate

Structure

Field Type Description
id String

Identifier of conference template.
name String

POST, PUT Name of conference template.
object ObjectConference

POST, PUT Object of conference from template.
created_at Integer

Conference template creation date in Unix Timestamp.
updated_at Integer

Conference template update date in Unix Timestamp.
creator_id String

Identifier of conference template creator.

 
{
     "id": "8b566f97",
     "name": "test",
     "created_at": 1523401234,
     "updated_at": 1523412345,
     "creator_id": null,
     "object": {ObjectConference}
 }

Objects | Conference template

Conference template object.

object 
ConferenceTemplate

Structure

Field Type Description
id String

Identifier of conference template.
name String

POST, PUT Name of conference template.
object ObjectConference

POST, PUT Object of conference from template.
created_at Integer

Conference template creation date in Unix Timestamp.
updated_at Integer

Conference template update date in Unix Timestamp.
creator_id String

Identifier of conference template creator.

 
{
     "id": "8b566f97",
     "name": "test",
     "created_at": 1523401234,
     "updated_at": 1523412345,
     "creator_id": null,
     "object": {ObjectConference}
 }

Objects | Conference template

Conference template object.

object 
ConferenceTemplate

Structure

Field Type Description
id String

Identifier of conference template.
name String

POST, PUT Name of conference template.
object ObjectConference

POST, PUT Object of conference from template.
created_at Integer

Conference template creation date in Unix Timestamp.
updated_at Integer

Conference template update date in Unix Timestamp.
creator_id String

Identifier of conference template creator.

 
{
     "id": "8b566f97",
     "name": "test",
     "created_at": 1523401234,
     "updated_at": 1523412345,
     "creator_id": null,
     "object": {ObjectConference}
 }

Objects | Conference Transcoding Settings

Conference transcoding settings object.

object 
ConferenceTranscodingSettings

Structure

Field Type Description
use_local_mixer_config Boolean

Use the conference transcoding config instead of the global config.
mixer_max_framerate Integer

Max framerate.

Allowed values: 10, 15, 30, 60

record_video_quality String

Video recording quality.

Allowed values: "180p", "360p", "720p", "1080p"

sip_video_quality String

SIP video quality.

Allowed values: "180p", "360p", "720p", "1080p", "540p", "QSIF", "QCIF", "QVGA", "SIF", "CIF", "VGA", "4SIF", "4CIF"

rtsp_video_quality String

RTSP video quality.

Allowed values: "180p", "360p", "720p", "1080p"

webrtc_video_quality String

WebRTC video quality.

Allowed values: "180p", "360p", "720p", "1080p"

enable_sip_layouts Boolean

Indicates whether to hide your video in the layout for H.323 and SIP devices.
enable_webrtc_layouts Boolean

Indicates whether to hide your video in the layout for WebRTC devices.
enable_vad_layouts Boolean

Automatically enlarge the video window of the active speaker.
enable_load_balancing Boolean

Use GPU to reduce the load on the central processor.

 
{
    "use_local_mixer_config": true,
    "mixer_max_framerate": 15,
    "record_video_quality": "720p",
    "sip_video_quality": "720p",
    "rtsp_video_quality": "360p",
    "webrtc_video_quality": "360p",
    "enable_sip_layouts": true,
    "enable_webrtc_layouts": true,
    "enable_vad_layouts": true,
    "enable_load_balancing": true
}

Objects | Conference

Conference object.

object 
Conference

Structure

Field Type Description
id String

POST Unique conference identifier. It can include digits, Latin characters, and underscores. The identifier will be generated automatically if it is not specified manually.

Size range: 1..128
topic String

POST | PUT Conference subject.

Size range: 1..240
description String

POST | PUT Conference description. The only field that can be edited during a conference call.
owner String

GET | POST | PUT User identifier (user_id) of the conference owner.

Size range: 1..64
type Integer

POST | PUT Conference mode. Click to learn more about available conference modes:
invitations Object[]

Invitations list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.
created_at Integer

Timestamp indicating when the conference was created.
multicast_enable Boolean

POST | PUT Indicates whether UDP Multicast is enabled for the conference.
multicast_address String

POST | PUT The multicast_address parameter specifies the multicast address utilized when UDP Multicast is enabled for the conference communication. null is used when UDP Multicast is disabled.
max_podiums Integer

The maximum number of conference speakers. The value of this parameter can be changed for “role-based” conferences. In “all-on-screen” conferences, the number of speakers equals the number of participants, while in “video lectures”, it is equal to 1.

Default value: $max_allowed
max_participants Integer

POST | PUT Maximum number of participants depends on the conference mode. Click to learn more about available conference modes:

Default value: $max_allowed
schedule Object

POST | PUT Schedule object.
allow_guests Boolean

POST | PUT Permission to invite guests to the conference. For editing you need a webinar license.

Default value: false
rights Object

POST | PUT ClientRights objects.
  guest Object

POST | PUT ClientRights object, applied to guests.
  user Object

POST | PUT ClientRights object, applied to users.
broadcast_enabled Boolean

POST | PUT Indicates whether the broadcasting preset is enabled for the conference.
broadcast_id String

POST | PUT Identifier for the broadcasting preset associated with the conference.
broadcast String

The link to PresetMini object that is associated with the conference.
allow_only_planned_participants Boolean

POST | PUT When set to true, only invited users can join the conference. This setting does not apply to public conferences (webinars).
auto_invite Integer

POST | PUT This parameter is responsible for sending automatic invitations at the conference start:

  • 0 - disabled
  • 1 - when any participant joins the conference
  • 2 - when any invited participant joins the conference

Default value: 0
url String

POST | PUT Conference page.
webclient_url String

POST | PUT Conference widget.
state String

GET | POST | PUT Conference state.

Allowed values: "running", "stopped"

tags Array

POST | PUT Conference tags for fast search.
recording Integer

POST | PUT Indicates whether conference recording should be enabled when the conference starts.

  • 0 - Recording is disabled
  • 1 - Recording is enabled

Allowed values: 0, 1

stream_recording_state Integer

Current state of the conference recording.

  • 0 - Recording is currently disabled
  • 1 - Recording is currently enabled

Allowed values: 0, 1

stream_id String

Unique identifier representing the ConferenceSession associated with the conference. It can be null, indicating that the conference is not currently running.
deeplinks Array

Array containing deeplinks for connecting to the conference through various platforms.

  • The "default" deeplink uses a TrueConf-specific scheme suitable for various platforms.
  • The "android" deeplink is designed for Android devices and uses an Android-specific intent.
connect_urls Array

Object containing various connection URLs for different protocols.

  • sip_external: URL for external SIP connections. If null, external SIP connections may not be available.
  • sip: Array of SIP URLs for internal connections. Each element represents a SIP connection option.
  • h323: Array of H.323 URLs for connections. Each element represents an H.323 connection option.
pin_enabled Boolean

Is there password for joining the conference.
pin String

POST | PUT Password for joining the conference. The value will be available only to the conference owner; otherwise, null will be returned.
meeting_room String

POST | PUT Conference meeting room. It can be null.
on_join_mute_mic Integer

POST | PUT Mute participants on entry.

Allowed values: 0, 1

on_join_mute_camera Integer

POST | PUT Stop participants’ video on entry.

Allowed values: 0, 1

registration Object

POST | PUT Registration object.
vad_selector Integer

POST | PUT Is smart meeting enabled. A smart meeting is a type of a conference where an attendee is immediately seen and heard by other users when he/she starts speaking (voice activity detection).

Allowed values: 0, 1

max_guests Integer

POST | PUT Maximum number of guest connections.

Default value: $max_allowed
participants_lock_enabled Boolean

Is the ongoing conference inaccessible to new participants.

  • if the value is null, then the conference is not currently running.
reminders_enabled Boolean

Is the conference reminders enabled. Reminder is a notification that is sent to the conference participants before (5/10/15/30 minutes/1 hour/1 day) the conference start.
reminders Object[]

List of ObjectReminder.
waiting_room_enabled Boolean

POST | PUT Is waiting room enabled.
waiting_room_scope String

POST | PUT Waiting room scope.

Default value: all

Allowed values: "all", "unplanned", "strangers", "guests"

origin_type String

Indicates the origin of the conference creation.

  • restfulapi - The conference was created using the API
  • clientapp - The conference was initiated from a client application
use_translation Boolean

POST | PUT Is synchronous translation enabled.

Default value: false
translation_flat_volume Integer

POST | PUT The volume level of the original audio track during synchronous translation.

  • If the parameter is null, the default value (30) is used.

Allowed values: 0-100

expiration_time_updating_allowed Boolean

POST | PUT Indicates if conference duration can be extended.
expiration_time_alert Integer

POST | PUT Sets the time (in seconds) when to display the notification about the impending conference end. No notification is sent if the value is 0.
sequence_type Integer

POST | PUT The type of interleaving for scanning slots across all conference layouts.

  • 0 - replace
  • 1 - move

Allowed values: 0, 1

scan_type Integer

POST | PUT The direction of movement of scanning slots when using the interleaving type "move".

  • 0 - direct
  • 1 - reverse

Allowed values: 0, 1

disable_audio_remarks Boolean

POST | PUT Indicates if audio remarks are disabled.
mcu_mode Boolean

Enable MCU mode. POST | PUT
transcoding Object

POST | PUT Transcoding object.
participant_restrictions Object

POST | PUT Participant Restrictions object.
join_options_enabled Boolean

POST | PUT Indicates if the local configuration is used for conference join options.
join_options Array

POST | PUT Contains the methods available for participants to join the conference. Note that starting from API v3.10, this parameter only includes conference local join options.

  • Possible values:
    • clients - Participants can join using TrueConf clients.
    • webrtc - Participants can join using WebRTC-enabled browser.
    • qr_code - Participants can join by scanning a QR code.
    • terminal - Participants can join through H.323/SIP terminals.

If UDP Multicast is enabled, the available options are limited to clients and qr_code.

If MCU Mode is enabled, the options are restricted to webrtc and terminal (subject to license availability) and cannot be modified.

UDP Multicast and MCU Mode cannot be enabled at the same time.

 
{
     "id": "webinar",
     "type": 0,
     "topic": "Topic of conference",
     "owner": "user1@server.name",
     "description": "Description of conference",
     "max_podiums": 25,
     "max_participants": 25,
     "schedule": ObjectSchedule,
     "invitations": [
        {InvitationMini},
        {InvitationMini}
     ],
     "url": "https://server.name/c/webinar",
     "webclient_url": "https://server.name/webrtc/webinar",
     "allow_guests": true,
     "rights": {
         "guest": ObjectClientRights,
         "user": ObjectClientRights
     },
     "broadcast_enabled": true,
     "broadcast_id": "606a8a",
     "broadcast": "https://server.name/api/v3.1/broadcasts/606a8a",
     "allow_only_planned_participants": false,
     "auto_invite": 0,
     "state": "stopped",
     "tags": [
         "tag1",
         "tag2"
     ],
     "recording": 0,
     "stream_recording_state": 0,
     "stream_id": null,
     "deeplinks": {
         "default": "trueconf:\\c\\1313717611@example.trueconf.name%23vcs&h=10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1",
         "android": "intent:\\c\\1313717611%40example.trueconf.name%23vcs%26h%3d10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1#Intent;scheme=trueconf;package=com.trueconf.videochat;end"
     },
     "connect_urls": {
         "sip_external": null,
         "sip": [
             "001313717611@10.110.14.123",
             "001313717611@[fd00:110::15:a692]",
             "001313717611@192.168.56.1",
             "001313717611@172.27.112.1"
         ],
         "h323": [
             "10.110.14.123##001313717611",
             "[fd00:110::15:a692]##001313717611",
             "192.168.56.1##001313717611",
             "172.27.112.1##001313717611"
         ]
     },
     "pin_enabled": false,
     "pin": null,
     "meeting_room": "Переговорка 123",
     "on_join_mute_mic": 1,
     "on_join_mute_camera": 0,
     "registration": {ObjectRegistration},
     "vad_selector": 0,
     "max_guests": 100,
     "participants_lock_enabled": null,
     "reminders_enabled": true,
     "reminders": [
         {
             "before_start": 0
         }
     ],
     "waiting_room_enabled": false,
     "origin_type": "restfulapi",
     "use_translation": false,
     "translation_flat_volume": 30,
     "expiration_time_updating_allowed": true,
     "expiration_time_alert": 15,
     "sequence_type": 0,
     "scan_type": 0,
     "disable_audio_remarks": false,
     "mcu_mode": false,
     "transcoding": {ObjectConferenceTranscodingSettings},
     "participant_restrictions": {ObjectConferenceParticipantRestrictionsSettings}
     "join_options_enabled": true,
     "join_options": [
         "clients",
         "webrtc",
         "qr_code",
         "terminal"
     ]
 }

Objects | Conference

Conference object.

object 
Conference

Structure

Field Type Description
id String

POST Unique conference identifier. It can include digits, Latin characters, and underscores. The identifier will be generated automatically if it is not specified manually.

Size range: 1..128
topic String

POST | PUT Conference subject.

Size range: 1..240
description String

POST | PUT Conference description. The only field that can be edited during a conference call.
owner String

GET | POST | PUT User identifier (user_id) of the conference owner.

Size range: 1..64
type Integer

POST | PUT Conference mode. Click to learn more about available conference modes:
invitations Object[]

Invitations list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.
created_at Integer

Timestamp indicating when the conference was created.
multicast_enable Boolean

POST | PUT Indicates whether UDP Multicast is enabled for the conference.
multicast_address String

POST | PUT The multicast_address parameter specifies the multicast address utilized when UDP Multicast is enabled for the conference communication. null is used when UDP Multicast is disabled.
max_podiums Integer

The maximum number of conference speakers. The value of this parameter can be changed for “role-based” conferences. In “all-on-screen” conferences, the number of speakers equals the number of participants, while in “video lectures”, it is equal to 1.

Default value: $max_allowed
max_participants Integer

POST | PUT Maximum number of participants depends on the conference mode. Click to learn more about available conference modes:

Default value: $max_allowed
schedule Object

POST | PUT Schedule object.
allow_guests Boolean

POST | PUT Permission to invite guests to the conference. For editing you need a webinar license.

Default value: false
rights Object

POST | PUT ClientRights objects.
  guest Object

POST | PUT ClientRights object, applied to guests.
  user Object

POST | PUT ClientRights object, applied to users.
broadcast_enabled Boolean

POST | PUT Indicates whether the broadcasting preset is enabled for the conference.
broadcast_id String

POST | PUT Identifier for the broadcasting preset associated with the conference.
broadcast String

The link to PresetMini object that is associated with the conference.
allow_only_planned_participants Boolean

POST | PUT When set to true, only invited users can join the conference. This setting does not apply to public conferences (webinars).
auto_invite Integer

POST | PUT This parameter is responsible for sending automatic invitations at the conference start:

  • 0 - disabled
  • 1 - when any participant joins the conference
  • 2 - when any invited participant joins the conference

Default value: 0
url String

POST | PUT Conference page.
webclient_url String

POST | PUT Conference widget.
state String

GET | POST | PUT Conference state.

Allowed values: "running", "stopped"

tags Array

POST | PUT Conference tags for fast search.
recording Integer

POST | PUT Indicates whether conference recording should be enabled when the conference starts.

  • 0 - Recording is disabled
  • 1 - Recording is enabled

Allowed values: 0, 1

stream_recording_state Integer

Current state of the conference recording.

  • 0 - Recording is currently disabled
  • 1 - Recording is currently enabled

Allowed values: 0, 1

stream_id String

Unique identifier representing the ConferenceSession associated with the conference. It can be null, indicating that the conference is not currently running.
deeplinks Array

Array containing deeplinks for connecting to the conference through various platforms.

  • The "default" deeplink uses a TrueConf-specific scheme suitable for various platforms.
  • The "android" deeplink is designed for Android devices and uses an Android-specific intent.
connect_urls Array

Object containing various connection URLs for different protocols.

  • sip_external: URL for external SIP connections. If null, external SIP connections may not be available.
  • sip: Array of SIP URLs for internal connections. Each element represents a SIP connection option.
  • h323: Array of H.323 URLs for connections. Each element represents an H.323 connection option.
pin_enabled Boolean

Is there password for joining the conference.
pin String

POST | PUT Password for joining the conference. The value will be available only to the conference owner; otherwise, null will be returned.
meeting_room String

POST | PUT Conference meeting room. It can be null.
on_join_mute_mic Integer

POST | PUT Mute participants on entry.

Allowed values: 0, 1

on_join_mute_camera Integer

POST | PUT Stop participants’ video on entry.

Allowed values: 0, 1

registration Object

POST | PUT Registration object.
vad_selector Integer

POST | PUT Is smart meeting enabled. A smart meeting is a type of a conference where an attendee is immediately seen and heard by other users when he/she starts speaking (voice activity detection).

Allowed values: 0, 1

max_guests Integer

POST | PUT Maximum number of guest connections.

Default value: $max_allowed
participants_lock_enabled Boolean

Is the ongoing conference inaccessible to new participants.

  • if the value is null, then the conference is not currently running.
reminders_enabled Boolean

Is the conference reminders enabled. Reminder is a notification that is sent to the conference participants before (5/10/15/30 minutes/1 hour/1 day) the conference start.
reminders Object[]

List of ObjectReminder.
waiting_room_enabled Boolean

POST | PUT Is waiting room enabled.
waiting_room_scope String

POST | PUT Waiting room scope.

Default value: all

Allowed values: "all", "unplanned", "strangers", "guests"

origin_type String

Indicates the origin of the conference creation.

  • restfulapi - The conference was created using the API
  • clientapp - The conference was initiated from a client application
use_translation Boolean

POST | PUT Is synchronous translation enabled.

Default value: false
translation_flat_volume Integer

POST | PUT The volume level of the original audio track during synchronous translation.

  • If the parameter is null, the default value (30) is used.

Allowed values: 0-100

expiration_time_updating_allowed Boolean

POST | PUT Indicates if conference duration can be extended.
expiration_time_alert Integer

POST | PUT Sets the time (in seconds) when to display the notification about the impending conference end. No notification is sent if the value is 0.
join_options Array

POST | PUT The available methods for participants to join the conference.

  • Possible values:
    • clients - Participants can join using TrueConf clients.
    • webrtc - Participants can join using WebRTC-enabled browser.
    • qr_code - Participants can join by scanning a QR code.
    • terminal - Participants can join through H.323/SIP terminals.
sequence_type Integer

POST | PUT The type of interleaving for scanning slots across all conference layouts.

  • 0 - replace
  • 1 - move

Allowed values: 0, 1

scan_type Integer

POST | PUT The direction of movement of scanning slots when using the interleaving type "move".

  • 0 - direct
  • 1 - reverse

Allowed values: 0, 1

disable_audio_remarks Boolean

POST | PUT Indicates if audio remarks are disabled.

 
{
     "id": "webinar",
     "type": 0,
     "topic": "Topic of conference",
     "owner": "user1@server.name",
     "description": "Description of conference",
     "max_podiums": 25,
     "max_participants": 25,
     "schedule": ObjectSchedule,
     "invitations": [
        {InvitationMini},
        {InvitationMini}
     ],
     "url": "https://server.name/c/webinar",
     "webclient_url": "https://server.name/webrtc/webinar",
     "allow_guests": true,
     "rights": {
         "guest": ObjectClientRights,
         "user": ObjectClientRights
     },
     "broadcast_enabled": true,
     "broadcast_id": "606a8a",
     "broadcast": "https://server.name/api/v3.1/broadcasts/606a8a",
     "allow_only_planned_participants": false,
     "auto_invite": 0,
     "state": "stopped",
     "tags": [
         "tag1",
         "tag2"
     ],
     "recording": 0,
     "stream_recording_state": 0,
     "stream_id": null,
     "deeplinks": {
         "default": "trueconf:\\c\\1313717611@example.trueconf.name%23vcs&h=10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1",
         "android": "intent:\\c\\1313717611%40example.trueconf.name%23vcs%26h%3d10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1#Intent;scheme=trueconf;package=com.trueconf.videochat;end"
     },
     "connect_urls": {
         "sip_external": null,
         "sip": [
             "001313717611@10.110.14.123",
             "001313717611@[fd00:110::15:a692]",
             "001313717611@192.168.56.1",
             "001313717611@172.27.112.1"
         ],
         "h323": [
             "10.110.14.123##001313717611",
             "[fd00:110::15:a692]##001313717611",
             "192.168.56.1##001313717611",
             "172.27.112.1##001313717611"
         ]
     },
     "pin_enabled": false,
     "pin": null,
     "meeting_room": "Переговорка 123",
     "on_join_mute_mic": 1,
     "on_join_mute_camera": 0,
     "registration": {ObjectRegistration},
     "vad_selector": 0,
     "max_guests": 100,
     "participants_lock_enabled": null,
     "reminders_enabled": true,
     "reminders": [
         {
             "before_start": 0
         }
     ],
     "waiting_room_enabled": false,
     "origin_type": "restfulapi",
     "use_translation": false,
     "translation_flat_volume": 30,
     "expiration_time_updating_allowed": true,
     "expiration_time_alert": 15,
     "join_options": [
         "clients",
         "webrtc",
         "qr_code",
         "terminal"
     ],
     "sequence_type": 0,
     "scan_type": 0,
     "disable_audio_remarks": false
 }

Objects | Conference

Conference object.

object 
Conference

Structure

Field Type Description
id String

POST Unique conference identifier. It can include digits, Latin characters, and underscores. The identifier will be generated automatically if it is not specified manually.

Size range: 1..128
topic String

POST | PUT Conference subject.

Size range: 1..240
description String

POST | PUT Conference description. The only field that can be edited during a conference call.
owner String

GET | POST | PUT User identifier (user_id) of the conference owner.

Size range: 1..64
type Integer

POST | PUT Conference mode. Click to learn more about available conference modes:
invitations Object[]

Invitations list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.
created_at Integer

Timestamp indicating when the conference was created.
multicast_enable Boolean

POST | PUT Indicates whether UDP Multicast is enabled for the conference.
multicast_address String

POST | PUT The multicast_address parameter specifies the multicast address utilized when UDP Multicast is enabled for the conference communication. null is used when UDP Multicast is disabled.
max_podiums Integer

The maximum number of conference speakers. The value of this parameter can be changed for “role-based” conferences. In “all-on-screen” conferences, the number of speakers equals the number of participants, while in “video lectures”, it is equal to 1.

Default value: $max_allowed
max_participants Integer

POST | PUT Maximum number of participants depends on the conference mode. Click to learn more about available conference modes:

Default value: $max_allowed
schedule Object

POST | PUT Schedule object.
allow_guests Boolean

POST | PUT Permission to invite guests to the conference. For editing you need a webinar license.

Default value: false
rights Object

POST | PUT ClientRights objects.
  guest Object

POST | PUT ClientRights object, applied to guests.
  user Object

POST | PUT ClientRights object, applied to users.
broadcast_enabled Boolean

POST | PUT Indicates whether the broadcasting preset is enabled for the conference.
broadcast_id String

POST | PUT Identifier for the broadcasting preset associated with the conference.
broadcast String

The link to PresetMini object that is associated with the conference.
allow_only_planned_participants Boolean

POST | PUT When set to true, only invited users can join the conference. This setting does not apply to public conferences (webinars).
auto_invite Integer

POST | PUT This parameter is responsible for sending automatic invitations at the conference start:

  • 0 - disabled
  • 1 - when any participant joins the conference
  • 2 - when any invited participant joins the conference

Default value: 0
url String

POST | PUT Conference page.
webclient_url String

POST | PUT Conference widget.
state String

GET | POST | PUT Conference state.

Allowed values: "running", "stopped"

tags Array

POST | PUT Conference tags for fast search.
recording Integer

POST | PUT Indicates whether conference recording should be enabled when the conference starts.

  • 0 - Recording is disabled
  • 1 - Recording is enabled

Allowed values: 0, 1

stream_recording_state Integer

Current state of the conference recording.

  • 0 - Recording is currently disabled
  • 1 - Recording is currently enabled

Allowed values: 0, 1

stream_id String

Unique identifier representing the ConferenceSession associated with the conference. It can be null, indicating that the conference is not currently running.
deeplinks Array

Array containing deeplinks for connecting to the conference through various platforms.

  • The "default" deeplink uses a TrueConf-specific scheme suitable for various platforms.
  • The "android" deeplink is designed for Android devices and uses an Android-specific intent.
connect_urls Array

Object containing various connection URLs for different protocols.

  • sip_external: URL for external SIP connections. If null, external SIP connections may not be available.
  • sip: Array of SIP URLs for internal connections. Each element represents a SIP connection option.
  • h323: Array of H.323 URLs for connections. Each element represents an H.323 connection option.
pin_enabled Boolean

Is there password for joining the conference.
pin String

POST | PUT Password for joining the conference. The value will be available only to the conference owner; otherwise, null will be returned.
meeting_room String

POST | PUT Conference meeting room. It can be null.
on_join_mute_mic Integer

POST | PUT Mute participants on entry.

Allowed values: 0, 1

on_join_mute_camera Integer

POST | PUT Stop participants’ video on entry.

Allowed values: 0, 1

registration Object

POST | PUT Registration object.
vad_selector Integer

POST | PUT Is smart meeting enabled. A smart meeting is a type of a conference where an attendee is immediately seen and heard by other users when he/she starts speaking (voice activity detection).

Allowed values: 0, 1

max_guests Integer

POST | PUT Maximum number of guest connections.

Default value: $max_allowed
participants_lock_enabled Boolean

Is the ongoing conference inaccessible to new participants.

  • if the value is null, then the conference is not currently running.
reminders_enabled Boolean

Is the conference reminders enabled. Reminder is a notification that is sent to the conference participants before (5/10/15/30 minutes/1 hour/1 day) the conference start.
reminders Object[]

List of ObjectReminder.
waiting_room_enabled Boolean

POST | PUT Is waiting room enabled.
waiting_room_scope String

POST | PUT Waiting room scope.

Default value: all

Allowed values: "all", "unplanned", "strangers", "guests"

origin_type String

Indicates the origin of the conference creation.

  • restfulapi - The conference was created using the API
  • clientapp - The conference was initiated from a client application
 
{
     "id": "webinar",
     "type": 0,
     "topic": "Topic of conference",
     "owner": "user1@server.name",
     "description": "Description of conference",
     "max_podiums": 25,
     "max_participants": 25,
     "schedule": ObjectSchedule,
     "invitations": [
        {InvitationMini},
        {InvitationMini}
     ],
     "url": "https://server.name/c/webinar",
     "webclient_url": "https://server.name/webrtc/webinar",
     "allow_guests": true,
     "rights": {
         "guest": ObjectClientRights,
         "user": ObjectClientRights
     },
     "broadcast_enabled": true,
     "broadcast_id": "606a8a",
     "broadcast": "https://server.name/api/v3.1/broadcasts/606a8a",
     "allow_only_planned_participants": false,
     "auto_invite": 0,
     "state": "stopped",
     "tags": [
         "tag1",
         "tag2"
     ],
     "recording": 0,
     "stream_recording_state": 0,
     "stream_id": null,
     "deeplinks": {
         "default": "trueconf:\\c\\1313717611@example.trueconf.name%23vcs&h=10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1",
         "android": "intent:\\c\\1313717611%40example.trueconf.name%23vcs%26h%3d10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1#Intent;scheme=trueconf;package=com.trueconf.videochat;end"
     },
     "connect_urls": {
         "sip_external": null,
         "sip": [
             "001313717611@10.110.14.123",
             "001313717611@[fd00:110::15:a692]",
             "001313717611@192.168.56.1",
             "001313717611@172.27.112.1"
         ],
         "h323": [
             "10.110.14.123##001313717611",
             "[fd00:110::15:a692]##001313717611",
             "192.168.56.1##001313717611",
             "172.27.112.1##001313717611"
         ]
     },
     "pin_enabled": false,
     "pin": null,
     "meeting_room": "Переговорка 123",
     "on_join_mute_mic": 1,
     "on_join_mute_camera": 0,
     "registration": {ObjectRegistration},
     "vad_selector": 0,
     "max_guests": 100,
     "participants_lock_enabled": null,
     "reminders_enabled": true,
     "reminders": [
         {
             "before_start": 0
         }
     ],
     "waiting_room_enabled": false,
     "origin_type": "restfulapi"
 }

Objects | Conference

Conference object.

object 
Conference

Structure

Field Type Description
id String

POST Unique conference identifier. It can include digits, Latin characters, and underscores. The identifier will be generated automatically if it is not specified manually.

Size range: 1..128
topic String

POST | PUT Conference subject.

Size range: 1..240
description String

POST | PUT Conference description. The only field that can be edited during a conference call.
owner String

GET | POST | PUT User identifier (user_id) of the conference owner.

Size range: 1..64
type Integer

POST | PUT Conference mode. Click to learn more about available conference modes:
invitations Object[]

Invitations list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.
created_at Integer

Timestamp indicating when the conference was created.
multicast_enable Boolean

POST | PUT Indicates whether UDP Multicast is enabled for the conference.
multicast_address String

POST | PUT The multicast_address parameter specifies the multicast address utilized when UDP Multicast is enabled for the conference communication. null is used when UDP Multicast is disabled.
max_podiums Integer

The maximum number of conference speakers. The value of this parameter can be changed for “role-based” conferences. In “all-on-screen” conferences, the number of speakers equals the number of participants, while in “video lectures”, it is equal to 1.

Default value: $max_allowed
max_participants Integer

POST | PUT Maximum number of participants depends on the conference mode. Click to learn more about available conference modes:

Default value: $max_allowed
schedule Object

POST | PUT Schedule object.
allow_guests Boolean

POST | PUT Permission to invite guests to the conference. For editing you need a webinar license.

Default value: false
rights Object

POST | PUT ClientRights objects.
  guest Object

POST | PUT ClientRights object, applied to guests.
  user Object

POST | PUT ClientRights object, applied to users.
broadcast_enabled Boolean

POST | PUT Indicates whether the broadcasting preset is enabled for the conference.
broadcast_id String

POST | PUT Identifier for the broadcasting preset associated with the conference.
broadcast String

The link to PresetMini object that is associated with the conference.
allow_only_planned_participants Boolean

POST | PUT When set to true, only invited users can join the conference. This setting does not apply to public conferences (webinars).
auto_invite Integer

POST | PUT This parameter is responsible for sending automatic invitations at the conference start:

  • 0 - disabled
  • 1 - when any participant joins the conference
  • 2 - when any invited participant joins the conference

Default value: 0
url String

POST | PUT Conference page.
webclient_url String

POST | PUT Conference widget.
state String

GET | POST | PUT Conference state.

Allowed values: "running", "stopped"

tags Array

POST | PUT Conference tags for fast search.
recording Integer

POST | PUT Indicates whether conference recording should be enabled when the conference starts.

  • 0 - Recording is disabled
  • 1 - Recording is enabled

Allowed values: 0, 1

stream_recording_state Integer

Current state of the conference recording.

  • 0 - Recording is currently disabled
  • 1 - Recording is currently enabled

Allowed values: 0, 1

stream_id String

Unique identifier representing the ConferenceSession associated with the conference. It can be null, indicating that the conference is not currently running.
deeplinks Array

Array containing deeplinks for connecting to the conference through various platforms.

  • The "default" deeplink uses a TrueConf-specific scheme suitable for various platforms.
  • The "android" deeplink is designed for Android devices and uses an Android-specific intent.
connect_urls Array

Object containing various connection URLs for different protocols.

  • sip_external: URL for external SIP connections. If null, external SIP connections may not be available.
  • sip: Array of SIP URLs for internal connections. Each element represents a SIP connection option.
  • h323: Array of H.323 URLs for connections. Each element represents an H.323 connection option.
pin_enabled Boolean

Is there password for joining the conference.
pin String

POST | PUT Password for joining the conference. The value will be available only to the conference owner; otherwise, null will be returned.
meeting_room String

POST | PUT Conference meeting room. It can be null.
on_join_mute_mic Integer

POST | PUT Mute participants on entry.

Allowed values: 0, 1

on_join_mute_camera Integer

POST | PUT Stop participants’ video on entry.

Allowed values: 0, 1

registration Object

POST | PUT Registration object.
vad_selector Integer

POST | PUT Is smart meeting enabled. A smart meeting is a type of a conference where an attendee is immediately seen and heard by other users when he/she starts speaking (voice activity detection).

Allowed values: 0, 1

max_guests Integer

POST | PUT Maximum number of guest connections.

Default value: $max_allowed
participants_lock_enabled Boolean

Is the ongoing conference inaccessible to new participants.

  • if the value is null, then the conference is not currently running.
reminders_enabled Boolean

Is the conference reminders enabled. Reminder is a notification that is sent to the conference participants before (5/10/15/30 minutes/1 hour/1 day) the conference start.
reminders Object[]

List of ObjectReminder.
waiting_room_enabled Boolean

POST | PUT Is waiting room enabled.
waiting_room_scope String

POST | PUT Waiting room scope.

Default value: all

Allowed values: "all", "unplanned", "strangers", "guests" 

{
     "id": "webinar",
     "type": 0,
     "topic": "Topic of conference",
     "owner": "user1@server.name",
     "description": "Description of conference",
     "max_podiums": 25,
     "max_participants": 25,
     "schedule": ObjectSchedule,
     "invitations": [
        {InvitationMini},
        {InvitationMini}
     ],
     "url": "https://server.name/c/webinar",
     "webclient_url": "https://server.name/webrtc/webinar",
     "allow_guests": true,
     "rights": {
         "guest": ObjectClientRights,
         "user": ObjectClientRights
     },
     "broadcast_enabled": true,
     "broadcast_id": "606a8a",
     "broadcast": "https://server.name/api/v3.1/broadcasts/606a8a",
     "allow_only_planned_participants": false,
     "auto_invite": 0,
     "state": "stopped",
     "tags": [
         "tag1",
         "tag2"
     ],
     "recording": 0,
     "stream_recording_state": 0,
     "stream_id": null,
     "deeplinks": {
         "default": "trueconf:\\c\\1313717611@example.trueconf.name%23vcs&h=10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1",
         "android": "intent:\\c\\1313717611%40example.trueconf.name%23vcs%26h%3d10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1#Intent;scheme=trueconf;package=com.trueconf.videochat;end"
     },
     "connect_urls": {
         "sip_external": null,
         "sip": [
             "001313717611@10.110.14.123",
             "001313717611@[fd00:110::15:a692]",
             "001313717611@192.168.56.1",
             "001313717611@172.27.112.1"
         ],
         "h323": [
             "10.110.14.123##001313717611",
             "[fd00:110::15:a692]##001313717611",
             "192.168.56.1##001313717611",
             "172.27.112.1##001313717611"
         ]
     },
     "pin_enabled": false,
     "pin": null,
     "meeting_room": "Переговорка 123",
     "on_join_mute_mic": 1,
     "on_join_mute_camera": 0,
     "registration": {ObjectRegistration},
     "vad_selector": 0,
     "max_guests": 100,
     "participants_lock_enabled": null,
     "reminders_enabled": true,
     "reminders": [
         {
             "before_start": 0
         }
     ],
     "waiting_room_enabled": false
 }

Objects | Conference

Conference object.

object 
Conference

Structure

Field Type Description
id String

POST Unique conference identifier. It can include digits, Latin characters, and underscores. The identifier will be generated automatically if it is not specified manually.

Size range: 1..128
topic String

POST | PUT Conference subject.

Size range: 1..240
description String

POST | PUT Conference description. The only field that can be edited during a conference call.
owner String

GET | POST | PUT User identifier (user_id) of the conference owner.

Size range: 1..64
type Integer

POST | PUT Conference mode. Click to learn more about available conference modes:
invitations Object[]

Invitations list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.
created_at Integer

Timestamp indicating when the conference was created.
multicast_enable Boolean

POST | PUT Indicates whether UDP Multicast is enabled for the conference.
multicast_address String

POST | PUT The multicast_address parameter specifies the multicast address utilized when UDP Multicast is enabled for the conference communication. null is used when UDP Multicast is disabled.
max_podiums Integer

The maximum number of conference speakers. The value of this parameter can be changed for “role-based” conferences. In “all-on-screen” conferences, the number of speakers equals the number of participants, while in “video lectures”, it is equal to 1.

Default value: $max_allowed
max_participants Integer

POST | PUT Maximum number of participants depends on the conference mode. Click to learn more about available conference modes:

Default value: $max_allowed
schedule Object

POST | PUT Schedule object.
allow_guests Boolean

POST | PUT Permission to invite guests to the conference. For editing you need a webinar license.

Default value: false
rights Object

POST | PUT ClientRights objects.
  guest Object

POST | PUT ClientRights object, applied to guests.
  user Object

POST | PUT ClientRights object, applied to users.
broadcast_enabled Boolean

POST | PUT Indicates whether the broadcasting preset is enabled for the conference.
broadcast_id String

POST | PUT Identifier for the broadcasting preset associated with the conference.
broadcast String

The link to PresetMini object that is associated with the conference.
allow_only_planned_participants Boolean

POST | PUT When set to true, only invited users can join the conference. This setting does not apply to public conferences (webinars).
auto_invite Integer

POST | PUT This parameter is responsible for sending automatic invitations at the conference start:

  • 0 - disabled
  • 1 - when any participant joins the conference
  • 2 - when any invited participant joins the conference

Default value: 0
url String

POST | PUT Conference page.
webclient_url String

POST | PUT Conference widget.
state String

GET | POST | PUT Conference state.

Allowed values: "running", "stopped"

tags Array

POST | PUT Conference tags for fast search.
recording Integer

POST | PUT Indicates whether conference recording should be enabled when the conference starts.

  • 0 - Recording is disabled
  • 1 - Recording is enabled

Allowed values: 0, 1

stream_recording_state Integer

Current state of the conference recording.

  • 0 - Recording is currently disabled
  • 1 - Recording is currently enabled

Allowed values: 0, 1

stream_id String

Unique identifier representing the ConferenceSession associated with the conference. It can be null, indicating that the conference is not currently running.
deeplinks Array

Array containing deeplinks for connecting to the conference through various platforms.

  • The "default" deeplink uses a TrueConf-specific scheme suitable for various platforms.
  • The "android" deeplink is designed for Android devices and uses an Android-specific intent.
connect_urls Array

Object containing various connection URLs for different protocols.

  • sip_external: URL for external SIP connections. If null, external SIP connections may not be available.
  • sip: Array of SIP URLs for internal connections. Each element represents a SIP connection option.
  • h323: Array of H.323 URLs for connections. Each element represents an H.323 connection option.
pin_enabled Boolean

Is there password for joining the conference.
pin String

POST | PUT Password for joining the conference. The value will be available only to the conference owner; otherwise, null will be returned.
meeting_room String

POST | PUT Conference meeting room. It can be null.
on_join_mute_mic Integer

POST | PUT Mute participants on entry.

Allowed values: 0, 1

on_join_mute_camera Integer

POST | PUT Stop participants’ video on entry.

Allowed values: 0, 1

registration Object

POST | PUT Registration object.
vad_selector Integer

POST | PUT Is smart meeting enabled. A smart meeting is a type of a conference where an attendee is immediately seen and heard by other users when he/she starts speaking (voice activity detection).

Allowed values: 0, 1

max_guests Integer

POST | PUT Maximum number of guest connections.

Default value: $max_allowed

 
{
     "id": "webinar",
     "type": 0,
     "topic": "Topic of conference",
     "owner": "user1@server.name",
     "description": "Description of conference",
     "max_podiums": 25,
     "max_participants": 25,
     "schedule": ObjectSchedule,
     "invitations": [
        {InvitationMini},
        {InvitationMini}
     ],
     "url": "https://server.name/c/webinar",
     "webclient_url": "https://server.name/webrtc/webinar",
     "allow_guests": true,
     "rights": {
         "guest": ObjectClientRights,
         "user": ObjectClientRights
     },
     "broadcast_enabled": true,
     "broadcast_id": "606a8a",
     "broadcast": "https://server.name/api/v3.1/broadcasts/606a8a",
     "allow_only_planned_participants": false,
     "auto_invite": 0,
     "state": "stopped",
     "tags": [
         "tag1",
         "tag2"
     ],
     "recording": 0,
     "stream_recording_state": 0,
     "stream_id": null,
     "deeplinks": {
         "default": "trueconf:\\c\\1313717611@example.trueconf.name%23vcs&h=10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1",
         "android": "intent:\\c\\1313717611%40example.trueconf.name%23vcs%26h%3d10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1#Intent;scheme=trueconf;package=com.trueconf.videochat;end"
     },
     "connect_urls": {
         "sip_external": null,
         "sip": [
             "001313717611@10.110.14.123",
             "001313717611@[fd00:110::15:a692]",
             "001313717611@192.168.56.1",
             "001313717611@172.27.112.1"
         ],
         "h323": [
             "10.110.14.123##001313717611",
             "[fd00:110::15:a692]##001313717611",
             "192.168.56.1##001313717611",
             "172.27.112.1##001313717611"
         ]
     },
     "pin_enabled": false,
     "pin": null,
     "meeting_room": "Переговорка 123",
     "on_join_mute_mic": 1,
     "on_join_mute_camera": 0,
     "registration": {ObjectRegistration},
     "vad_selector": 0,
     "max_guests": 100
 }

Objects | Conference

Conference object.

object 
Conference

Structure

Field Type Description
id String

POST Unique conference identifier. It can include digits, Latin characters, and underscores. The identifier will be generated automatically if it is not specified manually.

Size range: 1..128
topic String

POST | PUT Conference subject.

Size range: 1..240
description String

POST | PUT Conference description. The only field that can be edited during a conference call.
owner String

GET | POST | PUT User identifier (user_id) of the conference owner.

Size range: 1..64
type Integer

POST | PUT Conference mode. Click to learn more about available conference modes:
invitations Object[]

Invitations list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.
created_at Integer

Timestamp indicating when the conference was created.
multicast_enable Boolean

POST | PUT Indicates whether UDP Multicast is enabled for the conference.
multicast_address String

POST | PUT The multicast_address parameter specifies the multicast address utilized when UDP Multicast is enabled for the conference communication. null is used when UDP Multicast is disabled.
max_podiums Integer

The maximum number of conference speakers. The value of this parameter can be changed for “role-based” conferences. In “all-on-screen” conferences, the number of speakers equals the number of participants, while in “video lectures”, it is equal to 1.

Default value: $max_allowed
max_participants Integer

POST | PUT Maximum number of participants depends on the conference mode. Click to learn more about available conference modes:

Default value: $max_allowed
schedule Object

POST | PUT Schedule object.
allow_guests Boolean

POST | PUT Permission to invite guests to the conference. For editing you need a webinar license.

Default value: false
rights Object

POST | PUT ClientRights objects.
  guest Object

POST | PUT ClientRights object, applied to guests.
  user Object

POST | PUT ClientRights object, applied to users.
broadcast_enabled Boolean

POST | PUT Indicates whether the broadcasting preset is enabled for the conference.
broadcast_id String

POST | PUT Identifier for the broadcasting preset associated with the conference.
broadcast String

The link to PresetMini object that is associated with the conference.
allow_only_planned_participants Boolean

POST | PUT When set to true, only invited users can join the conference. This setting does not apply to public conferences (webinars).
auto_invite Integer

POST | PUT This parameter is responsible for sending automatic invitations at the conference start:

  • 0 - disabled
  • 1 - when any participant joins the conference
  • 2 - when any invited participant joins the conference

Default value: 0
url String

POST | PUT Conference page.
webclient_url String

POST | PUT Conference widget.
state String

GET | POST | PUT Conference state.

Allowed values: "running", "stopped"

tags Array

POST | PUT Conference tags for fast search.
recording Integer

POST | PUT Indicates whether conference recording should be enabled when the conference starts.

  • 0 - Recording is disabled
  • 1 - Recording is enabled

Allowed values: 0, 1

stream_recording_state Integer

Current state of the conference recording.

  • 0 - Recording is currently disabled
  • 1 - Recording is currently enabled

Allowed values: 0, 1

stream_id String

Unique identifier representing the ConferenceSession associated with the conference. It can be null, indicating that the conference is not currently running.
deeplinks Array

Array containing deeplinks for connecting to the conference through various platforms.

  • The "default" deeplink uses a TrueConf-specific scheme suitable for various platforms.
  • The "android" deeplink is designed for Android devices and uses an Android-specific intent.
connect_urls Array

Object containing various connection URLs for different protocols.

  • sip_external: URL for external SIP connections. If null, external SIP connections may not be available.
  • sip: Array of SIP URLs for internal connections. Each element represents a SIP connection option.
  • h323: Array of H.323 URLs for connections. Each element represents an H.323 connection option.
pin_enabled Boolean

Is there password for joining the conference.
pin String

POST | PUT Password for joining the conference. The value will be available only to the conference owner; otherwise, null will be returned.
meeting_room String

POST | PUT Conference meeting room. It can be null.
on_join_mute_mic Integer

POST | PUT Mute participants on entry.

Allowed values: 0, 1

on_join_mute_camera Integer

POST | PUT Stop participants’ video on entry.

Allowed values: 0, 1

registration Object

POST | PUT Registration object.
vad_selector Integer

POST | PUT Is smart meeting enabled. A smart meeting is a type of a conference where an attendee is immediately seen and heard by other users when he/she starts speaking (voice activity detection).

Allowed values: 0, 1 

{
     "id": "webinar",
     "type": 0,
     "topic": "Topic of conference",
     "owner": "user1@server.name",
     "description": "Description of conference",
     "max_podiums": 25,
     "max_participants": 25,
     "schedule": ObjectSchedule,
     "invitations": [
        {InvitationMini},
        {InvitationMini}
     ],
     "url": "https://server.name/c/webinar",
     "webclient_url": "https://server.name/webrtc/webinar",
     "allow_guests": true,
     "rights": {
         "guest": ObjectClientRights,
         "user": ObjectClientRights
     },
     "broadcast_enabled": true,
     "broadcast_id": "606a8a",
     "broadcast": "https://server.name/api/v3.1/broadcasts/606a8a",
     "allow_only_planned_participants": false,
     "auto_invite": 0,
     "state": "stopped",
     "tags": [
         "tag1",
         "tag2"
     ],
     "recording": 0,
     "stream_recording_state": 0,
     "stream_id": null,
     "deeplinks": {
         "default": "trueconf:\\c\\1313717611@example.trueconf.name%23vcs&h=10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1",
         "android": "intent:\\c\\1313717611%40example.trueconf.name%23vcs%26h%3d10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1#Intent;scheme=trueconf;package=com.trueconf.videochat;end"
     },
     "connect_urls": {
         "sip_external": null,
         "sip": [
             "001313717611@10.110.14.123",
             "001313717611@[fd00:110::15:a692]",
             "001313717611@192.168.56.1",
             "001313717611@172.27.112.1"
         ],
         "h323": [
             "10.110.14.123##001313717611",
             "[fd00:110::15:a692]##001313717611",
             "192.168.56.1##001313717611",
             "172.27.112.1##001313717611"
         ]
     },
     "pin_enabled": false,
     "pin": null,
     "meeting_room": "Переговорка 123",
     "on_join_mute_mic": 1,
     "on_join_mute_camera": 0,
     "registration": {ObjectRegistration},
     "vad_selector": 0
 }

Objects | Conference

Conference object.

object 
Conference

Structure

Field Type Description
id String

POST Unique conference identifier. It can include digits, Latin characters, and underscores. The identifier will be generated automatically if it is not specified manually.

Size range: 1..128
topic String

POST | PUT Conference subject.

Size range: 1..240
description String

POST | PUT Conference description. The only field that can be edited during a conference call.
owner String

GET | POST | PUT User identifier (user_id) of the conference owner.

Size range: 1..64
type Integer

POST | PUT Conference mode. Click to learn more about available conference modes:
invitations Object[]

Invitations list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.
created_at Integer

Timestamp indicating when the conference was created.
multicast_enable Boolean

POST | PUT Indicates whether UDP Multicast is enabled for the conference.
multicast_address String

POST | PUT The multicast_address parameter specifies the multicast address utilized when UDP Multicast is enabled for the conference communication. null is used when UDP Multicast is disabled.
max_podiums Integer

The maximum number of conference speakers. The value of this parameter can be changed for “role-based” conferences. In “all-on-screen” conferences, the number of speakers equals the number of participants, while in “video lectures”, it is equal to 1.

Default value: $max_allowed
max_participants Integer

POST | PUT Maximum number of participants depends on the conference mode. Click to learn more about available conference modes:

Default value: $max_allowed
schedule Object

POST | PUT Schedule object.
allow_guests Boolean

POST | PUT Permission to invite guests to the conference. For editing you need a webinar license.

Default value: false
rights Object

POST | PUT ClientRights objects.
  guest Object

POST | PUT ClientRights object, applied to guests.
  user Object

POST | PUT ClientRights object, applied to users.
broadcast_enabled Boolean

POST | PUT Indicates whether the broadcasting preset is enabled for the conference.
broadcast_id String

POST | PUT Identifier for the broadcasting preset associated with the conference.
broadcast String

The link to PresetMini object that is associated with the conference.
allow_only_planned_participants Boolean

POST | PUT When set to true, only invited users can join the conference. This setting does not apply to public conferences (webinars).
auto_invite Integer

POST | PUT This parameter is responsible for sending automatic invitations at the conference start:

  • 0 - disabled
  • 1 - when any participant joins the conference
  • 2 - when any invited participant joins the conference

Default value: 0
url String

POST | PUT Conference page.
webclient_url String

POST | PUT Conference widget.
state String

GET | POST | PUT Conference state.

Allowed values: "running", "stopped"

tags Array

POST | PUT Conference tags for fast search.
recording Integer

POST | PUT Indicates whether conference recording should be enabled when the conference starts.

  • 0 - Recording is disabled
  • 1 - Recording is enabled

Allowed values: 0, 1

stream_recording_state Integer

Current state of the conference recording.

  • 0 - Recording is currently disabled
  • 1 - Recording is currently enabled

Allowed values: 0, 1

stream_id String

Unique identifier representing the ConferenceSession associated with the conference. It can be null, indicating that the conference is not currently running.
deeplinks Array

Array containing deeplinks for connecting to the conference through various platforms.

  • The "default" deeplink uses a TrueConf-specific scheme suitable for various platforms.
  • The "android" deeplink is designed for Android devices and uses an Android-specific intent.
connect_urls Array

Object containing various connection URLs for different protocols.

  • sip_external: URL for external SIP connections. If null, external SIP connections may not be available.
  • sip: Array of SIP URLs for internal connections. Each element represents a SIP connection option.
  • h323: Array of H.323 URLs for connections. Each element represents an H.323 connection option.
pin_enabled Boolean

Is there password for joining the conference.
pin String

POST | PUT Password for joining the conference. The value will be available only to the conference owner; otherwise, null will be returned.
meeting_room String

POST | PUT Conference meeting room. It can be null.
on_join_mute_mic Integer

POST | PUT Mute participants on entry.

Allowed values: 0, 1

on_join_mute_camera Integer

POST | PUT Stop participants’ video on entry.

Allowed values: 0, 1

registration Object

POST | PUT Registration object.

 
{
     "id": "webinar",
     "type": 0,
     "topic": "Topic of conference",
     "owner": "user1@server.name",
     "description": "Description of conference",
     "max_podiums": 25,
     "max_participants": 25,
     "schedule": ObjectSchedule,
     "invitations": [
        {InvitationMini},
        {InvitationMini}
     ],
     "url": "https://server.name/c/webinar",
     "webclient_url": "https://server.name/webrtc/webinar",
     "allow_guests": true,
     "rights": {
         "guest": ObjectClientRights,
         "user": ObjectClientRights
     },
     "broadcast_enabled": true,
     "broadcast_id": "606a8a",
     "broadcast": "https://server.name/api/v3.1/broadcasts/606a8a",
     "allow_only_planned_participants": false,
     "auto_invite": 0,
     "state": "stopped",
     "tags": [
         "tag1",
         "tag2"
     ],
     "recording": 0,
     "stream_recording_state": 0,
     "stream_id": null,
     "deeplinks": {
         "default": "trueconf:\\c\\1313717611@example.trueconf.name%23vcs&h=10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1",
         "android": "intent:\\c\\1313717611%40example.trueconf.name%23vcs%26h%3d10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1#Intent;scheme=trueconf;package=com.trueconf.videochat;end"
     },
     "connect_urls": {
         "sip_external": null,
         "sip": [
             "001313717611@10.110.14.123",
             "001313717611@[fd00:110::15:a692]",
             "001313717611@192.168.56.1",
             "001313717611@172.27.112.1"
         ],
         "h323": [
             "10.110.14.123##001313717611",
             "[fd00:110::15:a692]##001313717611",
             "192.168.56.1##001313717611",
             "172.27.112.1##001313717611"
         ]
     },
     "pin_enabled": false,
     "pin": null,
     "meeting_room": "Переговорка 123",
     "on_join_mute_mic": 1,
     "on_join_mute_camera": 0,
     "registration": {ObjectRegistration}
 }

Objects | Conference

Conference object.

object 
Conference

Structure

Field Type Description
id String

POST Unique conference identifier. It can include digits, Latin characters, and underscores. The identifier will be generated automatically if it is not specified manually.

Size range: 1..128
topic String

POST | PUT Conference subject.

Size range: 1..240
description String

POST | PUT Conference description.
owner String

GET | POST | PUT User identifier (user_id) of the conference owner.

Size range: 1..64
type Integer

POST | PUT Conference mode. Click to learn more about available conference modes:
invitations Object[]

Invitations list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.
created_at Integer

Timestamp indicating when the conference was created.
multicast_enable Boolean

POST | PUT Indicates whether UDP Multicast is enabled for the conference.
multicast_address String

POST | PUT The multicast_address parameter specifies the multicast address utilized when UDP Multicast is enabled for the conference communication. null is used when UDP Multicast is disabled.
max_podiums Integer

The maximum number of conference speakers. The value of this parameter can be changed for “role-based” conferences. In “all-on-screen” conferences, the number of speakers equals the number of participants, while in “video lectures”, it is equal to 1.

Default value: $max_allowed
max_participants Integer

POST | PUT Maximum number of participants depends on the conference mode. Click to learn more about available conference modes:

Default value: $max_allowed
schedule Object

POST | PUT Schedule object.
allow_guests Boolean

POST | PUT Permission to invite guests to the conference. For editing you need a webinar license.

Default value: false
rights Object

POST | PUT ClientRights objects.
  guest Object

POST | PUT ClientRights object, applied to guests.
  user Object

POST | PUT ClientRights object, applied to users.
broadcast_enabled Boolean

POST | PUT Indicates whether the broadcasting preset is enabled for the conference.
broadcast_id String

POST | PUT Identifier for the broadcasting preset associated with the conference.
broadcast String

The link to PresetMini object that is associated with the conference.
allow_only_planned_participants Boolean

POST | PUT When set to true, only invited users can join the conference. This setting does not apply to public conferences (webinars).
auto_invite Integer

POST | PUT This parameter is responsible for sending automatic invitations at the conference start:

  • 0 - disabled
  • 1 - when any participant joins the conference
  • 2 - when any invited participant joins the conference

Default value: 0
url String

POST | PUT Conference page.
webclient_url String

POST | PUT Conference widget.
state String

GET | POST | PUT Conference state.

Allowed values: "running", "stopped"

tags Array

POST | PUT Conference tags for fast search.
recording Integer

POST | PUT Indicates whether conference recording should be enabled when the conference starts.

  • 0 - Recording is disabled
  • 1 - Recording is enabled

Allowed values: 0, 1

stream_recording_state Integer

Current state of the conference recording.

  • 0 - Recording is currently disabled
  • 1 - Recording is currently enabled

Allowed values: 0, 1

stream_id String

Unique identifier representing the ConferenceSession associated with the conference. It can be null, indicating that the conference is not currently running.
deeplinks Array

Array containing deeplinks for connecting to the conference through various platforms.

  • The "default" deeplink uses a TrueConf-specific scheme suitable for various platforms.
  • The "android" deeplink is designed for Android devices and uses an Android-specific intent.
connect_urls Array

Object containing various connection URLs for different protocols.

  • sip_external: URL for external SIP connections. If null, external SIP connections may not be available.
  • sip: Array of SIP URLs for internal connections. Each element represents a SIP connection option.
  • h323: Array of H.323 URLs for connections. Each element represents an H.323 connection option.
 
{
     "id": "webinar",
     "type": 0,
     "topic": "Topic of conference",
     "owner": "user1@server.name",
     "description": "Description of conference",
     "max_podiums": 25,
     "max_participants": 25,
     "schedule": ObjectSchedule,
     "invitations": [
        {InvitationMini},
        {InvitationMini}
     ],
     "url": "https://server.name/c/webinar",
     "webclient_url": "https://server.name/webrtc/webinar",
     "allow_guests": true,
     "rights": {
         "guest": ObjectClientRights,
         "user": ObjectClientRights
     },
     "broadcast_enabled": true,
     "broadcast_id": "606a8a",
     "broadcast": "https://server.name/api/v3.1/broadcasts/606a8a",
     "allow_only_planned_participants": false,
     "auto_invite": 0,
     "state": "stopped",
     "tags": [
         "tag1",
         "tag2"
     ],
     "recording": 0,
     "stream_recording_state": 0,
     "stream_id": null,
     "deeplinks": {
         "default": "trueconf:\\c\\1313717611@example.trueconf.name%23vcs&h=10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1",
         "android: "intent:\\c\\1313717611%40example.trueconf.name%23vcs%26h%3d10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1#Intent;scheme=trueconf;package=com.trueconf.videochat;end"
     },
     "connect_urls": {
         "sip_external": null,
         "sip": [
             "001313717611@10.110.14.123",
             "001313717611@[fd00:110::15:a692]",
             "001313717611@192.168.56.1",
             "001313717611@172.27.112.1"
         ],
         "h323": [
             "10.110.14.123##001313717611",
             "[fd00:110::15:a692]##001313717611",
             "192.168.56.1##001313717611",
             "172.27.112.1##001313717611"
         ]
     }
 }

Objects | Conference

Conference object.

object 
Conference

Structure

Field Type Description
id String

POST Unique conference identifier. It can include digits, Latin characters, and underscores. The identifier will be generated automatically if it is not specified manually.

Size range: 1..128
topic String

POST | PUT Conference subject.

Size range: 1..240
description String

POST | PUT Conference description.
owner String

GET | POST | PUT User identifier (user_id) of the conference owner.

Size range: 1..64
type Integer

POST | PUT Conference mode. Click to learn more about available conference modes:
invitations Object[]

Invitations list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.
created_at Integer

Timestamp indicating when the conference was created.
multicast_enable Boolean

POST | PUT Indicates whether UDP Multicast is enabled for the conference.
multicast_address String

POST | PUT The multicast_address parameter specifies the multicast address utilized when UDP Multicast is enabled for the conference communication. null is used when UDP Multicast is disabled.
max_podiums Integer

The maximum number of conference speakers. The value of this parameter can be changed for “role-based” conferences. In “all-on-screen” conferences, the number of speakers equals the number of participants, while in “video lectures”, it is equal to 1.

Default value: $max_allowed
max_participants Integer

POST | PUT Maximum number of participants depends on the conference mode. Click to learn more about available conference modes:

Default value: $max_allowed
schedule Object

POST | PUT Schedule object.
allow_guests Boolean

POST | PUT Permission to invite guests to the conference. For editing you need a webinar license.

Default value: false
rights Object

POST | PUT ClientRights objects.
  guest Object

POST | PUT ClientRights object, applied to guests.
  user Object

POST | PUT ClientRights object, applied to users.
broadcast_enabled Boolean

POST | PUT Indicates whether the broadcasting preset is enabled for the conference.
broadcast_id String

POST | PUT Identifier for the broadcasting preset associated with the conference.
broadcast String

The link to PresetMini object that is associated with the conference.
allow_only_planned_participants Boolean

POST | PUT When set to true, only invited users can join the conference. This setting does not apply to public conferences (webinars).
auto_invite Integer

POST | PUT This parameter is responsible for sending automatic invitations at the conference start:

  • 0 - disabled
  • 1 - when any participant joins the conference
  • 2 - when any invited participant joins the conference

Default value: 0
url String

POST | PUT Conference page.
webclient_url String

POST | PUT Conference widget.
state String

GET | POST | PUT Conference state.

Allowed values: "running", "stopped"

tags Array

POST | PUT Conference tags for fast search.
recording Integer

POST | PUT Indicates whether conference recording should be enabled when the conference starts.

  • 0 - Recording is disabled
  • 1 - Recording is enabled

Allowed values: 0, 1

stream_recording_state Integer

Current state of the conference recording.

  • 0 - Recording is currently disabled
  • 1 - Recording is currently enabled

Allowed values: 0, 1

stream_id String

Unique identifier representing the ConferenceSession associated with the conference. It can be null, indicating that the conference is not currently running.
deeplinks Array

Array containing deeplinks for connecting to the conference through various platforms.

  • The "default" deeplink uses a TrueConf-specific scheme suitable for various platforms.
  • The "android" deeplink is designed for Android devices and uses an Android-specific intent.
connect_urls Array

Object containing various connection URLs for different protocols.

  • sip_external: URL for external SIP connections. If null, external SIP connections may not be available.
  • sip: Array of SIP URLs for internal connections. Each element represents a SIP connection option.
  • h323: Array of H.323 URLs for connections. Each element represents an H.323 connection option.
 
{
     "id": "webinar",
     "type": 0,
     "topic": "Topic of conference",
     "owner": "user1@server.name",
     "description": "Description of conference",
     "max_podiums": 25,
     "max_participants": 25,
     "schedule": ObjectSchedule,
     "invitations": [
        {InvitationMini},
        {InvitationMini}
     ],
     "url": "https://server.name/c/webinar",
     "webclient_url": "https://server.name/webrtc/webinar",
     "allow_guests": true,
     "rights": {
         "guest": ObjectClientRights,
         "user": ObjectClientRights
     },
     "broadcast_enabled": true,
     "broadcast_id": "606a8a",
     "broadcast": "https://server.name/api/v3.1/broadcasts/606a8a",
     "allow_only_planned_participants": false,
     "auto_invite": 0,
     "state": "stopped",
     "tags": [
         "tag1",
         "tag2"
     ],
     "recording": 0,
     "stream_recording_state": 0,
     "stream_id": null,
     "deeplinks": {
         "default": "trueconf:\\c\\1313717611@example.trueconf.name%23vcs&h=10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1",
         "android: "intent:\\c\\1313717611%40example.trueconf.name%23vcs%26h%3d10.110.14.123,[fd00:110::15:a692],192.168.56.1,172.27.112.1#Intent;scheme=trueconf;package=com.trueconf.videochat;end"
     },
     "connect_urls": {
         "sip_external": null,
         "sip": [
             "001313717611@10.110.14.123",
             "001313717611@[fd00:110::15:a692]",
             "001313717611@192.168.56.1",
             "001313717611@172.27.112.1"
         ],
         "h323": [
             "10.110.14.123##001313717611",
             "[fd00:110::15:a692]##001313717611",
             "192.168.56.1##001313717611",
             "172.27.112.1##001313717611"
         ]
     }
 }

Objects | Conference

Conference object.

object 
Conference

Structure

Field Type Description
id String

POST Unique conference identifier. It can include digits, Latin characters, and underscores. The identifier will be generated automatically if it is not specified manually.

Size range: 1..128
topic String

POST | PUT Conference subject.

Size range: 1..240
description String

POST | PUT Conference description.
owner String

GET | POST | PUT User identifier (user_id) of the conference owner.

Size range: 1..64
type Integer

POST | PUT Conference mode. Click to learn more about available conference modes:
invitations Object[]

Invitations list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.
created_at Integer

Timestamp indicating when the conference was created.
multicast_enable Boolean

POST | PUT Indicates whether UDP Multicast is enabled for the conference.
multicast_address String

POST | PUT The multicast_address parameter specifies the multicast address utilized when UDP Multicast is enabled for the conference communication. null is used when UDP Multicast is disabled.
max_podiums Integer

The maximum number of conference speakers. The value of this parameter can be changed for “role-based” conferences. In “all-on-screen” conferences, the number of speakers equals the number of participants, while in “video lectures”, it is equal to 1.

Default value: $max_allowed
max_participants Integer

POST | PUT Maximum number of participants depends on the conference mode. Click to learn more about available conference modes:

Default value: $max_allowed
schedule Object

POST | PUT Schedule object.
allow_guests Boolean

POST | PUT Permission to invite guests to the conference. For editing you need a webinar license.

Default value: false
rights Object

POST | PUT ClientRights objects.
  guest Object

POST | PUT ClientRights object, applied to guests.
  user Object

POST | PUT ClientRights object, applied to users.
broadcast_enabled Boolean

POST | PUT Indicates whether the broadcasting preset is enabled for the conference.
broadcast_id String

POST | PUT Identifier for the broadcasting preset associated with the conference.
broadcast String

The link to PresetMini object that is associated with the conference.
allow_only_planned_participants Boolean

POST | PUT When set to true, only invited users can join the conference. This setting does not apply to public conferences (webinars).
auto_invite Integer

POST | PUT This parameter is responsible for sending automatic invitations at the conference start:

  • 0 - disabled
  • 1 - when any participant joins the conference
  • 2 - when any invited participant joins the conference

Default value: 0
url String

POST | PUT Conference page.
webclient_url String

POST | PUT Conference widget.
state String

GET | POST | PUT Conference state.

Allowed values: "running", "stopped"

tags Array

POST | PUT Conference tags for fast search.
recording Integer

POST | PUT Indicates whether conference recording should be enabled when the conference starts.

  • 0 - Recording is disabled
  • 1 - Recording is enabled

Allowed values: 0, 1

stream_recording_state Integer

Current state of the conference recording.

  • 0 - Recording is currently disabled
  • 1 - Recording is currently enabled

Allowed values: 0, 1 

{
     "id": "webinar",
     "type": 0,
     "topic": "Topic of conference",
     "owner": "user1@server.name",
     "description": "Description of conference",
     "max_podiums": 25,
     "max_participants": 25,
     "schedule": ObjectSchedule,
     "invitations": [
        {InvitationMini},
        {InvitationMini}
     ],
     "url": "https://server.name/c/webinar",
     "webclient_url": "https://server.name/webrtc/webinar",
     "allow_guests": true,
     "rights": {
         "guest": ObjectClientRights,
         "user": ObjectClientRights
     },
     "broadcast_enabled": true,
     "broadcast_id": "606a8a",
     "broadcast": "https://server.name/api/v3.1/broadcasts/606a8a",
     "allow_only_planned_participants": false,
     "auto_invite": 0,
     "state": "stopped",
     "tags": [
         "tag1",
         "tag2"
     ],
     "recording": 0,
     "stream_recording_state": 0
 }

Objects | Conference

Conference object.

object 
Conference

Structure

Field Type Description
id String

POST Unique conference identifier. It can include digits, Latin characters, and underscores. The identifier will be generated automatically if it is not specified manually.

Size range: 1..128
topic String

POST | PUT Conference subject.

Size range: 1..240
description String

POST | PUT Conference description.
owner String

POST | PUT User identifier (user_id) of the conference owner.

Size range: 1..64
type Integer

POST | PUT Conference mode. Click to learn more about available conference modes:
invitations String[]

Invitations list. They are used to automatically invite to the conferences.
max_podiums Integer

The maximum number of conference speakers. The value of this parameter can be changed for “role-based” conferences. In “all-on-screen” conferences, the number of speakers equals the number of participants, while in “video lectures”, it is equal to 1.

Default value: $max_allowed
max_participants Integer

POST | PUT Maximum number of participants depends on the conference mode. Click to learn more about available conference modes:

Default value: $max_allowed
schedule Object

POST | PUT Schedule
allow_guests Boolean

POST | PUT Permission to invite guests to the conference. For editing you need a webinar license.

Default value: false
allow_guests_message Boolean

POST | PUT Permission to send messages to conference guests. For editing you need a webinar license.

Default value: true
allow_guests_audio_video Boolean

POST | PUT Permission to send audio and video data to conference guests. For editing you need a webinar license.

Default value: true
auto_invite Integer

POST | PUT This parameter is responsible for sending automatic invitations at the conference start:

  • 0 - disabled
  • 1 - when any participant joins the conference
  • 2 - when any invited participant joins the conference

Default value: 0
url String

Conference page.
webclient_url String

Conference widget.
state String

Conference state

Allowed values: "running", "stopped" 

{
     "id": "webinar",
     "type": 0,
     "topic": "Topic of conference",
     "owner": "user1@server.name",
     "description": "Description of conference",
     "max_podiums": 25,
     "max_participants": 25,
     "schedule": ObjectSchedule,
     "invitations": [
         "user1"
     ],
     "url": "https://server.name/c/webinar",
     "webclient_url": "https://server.name/webrtc/webinar",
     "allow_guests": true,
     "allow_guests_message": true,
     "allow_guests_audio_video": true,
     "auto_invite": 0,
     "state": "stopped"
 }

Objects | Contact

Contact object from the address book.
Object can contain information from ObjectUser.

object 
Contact

Structure

Field Type Description
type String

The type of the participant invited to the conference.

  • "user" is a server user
  • "custom" is a guest
owner String

Contact owner. It can be null.
If the contact owner is null, the contact is in the same group with the user and cannot be removed.
owner_type Integer

'Core\LDAP\LDAPSearchResult Contact owner type.

  • 1 - group
  • 2 - user

    • Allowed values: 1, 2 

    {
     "id": "1",
     "uid": "1@ru9nd.trueconf.name",
     "avatar": null,
     "display_name": "User 1",
     "login_name": "user1",
     "email": "1@ru9nd.trueconf.name",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "first_name": "",
     "last_name": "",
     "company": "",
     "status": 0,
     "owner": null,
     "type": "user"
 }

    Objects | Contact

    Contact object from the address book.
    Object can contain information from ObjectUser.

    object 
    Contact

    Structure

    Field Type Description
    type String

    The type of the participant invited to the conference.

    • "user" is a server user
    • "custom" is a guest
    owner String

    Contact owner. It can be null.
    If the contact owner is null, the contact is in the same group with the user and cannot be removed.
    owner_type Integer

    'Core\LDAP\LDAPSearchResult Contact owner type.

  • 1 - group
  • 2 - user

    • Allowed values: 1, 2 

    {
     "id": "1",
     "uid": "1@ru9nd.trueconf.name",
     "avatar": null,
     "display_name": "User 1",
     "login_name": "user1",
     "email": "1@ru9nd.trueconf.name",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "first_name": "",
     "last_name": "",
     "company": "",
     "status": 0,
     "owner": null,
     "type": "user"
 }

    Objects | Contact

    Contact object from the address book.
    Object can contain information from ObjectUser.

    object 
    Contact

    Structure

    Field Type Description
    type String

    The type of the participant invited to the conference.

    • "user" is a server user
    • "custom" is a guest
    owner String

    Contact owner. It can be null.
    If the contact owner is null, the contact is in the same group with the user and cannot be removed.
    owner_type Integer

    'Core\LDAP\LDAPSearchResult Contact owner type.

  • 1 - group
  • 2 - user

    • Allowed values: 1, 2 

    {
     "id": "1",
     "uid": "1@ru9nd.trueconf.name",
     "avatar": null,
     "display_name": "User 1",
     "login_name": "user1",
     "email": "1@ru9nd.trueconf.name",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "first_name": "",
     "last_name": "",
     "company": "",
     "status": 0,
     "owner": null,
     "type": "user"
 }

    Objects | Contact

    Contact object from the address book.
    Object can contain information from ObjectUser.

    object 
    Contact

    Structure

    Field Type Description
    type String

    The type of the participant invited to the conference.

    • "user" is a server user
    • "custom" is a guest
    owner String

    Contact owner. It can be null.
    If the contact owner is null, the contact is in the same group with the user and cannot be removed.
    owner_type Integer

    'Core\LDAP\LDAPSearchResult Contact owner type.

  • 1 - group
  • 2 - user

    • Allowed values: 1, 2 

    {
     "id": "1",
     "uid": "1@ru9nd.trueconf.name",
     "avatar": null,
     "display_name": "User 1",
     "login_name": "user1",
     "email": "1@ru9nd.trueconf.name",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "first_name": "",
     "last_name": "",
     "company": "",
     "status": 0,
     "owner": null,
     "type": "user"
 }

    Objects | Contact

    Contact object from the address book.
    Object can contain information from ObjectUser.

    object 
    Contact

    Structure

    Field Type Description
    type String

    The type of the participant invited to the conference.

    • "user" is a server user
    • "custom" is a guest
    owner String

    Contact owner. It can be null.
    If the contact owner is null, the contact is in the same group with the user and cannot be removed.
    owner_type Integer

    'Core\LDAP\LDAPSearchResult Contact owner type.

  • 1 - group
  • 2 - user

    • Allowed values: 1, 2 

    {
     "id": "1",
     "uid": "1@ru9nd.trueconf.name",
     "avatar": null,
     "display_name": "User 1",
     "login_name": "user1",
     "email": "1@ru9nd.trueconf.name",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "first_name": "",
     "last_name": "",
     "company": "",
     "status": 0,
     "owner": null,
     "type": "user"
 }

    Objects | Contact

    Contact object from the address book.
    Object can contain information from ObjectUser.

    object 
    Contact

    Structure

    Field Type Description
    type String

    The type of the participant invited to the conference.

    • "user" is a server user
    • "custom" is a guest
    owner String

    Contact owner. It can be null.
    If the contact owner is null, the contact is in the same group with the user and cannot be removed.
    owner_type Integer

    'Core\LDAP\LDAPSearchResult Contact owner type.

  • 1 - group
  • 2 - user

    • Allowed values: 1, 2 

    {
     "id": "1",
     "uid": "1@ru9nd.trueconf.name",
     "avatar": null,
     "display_name": "User 1",
     "login_name": "user1",
     "email": "1@ru9nd.trueconf.name",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "first_name": "",
     "last_name": "",
     "company": "",
     "status": 0,
     "owner": null,
     "type": "user"
 }

    Objects | Contact

    Contact object from the address book.
    Object can contain information from ObjectUser.

    object 
    Contact

    Structure

    Field Type Description
    type String

    The type of the participant invited to the conference.

    • "user" is a server user
    • "custom" is a guest
    owner String

    Contact owner. It can be null.
    If the contact owner is null, the contact is in the same group with the user and cannot be removed.
    owner_type Integer

    'Core\LDAP\LDAPSearchResult Contact owner type.

  • 1 - group
  • 2 - user

    • Allowed values: 1, 2 

    {
     "id": "1",
     "uid": "1@ru9nd.trueconf.name",
     "avatar": null,
     "display_name": "User 1",
     "login_name": "user1",
     "email": "1@ru9nd.trueconf.name",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "first_name": "",
     "last_name": "",
     "company": "",
     "status": 0,
     "owner": null,
     "type": "user"
 }

    Objects | Contact

    Contact object from the address book.
    Object can contain information from ObjectUser.

    object 
    Contact

    Structure

    Field Type Description
    type String

    The type of the participant invited to the conference.

    • "user" is a server user
    • "custom" is a guest
    owner String

    Contact owner. It can be null.
    If the contact owner is null, the contact is in the same group with the user and cannot be removed.
    owner_type Integer

    'Core\LDAP\LDAPSearchResult Contact owner type.

  • 1 - group
  • 2 - user

    • Allowed values: 1, 2 

    {
     "id": "1",
     "uid": "1@ru9nd.trueconf.name",
     "avatar": null,
     "display_name": "User 1",
     "login_name": "user1",
     "email": "1@ru9nd.trueconf.name",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "first_name": "",
     "last_name": "",
     "company": "",
     "status": 0,
     "owner": null,
     "type": "user"
 }

    Objects | Contact

    Contact object from the address book.
    Object can contain information from ObjectUser.

    object 
    Contact

    Structure

    Field Type Description
    type String

    The type of the participant invited to the conference.

    • "user" is a server user
    • "custom" is a guest
    owner String

    Contact owner. It can be null.
    If the contact owner is null, the contact is in the same group with the user and cannot be removed.
    owner_type Integer

    'Core\LDAP\LDAPSearchResult Contact owner type.

  • 1 - group
  • 2 - user

    • Allowed values: 1, 2 

    {
     "id": "1",
     "uid": "1@ru9nd.trueconf.name",
     "avatar": null,
     "display_name": "User 1",
     "login_name": "user1",
     "email": "1@ru9nd.trueconf.name",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "first_name": "",
     "last_name": "",
     "company": "",
     "status": 0,
     "owner": null,
     "type": "user"
 }

    Objects | Contact

    Contact object from the address book.
    Object can contain information from ObjectUser.

    object 
    Contact

    Structure

    Field Type Description
    type String

    The type of the participant invited to the conference.

    • "user" is a server user
    • "custom" is a guest
    owner String

    Contact owner. It can be null.
    If the contact owner is null, the contact is in the same group with the user and cannot be removed.
    owner_type Integer

    'Core\LDAP\LDAPSearchResult Contact owner type.

  • 1 - group
  • 2 - user

    • Allowed values: 1, 2 

    {
     "id": "1",
     "uid": "1@ru9nd.trueconf.name",
     "avatar": null,
     "display_name": "User 1",
     "login_name": "user1",
     "email": "1@ru9nd.trueconf.name",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "first_name": "",
     "last_name": "",
     "company": "",
     "status": 0,
     "owner": null,
     "type": "user"
 }

    Objects | Contact

    Contact object from the address book.
    Object can contain information from ObjectUser.

    object 
    Contact

    Structure

    Field Type Description
    type String

    The type of the participant invited to the conference.

    • "user" is a server user
    • "custom" is a guest
    owner String

    Contact owner. It can be null.
    If the contact owner is null, the contact is in the same group with the user and cannot be removed.

    		 
    {
    "id": "1",
    "uid": "1@ru9nd.trueconf.name",
    "avatar": null,
    "display_name": "User 1",
    "login_name": "user1",
    "email": "1@ru9nd.trueconf.name",
    "groups": [
        "@no_group"
    ],
    "first_name": "",
    "last_name": "",
    "company": "",
    "status": 0,
    "owner": null,
    "type": "user"
}

    Objects | ErrorDetail

    Detailed error object.
    Detailed errors can be found in ObjectError object.

    object 
    ErrorDetail

    Structure

    Field Type Description
    reason String

    Cause of the error.
    message String

    Detailed error message.
    locationType optional String

    error source category.

    Allowed values: "parameter", "path"

    location optional String

    error source name.

    		 
    {
    "reason": "missingRequiredField",
    "message": "Missing required field.",
    "locationType": "parameter",
    "location": "param_name"
}

    Objects | ErrorDetail

    Detailed error object.
    Detailed errors can be found in ObjectError object.

    object 
    ErrorDetail

    Structure

    Field Type Description
    reason String

    Cause of the error.
    message String

    Detailed error message.
    locationType optional String

    error source category.

    Allowed values: "parameter", "path"

    location optional String

    error source name.

    		 
    {
    "reason": "missingRequiredField",
    "message": "Missing required field.",
    "locationType": "parameter",
    "location": "param_name"
}

    Objects | ErrorDetail

    Detailed error object.
    Detailed errors can be found in ObjectError object.

    object 
    ErrorDetail

    Structure

    Field Type Description
    reason String

    Cause of the error.
    message String

    Detailed error message.
    locationType optional String

    error source category.

    Allowed values: "parameter", "path"

    location optional String

    error source name.

    		 
    {
    "reason": "missingRequiredField",
    "message": "Missing required field.",
    "locationType": "parameter",
    "location": "param_name"
}

    Objects | ErrorDetail

    Detailed error object.
    Detailed errors can be found in ObjectError object.

    object 
    ErrorDetail

    Structure

    Field Type Description
    reason String

    Cause of the error.
    message String

    Detailed error message.
    locationType optional String

    error source category.

    Allowed values: "parameter", "path"

    location optional String

    error source name.

    		 
    {
    "reason": "missingRequiredField",
    "message": "Missing required field.",
    "locationType": "parameter",
    "location": "param_name"
}

    Objects | ErrorDetail

    Detailed error object.
    Detailed errors can be found in ObjectError object.

    object 
    ErrorDetail

    Structure

    Field Type Description
    reason String

    Cause of the error.
    message String

    Detailed error message.
    locationType optional String

    error source category.

    Allowed values: "parameter", "path"

    location optional String

    error source name.

    		 
    {
    "reason": "missingRequiredField",
    "message": "Missing required field.",
    "locationType": "parameter",
    "location": "param_name"
}

    Objects | ErrorDetail

    Detailed error object.
    Detailed errors can be found in ObjectError object.

    object 
    ErrorDetail

    Structure

    Field Type Description
    reason String

    Cause of the error.
    message String

    Detailed error message.
    locationType optional String

    error source category.

    Allowed values: "parameter", "path"

    location optional String

    error source name.

    		 
    {
    "reason": "missingRequiredField",
    "message": "Missing required field.",
    "locationType": "parameter",
    "location": "param_name"
}

    Objects | ErrorDetail

    Detailed error object.
    Detailed errors can be found in ObjectError object.

    object 
    ErrorDetail

    Structure

    Field Type Description
    reason String

    Cause of the error.
    message String

    Detailed error message.
    locationType optional String

    error source category.

    Allowed values: "parameter", "path"

    location optional String

    error source name.

    		 
    {
    "reason": "missingRequiredField",
    "message": "Missing required field.",
    "locationType": "parameter",
    "location": "param_name"
}

    Objects | ErrorDetail

    Detailed error object.
    Detailed errors can be found in ObjectError object.

    object 
    ErrorDetail

    Structure

    Field Type Description
    reason String

    Cause of the error.
    message String

    Detailed error message.
    locationType optional String

    error source category.

    Allowed values: "parameter", "path"

    location optional String

    error source name.

    		 
    {
    "reason": "missingRequiredField",
    "message": "Missing required field.",
    "locationType": "parameter",
    "location": "param_name"
}

    Objects | ErrorDetail

    Detailed error object.
    Detailed errors can be found in ObjectError object.

    object 
    ErrorDetail

    Structure

    Field Type Description
    reason String

    Cause of the error.
    message String

    Detailed error message.
    locationType optional String

    error source category.

    Allowed values: "parameter", "path"

    location optional String

    error source name.

    		 
    {
    "reason": "missingRequiredField",
    "message": "Missing required field.",
    "locationType": "parameter",
    "location": "param_name"
}

    Objects | ErrorDetail

    Detailed error object.
    Detailed errors can be found in ObjectError object.

    object 
    ErrorDetail

    Structure

    Field Type Description
    reason String

    Cause of the error.
    message String

    Detailed error message.
    locationType optional String

    error source category.

    Allowed values: "parameter", "path"

    location optional String

    error source name.

    		 
    {
    "reason": "missingRequiredField",
    "message": "Missing required field.",
    "locationType": "parameter",
    "location": "param_name"
}

    Objects | ErrorDetail

    Detailed error object.
    Detailed errors can be found in ObjectError object.

    object 
    ErrorDetail

    Structure

    Field Type Description
    reason String

    Cause of the error.
    message String

    Detailed error message.
    locationType optional String

    error source category

    Allowed values: "parameter", "path"

    location optional String

    error source name

    		 
    {
    "reason": "missingRequiredField",
    "message": "Missing required field.",
    "locationType": "parameter",
    "location": "param_name"
}

    Objects | Event

    Event log object.

    object 
    Event

    Structure

    Field Type Description
    id String

    Identifier of event.
    event_type String

    Event type.
    object_type String

    Event source object type.
    object_name String

    Event source object name.
    payload String

    Event payload. It is contained changes generated by an event.
    created_at String

    Event detection date. It can be null.
    severity String

    Event severity. It can be null.

    Allowed values: "low", "middle", "high" 

    {
    "id": "513",
    "event_type": "logout",
    "object_type": "user",
    "object_name": "#guest:c33ededa@ruhyn.trueconf.name",
    "payload": {
        "Type": -1,
        "Cause": 0,
        "Method": "UserLoggedout",
        "Result": 0
    },
    "created_at": {
        "date": "2018-04-12 16:38:40.830863",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "severity": "low"
}
    {
    "id": "533",
    "event_type": "status",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "NewStatus": 1,
        "OldStatus": -127,
        "DisplayName": "apiv3_unittest_user"
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.392452",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "severity": "low"
}
    {
    "id": "532",
    "event_type": "login",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "Host": "192.168.62.165",
        "Type": 0,
        "appId": "6193G258515D14A651D3F3AB1CB5912C",
        "Method": "UserLoggedin",
        "Result": 0,
        "Rights": 289341425,
        "AppName": "TrueConf Windows",
        "Session": "0092BA298C12D78EFF5BE8F3B7F5C5FBAE6C2D91",
        "UserName": "apiv3_unittest_user@ruhyn.trueconf.name",
        "ClientType": 0,
        "TarifRestr": 77603876,
        "DisplayName": "apiv3_unittest_user",
        "ProtocolVersion": 47
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.391148",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "severity": "low"
}

    Objects | Event

    Event log object.

    object 
    Event

    Structure

    Field Type Description
    id String

    Identifier of event.
    event_type String

    Event type.
    object_type String

    Event source object type.
    object_name String

    Event source object name.
    payload String

    Event payload. It is contained changes generated by an event.
    created_at String

    Event detection date. It can be null.
    severity String

    Event severity. It can be null.

    Allowed values: "low", "middle", "high" 

    {
    "id": "513",
    "event_type": "logout",
    "object_type": "user",
    "object_name": "#guest:c33ededa@ruhyn.trueconf.name",
    "payload": {
        "Type": -1,
        "Cause": 0,
        "Method": "UserLoggedout",
        "Result": 0
    },
    "created_at": {
        "date": "2018-04-12 16:38:40.830863",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "severity": "low"
}
    {
    "id": "533",
    "event_type": "status",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "NewStatus": 1,
        "OldStatus": -127,
        "DisplayName": "apiv3_unittest_user"
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.392452",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "severity": "low"
}
    {
    "id": "532",
    "event_type": "login",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "Host": "192.168.62.165",
        "Type": 0,
        "appId": "6193G258515D14A651D3F3AB1CB5912C",
        "Method": "UserLoggedin",
        "Result": 0,
        "Rights": 289341425,
        "AppName": "TrueConf Windows",
        "Session": "0092BA298C12D78EFF5BE8F3B7F5C5FBAE6C2D91",
        "UserName": "apiv3_unittest_user@ruhyn.trueconf.name",
        "ClientType": 0,
        "TarifRestr": 77603876,
        "DisplayName": "apiv3_unittest_user",
        "ProtocolVersion": 47
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.391148",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "severity": "low"
}

    Objects | Event

    Event log object.

    object 
    Event

    Structure

    Field Type Description
    id String

    Identifier of event.
    event_type String

    Event type.
    object_type String

    Event source object type.
    object_name String

    Event source object name.
    payload String

    Event payload. It is contained changes generated by an event.
    created_at String

    Event detection date. It can be null.
    severity String

    Event severity. It can be null.

    Allowed values: "low", "middle", "high" 

    {
    "id": "513",
    "event_type": "logout",
    "object_type": "user",
    "object_name": "#guest:c33ededa@ruhyn.trueconf.name",
    "payload": {
        "Type": -1,
        "Cause": 0,
        "Method": "UserLoggedout",
        "Result": 0
    },
    "created_at": {
        "date": "2018-04-12 16:38:40.830863",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "severity": "low"
}
    {
    "id": "533",
    "event_type": "status",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "NewStatus": 1,
        "OldStatus": -127,
        "DisplayName": "apiv3_unittest_user"
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.392452",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "severity": "low"
}
    {
    "id": "532",
    "event_type": "login",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "Host": "192.168.62.165",
        "Type": 0,
        "appId": "6193G258515D14A651D3F3AB1CB5912C",
        "Method": "UserLoggedin",
        "Result": 0,
        "Rights": 289341425,
        "AppName": "TrueConf Windows",
        "Session": "0092BA298C12D78EFF5BE8F3B7F5C5FBAE6C2D91",
        "UserName": "apiv3_unittest_user@ruhyn.trueconf.name",
        "ClientType": 0,
        "TarifRestr": 77603876,
        "DisplayName": "apiv3_unittest_user",
        "ProtocolVersion": 47
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.391148",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "severity": "low"
}

    Objects | Event

    Event log object.

    object 
    Event

    Structure

    Field Type Description
    id String

    Identifier of event.
    event_type String

    Event type.
    object_type String

    Event source object type.
    object_name String

    Event source object name.
    payload String

    Event payload. It is contained changes generated by an event.
    created_at String

    Event detection date. It can be null.
    severity String

    Event severity. It can be null.

    Allowed values: "low", "middle", "high" 

    {
    "id": "513",
    "event_type": "logout",
    "object_type": "user",
    "object_name": "#guest:c33ededa@ruhyn.trueconf.name",
    "payload": {
        "Type": -1,
        "Cause": 0,
        "Method": "UserLoggedout",
        "Result": 0
    },
    "created_at": {
        "date": "2018-04-12 16:38:40.830863",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "severity": "low"
}
    {
    "id": "533",
    "event_type": "status",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "NewStatus": 1,
        "OldStatus": -127,
        "DisplayName": "apiv3_unittest_user"
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.392452",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "severity": "low"
}
    {
    "id": "532",
    "event_type": "login",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "Host": "192.168.62.165",
        "Type": 0,
        "appId": "6193G258515D14A651D3F3AB1CB5912C",
        "Method": "UserLoggedin",
        "Result": 0,
        "Rights": 289341425,
        "AppName": "TrueConf Windows",
        "Session": "0092BA298C12D78EFF5BE8F3B7F5C5FBAE6C2D91",
        "UserName": "apiv3_unittest_user@ruhyn.trueconf.name",
        "ClientType": 0,
        "TarifRestr": 77603876,
        "DisplayName": "apiv3_unittest_user",
        "ProtocolVersion": 47
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.391148",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "severity": "low"
}

    Objects | Event

    Event log object.

    object 
    Event

    Structure

    Field Type Description
    id String

    Identifier of event.
    event_type String

    Event type.
    object_type String

    Event source object type.
    object_name String

    Event source object name.
    payload String

    Event payload. It is contained changes generated by an event.
    created_at String

    Event detection date. It can be null.

    		 
    {
    "id": "513",
    "event_type": "logout",
    "object_type": "user",
    "object_name": "#guest:c33ededa@ruhyn.trueconf.name",
    "payload": {
        "Type": -1,
        "Cause": 0,
        "Method": "UserLoggedout",
        "Result": 0
    },
    "created_at": {
        "date": "2018-04-12 16:38:40.830863",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}
    {
    "id": "533",
    "event_type": "status",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "NewStatus": 1,
        "OldStatus": -127,
        "DisplayName": "apiv3_unittest_user"
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.392452",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}
    {
    "id": "532",
    "event_type": "login",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "Host": "192.168.62.165",
        "Type": 0,
        "appId": "6193G258515D14A651D3F3AB1CB5912C",
        "Method": "UserLoggedin",
        "Result": 0,
        "Rights": 289341425,
        "AppName": "TrueConf Windows",
        "Session": "0092BA298C12D78EFF5BE8F3B7F5C5FBAE6C2D91",
        "UserName": "apiv3_unittest_user@ruhyn.trueconf.name",
        "ClientType": 0,
        "TarifRestr": 77603876,
        "DisplayName": "apiv3_unittest_user",
        "ProtocolVersion": 47
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.391148",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}

    Objects | Event

    Event log object.

    object 
    Event

    Structure

    Field Type Description
    id String

    Identifier of event.
    event_type String

    Event type.
    object_type String

    Event source object type.
    object_name String

    Event source object name.
    payload String

    Event payload. It is contained changes generated by an event.
    created_at String

    Event detection date. It can be null.

    		 
    {
    "id": "513",
    "event_type": "logout",
    "object_type": "user",
    "object_name": "#guest:c33ededa@ruhyn.trueconf.name",
    "payload": {
        "Type": -1,
        "Cause": 0,
        "Method": "UserLoggedout",
        "Result": 0
    },
    "created_at": {
        "date": "2018-04-12 16:38:40.830863",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}
    {
    "id": "533",
    "event_type": "status",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "NewStatus": 1,
        "OldStatus": -127,
        "DisplayName": "apiv3_unittest_user"
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.392452",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}
    {
    "id": "532",
    "event_type": "login",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "Host": "192.168.62.165",
        "Type": 0,
        "appId": "6193G258515D14A651D3F3AB1CB5912C",
        "Method": "UserLoggedin",
        "Result": 0,
        "Rights": 289341425,
        "AppName": "TrueConf Windows",
        "Session": "0092BA298C12D78EFF5BE8F3B7F5C5FBAE6C2D91",
        "UserName": "apiv3_unittest_user@ruhyn.trueconf.name",
        "ClientType": 0,
        "TarifRestr": 77603876,
        "DisplayName": "apiv3_unittest_user",
        "ProtocolVersion": 47
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.391148",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}

    Objects | Event

    Event log object.

    object 
    Event

    Structure

    Field Type Description
    id String

    Identifier of event.
    event_type String

    Event type.
    object_type String

    Event source object type.
    object_name String

    Event source object name.
    payload String

    Event payload. It is contained changes generated by an event.
    created_at String

    Event detection date. It can be null.

    		 
    {
    "id": "513",
    "event_type": "logout",
    "object_type": "user",
    "object_name": "#guest:c33ededa@ruhyn.trueconf.name",
    "payload": {
        "Type": -1,
        "Cause": 0,
        "Method": "UserLoggedout",
        "Result": 0
    },
    "created_at": {
        "date": "2018-04-12 16:38:40.830863",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}
    {
    "id": "533",
    "event_type": "status",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "NewStatus": 1,
        "OldStatus": -127,
        "DisplayName": "apiv3_unittest_user"
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.392452",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}
    {
    "id": "532",
    "event_type": "login",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "Host": "192.168.62.165",
        "Type": 0,
        "appId": "6193G258515D14A651D3F3AB1CB5912C",
        "Method": "UserLoggedin",
        "Result": 0,
        "Rights": 289341425,
        "AppName": "TrueConf Windows",
        "Session": "0092BA298C12D78EFF5BE8F3B7F5C5FBAE6C2D91",
        "UserName": "apiv3_unittest_user@ruhyn.trueconf.name",
        "ClientType": 0,
        "TarifRestr": 77603876,
        "DisplayName": "apiv3_unittest_user",
        "ProtocolVersion": 47
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.391148",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}

    Objects | Event

    Event log object.

    object 
    Event

    Structure

    Field Type Description
    id String

    Identifier of event.
    event_type String

    Event type.
    object_type String

    Event source object type.
    object_name String

    Event source object name.
    payload String

    Event payload. It is contained changes generated by an event.
    created_at String

    Event detection date. It can be null.

    		 
    {
    "id": "513",
    "event_type": "logout",
    "object_type": "user",
    "object_name": "#guest:c33ededa@ruhyn.trueconf.name",
    "payload": {
        "Type": -1,
        "Cause": 0,
        "Method": "UserLoggedout",
        "Result": 0
    },
    "created_at": {
        "date": "2018-04-12 16:38:40.830863",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}
    {
    "id": "533",
    "event_type": "status",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "NewStatus": 1,
        "OldStatus": -127,
        "DisplayName": "apiv3_unittest_user"
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.392452",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}
    {
    "id": "532",
    "event_type": "login",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "Host": "192.168.62.165",
        "Type": 0,
        "appId": "6193G258515D14A651D3F3AB1CB5912C",
        "Method": "UserLoggedin",
        "Result": 0,
        "Rights": 289341425,
        "AppName": "TrueConf Windows",
        "Session": "0092BA298C12D78EFF5BE8F3B7F5C5FBAE6C2D91",
        "UserName": "apiv3_unittest_user@ruhyn.trueconf.name",
        "ClientType": 0,
        "TarifRestr": 77603876,
        "DisplayName": "apiv3_unittest_user",
        "ProtocolVersion": 47
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.391148",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}

    Objects | Event

    Event log object.

    object 
    Event

    Structure

    Field Type Description
    id String

    Identifier of event.
    event_type String

    Event type.
    object_type String

    Event source object type.
    object_name String

    Event source object name.
    payload String

    Event payload. It is contained changes generated by an event.
    created_at String

    Event detection date. It can be null.

    		 
    {
    "id": "513",
    "event_type": "logout",
    "object_type": "user",
    "object_name": "#guest:c33ededa@ruhyn.trueconf.name",
    "payload": {
        "Type": -1,
        "Cause": 0,
        "Method": "UserLoggedout",
        "Result": 0
    },
    "created_at": {
        "date": "2018-04-12 16:38:40.830863",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}
    {
    "id": "533",
    "event_type": "status",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "NewStatus": 1,
        "OldStatus": -127,
        "DisplayName": "apiv3_unittest_user"
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.392452",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}
    {
    "id": "532",
    "event_type": "login",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "Host": "192.168.62.165",
        "Type": 0,
        "appId": "6193G258515D14A651D3F3AB1CB5912C",
        "Method": "UserLoggedin",
        "Result": 0,
        "Rights": 289341425,
        "AppName": "TrueConf Windows",
        "Session": "0092BA298C12D78EFF5BE8F3B7F5C5FBAE6C2D91",
        "UserName": "apiv3_unittest_user@ruhyn.trueconf.name",
        "ClientType": 0,
        "TarifRestr": 77603876,
        "DisplayName": "apiv3_unittest_user",
        "ProtocolVersion": 47
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.391148",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}

    Objects | Event

    Event log object.

    object 
    Event

    Structure

    Field Type Description
    id String

    Identifier of event.
    event_type String

    Event type.
    object_type String

    Event source object type.
    object_name String

    Event source object name.
    payload String

    Event payload. It is contained changes generated by an event.
    created_at String

    Event detection date. It can be null.

    		 
    {
    "id": "513",
    "event_type": "logout",
    "object_type": "user",
    "object_name": "#guest:c33ededa@ruhyn.trueconf.name",
    "payload": {
        "Type": -1,
        "Cause": 0,
        "Method": "UserLoggedout",
        "Result": 0
    },
    "created_at": {
        "date": "2018-04-12 16:38:40.830863",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}
    {
    "id": "533",
    "event_type": "status",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "NewStatus": 1,
        "OldStatus": -127,
        "DisplayName": "apiv3_unittest_user"
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.392452",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}
    {
    "id": "532",
    "event_type": "login",
    "object_type": "user",
    "object_name": "apiv3_unittest_user@ruhyn.trueconf.name",
    "payload": {
        "Host": "192.168.62.165",
        "Type": 0,
        "appId": "6193G258515D14A651D3F3AB1CB5912C",
        "Method": "UserLoggedin",
        "Result": 0,
        "Rights": 289341425,
        "AppName": "TrueConf Windows",
        "Session": "0092BA298C12D78EFF5BE8F3B7F5C5FBAE6C2D91",
        "UserName": "apiv3_unittest_user@ruhyn.trueconf.name",
        "ClientType": 0,
        "TarifRestr": 77603876,
        "DisplayName": "apiv3_unittest_user",
        "ProtocolVersion": 47
    },
    "created_at": {
        "date": "2018-04-12 17:13:38.391148",
        "timezone_type": 3,
        "timezone": "Europe/London"
    }
}

    Objects | Group

    Group object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    POST | PUT Unique group name.
    rights String[]

    POST | PUT Group rights list.

    Allowed values: "make_calls", "collaboration_tools", "create_group_conference", "address_book_editing", "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "make_calls",
        "collaboration_tools",
        "create_group_conference",
        "address_book_editing",
        "operator_rights"
    ]
}

    Objects | Group

    Group object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    POST | PUT Unique group name.
    rights String[]

    POST | PUT Group rights list.

    Allowed values: "make_calls", "collaboration_tools", "create_group_conference", "address_book_editing", "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "make_calls",
        "collaboration_tools",
        "create_group_conference",
        "address_book_editing",
        "operator_rights"
    ]
}

    Objects | Group

    Group object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    POST | PUT Unique group name.
    rights String[]

    POST | PUT Group rights list.

    Allowed values: "make_calls", "collaboration_tools", "create_group_conference", "address_book_editing", "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "make_calls",
        "collaboration_tools",
        "create_group_conference",
        "address_book_editing",
        "operator_rights"
    ]
}

    Objects | Group

    Group object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    POST | PUT Unique group name.
    rights String[]

    POST | PUT Group rights list.

    Allowed values: "make_calls", "collaboration_tools", "create_group_conference", "address_book_editing", "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "make_calls",
        "collaboration_tools",
        "create_group_conference",
        "address_book_editing",
        "operator_rights"
    ]
}

    Objects | Group

    Group object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    POST | PUT Unique group name.
    rights String[]

    POST | PUT Group rights list.

    Allowed values: "make_calls", "collaboration_tools", "create_group_conference", "address_book_editing", "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "make_calls",
        "collaboration_tools",
        "create_group_conference",
        "address_book_editing",
        "operator_rights"
    ]
}

    Objects | Group

    Group object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    POST | PUT Unique group name.
    rights String[]

    POST | PUT Group rights list.

    Allowed values: "address_book_editing", "make_calls", "create_group_conference", "screen_sharing", "remote_desktop_control", "slideshow", "file_sharing", "conference_recording", "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "address_book_editing",
        "make_calls",
        "create_group_conference",
        "screen_sharing",
        "remote_desktop_control",
        "slideshow",
        "file_sharing",
        "conference_recording",
        "operator_rights"
    ]
}

    Objects | Group

    Group object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    POST | PUT Unique group name.
    rights String[]

    POST | PUT Group rights list.

    Allowed values: "address_book_editing", "make_calls", "create_group_conference", "screen_sharing", "remote_desktop_control", "slideshow", "file_sharing", "conference_recording", "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "address_book_editing",
        "make_calls",
        "create_group_conference",
        "screen_sharing",
        "remote_desktop_control",
        "slideshow",
        "file_sharing",
        "conference_recording",
        "operator_rights"
    ]
}

    Objects | Group

    Group object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    POST | PUT Unique group name.
    rights String[]

    POST | PUT Group rights list.

    Allowed values: "make_calls", "collaboration_tools", "create_group_conference", "address_book_editing", "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "make_calls",
        "collaboration_tools",
        "create_group_conference",
        "address_book_editing",
        "operator_rights"
    ]
}

    Objects | Group

    Group object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    POST | PUT Unique group name.
    rights String[]

    POST | PUT Group rights list.

    Allowed values: "make_calls", "collaboration_tools", "create_group_conference", "address_book_editing", "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "make_calls",
        "collaboration_tools",
        "create_group_conference",
        "address_book_editing",
        "operator_rights"
    ]
}

    Objects | Group

    Group object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    POST | PUT Unique group name.
    rights String[]

    POST | PUT Group rights list.

    Allowed values: "make_calls", "collaboration_tools", "create_group_conference", "address_book_editing", "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "make_calls",
        "collaboration_tools",
        "create_group_conference",
        "address_book_editing",
        "operator_rights"
    ]
}

    Objects | Group

    Group object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    POST | PUT Unique group name.
    rights String[]

    POST | PUT Group rights list.

    Allowed values: "make_calls", "collaboration_tools", "create_group_conference", "address_book_editing", "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "make_calls",
        "collaboration_tools",
        "create_group_conference",
        "address_book_editing",
        "operator_rights"
    ]
}

    Objects | Invitation

    Conference invitation object.
    The object can contain information from ObjectUser.

    object 
    Invitation

    Structure

    Field Type Description
    id String

    POST Identifier of user.

    Allowed values: 1..64

    display_name String

    POST | PUT Display user name.

    Allowed values: 1..64

    is_owner Boolean

    If the user is the conference owner.
    type String

    The type of the participant invited to the conference:

    • "user" - server user
    • "custom" - guest
    translator Object

    Translator object.
    It can be null.
    If the object is not null then the participant has the role of a translator.

    		 
    {
    "id": "user1",
    "uid": "user1@ru9nd.trueconf.name",
    "avatar": null,
    "login_name": "user1",
    "email": "user1@ru9nd.trueconf.name",
    "display_name": "user1",
    "first_name": "",
    "last_name": "",
    "company": "",
    "groups": [
        {ObjectGroupMini},
        {ObjectGroupMini},
    ],
    "mobile_phone": "",
    "work_phone": "",
    "home_phone": "",
    "is_active": 1,
    "status": 1,
    "is_owner": true,
    "type": "user",
    "translator": {
        "languages": [
            "ru",
            "en"
        ]
    }
 }

    Objects | Invitation

    Conference invitation object.
    The object can contain information from ObjectUser.

    object 
    Invitation

    Structure

    Field Type Description
    id String

    POST Identifier of user.

    Allowed values: 1..64

    display_name String

    POST | PUT Display user name.

    Allowed values: 1..64

    is_owner Boolean

    If the user is the conference owner.
    type String

    The type of the participant invited to the conference:

    • "user" - server user
    • "custom" - guest
    translator Object

    Translator object.
    It can be null.
    If the object is not null then the participant has the role of a translator.

    		 
    {
    "id": "user1",
    "uid": "user1@ru9nd.trueconf.name",
    "avatar": null,
    "login_name": "user1",
    "email": "user1@ru9nd.trueconf.name",
    "display_name": "user1",
    "first_name": "",
    "last_name": "",
    "company": "",
    "groups": [
        {ObjectGroupMini},
        {ObjectGroupMini},
    ],
    "mobile_phone": "",
    "work_phone": "",
    "home_phone": "",
    "is_active": 1,
    "status": 1,
    "is_owner": true,
    "type": "user",
    "translator": {
        "languages": [
            "ru",
            "en"
        ]
    }
 }

    Objects | Invitation

    Conference invitation object.
    The object can contain information from ObjectUser.

    object 
    Invitation

    Structure

    Field Type Description
    id String

    POST Identifier of user.

    Allowed values: 1..64

    display_name String

    POST | PUT Display user name.

    Allowed values: 1..64

    is_owner Boolean

    If the user is the conference owner.
    type String

    The type of the participant invited to the conference:

    • "user" - server user
    • "custom" - guest
    		 
    {
    "id": "user1",
    "uid": "user1@ru9nd.trueconf.name",
    "avatar": null,
    "login_name": "user1",
    "email": "user1@ru9nd.trueconf.name",
    "display_name": "user1",
    "first_name": "",
    "last_name": "",
    "company": "",
    "groups": [
        {ObjectGroupMini},
        {ObjectGroupMini},
    ],
    "mobile_phone": "",
    "work_phone": "",
    "home_phone": "",
    "is_active": 1,
    "status": 1,
    "is_owner": true,
    "type": "user"
 }

    Objects | Invitation

    Conference invitation object.
    The object can contain information from ObjectUser.

    object 
    Invitation

    Structure

    Field Type Description
    id String

    POST Identifier of user.

    Allowed values: 1..64

    display_name String

    POST | PUT Display user name.

    Allowed values: 1..64

    is_owner Boolean

    If the user is the conference owner.
    type String

    The type of the participant invited to the conference:

    • "user" - server user
    • "custom" - guest
    		 
    {
    "id": "user1",
    "uid": "user1@ru9nd.trueconf.name",
    "avatar": null,
    "login_name": "user1",
    "email": "user1@ru9nd.trueconf.name",
    "display_name": "user1",
    "first_name": "",
    "last_name": "",
    "company": "",
    "groups": [
        {ObjectGroupMini},
        {ObjectGroupMini},
    ],
    "mobile_phone": "",
    "work_phone": "",
    "home_phone": "",
    "is_active": 1,
    "status": 1,
    "is_owner": true,
    "type": "user"
 }

    Objects | Invitation

    Conference invitation object.
    The object can contain information from ObjectUser.

    object 
    Invitation

    Structure

    Field Type Description
    id String

    POST Identifier of user.

    Allowed values: 1..64

    display_name String

    POST | PUT Display user name.

    Allowed values: 1..64

    is_owner Boolean

    If the user is the conference owner.
    type String

    The type of the participant invited to the conference:

    • "user" - server user
    • "custom" - guest
    		 
    {
    "id": "user1",
    "uid": "user1@ru9nd.trueconf.name",
    "avatar": null,
    "login_name": "user1",
    "email": "user1@ru9nd.trueconf.name",
    "display_name": "user1",
    "first_name": "",
    "last_name": "",
    "company": "",
    "groups": [
        {ObjectGroupMini},
        {ObjectGroupMini},
    ],
    "mobile_phone": "",
    "work_phone": "",
    "home_phone": "",
    "is_active": 1,
    "status": 1,
    "is_owner": true,
    "type": "user"
 }

    Objects | Invitation

    Conference invitation object.
    The object can contain information from ObjectUser.

    object 
    Invitation

    Structure

    Field Type Description
    id String

    POST Identifier of user.

    Allowed values: 1..64

    display_name String

    POST | PUT Display user name.

    Allowed values: 1..64

    is_owner Boolean

    If the user is the conference owner.
    type String

    The type of the participant invited to the conference:

    • "user" - server user
    • "custom" - guest
    		 
    {
    "id": "user1",
    "uid": "user1@ru9nd.trueconf.name",
    "avatar": null,
    "login_name": "user1",
    "email": "user1@ru9nd.trueconf.name",
    "display_name": "user1",
    "first_name": "",
    "last_name": "",
    "company": "",
    "groups": [
        {ObjectGroupMini},
        {ObjectGroupMini},
    ],
    "mobile_phone": "",
    "work_phone": "",
    "home_phone": "",
    "is_active": 1,
    "status": 1,
    "is_owner": true,
    "type": "user"
 }

    Objects | Invitation

    Conference invitation object.
    The object can contain information from ObjectUser.

    object 
    Invitation

    Structure

    Field Type Description
    id String

    POST Identifier of user.

    Allowed values: 1..64

    display_name String

    POST | PUT Display user name.

    Allowed values: 1..64

    is_owner Boolean

    If the user is the conference owner.
    type String

    The type of the participant invited to the conference:

    • "user" - server user
    • "custom" - guest
    		 
    {
    "id": "user1",
    "uid": "user1@ru9nd.trueconf.name",
    "avatar": null,
    "login_name": "user1",
    "email": "user1@ru9nd.trueconf.name",
    "display_name": "user1",
    "first_name": "",
    "last_name": "",
    "company": "",
    "groups": [
        {ObjectGroupMini},
        {ObjectGroupMini},
    ],
    "mobile_phone": "",
    "work_phone": "",
    "home_phone": "",
    "is_active": 1,
    "status": 1,
    "is_owner": true,
    "type": "user"
 }

    Objects | Invitation

    Conference invitation object.
    The object can contain information from ObjectUser.

    object 
    Invitation

    Structure

    Field Type Description
    id String

    POST Identifier of user.

    Allowed values: 1..64

    display_name String

    POST | PUT Display user name.

    Allowed values: 1..64

    is_owner Boolean

    If the user is the conference owner.
    type String

    The type of the participant invited to the conference:

    • "user" - server user
    • "custom" - guest
    		 
    {
    "id": "user1",
    "uid": "user1@ru9nd.trueconf.name",
    "avatar": null,
    "login_name": "user1",
    "email": "user1@ru9nd.trueconf.name",
    "display_name": "user1",
    "first_name": "",
    "last_name": "",
    "company": "",
    "groups": [
        {ObjectGroupMini},
        {ObjectGroupMini},
    ],
    "mobile_phone": "",
    "work_phone": "",
    "home_phone": "",
    "is_active": 1,
    "status": 1,
    "is_owner": true,
    "type": "user"
 }

    Objects | Invitation

    Conference invitation object.
    The object can contain information from ObjectUser.

    object 
    Invitation

    Structure

    Field Type Description
    id String

    POST Identifier of user.

    Allowed values: 1..64

    display_name String

    POST | PUT Display user name.

    Allowed values: 1..64

    is_owner Boolean

    If the user is the conference owner.
    type String

    The type of the participant invited to the conference:

    • "user" - server user
    • "custom" - guest
    		 
    {
    "id": "user1",
    "uid": "user1@ru9nd.trueconf.name",
    "avatar": null,
    "login_name": "user1",
    "email": "user1@ru9nd.trueconf.name",
    "display_name": "user1",
    "first_name": "",
    "last_name": "",
    "company": "",
    "groups": [
        {ObjectGroupMini},
        {ObjectGroupMini},
    ],
    "mobile_phone": "",
    "work_phone": "",
    "home_phone": "",
    "is_active": 1,
    "status": 1,
    "is_owner": true,
    "type": "user"
 }

    Objects | Invitation

    Conference invitation object.
    The object can contain information from ObjectUser.

    object 
    Invitation

    Structure

    Field Type Description
    id String

    POST Identifier of user.

    Allowed values: 1..64

    display_name String

    POST | PUT Display user name.

    Allowed values: 1..64

    is_owner Boolean

    If the user is the conference owner.
    type String

    The type of the participant invited to the conference:

    • "user" - server user
    • "custom" - guest
    		 
    {
    "id": "user1",
    "uid": "user1@ru9nd.trueconf.name",
    "avatar": null,
    "login_name": "user1",
    "email": "user1@ru9nd.trueconf.name",
    "display_name": "user1",
    "first_name": "",
    "last_name": "",
    "company": "",
    "groups": [
        {ObjectGroupMini},
        {ObjectGroupMini},
    ],
    "mobile_phone": "",
    "work_phone": "",
    "home_phone": "",
    "is_active": 1,
    "status": 1,
    "is_owner": true,
    "type": "user"
 }

    Objects | Invitation

    Conference invitation object.
    The object can contain information from ObjectUser.

    object 
    Invitation

    Structure

    Field Type Description
    id String

    POST Identifier of user.

    Allowed values: 1..64

    display_name String

    POST | PUT Display user name.

    Allowed values: 1..64

    is_owner Boolean

    If the user is the conference owner
    type String

    The type of the participant invited to the conference

    • "user" - server user
    • "custom" - guest
    		 
    {
    "id": "user1",
    "uid": "user1@ru9nd.trueconf.name",
    "avatar": null,
    "login_name": "user1",
    "email": "user1@ru9nd.trueconf.name",
    "display_name": "user1",
    "first_name": "",
    "last_name": "",
    "company": "",
    "groups": [
        "@no_group"
    ],
    "mobile_phone": "",
    "work_phone": "",
    "home_phone": "",
    "is_active": 1,
    "status": 1,
    "is_owner": true,
    "type": "user"
}

    Objects | Mini Group

    Group object for using in User based object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    Unique group name.
    rights String[]

    Group rights list, limited to operator_rights value.

    Allowed values: "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "operator_rights"
    ]
}

    Objects | Mini Group

    Group object for using in User based object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    Unique group name.
    rights String[]

    Group rights list, limited to operator_rights value.

    Allowed values: "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "operator_rights"
    ]
}

    Objects | Mini Group

    Group object for using in User based object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    Unique group name.
    rights String[]

    Group rights list, limited to operator_rights value.

    Allowed values: "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "operator_rights"
    ]
}

    Objects | Mini Group

    Group object for using in User based object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    Unique group name.
    rights String[]

    Group rights list, limited to operator_rights value.

    Allowed values: "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "operator_rights"
    ]
}

    Objects | Mini Group

    Group object for using in User based object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    Unique group name.
    rights String[]

    Group rights list, limited to operator_rights value.

    Allowed values: "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "operator_rights"
    ]
}

    Objects | Mini Group

    Group object for using in User based object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    Unique group name.
    rights String[]

    Group rights list, limited to operator_rights value.

    Allowed values: "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "operator_rights"
    ]
}

    Objects | Mini Group

    Group object for using in User based object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    Unique group name.
    rights String[]

    Group rights list, limited to operator_rights value.

    Allowed values: "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "operator_rights"
    ]
}

    Objects | Mini Group

    Group object for using in User based object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    Unique group name.
    rights String[]

    Group rights list, limited to operator_rights value.

    Allowed values: "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "operator_rights"
    ]
}

    Objects | Mini Group

    Group object for using in User based object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    Unique group name.
    rights String[]

    Group rights list, limited to operator_rights value.

    Allowed values: "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "operator_rights"
    ]
}

    Objects | Mini Group

    Group object for using in User based object.

    object 
    Group

    Structure

    Field Type Description
    id String

    Unique group ID.
    display_name String

    Unique group name.
    rights String[]

    Group rights list, limited to operator_rights value.

    Allowed values: "operator_rights" 

    {
    "id": "group_id1",
    "display_name": "Group Name",
    "rights": [
        "operator_rights"
    ]
}

    Objects | Mini Invitation

    Conference invitation object for using in Conference based object.
    The object can contain information from ObjectUser.

    object 
    Invitation

    Structure

    Field Type Description
    id String

    Identifier of user.
    display_name String

    Display user name.
    translator Object

    Translator object.
    It can be null.
    If the object is not null then the participant has the role of a translator.

    		 
    {
    "id": "user1",
    "display_name": "user1",
    "translator": {ObjectTranslator}
 }

    Objects | Mini Invitation

    Conference invitation object for using in Conference based object.
    The object can contain information from ObjectUser.

    object 
    Invitation

    Structure

    Field Type Description
    id String

    Identifier of user.
    display_name String

    Display user name.
    translator Object

    Translator object.
    It can be null.
    If the object is not null then the participant has the role of a translator.

    		 
    {
    "id": "user1",
    "display_name": "user1",
    "translator": {ObjectTranslator}
 }

    Objects | Participant

    Conference participant object.
    Both server users and guests can be conference participants.
    The object can contain information from ObjectUser.

    object 
    Participant

    Structure

    Field Type Description
    invite_time Integer

    Conference participant invitation time in UNIX Timestamp.
    It can be null.
    join_time Integer

    Conference participant connection time in UNIX Timestamp.
    It can be null.
    is_owner Boolean

    If the user is the conference owner.

    		 
    {
    "id": "#guest:2cbb00f@server.name",
    "display_name": "guest123",
    "join_time": 1510067899,
    "login_name": "#guest:2cbb00f",
    "status": 0,
    "is_owner": false
}
    {
      "id": "user1@serer.name",
      "uid": "user1@server.name",
      "avatar": null,
      "login_name": "user1",
      "email": "user1@server.name",
      "display_name": "user1",
      "first_name": "",
      "last_name": "",
      "company": "",
      "groups": [
          {ObjectGroupMini},
          {ObjectGroupMini},
      ],
      "mobile_phone": "",
      "work_phone": "",
      "home_phone": "",
      "is_active": 1,
      "status": 5,
      "join_time": 1510067906,
      "is_owner": true
}

    Objects | Participant

    Conference participant object.
    Both server users and guests can be conference participants.
    The object can contain information from ObjectUser.

    object 
    Participant

    Structure

    Field Type Description
    invite_time Integer

    Conference participant invitation time in UNIX Timestamp.
    It can be null.
    join_time Integer

    Conference participant connection time in UNIX Timestamp.
    It can be null.
    is_owner Boolean

    If the user is the conference owner.

    		 
    {
    "id": "#guest:2cbb00f@server.name",
    "display_name": "guest123",
    "join_time": 1510067899,
    "login_name": "#guest:2cbb00f",
    "status": 0,
    "is_owner": false
}
    {
      "id": "user1@serer.name",
      "uid": "user1@server.name",
      "avatar": null,
      "login_name": "user1",
      "email": "user1@server.name",
      "display_name": "user1",
      "first_name": "",
      "last_name": "",
      "company": "",
      "groups": [
          {ObjectGroupMini},
          {ObjectGroupMini},
      ],
      "mobile_phone": "",
      "work_phone": "",
      "home_phone": "",
      "is_active": 1,
      "status": 5,
      "join_time": 1510067906,
      "is_owner": true
}

    Objects | Participant

    Conference participant object.
    Both server users and guests can be conference participants.
    The object can contain information from ObjectUser.

    object 
    Participant

    Structure

    Field Type Description
    invite_time Integer

    Conference participant invitation time in UNIX Timestamp.
    It can be null.
    join_time Integer

    Conference participant connection time in UNIX Timestamp.
    It can be null.
    is_owner Boolean

    If the user is the conference owner.

    		 
    {
    "id": "#guest:2cbb00f@server.name",
    "display_name": "guest123",
    "join_time": 1510067899,
    "login_name": "#guest:2cbb00f",
    "status": 0,
    "is_owner": false
}
    {
      "id": "user1@serer.name",
      "uid": "user1@server.name",
      "avatar": null,
      "login_name": "user1",
      "email": "user1@server.name",
      "display_name": "user1",
      "first_name": "",
      "last_name": "",
      "company": "",
      "groups": [
          {ObjectGroupMini},
          {ObjectGroupMini},
      ],
      "mobile_phone": "",
      "work_phone": "",
      "home_phone": "",
      "is_active": 1,
      "status": 5,
      "join_time": 1510067906,
      "is_owner": true
}

    Objects | Participant

    Conference participant object.
    Both server users and guests can be conference participants.
    The object can contain information from ObjectUser.

    object 
    Participant

    Structure

    Field Type Description
    invite_time Integer

    Conference participant invitation time in UNIX Timestamp.
    It can be null.
    join_time Integer

    Conference participant connection time in UNIX Timestamp.
    It can be null.
    is_owner Boolean

    If the user is the conference owner.

    		 
    {
    "id": "#guest:2cbb00f@server.name",
    "display_name": "guest123",
    "join_time": 1510067899,
    "login_name": "#guest:2cbb00f",
    "status": 0,
    "is_owner": false
}
    {
      "id": "user1@serer.name",
      "uid": "user1@server.name",
      "avatar": null,
      "login_name": "user1",
      "email": "user1@server.name",
      "display_name": "user1",
      "first_name": "",
      "last_name": "",
      "company": "",
      "groups": [
          {ObjectGroupMini},
          {ObjectGroupMini},
      ],
      "mobile_phone": "",
      "work_phone": "",
      "home_phone": "",
      "is_active": 1,
      "status": 5,
      "join_time": 1510067906,
      "is_owner": true
}

    Objects | Participant

    Conference participant object.
    Both server users and guests can be conference participants.
    The object can contain information from ObjectUser.

    object 
    Participant

    Structure

    Field Type Description
    invite_time Integer

    Conference participant invitation time in UNIX Timestamp.
    It can be null.
    join_time Integer

    Conference participant connection time in UNIX Timestamp.
    It can be null.
    is_owner Boolean

    If the user is the conference owner.

    		 
    {
    "id": "#guest:2cbb00f@server.name",
    "display_name": "guest123",
    "join_time": 1510067899,
    "login_name": "#guest:2cbb00f",
    "status": 0,
    "is_owner": false
}
    {
      "id": "user1@serer.name",
      "uid": "user1@server.name",
      "avatar": null,
      "login_name": "user1",
      "email": "user1@server.name",
      "display_name": "user1",
      "first_name": "",
      "last_name": "",
      "company": "",
      "groups": [
          {ObjectGroupMini},
          {ObjectGroupMini},
      ],
      "mobile_phone": "",
      "work_phone": "",
      "home_phone": "",
      "is_active": 1,
      "status": 5,
      "join_time": 1510067906,
      "is_owner": true
}

    Objects | Participant

    Conference participant object.
    Both server users and guests can be conference participants.
    The object can contain information from ObjectUser.

    object 
    Participant

    Structure

    Field Type Description
    invite_time Integer

    Conference participant invitation time in UNIX Timestamp.
    It can be null.
    join_time Integer

    Conference participant connection time in UNIX Timestamp.
    It can be null.
    is_owner Boolean

    If the user is the conference owner.

    		 
    {
    "id": "#guest:2cbb00f@server.name",
    "display_name": "guest123",
    "join_time": 1510067899,
    "login_name": "#guest:2cbb00f",
    "status": 0,
    "is_owner": false
}
    {
      "id": "user1@serer.name",
      "uid": "user1@server.name",
      "avatar": null,
      "login_name": "user1",
      "email": "user1@server.name",
      "display_name": "user1",
      "first_name": "",
      "last_name": "",
      "company": "",
      "groups": [
          {ObjectGroupMini},
          {ObjectGroupMini},
      ],
      "mobile_phone": "",
      "work_phone": "",
      "home_phone": "",
      "is_active": 1,
      "status": 5,
      "join_time": 1510067906,
      "is_owner": true
}

    Objects | Participant

    Conference participant object.
    Both server users and guests can be conference participants.
    The object can contain information from ObjectUser.

    object 
    Participant

    Structure

    Field Type Description
    invite_time Integer

    Conference participant invitation time in UNIX Timestamp.
    It can be null.
    join_time Integer

    Conference participant connection time in UNIX Timestamp.
    It can be null.
    is_owner Boolean

    If the user is the conference owner.

    		 
    {
    "id": "#guest:2cbb00f@server.name",
    "display_name": "guest123",
    "join_time": 1510067899,
    "login_name": "#guest:2cbb00f",
    "status": 0,
    "is_owner": false
}
    {
      "id": "user1@serer.name",
      "uid": "user1@server.name",
      "avatar": null,
      "login_name": "user1",
      "email": "user1@server.name",
      "display_name": "user1",
      "first_name": "",
      "last_name": "",
      "company": "",
      "groups": [
          {ObjectGroupMini},
          {ObjectGroupMini},
      ],
      "mobile_phone": "",
      "work_phone": "",
      "home_phone": "",
      "is_active": 1,
      "status": 5,
      "join_time": 1510067906,
      "is_owner": true
}

    Objects | Participant

    Conference participant object.
    Both server users and guests can be conference participants.
    The object can contain information from ObjectUser.

    object 
    Participant

    Structure

    Field Type Description
    invite_time Integer

    Conference participant invitation time in UNIX Timestamp.
    It can be null.
    join_time Integer

    Conference participant connection time in UNIX Timestamp.
    It can be null.
    is_owner Boolean

    If the user is the conference owner.

    		 
    {
    "id": "#guest:2cbb00f@server.name",
    "display_name": "guest123",
    "join_time": 1510067899,
    "login_name": "#guest:2cbb00f",
    "status": 0,
    "is_owner": false
}
    {
      "id": "user1@serer.name",
      "uid": "user1@server.name",
      "avatar": null,
      "login_name": "user1",
      "email": "user1@server.name",
      "display_name": "user1",
      "first_name": "",
      "last_name": "",
      "company": "",
      "groups": [
          {ObjectGroupMini},
          {ObjectGroupMini},
      ],
      "mobile_phone": "",
      "work_phone": "",
      "home_phone": "",
      "is_active": 1,
      "status": 5,
      "join_time": 1510067906,
      "is_owner": true
}

    Objects | Participant

    Conference participant object.
    Both server users and guests can be conference participants.
    The object can contain information from ObjectUser.

    object 
    Participant

    Structure

    Field Type Description
    invite_time Integer

    Conference participant invitation time in UNIX Timestamp.
    It can be null.
    join_time Integer

    Conference participant connection time in UNIX Timestamp.
    It can be null.
    is_owner Boolean

    If the user is the conference owner.

    		 
    {
    "id": "#guest:2cbb00f@server.name",
    "display_name": "guest123",
    "join_time": 1510067899,
    "login_name": "#guest:2cbb00f",
    "status": 0,
    "is_owner": false
}
    {
      "id": "user1@serer.name",
      "uid": "user1@server.name",
      "avatar": null,
      "login_name": "user1",
      "email": "user1@server.name",
      "display_name": "user1",
      "first_name": "",
      "last_name": "",
      "company": "",
      "groups": [
          {ObjectGroupMini},
          {ObjectGroupMini},
      ],
      "mobile_phone": "",
      "work_phone": "",
      "home_phone": "",
      "is_active": 1,
      "status": 5,
      "join_time": 1510067906,
      "is_owner": true
}

    Objects | Participant

    Conference participant object.
    Both server users and guests can be conference participants.
    The object can contain information from ObjectUser.

    object 
    Participant

    Structure

    Field Type Description
    invite_time Integer

    Conference participant invitation time in UNIX Timestamp.
    It can be null.
    join_time Integer

    Conference participant connection time in UNIX Timestamp.
    It can be null.
    is_owner Boolean

    If the user is the conference owner.

    		 
    {
    "id": "#guest:2cbb00f@server.name",
    "display_name": "guest123",
    "join_time": 1510067899,
    "login_name": "#guest:2cbb00f",
    "status": 0,
    "is_owner": false
}
    {
      "id": "user1@serer.name",
      "uid": "user1@server.name",
      "avatar": null,
      "login_name": "user1",
      "email": "user1@server.name",
      "display_name": "user1",
      "first_name": "",
      "last_name": "",
      "company": "",
      "groups": [
          {ObjectGroupMini},
          {ObjectGroupMini},
      ],
      "mobile_phone": "",
      "work_phone": "",
      "home_phone": "",
      "is_active": 1,
      "status": 5,
      "join_time": 1510067906,
      "is_owner": true
}

    Objects | Participant

    Conference participant object.
    Both server users and guests can be conference participants.

    object 
    Participant

    Structure

    Field Type Description
    invite_time Integer

    Conference participant invitation time in UNIX Timestamp.
    It can be null
    join_time Integer

    Conference participant connection time in UNIX Timestamp.
    It can be null
    is_owner Boolean

    If the user is the conference owner

    		 
    {
    "id": "#guest:2cbb00f@server.name",
    "display_name": "guest123",
    "invite_time": null,
    "join_time": 1510067899,
    "login_name": "#guest:2cbb00f",
    "status": 0,
    "is_owner": false
}
    {
    "id": "user1@serer.name",
    "uid": "user1@server.name",
    "avatar": null,
    "login_name": "user1",
    "email": "user1@server.name",
    "display_name": "user1",
    "first_name": "",
    "last_name": "",
    "company": "",
    "groups": [
        "@no_group"
    ],
    "mobile_phone": "",
    "work_phone": "",
    "home_phone": "",
    "is_active": 1,
    "status": 5,
    "invite_time": 1510067899,
    "join_time": 1510067906,
    "is_owner": true
}

    Objects | Preset Payload

    Preset payload object
    *

    object 
    PresetPayload

    Permission: access_token

    YoutubePayload

    Field Type Description
    stream_url String

    POST | PUT Youtube Stream URL
    stream_key String

    POST | PUT Youtube Stream Key
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: MP3

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    CdnPayload

    Field Type Description
    username String

    POST | PUT Username
    password String

    POST | PUT Password

    ManualPullPayload

    Field Type Description
    audio_codec String

    POST | PUT Audio codec for streaming

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec String

    POST | PUT Video codec for streaming

    Allowed values: H264, VP8

    ManualPushPayload

    Field Type Description
    url_publish String

    POST | PUT Streaming URL
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: MP3

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: false
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 60
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 10

    WowzaCloudPayload

    Field Type Description
    primary_server String

    POST | PUT WowzaСloud Primary Server
    stream_name String

    POST | PUT WowzaCloud Stream Name
    host_port Integer

    POST | PUT Connection port
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: AAC

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: true
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 0
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Delay before retrying publication in seconds

    Default value: 10

    WowzaServerPayload

    Field Type Description
    host_server String

    POST | PUT Host Server WowzaServer

    Size range: 1..256
    application String

    POST | PUT Application WowzaServer

    Size range: 1..256
    host_port Integer

    POST | PUT Connection port
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: AAC

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: true
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 0
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Delay before retrying publication in seconds

    Default value: 10

    		 
    {
    "stream_url": "rtmp://a.rtmp.youtube.com/live2",
    "stream_key": "jseq-jdp1-676g-npj4-3h8c",
    "audio_codec": "MP3",
    "video_codec": "H264"
}
    {
    "username": "example+12345@truf.ru",
    "password": "12345"
}
    {
    "audio_codec": "MP3",
    "video_codec": "H264"
}
    {
    "url_publish": "rtmp://a.rtmp.youtube.com/live2",
    "audio_codec": "MP3",
    "video_codec": "H264"
}

    Objects | Preset Payload

    Preset payload object
    *

    object 
    PresetPayload

    Permission: access_token

    YoutubePayload

    Field Type Description
    stream_url String

    POST | PUT Youtube Stream URL
    stream_key String

    POST | PUT Youtube Stream Key
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: MP3

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    CdnPayload

    Field Type Description
    username String

    POST | PUT Username
    password String

    POST | PUT Password

    ManualPullPayload

    Field Type Description
    audio_codec String

    POST | PUT Audio codec for streaming

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec String

    POST | PUT Video codec for streaming

    Allowed values: H264, VP8

    ManualPushPayload

    Field Type Description
    url_publish String

    POST | PUT Streaming URL
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: MP3

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: false
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 60
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 10

    WowzaCloudPayload

    Field Type Description
    primary_server String

    POST | PUT WowzaСloud Primary Server
    stream_name String

    POST | PUT WowzaCloud Stream Name
    host_port Integer

    POST | PUT Connection port
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: AAC

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: true
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 0
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Delay before retrying publication in seconds

    Default value: 10

    WowzaServerPayload

    Field Type Description
    host_server String

    POST | PUT Host Server WowzaServer

    Size range: 1..256
    application String

    POST | PUT Application WowzaServer

    Size range: 1..256
    host_port Integer

    POST | PUT Connection port
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: AAC

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: true
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 0
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Delay before retrying publication in seconds

    Default value: 10

    		 
    {
    "stream_url": "rtmp://a.rtmp.youtube.com/live2",
    "stream_key": "jseq-jdp1-676g-npj4-3h8c",
    "audio_codec": "MP3",
    "video_codec": "H264"
}
    {
    "username": "example+12345@truf.ru",
    "password": "12345"
}
    {
    "audio_codec": "MP3",
    "video_codec": "H264"
}
    {
    "url_publish": "rtmp://a.rtmp.youtube.com/live2",
    "audio_codec": "MP3",
    "video_codec": "H264"
}

    Objects | Preset Payload

    Preset payload object
    *

    object 
    PresetPayload

    Permission: access_token

    YoutubePayload

    Field Type Description
    stream_url String

    POST | PUT Youtube Stream URL
    stream_key String

    POST | PUT Youtube Stream Key
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: MP3

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    CdnPayload

    Field Type Description
    username String

    POST | PUT Username
    password String

    POST | PUT Password

    ManualPullPayload

    Field Type Description
    audio_codec String

    POST | PUT Audio codec for streaming

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec String

    POST | PUT Video codec for streaming

    Allowed values: H264, VP8

    ManualPushPayload

    Field Type Description
    url_publish String

    POST | PUT Streaming URL
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: MP3

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: false
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 60
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 10

    WowzaCloudPayload

    Field Type Description
    primary_server String

    POST | PUT WowzaСloud Primary Server
    stream_name String

    POST | PUT WowzaCloud Stream Name
    host_port Integer

    POST | PUT Connection port
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: AAC

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: true
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 0
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Delay before retrying publication in seconds

    Default value: 10

    WowzaServerPayload

    Field Type Description
    host_server String

    POST | PUT Host Server WowzaServer

    Size range: 1..256
    application String

    POST | PUT Application WowzaServer

    Size range: 1..256
    host_port Integer

    POST | PUT Connection port
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: AAC

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: true
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 0
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Delay before retrying publication in seconds

    Default value: 10

    		 
    {
    "stream_url": "rtmp://a.rtmp.youtube.com/live2",
    "stream_key": "jseq-jdp1-676g-npj4-3h8c",
    "audio_codec": "MP3",
    "video_codec": "H264"
}
    {
    "username": "example+12345@truf.ru",
    "password": "12345"
}
    {
    "audio_codec": "MP3",
    "video_codec": "H264"
}
    {
    "url_publish": "rtmp://a.rtmp.youtube.com/live2",
    "audio_codec": "MP3",
    "video_codec": "H264"
}

    Objects | Preset Payload

    Preset payload object
    *

    object 
    PresetPayload

    Permission: access_token

    YoutubePayload

    Field Type Description
    stream_url String

    POST | PUT Youtube Stream URL
    stream_key String

    POST | PUT Youtube Stream Key
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: MP3

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    CdnPayload

    Field Type Description
    username String

    POST | PUT Username
    password String

    POST | PUT Password

    ManualPullPayload

    Field Type Description
    audio_codec String

    POST | PUT Audio codec for streaming

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec String

    POST | PUT Video codec for streaming

    Allowed values: H264, VP8

    ManualPushPayload

    Field Type Description
    url_publish String

    POST | PUT Streaming URL
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: MP3

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: false
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 60
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 10

    WowzaCloudPayload

    Field Type Description
    primary_server String

    POST | PUT WowzaСloud Primary Server
    stream_name String

    POST | PUT WowzaCloud Stream Name
    host_port Integer

    POST | PUT Connection port
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: AAC

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: true
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 0
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Delay before retrying publication in seconds

    Default value: 10

    WowzaServerPayload

    Field Type Description
    host_server String

    POST | PUT Host Server WowzaServer

    Size range: 1..256
    application String

    POST | PUT Application WowzaServer

    Size range: 1..256
    host_port Integer

    POST | PUT Connection port
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: AAC

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: true
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 0
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Delay before retrying publication in seconds

    Default value: 10

    		 
    {
    "stream_url": "rtmp://a.rtmp.youtube.com/live2",
    "stream_key": "jseq-jdp1-676g-npj4-3h8c",
    "audio_codec": "MP3",
    "video_codec": "H264"
}
    {
    "username": "example+12345@truf.ru",
    "password": "12345"
}
    {
    "audio_codec": "MP3",
    "video_codec": "H264"
}
    {
    "url_publish": "rtmp://a.rtmp.youtube.com/live2",
    "audio_codec": "MP3",
    "video_codec": "H264"
}

    Objects | Preset Payload

    Preset payload object
    *

    object 
    PresetPayload

    Permission: access_token

    YoutubePayload

    Field Type Description
    stream_url String

    POST | PUT Youtube Stream URL
    stream_key String

    POST | PUT Youtube Stream Key
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: MP3

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    CdnPayload

    Field Type Description
    username String

    POST | PUT Username
    password String

    POST | PUT Password

    ManualPullPayload

    Field Type Description
    audio_codec String

    POST | PUT Audio codec for streaming

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec String

    POST | PUT Video codec for streaming

    Allowed values: H264, VP8

    ManualPushPayload

    Field Type Description
    url_publish String

    POST | PUT Streaming URL
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: MP3

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: false
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 60
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 10

    WowzaCloudPayload

    Field Type Description
    primary_server String

    POST | PUT WowzaСloud Primary Server
    stream_name String

    POST | PUT WowzaCloud Stream Name
    host_port Integer

    POST | PUT Connection port
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: AAC

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: true
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 0
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Delay before retrying publication in seconds

    Default value: 10

    WowzaServerPayload

    Field Type Description
    host_server String

    POST | PUT Host Server WowzaServer

    Size range: 1..256
    application String

    POST | PUT Application WowzaServer

    Size range: 1..256
    host_port Integer

    POST | PUT Connection port
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: AAC

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: true
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 0
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Delay before retrying publication in seconds

    Default value: 10

    		 
    {
    "stream_url": "rtmp://a.rtmp.youtube.com/live2",
    "stream_key": "jseq-jdp1-676g-npj4-3h8c",
    "audio_codec": "MP3",
    "video_codec": "H264"
}
    {
    "username": "example+12345@truf.ru",
    "password": "12345"
}
    {
    "audio_codec": "MP3",
    "video_codec": "H264"
}
    {
    "url_publish": "rtmp://a.rtmp.youtube.com/live2",
    "audio_codec": "MP3",
    "video_codec": "H264"
}

    Objects | Preset Payload

    Preset payload object
    *

    object 
    PresetPayload

    Permission: access_token

    YoutubePayload

    Field Type Description
    stream_url String

    POST | PUT Youtube Stream URL
    stream_key String

    POST | PUT Youtube Stream Key
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: MP3

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    CdnPayload

    Field Type Description
    username String

    POST | PUT Username
    password String

    POST | PUT Password

    ManualPullPayload

    Field Type Description
    audio_codec String

    POST | PUT Audio codec for streaming

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec String

    POST | PUT Video codec for streaming

    Allowed values: H264, VP8

    ManualPushPayload

    Field Type Description
    url_publish String

    POST | PUT Streaming URL
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: MP3

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: false
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 60
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 10

    WowzaCloudPayload

    Field Type Description
    primary_server String

    POST | PUT WowzaСloud Primary Server
    stream_name String

    POST | PUT WowzaCloud Stream Name
    host_port Integer

    POST | PUT Connection port
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: AAC

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: true
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 0
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Delay before retrying publication in seconds

    Default value: 10

    WowzaServerPayload

    Field Type Description
    host_server String

    POST | PUT Host Server WowzaServer

    Size range: 1..256
    application String

    POST | PUT Application WowzaServer

    Size range: 1..256
    host_port Integer

    POST | PUT Connection port
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: AAC

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: true
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 0
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Delay before retrying publication in seconds

    Default value: 10

    		 
    {
    "stream_url": "rtmp://a.rtmp.youtube.com/live2",
    "stream_key": "jseq-jdp1-676g-npj4-3h8c",
    "audio_codec": "MP3",
    "video_codec": "H264"
}
    {
    "username": "example+12345@truf.ru",
    "password": "12345"
}
    {
    "audio_codec": "MP3",
    "video_codec": "H264"
}
    {
    "url_publish": "rtmp://a.rtmp.youtube.com/live2",
    "audio_codec": "MP3",
    "video_codec": "H264"
}

    Objects | Preset Payload

    Preset payload object
    *

    object 
    PresetPayload

    Permission: access_token

    YoutubePayload

    Field Type Description
    stream_url String

    POST | PUT Youtube Stream URL
    stream_key String

    POST | PUT Youtube Stream Key
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: MP3

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    CdnPayload

    Field Type Description
    username String

    POST | PUT Username
    password String

    POST | PUT Password

    ManualPullPayload

    Field Type Description
    audio_codec String

    POST | PUT Audio codec for streaming

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec String

    POST | PUT Video codec for streaming

    Allowed values: H264, VP8

    ManualPushPayload

    Field Type Description
    url_publish String

    POST | PUT Streaming URL
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: MP3

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: false
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 60
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 10

    WowzaCloudPayload

    Field Type Description
    primary_server String

    POST | PUT WowzaСloud Primary Server
    stream_name String

    POST | PUT WowzaCloud Stream Name
    host_port Integer

    POST | PUT Connection port
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: AAC

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: true
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 0
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Delay before retrying publication in seconds

    Default value: 10

    WowzaServerPayload

    Field Type Description
    host_server String

    POST | PUT Host Server WowzaServer

    Size range: 1..256
    application String

    POST | PUT Application WowzaServer

    Size range: 1..256
    host_port Integer

    POST | PUT Connection port
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: AAC

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: true
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 0
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Delay before retrying publication in seconds

    Default value: 10

    		 
    {
    "stream_url": "rtmp://a.rtmp.youtube.com/live2",
    "stream_key": "jseq-jdp1-676g-npj4-3h8c",
    "audio_codec": "MP3",
    "video_codec": "H264"
}
    {
    "username": "example+12345@truf.ru",
    "password": "12345"
}
    {
    "audio_codec": "MP3",
    "video_codec": "H264"
}
    {
    "url_publish": "rtmp://a.rtmp.youtube.com/live2",
    "audio_codec": "MP3",
    "video_codec": "H264"
}

    Objects | Preset Payload

    Preset payload object
    *

    object 
    PresetPayload

    Permission: access_token

    YoutubePayload

    Field Type Description
    stream_url String

    POST | PUT Youtube Stream URL
    stream_key String

    POST | PUT Youtube Stream Key
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: MP3

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    CdnPayload

    Field Type Description
    username String

    POST | PUT Username
    password String

    POST | PUT Password

    ManualPullPayload

    Field Type Description
    audio_codec String

    POST | PUT Audio codec for streaming

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec String

    POST | PUT Video codec for streaming

    Allowed values: H264, VP8

    ManualPushPayload

    Field Type Description
    url_publish String

    POST | PUT Streaming URL
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: MP3

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: false
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 60
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 10

    WowzaCloudPayload

    Field Type Description
    primary_server String

    POST | PUT WowzaСloud Primary Server
    stream_name String

    POST | PUT WowzaCloud Stream Name
    host_port Integer

    POST | PUT Connection port
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: AAC

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: true
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 0
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Delay before retrying publication in seconds

    Default value: 10

    WowzaServerPayload

    Field Type Description
    host_server String

    POST | PUT Host Server WowzaServer

    Size range: 1..256
    application String

    POST | PUT Application WowzaServer

    Size range: 1..256
    host_port Integer

    POST | PUT Connection port
    audio_codec optional String

    POST | PUT Audio codec for streaming

    Default value: AAC

    Allowed values: MP3, PCM, G711_U, G711_A, AAC

    video_codec optional String

    POST | PUT Video codec for streaming

    Default value: H264

    Allowed values: H264, VP8

    username optional String

    POST | PUT Username
    password optional String

    POST | PUT Password
    rtp_over_tcp optional Boolean

    POST | PUT Prefer RTP over TCP

    Default value: true
    inactive_receiver_timeout optional Integer

    POST | PUT Timeout in seconds for disconnecting inactive clients

    Default value: 0
    retries optional Integer

    POST | PUT Number of retries to enable publishing on errors

    Default value: 0
    retry_delay optional Integer

    POST | PUT Delay before retrying publication in seconds

    Default value: 10

    		 
    {
    "stream_url": "rtmp://a.rtmp.youtube.com/live2",
    "stream_key": "jseq-jdp1-676g-npj4-3h8c",
    "audio_codec": "MP3",
    "video_codec": "H264"
}
    {
    "username": "example+12345@truf.ru",
    "password": "12345"
}
    {
    "audio_codec": "MP3",
    "video_codec": "H264"
}
    {
    "url_publish": "rtmp://a.rtmp.youtube.com/live2",
    "audio_codec": "MP3",
    "video_codec": "H264"
}

    Objects | Preset

    Preset object.

    object 
    Preset

    Structure

    Field Type Description
    id String

    Preset id.
    name String

    POST | PUT Preset name.
    type String

    POST Preset type.

    • "youtube" - Youtube
    • "cdnvideo" - CDN
    • "manualPull" - Manual Pull
    • "manualPush" - Manual Push
    • "wowzaCloud" - Wowza Cloud
    • "wowzaServer" - Wowza Server

    Allowed values: youtube, cdnvideo, manualPull, manualPush, wowzaCloud, wowzaServer

    payload Object

    POST | PUT Preset payload.

    		 
    {
    "id": "cfa59a",
    "name": "My Preset",
    "type": "youtube",
    "payload": {
        "stream_url": "rtmp://a.rtmp.youtube.com/live2",
        "stream_key": "jseq-jdp1-676g-npj4-3h8c",
        "audio_codec": "MP3",
        "video_codec": "H264"
    }
}

    Objects | Preset

    Preset object.

    object 
    Preset

    Structure

    Field Type Description
    id String

    Preset id.
    name String

    POST | PUT Preset name.
    type String

    POST Preset type.

    • "youtube" - Youtube
    • "cdnvideo" - CDN
    • "manualPull" - Manual Pull
    • "manualPush" - Manual Push
    • "wowzaCloud" - Wowza Cloud
    • "wowzaServer" - Wowza Server

    Allowed values: youtube, cdnvideo, manualPull, manualPush, wowzaCloud, wowzaServer

    payload Object

    POST | PUT Preset payload.

    		 
    {
    "id": "cfa59a",
    "name": "My Preset",
    "type": "youtube",
    "payload": {
        "stream_url": "rtmp://a.rtmp.youtube.com/live2",
        "stream_key": "jseq-jdp1-676g-npj4-3h8c",
        "audio_codec": "MP3",
        "video_codec": "H264"
    }
}

    Objects | Preset

    Preset object.

    object 
    Preset

    Structure

    Field Type Description
    id String

    Preset id.
    name String

    POST | PUT Preset name.
    type String

    POST Preset type.

    • "youtube" - Youtube
    • "cdnvideo" - CDN
    • "manualPull" - Manual Pull
    • "manualPush" - Manual Push
    • "wowzaCloud" - Wowza Cloud
    • "wowzaServer" - Wowza Server

    Allowed values: youtube, cdnvideo, manualPull, manualPush, wowzaCloud, wowzaServer

    payload Object

    POST | PUT Preset payload.

    		 
    {
    "id": "cfa59a",
    "name": "My Preset",
    "type": "youtube",
    "payload": {
        "stream_url": "rtmp://a.rtmp.youtube.com/live2",
        "stream_key": "jseq-jdp1-676g-npj4-3h8c",
        "audio_codec": "MP3",
        "video_codec": "H264"
    }
}

    Objects | Preset

    Preset object.

    object 
    Preset

    Structure

    Field Type Description
    id String

    Preset id.
    name String

    POST | PUT Preset name.
    type String

    POST Preset type.

    • "youtube" - Youtube
    • "cdnvideo" - CDN
    • "manualPull" - Manual Pull
    • "manualPush" - Manual Push
    • "wowzaCloud" - Wowza Cloud
    • "wowzaServer" - Wowza Server

    Allowed values: youtube, cdnvideo, manualPull, manualPush, wowzaCloud, wowzaServer

    payload Object

    POST | PUT Preset payload.

    		 
    {
    "id": "cfa59a",
    "name": "My Preset",
    "type": "youtube",
    "payload": {
        "stream_url": "rtmp://a.rtmp.youtube.com/live2",
        "stream_key": "jseq-jdp1-676g-npj4-3h8c",
        "audio_codec": "MP3",
        "video_codec": "H264"
    }
}

    Objects | Preset

    Preset object.

    object 
    Preset

    Structure

    Field Type Description
    id String

    Preset id.
    name String

    POST | PUT Preset name.
    type String

    POST Preset type.

    • "youtube" - Youtube
    • "cdnvideo" - CDN
    • "manualPull" - Manual Pull
    • "manualPush" - Manual Push
    • "wowzaCloud" - Wowza Cloud
    • "wowzaServer" - Wowza Server

    Allowed values: youtube, cdnvideo, manualPull, manualPush, wowzaCloud, wowzaServer

    payload Object

    POST | PUT Preset payload.

    		 
    {
    "id": "cfa59a",
    "name": "My Preset",
    "type": "youtube",
    "payload": {
        "stream_url": "rtmp://a.rtmp.youtube.com/live2",
        "stream_key": "jseq-jdp1-676g-npj4-3h8c",
        "audio_codec": "MP3",
        "video_codec": "H264"
    }
}

    Objects | Preset

    Preset object.

    object 
    Preset

    Structure

    Field Type Description
    id String

    Preset id.
    name String

    POST | PUT Preset name.
    type String

    POST Preset type.

    • "youtube" - Youtube
    • "cdnvideo" - CDN
    • "manualPull" - Manual Pull
    • "manualPush" - Manual Push
    • "wowzaCloud" - Wowza Cloud
    • "wowzaServer" - Wowza Server

    Allowed values: youtube, cdnvideo, manualPull, manualPush, wowzaCloud, wowzaServer

    payload Object

    POST | PUT Preset payload.

    		 
    {
    "id": "cfa59a",
    "name": "My Preset",
    "type": "youtube",
    "payload": {
        "stream_url": "rtmp://a.rtmp.youtube.com/live2",
        "stream_key": "jseq-jdp1-676g-npj4-3h8c",
        "audio_codec": "MP3",
        "video_codec": "H264"
    }
}

    Objects | Preset

    Preset object.

    object 
    Preset

    Structure

    Field Type Description
    id String

    Preset id.
    name String

    POST | PUT Preset name.
    type String

    POST Preset type.

    • "youtube" - Youtube
    • "cdnvideo" - CDN
    • "manualPull" - Manual Pull
    • "manualPush" - Manual Push
    • "wowzaCloud" - Wowza Cloud
    • "wowzaServer" - Wowza Server

    Allowed values: youtube, cdnvideo, manualPull, manualPush, wowzaCloud, wowzaServer

    payload Object

    POST | PUT Preset payload.

    		 
    {
    "id": "cfa59a",
    "name": "My Preset",
    "type": "youtube",
    "payload": {
        "stream_url": "rtmp://a.rtmp.youtube.com/live2",
        "stream_key": "jseq-jdp1-676g-npj4-3h8c",
        "audio_codec": "MP3",
        "video_codec": "H264"
    }
}

    Objects | Preset

    Preset object.

    object 
    Preset

    Structure

    Field Type Description
    id String

    Preset id.
    name String

    POST | PUT Preset name.
    type String

    POST Preset type.

    • "youtube" - Youtube
    • "cdnvideo" - CDN
    • "manualPull" - Manual Pull
    • "manualPush" - Manual Push
    • "wowzaCloud" - Wowza Cloud
    • "wowzaServer" - Wowza Server

    Allowed values: youtube, cdnvideo, manualPull, manualPush, wowzaCloud, wowzaServer

    payload Object

    POST | PUT Preset payload.

    		 
    {
    "id": "cfa59a",
    "name": "My Preset",
    "type": "youtube",
    "payload": {
        "stream_url": "rtmp://a.rtmp.youtube.com/live2",
        "stream_key": "jseq-jdp1-676g-npj4-3h8c",
        "audio_codec": "MP3",
        "video_codec": "H264"
    }
}

    Objects | Record

    Conference record object.

    object 
    Record

    Structure

    Field Type Description
    name String

    Video file name.
    size String

    Video file size in bytes.
    created Integer

    Video file creation date in Unix Timestamp.
    download_url String

    Video file download link.

    		 
    {
    "name": "0000006a_2017-11-04_15-55-46.mkv",
    "size": "202018",
    "created": 1509800146,
    "download_url": ".../download"
}

    Objects | Record

    Conference record object.

    object 
    Record

    Structure

    Field Type Description
    name String

    Video file name.
    size String

    Video file size in bytes.
    created Integer

    Video file creation date in Unix Timestamp.
    download_url String

    Video file download link.

    		 
    {
    "name": "0000006a_2017-11-04_15-55-46.mkv",
    "size": "202018",
    "created": 1509800146,
    "download_url": ".../download"
}

    Objects | Record

    Conference record object.

    object 
    Record

    Structure

    Field Type Description
    name String

    Video file name.
    size String

    Video file size in bytes.
    created Integer

    Video file creation date in Unix Timestamp.
    download_url String

    Video file download link.

    		 
    {
    "name": "0000006a_2017-11-04_15-55-46.mkv",
    "size": "202018",
    "created": 1509800146,
    "download_url": ".../download"
}

    Objects | Record

    Conference record object.

    object 
    Record

    Structure

    Field Type Description
    name String

    Video file name.
    size String

    Video file size in bytes.
    created Integer

    Video file creation date in Unix Timestamp.
    download_url String

    Video file download link.

    		 
    {
    "name": "0000006a_2017-11-04_15-55-46.mkv",
    "size": "202018",
    "created": 1509800146,
    "download_url": ".../download"
}

    Objects | Record

    Conference record object.

    object 
    Record

    Structure

    Field Type Description
    name String

    Video file name.
    size String

    Video file size in bytes.
    created Integer

    Video file creation date in Unix Timestamp.
    download_url String

    Video file download link.

    		 
    {
    "name": "0000006a_2017-11-04_15-55-46.mkv",
    "size": "202018",
    "created": 1509800146,
    "download_url": ".../download"
}

    Objects | Record

    Conference record object.

    object 
    Record

    Structure

    Field Type Description
    name String

    Video file name.
    size String

    Video file size in bytes.
    created Integer

    Video file creation date in Unix Timestamp.
    download_url String

    Video file download link.

    		 
    {
    "name": "0000006a_2017-11-04_15-55-46.mkv",
    "size": "202018",
    "created": 1509800146,
    "download_url": ".../download"
}

    Objects | Record

    Conference record object.

    object 
    Record

    Structure

    Field Type Description
    name String

    Video file name.
    size String

    Video file size in bytes.
    created Integer

    Video file creation date in Unix Timestamp.
    download_url String

    Video file download link.

    		 
    {
    "name": "0000006a_2017-11-04_15-55-46.mkv",
    "size": "202018",
    "created": 1509800146,
    "download_url": ".../download"
}

    Objects | Record

    Conference record object.

    object 
    Record

    Structure

    Field Type Description
    name String

    Video file name.
    size String

    Video file size in bytes.
    created Integer

    Video file creation date in Unix Timestamp.
    download_url String

    Video file download link.

    		 
    {
    "name": "0000006a_2017-11-04_15-55-46.mkv",
    "size": "202018",
    "created": 1509800146,
    "download_url": ".../download"
}

    Objects | Record

    Conference record object.

    object 
    Record

    Structure

    Field Type Description
    name String

    Video file name.
    size String

    Video file size in bytes.
    created Integer

    Video file creation date in Unix Timestamp.
    download_url String

    Video file download link.

    		 
    {
    "name": "0000006a_2017-11-04_15-55-46.mkv",
    "size": "202018",
    "created": 1509800146,
    "download_url": ".../download"
}

    Objects | Record

    Conference recording object.

    object 
    Record

    Structure

    Field Type Description
    name String

    Video file name.
    size String

    Video file size in bytes.
    created Integer

    Video file creation date in Unix Timestamp.
    download_url String

    Video file download link.

    		 
    {
    "name": "0000006a_2017-11-04_15-55-46.mkv",
    "size": "202018",
    "created": 1509800146,
    "download_url": ".../download"
}

    Objects | Record

    Conference recording object.

    object 
    Record

    Structure

    Field Type Description
    name String

    Video file name.
    size String

    Video file size in bytes.
    created Integer

    Video file creation date in Unix Timestamp.
    download_url String

    Video file download link.

    		 
    {
    "name": "0000006a_2017-11-04_15-55-46.mkv",
    "size": "202018",
    "created": 1509800146,
    "download_url": ".../download"
}

    Objects | Recording

    Conference recording object.

    object 
    Recording

    Structure

    Field Type Description
    id String

    Video file id.
    name String

    Video file name.
    stream_id String

    Stream id.
    conference_id String

    Conference id.
    topic String

    Conference topic.
    owner String

    Conference owner.
    created_at Integer

    Stream start date in Unix Timestamp.
    stopped_at Integer

    Stream stop date in Unix Timestamp.
    deleted_at Integer

    Video file deletion date in Unix Timestamp or null if it was nor deleted.
    size String

    Video file size in bytes.
    download_url String

    Video file download link.

    		 
    {
    "id": "1",
    "name": "000000de_2020-04-06_07-37-44.mkv",
    "stream_id": "000000de@ruxa1.trueconf.name#vcs",
    "conference_id": "9646050389",
    "topic": "True Conf",
    "owner": "user@example.trueconf.name",
    "started_at": 1586133464,
    "stopped_at": 1586133474,
    "deleted_at": null,
    "size": "304962",
    "download_url": "http://localhost/api/v3.10/logs/recordings/1/download"
}

    Objects | Recording

    Conference recording object.

    object 
    Recording

    Structure

    Field Type Description
    id String

    Video file id.
    name String

    Video file name.
    stream_id String

    Stream id.
    conference_id String

    Conference id.
    topic String

    Conference topic.
    owner String

    Conference owner.
    created_at Integer

    Stream start date in Unix Timestamp.
    stopped_at Integer

    Stream stop date in Unix Timestamp.
    deleted_at Integer

    Video file deletion date in Unix Timestamp or null if it was nor deleted.
    size String

    Video file size in bytes.
    download_url String

    Video file download link.

    		 
    {
    "id": "1",
    "name": "000000de_2020-04-06_07-37-44.mkv",
    "stream_id": "000000de@ruxa1.trueconf.name#vcs",
    "conference_id": "9646050389",
    "topic": "True Conf",
    "owner": "user@example.trueconf.name",
    "started_at": 1586133464,
    "stopped_at": 1586133474,
    "deleted_at": null,
    "size": "304962",
    "download_url": "http://localhost/api/v3.9/logs/recordings/1/download"
}

    Objects | Recording

    Conference recording object.

    object 
    Recording

    Structure

    Field Type Description
    id String

    Video file id.
    name String

    Video file name.
    stream_id String

    Stream id.
    conference_id String

    Conference id.
    topic String

    Conference topic.
    owner String

    Conference owner.
    created_at Integer

    Stream start date in Unix Timestamp.
    stopped_at Integer

    Stream stop date in Unix Timestamp.
    deleted_at Integer

    Video file deletion date in Unix Timestamp or null if it was nor deleted.
    size String

    Video file size in bytes.
    download_url String

    Video file download link.

    		 
    {
    "id": "1",
    "name": "000000de_2020-04-06_07-37-44.mkv",
    "stream_id": "000000de@ruxa1.trueconf.name#vcs",
    "conference_id": "9646050389",
    "topic": "True Conf",
    "owner": "user@example.trueconf.name",
    "started_at": 1586133464,
    "stopped_at": 1586133474,
    "deleted_at": null,
    "size": "304962",
    "download_url": "http://localhost/api/v3.8/logs/recordings/1/download"
}

    Objects | Recording

    Conference recording object.

    object 
    Recording

    Structure

    Field Type Description
    id String

    Video file id.
    name String

    Video file name.
    stream_id String

    Stream id.
    conference_id String

    Conference id.
    topic String

    Conference topic.
    owner String

    Conference owner.
    created_at Integer

    Stream start date in Unix Timestamp.
    stopped_at Integer

    Stream stop date in Unix Timestamp.
    deleted_at Integer

    Video file deletion date in Unix Timestamp or null if it was nor deleted.
    size String

    Video file size in bytes.
    download_url String

    Video file download link.

    		 
    {
    "id": "1",
    "name": "000000de_2020-04-06_07-37-44.mkv",
    "stream_id": "000000de@ruxa1.trueconf.name#vcs",
    "conference_id": "9646050389",
    "topic": "True Conf",
    "owner": "user@example.trueconf.name",
    "started_at": 1586133464,
    "stopped_at": 1586133474,
    "deleted_at": null,
    "size": "304962",
    "download_url": "http://localhost/api/v3.7/logs/recordings/1/download"
}

    Objects | Recording

    Conference recording object.

    object 
    Recording

    Structure

    Field Type Description
    id String

    Video file id.
    name String

    Video file name.
    stream_id String

    Stream id.
    conference_id String

    Conference id.
    owner String

    Conference owner.
    created_at Integer

    Stream start date in Unix Timestamp.
    stopped_at Integer

    Stream stop date in Unix Timestamp.
    deleted_at Integer

    Video file deletion date in Unix Timestamp or null if it was nor deleted.
    size String

    Video file size in bytes.
    download_url String

    Video file download link.

    		 
    {
    "id": "1",
    "name": "000000de_2020-04-06_07-37-44.mkv",
    "stream_id": "000000de@ruxa1.trueconf.name#vcs",
    "conference_id": "9646050389",
    "owner": "user@example.trueconf.name",
    "started_at": 1586133464,
    "stopped_at": 1586133474,
    "deleted_at": null,
    "size": "304962",
    "download_url": "http://localhost/api/v3.6/logs/recordings/1/download"
}

    Objects | Recording

    Conference recording object.

    object 
    Recording

    Structure

    Field Type Description
    id String

    Video file id.
    name String

    Video file name.
    stream_id String

    Stream id.
    conference_id String

    Conference id.
    owner String

    Conference owner.
    created_at Integer

    Stream start date in Unix Timestamp.
    stopped_at Integer

    Stream stop date in Unix Timestamp.
    deleted_at Integer

    Video file deletion date in Unix Timestamp or null if it was nor deleted.
    size String

    Video file size in bytes.
    download_url String

    Video file download link.

    		 
    {
    "id": "1",
    "name": "000000de_2020-04-06_07-37-44.mkv",
    "stream_id": "000000de@ruxa1.trueconf.name#vcs",
    "conference_id": "9646050389",
    "owner": "user@example.trueconf.name",
    "started_at": 1586133464,
    "stopped_at": 1586133474,
    "deleted_at": null,
    "size": "304962",
    "download_url": "http://localhost/api/v3.5/logs/recordings/1/download"
}

    Objects | Recording

    Conference recording object.

    object 
    Recording

    Structure

    Field Type Description
    id String

    Video file id.
    name String

    Video file name.
    stream_id String

    Stream id.
    conference_id String

    Conference id.
    owner String

    Conference owner.
    created_at Integer

    Stream start date in Unix Timestamp.
    stopped_at Integer

    Stream stop date in Unix Timestamp.
    deleted_at Integer

    Video file deletion date in Unix Timestamp or null if it was nor deleted.
    size String

    Video file size in bytes.
    download_url String

    Video file download link.

    		 
    {
    "id": "1",
    "name": "000000de_2020-04-06_07-37-44.mkv",
    "stream_id": "000000de@ruxa1.trueconf.name#vcs",
    "conference_id": "9646050389",
    "owner": "user@example.trueconf.name",
    "started_at": 1586133464,
    "stopped_at": 1586133474,
    "deleted_at": null,
    "size": "304962",
    "download_url": "http://localhost/api/v3.4/logs/recordings/1/download"
}

    Objects | Recording

    Conference recording object.

    object 
    Recording

    Structure

    Field Type Description
    id String

    Video file id.
    name String

    Video file name.
    stream_id String

    Stream id.
    conference_id String

    Conference id.
    created_at Integer

    Stream start date in Unix Timestamp.
    stopped_at Integer

    Stream stop date in Unix Timestamp.
    deleted_at Integer

    Video file deletion date in Unix Timestamp or null if it was nor deleted.
    size String

    Video file size in bytes.
    download_url String

    Video file download link.

    		 
    {
    "id": "1",
    "name": "000000de_2020-04-06_07-37-44.mkv",
    "stream_id": "000000de@ruxa1.trueconf.name#vcs",
    "conference_id": "9646050389",
    "started_at": 1586133464,
    "stopped_at": 1586133474,
    "deleted_at": null,
    "size": "304962",
    "download_url": "http://localhost/api/v3.3/logs/recordings/1/download"
}

    Objects | Recording

    Conference recording object.

    object 
    Recording

    Structure

    Field Type Description
    id String

    Video file id.
    name String

    Video file name.
    stream_id String

    Stream id.
    conference_id String

    Conference id.
    created_at Integer

    Stream start date in Unix Timestamp.
    stopped_at Integer

    Stream stop date in Unix Timestamp.
    deleted_at Integer

    Video file deletion date in Unix Timestamp or null if it was nor deleted.
    size String

    Video file size in bytes.
    download_url String

    Video file download link.

    		 
    {
    "id": "1",
    "name": "000000de_2020-04-06_07-37-44.mkv",
    "stream_id": "000000de@ruxa1.trueconf.name#vcs",
    "conference_id": "9646050389",
    "started_at": 1586133464,
    "stopped_at": 1586133474,
    "deleted_at": null,
    "size": "304962",
    "download_url": "http://localhost/api/v3.2/logs/recordings/1/download"
}

    Objects | Registration

    Conference registration object.

    object 
    Registration

    Structure

    Field Type Description
    enabled Boolean

    Indicates whether registration is enabled.

    Default value: false
    start_at String

    Specifies the Unix timestamp indicating the date and time when webinar registration is set to begin.

    • The start_at value cannot exceed the value set in registration.end_at.
    • if the value is null, there is no set limitation on the registration period and participants can register without any time constraints.
    end_at String

    Specifies the Unix timestamp indicating the date and time when webinar registration is set to end.

    • if the value is null, there is no set limitation on the registration period and participants can register without any time constraints.
    participants_limit_enabled Boolean

    Indicates whether there is a maximum limit on the number of participants allowed to register for webinar.

    Default value: false
    participants_limit Integer

    Specifies the maximum number of participants allowed to register for and participate in the webinar.

    • if the value is null, there is no specific limit, allowing an unrestricted number of participants.

    Default value: null
    allow_users_access Boolean

    Determines whether existing users can access the webinar without going through the registration process.

    Default value: false
    fields Object

    Defines the custom fields required for the registration form in the webinar. The fields object within the "registration" object allows customization of the registration form by specifying individual fields. Each field is represented by a unique identifier and includes additional properties.

    • display_name: Represents the display name field in the registration form.
      • index: Specifies the order in which the field appears in the form (e.g., 0 for the first position).
      • is_required: Indicates whether the field is mandatory for participants to fill in.
    • email: Represents the email field in the registration form with similar properties.

    Note: Additional fields may be added based on the webinar's customization requirements.
    limit_reached Boolean

    Indicates whether the maximum limit of participants allowed for registration in the conference has been reached.

    • When registration is disabled for the conference, the value is always false.
    		 
    {
    "enabled": true,
    "start_at": "1711910100",
    "end_at": "1711918800",
    "participants_limit_enabled": true,
    "participants_limit": null,
    "allow_users_access": false,
    "fields": {
        "display_name": {
            "index": 0,
            "is_required": true
        },
        "email": {
            "index": 1,
            "is_required": true
        }
    },
    "limit_reached": false
}

    Objects | Registration

    Conference registration object.

    object 
    Registration

    Structure

    Field Type Description
    enabled Boolean

    Indicates whether registration is enabled.

    Default value: false
    start_at String

    Specifies the Unix timestamp indicating the date and time when webinar registration is set to begin.

    • The start_at value cannot exceed the value set in registration.end_at.
    • if the value is null, there is no set limitation on the registration period and participants can register without any time constraints.
    end_at String

    Specifies the Unix timestamp indicating the date and time when webinar registration is set to end.

    • if the value is null, there is no set limitation on the registration period and participants can register without any time constraints.
    participants_limit_enabled Boolean

    Indicates whether there is a maximum limit on the number of participants allowed to register for webinar.

    Default value: false
    participants_limit Integer

    Specifies the maximum number of participants allowed to register for and participate in the webinar.

    • if the value is null, there is no specific limit, allowing an unrestricted number of participants.

    Default value: null
    allow_users_access Boolean

    Determines whether existing users can access the webinar without going through the registration process.

    Default value: false
    fields Object

    Defines the custom fields required for the registration form in the webinar. The fields object within the "registration" object allows customization of the registration form by specifying individual fields. Each field is represented by a unique identifier and includes additional properties.

    • display_name: Represents the display name field in the registration form.
      • index: Specifies the order in which the field appears in the form (e.g., 0 for the first position).
      • is_required: Indicates whether the field is mandatory for participants to fill in.
    • email: Represents the email field in the registration form with similar properties.

    Note: Additional fields may be added based on the webinar's customization requirements.
    limit_reached Boolean

    Indicates whether the maximum limit of participants allowed for registration in the conference has been reached.

    • When registration is disabled for the conference, the value is always false.
    		 
    {
    "enabled": true,
    "start_at": "1711910100",
    "end_at": "1711918800",
    "participants_limit_enabled": true,
    "participants_limit": null,
    "allow_users_access": false,
    "fields": {
        "display_name": {
            "index": 0,
            "is_required": true
        },
        "email": {
            "index": 1,
            "is_required": true
        }
    },
    "limit_reached": false
}

    Objects | Registration

    Conference registration object.

    object 
    Registration

    Structure

    Field Type Description
    enabled Boolean

    Indicates whether registration is enabled.

    Default value: false
    start_at String

    Specifies the Unix timestamp indicating the date and time when webinar registration is set to begin.

    • The start_at value cannot exceed the value set in registration.end_at.
    • if the value is null, there is no set limitation on the registration period and participants can register without any time constraints.
    end_at String

    Specifies the Unix timestamp indicating the date and time when webinar registration is set to end.

    • if the value is null, there is no set limitation on the registration period and participants can register without any time constraints.
    participants_limit_enabled Boolean

    Indicates whether there is a maximum limit on the number of participants allowed to register for webinar.

    Default value: false
    participants_limit Integer

    Specifies the maximum number of participants allowed to register for and participate in the webinar.

    • if the value is null, there is no specific limit, allowing an unrestricted number of participants.

    Default value: null
    allow_users_access Boolean

    Determines whether existing users can access the webinar without going through the registration process.

    Default value: false
    fields Object

    Defines the custom fields required for the registration form in the webinar. The fields object within the "registration" object allows customization of the registration form by specifying individual fields. Each field is represented by a unique identifier and includes additional properties.

    • display_name: Represents the display name field in the registration form.
      • index: Specifies the order in which the field appears in the form (e.g., 0 for the first position).
      • is_required: Indicates whether the field is mandatory for participants to fill in.
    • email: Represents the email field in the registration form with similar properties.

    Note: Additional fields may be added based on the webinar's customization requirements.
    limit_reached Boolean

    Indicates whether the maximum limit of participants allowed for registration in the conference has been reached.

    • When registration is disabled for the conference, the value is always false.
    		 
    {
    "enabled": true,
    "start_at": "1711910100",
    "end_at": "1711918800",
    "participants_limit_enabled": true,
    "participants_limit": null,
    "allow_users_access": false,
    "fields": {
        "display_name": {
            "index": 0,
            "is_required": true
        },
        "email": {
            "index": 1,
            "is_required": true
        }
    },
    "limit_reached": false
}

    Objects | Registration

    Conference registration object.

    object 
    Registration

    Structure

    Field Type Description
    enabled Boolean

    Indicates whether registration is enabled.

    Default value: false
    start_at String

    Specifies the Unix timestamp indicating the date and time when webinar registration is set to begin.

    • The start_at value cannot exceed the value set in registration.end_at.
    • if the value is null, there is no set limitation on the registration period and participants can register without any time constraints.
    end_at String

    Specifies the Unix timestamp indicating the date and time when webinar registration is set to end.

    • if the value is null, there is no set limitation on the registration period and participants can register without any time constraints.
    participants_limit_enabled Boolean

    Indicates whether there is a maximum limit on the number of participants allowed to register for webinar.

    Default value: false
    participants_limit Integer

    Specifies the maximum number of participants allowed to register for and participate in the webinar.

    • if the value is null, there is no specific limit, allowing an unrestricted number of participants.

    Default value: null
    allow_users_access Boolean

    Determines whether existing users can access the webinar without going through the registration process.

    Default value: false
    fields Object

    Defines the custom fields required for the registration form in the webinar. The fields object within the "registration" object allows customization of the registration form by specifying individual fields. Each field is represented by a unique identifier and includes additional properties.

    • display_name: Represents the display name field in the registration form.
      • index: Specifies the order in which the field appears in the form (e.g., 0 for the first position).
      • is_required: Indicates whether the field is mandatory for participants to fill in.
    • email: Represents the email field in the registration form with similar properties.

    Note: Additional fields may be added based on the webinar's customization requirements.

    		 
    {
    "enabled": true,
    "start_at": "1711910100",
    "end_at": "1711918800",
    "participants_limit_enabled": true,
    "participants_limit": null,
    "allow_users_access": false,
    "fields": {
        "display_name": {
            "index": 0,
            "is_required": true
        },
        "email": {
            "index": 1,
            "is_required": true
        }
    }
}

    Objects | Registration

    Conference registration object.

    object 
    Registration

    Structure

    Field Type Description
    enabled Boolean

    Indicates whether registration is enabled.

    Default value: false
    start_at String

    Specifies the Unix timestamp indicating the date and time when webinar registration is set to begin.

    • The start_at value cannot exceed the value set in registration.end_at.
    • if the value is null, there is no set limitation on the registration period and participants can register without any time constraints.
    end_at String

    Specifies the Unix timestamp indicating the date and time when webinar registration is set to end.

    • if the value is null, there is no set limitation on the registration period and participants can register without any time constraints.
    participants_limit_enabled Boolean

    Indicates whether there is a maximum limit on the number of participants allowed to register for webinar.

    Default value: false
    participants_limit Integer

    Specifies the maximum number of participants allowed to register for and participate in the webinar.

    • if the value is null, there is no specific limit, allowing an unrestricted number of participants.

    Default value: null
    allow_users_access Boolean

    Determines whether existing users can access the webinar without going through the registration process.

    Default value: false
    fields Object

    Defines the custom fields required for the registration form in the webinar. The fields object within the "registration" object allows customization of the registration form by specifying individual fields. Each field is represented by a unique identifier and includes additional properties.

    • display_name: Represents the display name field in the registration form.
      • index: Specifies the order in which the field appears in the form (e.g., 0 for the first position).
      • is_required: Indicates whether the field is mandatory for participants to fill in.
    • email: Represents the email field in the registration form with similar properties.

    Note: Additional fields may be added based on the webinar's customization requirements.

    		 
    {
    "enabled": true,
    "start_at": "1711910100",
    "end_at": "1711918800",
    "participants_limit_enabled": true,
    "participants_limit": null,
    "allow_users_access": false,
    "fields": {
        "display_name": {
            "index": 0,
            "is_required": true
        },
        "email": {
            "index": 1,
            "is_required": true
        }
    }
}

    Objects | Registration

    Conference registration object.

    object 
    Registration

    Structure

    Field Type Description
    enabled Boolean

    Indicates whether registration is enabled.

    Default value: false
    start_at String

    Specifies the Unix timestamp indicating the date and time when webinar registration is set to begin.

    • The start_at value cannot exceed the value set in registration.end_at.
    • if the value is null, there is no set limitation on the registration period and participants can register without any time constraints.
    end_at String

    Specifies the Unix timestamp indicating the date and time when webinar registration is set to end.

    • if the value is null, there is no set limitation on the registration period and participants can register without any time constraints.
    participants_limit_enabled Boolean

    Indicates whether there is a maximum limit on the number of participants allowed to register for webinar.

    Default value: false
    participants_limit Integer

    Specifies the maximum number of participants allowed to register for and participate in the webinar.

    • if the value is null, there is no specific limit, allowing an unrestricted number of participants.

    Default value: null
    allow_users_access Boolean

    Determines whether existing users can access the webinar without going through the registration process.

    Default value: false
    fields Object

    Defines the custom fields required for the registration form in the webinar. The fields object within the "registration" object allows customization of the registration form by specifying individual fields. Each field is represented by a unique identifier and includes additional properties.

    • display_name: Represents the display name field in the registration form.
      • index: Specifies the order in which the field appears in the form (e.g., 0 for the first position).
      • is_required: Indicates whether the field is mandatory for participants to fill in.
    • email: Represents the email field in the registration form with similar properties.

    Note: Additional fields may be added based on the webinar's customization requirements.

    		 
    {
    "enabled": true,
    "start_at": "1711910100",
    "end_at": "1711918800",
    "participants_limit_enabled": true,
    "participants_limit": null,
    "allow_users_access": false,
    "fields": {
        "display_name": {
            "index": 0,
            "is_required": true
        },
        "email": {
            "index": 1,
            "is_required": true
        }
    }
}

    Objects | Registration

    Conference registration object.

    object 
    Registration

    Structure

    Field Type Description
    enabled Boolean

    Indicates whether registration is enabled.

    Default value: false
    start_at String

    Specifies the Unix timestamp indicating the date and time when webinar registration is set to begin.

    • The start_at value cannot exceed the value set in registration.end_at.
    • if the value is null, there is no set limitation on the registration period and participants can register without any time constraints.
    end_at String

    Specifies the Unix timestamp indicating the date and time when webinar registration is set to end.

    • if the value is null, there is no set limitation on the registration period and participants can register without any time constraints.
    participants_limit_enabled Boolean

    Indicates whether there is a maximum limit on the number of participants allowed to register for webinar.

    Default value: false
    participants_limit Integer

    Specifies the maximum number of participants allowed to register for and participate in the webinar.

    • if the value is null, there is no specific limit, allowing an unrestricted number of participants.

    Default value: null
    allow_users_access Boolean

    Determines whether existing users can access the webinar without going through the registration process.

    Default value: false
    fields Object

    Defines the custom fields required for the registration form in the webinar. The fields object within the "registration" object allows customization of the registration form by specifying individual fields. Each field is represented by a unique identifier and includes additional properties.

    • display_name: Represents the display name field in the registration form.
      • index: Specifies the order in which the field appears in the form (e.g., 0 for the first position).
      • is_required: Indicates whether the field is mandatory for participants to fill in.
    • email: Represents the email field in the registration form with similar properties.

    Note: Additional fields may be added based on the webinar's customization requirements.

    		 
    {
    "enabled": true,
    "start_at": "1711910100",
    "end_at": "1711918800",
    "participants_limit_enabled": true,
    "participants_limit": null,
    "allow_users_access": false,
    "fields": {
        "display_name": {
            "index": 0,
            "is_required": true
        },
        "email": {
            "index": 1,
            "is_required": true
        }
    }
}

    Objects | Reminder

    Conference reminder object.

    object 
    Reminder

    Structure

    Field Type Description
    before_start Integer

    POST | PUT The number of minutes before the start of the conference to send a reminder.

    		 
    {
    "before_start": 60
}

    Objects | Reminder

    Conference reminder object.

    object 
    Reminder

    Structure

    Field Type Description
    before_start Integer

    POST | PUT The number of minutes before the start of the conference to send a reminder.

    		 
    {
    "before_start": 60
}

    Objects | Reminder

    Conference reminder object.

    object 
    Reminder

    Structure

    Field Type Description
    before_start Integer

    POST | PUT The number of minutes before the start of the conference to send a reminder.

    		 
    {
    "before_start": 60
}

    Objects | Reminder

    Conference reminder object.

    object 
    Reminder

    Structure

    Field Type Description
    before_start Integer

    POST | PUT The number of minutes before the start of the conference to send a reminder.

    		 
    {
    "before_start": 60
}

    Objects | Setting

    Setting log object.

    object 
    Setting

    Structure

    Field Type Description
    id String

    The identifier of the settings log record.
    user_name String

    The settings editor user name.
    created_at DateTime

    The date that the settings were detected. It can be null.
    object_type String

    The type of the settings object that has changed. GET
    object_id Integer

    The identifier of the settings object that has changed. GET
    action_type String

    The type of the action during the settings changes.

    Allowed values: "new", "edit", "delete"

    comment String

    The comment to action. GET
    old_value json

    The object including old settings state. GET
    new_value json

    The object including new settings state. GET

    		 
    {
    "id": "181",
    "user_name": "anonymous",
    "created_at": {
        "date": "2018-04-12 17:50:50.356411",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "object_type": "recordings_config",
    "object_id": 0,
    "action_type": "edit",
    "comment": "edit",
    "old_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": 0, \"conference_recording\": 0, \"webrtc_video_quality\": 1, \"conf_record_file_type\": 2, \"recordings_expire_days\": null}",
    "new_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": \"0\", \"conference_recording\": \"0\", \"webrtc_video_quality\": \"2\", \"conf_record_file_type\": \"2\", \"recordings_expire_days\": null}"
}

    Objects | Setting

    Setting log object.

    object 
    Setting

    Structure

    Field Type Description
    id String

    The identifier of the settings log record.
    user_name String

    The settings editor user name.
    created_at DateTime

    The date that the settings were detected. It can be null.
    object_type String

    The type of the settings object that has changed. GET
    object_id Integer

    The identifier of the settings object that has changed. GET
    action_type String

    The type of the action during the settings changes.

    Allowed values: "new", "edit", "delete"

    comment String

    The comment to action. GET
    old_value json

    The object including old settings state. GET
    new_value json

    The object including new settings state. GET

    		 
    {
    "id": "181",
    "user_name": "anonymous",
    "created_at": {
        "date": "2018-04-12 17:50:50.356411",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "object_type": "recordings_config",
    "object_id": 0,
    "action_type": "edit",
    "comment": "edit",
    "old_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": 0, \"conference_recording\": 0, \"webrtc_video_quality\": 1, \"conf_record_file_type\": 2, \"recordings_expire_days\": null}",
    "new_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": \"0\", \"conference_recording\": \"0\", \"webrtc_video_quality\": \"2\", \"conf_record_file_type\": \"2\", \"recordings_expire_days\": null}"
}

    Objects | Setting

    Setting log object.

    object 
    Setting

    Structure

    Field Type Description
    id String

    The identifier of the settings log record.
    user_name String

    The settings editor user name.
    created_at DateTime

    The date that the settings were detected. It can be null.
    object_type String

    The type of the settings object that has changed. GET
    object_id Integer

    The identifier of the settings object that has changed. GET
    action_type String

    The type of the action during the settings changes.

    Allowed values: "new", "edit", "delete"

    comment String

    The comment to action. GET
    old_value json

    The object including old settings state. GET
    new_value json

    The object including new settings state. GET

    		 
    {
    "id": "181",
    "user_name": "anonymous",
    "created_at": {
        "date": "2018-04-12 17:50:50.356411",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "object_type": "recordings_config",
    "object_id": 0,
    "action_type": "edit",
    "comment": "edit",
    "old_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": 0, \"conference_recording\": 0, \"webrtc_video_quality\": 1, \"conf_record_file_type\": 2, \"recordings_expire_days\": null}",
    "new_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": \"0\", \"conference_recording\": \"0\", \"webrtc_video_quality\": \"2\", \"conf_record_file_type\": \"2\", \"recordings_expire_days\": null}"
}

    Objects | Setting

    Setting log object.

    object 
    Setting

    Structure

    Field Type Description
    id String

    The identifier of the settings log record.
    user_name String

    The settings editor user name.
    created_at DateTime

    The date that the settings were detected. It can be null.
    object_type String

    The type of the settings object that has changed. GET
    object_id Integer

    The identifier of the settings object that has changed. GET
    action_type String

    The type of the action during the settings changes.

    Allowed values: "new", "edit", "delete"

    comment String

    The comment to action. GET
    old_value json

    The object including old settings state. GET
    new_value json

    The object including new settings state. GET

    		 
    {
    "id": "181",
    "user_name": "anonymous",
    "created_at": {
        "date": "2018-04-12 17:50:50.356411",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "object_type": "recordings_config",
    "object_id": 0,
    "action_type": "edit",
    "comment": "edit",
    "old_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": 0, \"conference_recording\": 0, \"webrtc_video_quality\": 1, \"conf_record_file_type\": 2, \"recordings_expire_days\": null}",
    "new_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": \"0\", \"conference_recording\": \"0\", \"webrtc_video_quality\": \"2\", \"conf_record_file_type\": \"2\", \"recordings_expire_days\": null}"
}

    Objects | Setting

    Setting log object.

    object 
    Setting

    Structure

    Field Type Description
    id String

    The identifier of the settings log record.
    user_name String

    The settings editor user name.
    created_at DateTime

    The date that the settings were detected. It can be null.
    object_type String

    The type of the settings object that has changed. GET
    object_id Integer

    The identifier of the settings object that has changed. GET
    action_type String

    The type of the action during the settings changes.

    Allowed values: "new", "edit", "delete"

    comment String

    The comment to action. GET
    old_value json

    The object including old settings state. GET
    new_value json

    The object including new settings state. GET

    		 
    {
    "id": "181",
    "user_name": "anonymous",
    "created_at": {
        "date": "2018-04-12 17:50:50.356411",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "object_type": "recordings_config",
    "object_id": 0,
    "action_type": "edit",
    "comment": "edit",
    "old_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": 0, \"conference_recording\": 0, \"webrtc_video_quality\": 1, \"conf_record_file_type\": 2, \"recordings_expire_days\": null}",
    "new_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": \"0\", \"conference_recording\": \"0\", \"webrtc_video_quality\": \"2\", \"conf_record_file_type\": \"2\", \"recordings_expire_days\": null}"
}

    Objects | Setting

    Setting log object.

    object 
    Setting

    Structure

    Field Type Description
    id String

    The identifier of the settings log record.
    user_name String

    The settings editor user name.
    created_at DateTime

    The date that the settings were detected. It can be null.
    object_type String

    The type of the settings object that has changed. GET
    object_id Integer

    The identifier of the settings object that has changed. GET
    action_type String

    The type of the action during the settings changes.

    Allowed values: "new", "edit", "delete"

    comment String

    The comment to action. GET
    old_value json

    The object including old settings state. GET
    new_value json

    The object including new settings state. GET

    		 
    {
    "id": "181",
    "user_name": "anonymous",
    "created_at": {
        "date": "2018-04-12 17:50:50.356411",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "object_type": "recordings_config",
    "object_id": 0,
    "action_type": "edit",
    "comment": "edit",
    "old_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": 0, \"conference_recording\": 0, \"webrtc_video_quality\": 1, \"conf_record_file_type\": 2, \"recordings_expire_days\": null}",
    "new_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": \"0\", \"conference_recording\": \"0\", \"webrtc_video_quality\": \"2\", \"conf_record_file_type\": \"2\", \"recordings_expire_days\": null}"
}

    Objects | Setting

    Setting log object.

    object 
    Setting

    Structure

    Field Type Description
    id String

    The identifier of the settings log record.
    user_name String

    The settings editor user name.
    created_at DateTime

    The date that the settings were detected. It can be null.
    object_type String

    The type of the settings object that has changed. GET
    object_id Integer

    The identifier of the settings object that has changed. GET
    action_type String

    The type of the action during the settings changes.

    Allowed values: "new", "edit", "delete"

    comment String

    The comment to action. GET
    old_value json

    The object including old settings state. GET
    new_value json

    The object including new settings state. GET

    		 
    {
    "id": "181",
    "user_name": "anonymous",
    "created_at": {
        "date": "2018-04-12 17:50:50.356411",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "object_type": "recordings_config",
    "object_id": 0,
    "action_type": "edit",
    "comment": "edit",
    "old_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": 0, \"conference_recording\": 0, \"webrtc_video_quality\": 1, \"conf_record_file_type\": 2, \"recordings_expire_days\": null}",
    "new_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": \"0\", \"conference_recording\": \"0\", \"webrtc_video_quality\": \"2\", \"conf_record_file_type\": \"2\", \"recordings_expire_days\": null}"
}

    Objects | Setting

    Setting log object.

    object 
    Setting

    Structure

    Field Type Description
    id String

    The identifier of the settings log record.
    user_name String

    The settings editor user name.
    created_at DateTime

    The date that the settings were detected. It can be null.
    object_type String

    The type of the settings object that has changed. GET
    object_id Integer

    The identifier of the settings object that has changed. GET
    action_type String

    The type of the action during the settings changes.

    Allowed values: "new", "edit", "delete"

    comment String

    The comment to action. GET
    old_value json

    The object including old settings state. GET
    new_value json

    The object including new settings state. GET

    		 
    {
    "id": "181",
    "user_name": "anonymous",
    "created_at": {
        "date": "2018-04-12 17:50:50.356411",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "object_type": "recordings_config",
    "object_id": 0,
    "action_type": "edit",
    "comment": "edit",
    "old_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": 0, \"conference_recording\": 0, \"webrtc_video_quality\": 1, \"conf_record_file_type\": 2, \"recordings_expire_days\": null}",
    "new_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": \"0\", \"conference_recording\": \"0\", \"webrtc_video_quality\": \"2\", \"conf_record_file_type\": \"2\", \"recordings_expire_days\": null}"
}

    Objects | Setting

    Setting log object.

    object 
    Setting

    Structure

    Field Type Description
    id String

    The identifier of the settings log record.
    user_name String

    The settings editor user name.
    created_at DateTime

    The date that the settings were detected. It can be null.
    object_type String

    The type of the settings object that has changed. GET
    object_id Integer

    The identifier of the settings object that has changed. GET
    action_type String

    The type of the action during the settings changes.

    Allowed values: "new", "edit", "delete"

    comment String

    The comment to action. GET
    old_value json

    The object including old settings state. GET
    new_value json

    The object including new settings state. GET

    		 
    {
    "id": "181",
    "user_name": "anonymous",
    "created_at": {
        "date": "2018-04-12 17:50:50.356411",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "object_type": "recordings_config",
    "object_id": 0,
    "action_type": "edit",
    "comment": "edit",
    "old_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": 0, \"conference_recording\": 0, \"webrtc_video_quality\": 1, \"conf_record_file_type\": 2, \"recordings_expire_days\": null}",
    "new_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": \"0\", \"conference_recording\": \"0\", \"webrtc_video_quality\": \"2\", \"conf_record_file_type\": \"2\", \"recordings_expire_days\": null}"
}

    Objects | Setting

    Setting log object.

    object 
    Setting

    Structure

    Field Type Description
    id String

    The identifier of the settings log record.
    user_name String

    The settings editor user name.
    created_at DateTime

    The date that the settings were detected. It can be null.
    object_type String

    The type of the settings object that has changed. GET
    object_id Integer

    The identifier of the settings object that has changed. GET
    action_type String

    The type of the action during the settings changes.

    Allowed values: "new", "edit", "delete"

    comment String

    The comment to action. GET
    old_value json

    The object including old settings state. GET
    new_value json

    The object including new settings state. GET

    		 
    {
    "id": "181",
    "user_name": "anonymous",
    "created_at": {
        "date": "2018-04-12 17:50:50.356411",
        "timezone_type": 3,
        "timezone": "Europe/London"
    },
    "object_type": "recordings_config",
    "object_id": 0,
    "action_type": "edit",
    "comment": "edit",
    "old_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": 0, \"conference_recording\": 0, \"webrtc_video_quality\": 1, \"conf_record_file_type\": 2, \"recordings_expire_days\": null}",
    "new_value": "{\"path\": \"C:\\\\TrueConf\\\\Recordings\", \"call_recording\": \"0\", \"conference_recording\": \"0\", \"webrtc_video_quality\": \"2\", \"conf_record_file_type\": \"2\", \"recordings_expire_days\": null}"
}

    Objects | Software client

    Client application object .

    object 
    SoftwareClient

    Permission: access_token

    Structure

    Field Type Description
    name String

    Client application name.
    type String

    Client application type:

    • standalone is a desktop application
    • Single-use is a one-time client application with hardwired conference and authentication data
    • web is a web application based on WebRTC technology
    platform String

    Client application launch platform:

    • macos
    • ios
    • android
    • linux
    • windows
    • webrtc
    download_url String

    URL for downloading client application.
    download_urls optional Object

    URL list for downloading client application.

    Default value: null
    market_url String

    URL for installing client application from the application store.
    web_url String

    WebRTC conferences or instructions on how to install a client application.
    iframe optional String

    HTML-code for WebRTC conferences integration.

    		 
    {
    "name": "TrueConf macOS",
    "type": "standalone",
    "platform": "macos",
    "download_url": "http://server.name/downloads/trueconf_client.dmg",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/osx.html?lang=auto"
}
    {
    "name": "TrueConf iOS",
    "type": "standalone",
    "platform": "ios",
    "download_url": "",
    "download_urls": null,
    "market_url": "https://itunes.apple.com/ru/app/trueconf/id536475636",
    "web_url": "https://trueconf.com/downloads/ios.html?lang=auto"
}
    {
    "name": "TrueConf Android",
    "type": "standalone",
    "platform": "android",
    "download_url": "https://server.name/downloads/trueconf_android_client.apk",
    "download_urls": null,
    "market_url": "https://play.google.com/store/apps/details?id=com.trueconf.videochat&hl=ru",
    "web_url": "https://trueconf.com/downloads/android.html?lang=auto"
}
    {
    "name": "TrueConf Linux",
    "type": "standalone",
    "platform": "linux",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.ru/tcs/installation-linux/?lang=auto&version=<tcs_version>"
}
    {
     "name": "TrueConf Windows",
     "type": "standalone",
     "platform": "windows",
     "download_url": "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
     "download_urls": {
"x86" => "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
"x64" => "https://server.name/downloads/trueconf_windows_client_x64_<base64_encoded_params>.exe",
     },
     "market_url": "",
     "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
 }
    {
    "name": "TrueConf Client",
    "type": "standalone",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows-legacy.html?lang=auto"
}
    {
    "name": "TrueConf Client",
    "type": "single-use",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
}
    {
    "name": "TrueConf Web",
    "type": "web",
    "platform": "webrtc",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru",
    "iframe": "<iframe src=\"https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru\" allowfullscreen=\"allowfullscreen\" allow=\"microphone; camera; autoplay; display-capture\" ><\\iframe>"
}

    Objects | Software client

    Client application object .

    object 
    SoftwareClient

    Permission: access_token

    Structure

    Field Type Description
    name String

    Client application name.
    type String

    Client application type:

    • standalone is a desktop application
    • Single-use is a one-time client application with hardwired conference and authentication data
    • web is a web application based on WebRTC technology
    platform String

    Client application launch platform:

    • macos
    • ios
    • android
    • linux
    • windows
    • webrtc
    download_url String

    URL for downloading client application.
    download_urls optional Object

    URL list for downloading client application.

    Default value: null
    market_url String

    URL for installing client application from the application store.
    web_url String

    WebRTC conferences or instructions on how to install a client application.
    iframe optional String

    HTML-code for WebRTC conferences integration.

    		 
    {
    "name": "TrueConf macOS",
    "type": "standalone",
    "platform": "macos",
    "download_url": "http://server.name/downloads/trueconf_client.dmg",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/osx.html?lang=auto"
}
    {
    "name": "TrueConf iOS",
    "type": "standalone",
    "platform": "ios",
    "download_url": "",
    "download_urls": null,
    "market_url": "https://itunes.apple.com/ru/app/trueconf/id536475636",
    "web_url": "https://trueconf.com/downloads/ios.html?lang=auto"
}
    {
    "name": "TrueConf Android",
    "type": "standalone",
    "platform": "android",
    "download_url": "https://server.name/downloads/trueconf_android_client.apk",
    "download_urls": null,
    "market_url": "https://play.google.com/store/apps/details?id=com.trueconf.videochat&hl=ru",
    "web_url": "https://trueconf.com/downloads/android.html?lang=auto"
}
    {
    "name": "TrueConf Linux",
    "type": "standalone",
    "platform": "linux",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.ru/tcs/installation-linux/?lang=auto&version=<tcs_version>"
}
    {
     "name": "TrueConf Windows",
     "type": "standalone",
     "platform": "windows",
     "download_url": "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
     "download_urls": {
"x86" => "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
"x64" => "https://server.name/downloads/trueconf_windows_client_x64_<base64_encoded_params>.exe",
     },
     "market_url": "",
     "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
 }
    {
    "name": "TrueConf Client",
    "type": "standalone",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows-legacy.html?lang=auto"
}
    {
    "name": "TrueConf Client",
    "type": "single-use",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
}
    {
    "name": "TrueConf Web",
    "type": "web",
    "platform": "webrtc",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru",
    "iframe": "<iframe src=\"https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru\" allowfullscreen=\"allowfullscreen\" allow=\"microphone; camera; autoplay; display-capture\" ><\\iframe>"
}

    Objects | Software client

    Client application object .

    object 
    SoftwareClient

    Permission: access_token

    Structure

    Field Type Description
    name String

    Client application name.
    type String

    Client application type:

    • standalone is a desktop application
    • Single-use is a one-time client application with hardwired conference and authentication data
    • web is a web application based on WebRTC technology
    platform String

    Client application launch platform:

    • macos
    • ios
    • android
    • linux
    • windows
    • webrtc
    download_url String

    URL for downloading client application.
    download_urls optional Object

    URL list for downloading client application.

    Default value: null
    market_url String

    URL for installing client application from the application store.
    web_url String

    WebRTC conferences or instructions on how to install a client application.
    iframe optional String

    HTML-code for WebRTC conferences integration.

    		 
    {
    "name": "TrueConf macOS",
    "type": "standalone",
    "platform": "macos",
    "download_url": "http://server.name/downloads/trueconf_client.dmg",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/osx.html?lang=auto"
}
    {
    "name": "TrueConf iOS",
    "type": "standalone",
    "platform": "ios",
    "download_url": "",
    "download_urls": null,
    "market_url": "https://itunes.apple.com/ru/app/trueconf/id536475636",
    "web_url": "https://trueconf.com/downloads/ios.html?lang=auto"
}
    {
    "name": "TrueConf Android",
    "type": "standalone",
    "platform": "android",
    "download_url": "https://server.name/downloads/trueconf_android_client.apk",
    "download_urls": null,
    "market_url": "https://play.google.com/store/apps/details?id=com.trueconf.videochat&hl=ru",
    "web_url": "https://trueconf.com/downloads/android.html?lang=auto"
}
    {
    "name": "TrueConf Linux",
    "type": "standalone",
    "platform": "linux",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.ru/tcs/installation-linux/?lang=auto&version=<tcs_version>"
}
    {
     "name": "TrueConf Windows",
     "type": "standalone",
     "platform": "windows",
     "download_url": "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
     "download_urls": {
"x86" => "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
"x64" => "https://server.name/downloads/trueconf_windows_client_x64_<base64_encoded_params>.exe",
     },
     "market_url": "",
     "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
 }
    {
    "name": "TrueConf Client",
    "type": "standalone",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows-legacy.html?lang=auto"
}
    {
    "name": "TrueConf Client",
    "type": "single-use",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
}
    {
    "name": "TrueConf Web",
    "type": "web",
    "platform": "webrtc",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru",
    "iframe": "<iframe src=\"https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru\" allowfullscreen=\"allowfullscreen\" allow=\"microphone; camera; autoplay; display-capture\" ><\\iframe>"
}

    Objects | Software client

    Client application object .

    object 
    SoftwareClient

    Permission: access_token

    Structure

    Field Type Description
    name String

    Client application name.
    type String

    Client application type:

    • standalone is a desktop application
    • Single-use is a one-time client application with hardwired conference and authentication data
    • web is a web application based on WebRTC technology
    platform String

    Client application launch platform:

    • macos
    • ios
    • android
    • linux
    • windows
    • webrtc
    download_url String

    URL for downloading client application.
    download_urls optional Object

    URL list for downloading client application.

    Default value: null
    market_url String

    URL for installing client application from the application store.
    web_url String

    WebRTC conferences or instructions on how to install a client application.
    iframe optional String

    HTML-code for WebRTC conferences integration.

    		 
    {
    "name": "TrueConf macOS",
    "type": "standalone",
    "platform": "macos",
    "download_url": "http://server.name/downloads/trueconf_client.dmg",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/osx.html?lang=auto"
}
    {
    "name": "TrueConf iOS",
    "type": "standalone",
    "platform": "ios",
    "download_url": "",
    "download_urls": null,
    "market_url": "https://itunes.apple.com/ru/app/trueconf/id536475636",
    "web_url": "https://trueconf.com/downloads/ios.html?lang=auto"
}
    {
    "name": "TrueConf Android",
    "type": "standalone",
    "platform": "android",
    "download_url": "https://server.name/downloads/trueconf_android_client.apk",
    "download_urls": null,
    "market_url": "https://play.google.com/store/apps/details?id=com.trueconf.videochat&hl=ru",
    "web_url": "https://trueconf.com/downloads/android.html?lang=auto"
}
    {
    "name": "TrueConf Linux",
    "type": "standalone",
    "platform": "linux",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.ru/tcs/installation-linux/?lang=auto&version=<tcs_version>"
}
    {
     "name": "TrueConf Windows",
     "type": "standalone",
     "platform": "windows",
     "download_url": "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
     "download_urls": {
"x86" => "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
"x64" => "https://server.name/downloads/trueconf_windows_client_x64_<base64_encoded_params>.exe",
     },
     "market_url": "",
     "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
 }
    {
    "name": "TrueConf Client",
    "type": "standalone",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows-legacy.html?lang=auto"
}
    {
    "name": "TrueConf Client",
    "type": "single-use",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
}
    {
    "name": "TrueConf Web",
    "type": "web",
    "platform": "webrtc",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru",
    "iframe": "<iframe src=\"https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru\" allowfullscreen=\"allowfullscreen\" allow=\"microphone; camera; autoplay; display-capture\" ><\\iframe>"
}

    Objects | Software client

    Client application object .

    object 
    SoftwareClient

    Permission: access_token

    Structure

    Field Type Description
    name String

    Client application name.
    type String

    Client application type:

    • standalone is a desktop application
    • Single-use is a one-time client application with hardwired conference and authentication data
    • web is a web application based on WebRTC technology
    platform String

    Client application launch platform:

    • macos
    • ios
    • android
    • linux
    • windows
    • webrtc
    download_url String

    URL for downloading client application.
    download_urls optional Object

    URL list for downloading client application.

    Default value: null
    market_url String

    URL for installing client application from the application store.
    web_url String

    WebRTC conferences or instructions on how to install a client application.
    iframe optional String

    HTML-code for WebRTC conferences integration.

    		 
    {
    "name": "TrueConf macOS",
    "type": "standalone",
    "platform": "macos",
    "download_url": "http://server.name/downloads/trueconf_client.dmg",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/osx.html?lang=auto"
}
    {
    "name": "TrueConf iOS",
    "type": "standalone",
    "platform": "ios",
    "download_url": "",
    "download_urls": null,
    "market_url": "https://itunes.apple.com/ru/app/trueconf/id536475636",
    "web_url": "https://trueconf.com/downloads/ios.html?lang=auto"
}
    {
    "name": "TrueConf Android",
    "type": "standalone",
    "platform": "android",
    "download_url": "https://server.name/downloads/trueconf_android_client.apk",
    "download_urls": null,
    "market_url": "https://play.google.com/store/apps/details?id=com.trueconf.videochat&hl=ru",
    "web_url": "https://trueconf.com/downloads/android.html?lang=auto"
}
    {
    "name": "TrueConf Linux",
    "type": "standalone",
    "platform": "linux",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.ru/tcs/installation-linux/?lang=auto&version=<tcs_version>"
}
    {
     "name": "TrueConf Windows",
     "type": "standalone",
     "platform": "windows",
     "download_url": "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
     "download_urls": {
"x86" => "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
"x64" => "https://server.name/downloads/trueconf_windows_client_x64_<base64_encoded_params>.exe",
     },
     "market_url": "",
     "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
 }
    {
    "name": "TrueConf Client",
    "type": "standalone",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows-legacy.html?lang=auto"
}
    {
    "name": "TrueConf Client",
    "type": "single-use",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
}
    {
    "name": "TrueConf Web",
    "type": "web",
    "platform": "webrtc",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru",
    "iframe": "<iframe src=\"https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru\" allowfullscreen=\"allowfullscreen\" allow=\"microphone; camera; autoplay; display-capture\" ><\\iframe>"
}

    Objects | Software client

    Client application object .

    object 
    SoftwareClient

    Permission: access_token

    Structure

    Field Type Description
    name String

    Client application name.
    type String

    Client application type:

    • standalone is a desktop application
    • Single-use is a one-time client application with hardwired conference and authentication data
    • web is a web application based on WebRTC technology
    platform String

    Client application launch platform:

    • macos
    • ios
    • android
    • linux
    • windows
    • webrtc
    download_url String

    URL for downloading client application.
    download_urls optional Object

    URL list for downloading client application.

    Default value: null
    market_url String

    URL for installing client application from the application store.
    web_url String

    WebRTC conferences or instructions on how to install a client application.
    iframe optional String

    HTML-code for WebRTC conferences integration.

    		 
    {
    "name": "TrueConf macOS",
    "type": "standalone",
    "platform": "macos",
    "download_url": "http://server.name/downloads/trueconf_client.dmg",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/osx.html?lang=auto"
}
    {
    "name": "TrueConf iOS",
    "type": "standalone",
    "platform": "ios",
    "download_url": "",
    "download_urls": null,
    "market_url": "https://itunes.apple.com/ru/app/trueconf/id536475636",
    "web_url": "https://trueconf.com/downloads/ios.html?lang=auto"
}
    {
    "name": "TrueConf Android",
    "type": "standalone",
    "platform": "android",
    "download_url": "https://server.name/downloads/trueconf_android_client.apk",
    "download_urls": null,
    "market_url": "https://play.google.com/store/apps/details?id=com.trueconf.videochat&hl=ru",
    "web_url": "https://trueconf.com/downloads/android.html?lang=auto"
}
    {
    "name": "TrueConf Linux",
    "type": "standalone",
    "platform": "linux",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.ru/tcs/installation-linux/?lang=auto&version=<tcs_version>"
}
    {
     "name": "TrueConf Windows",
     "type": "standalone",
     "platform": "windows",
     "download_url": "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
     "download_urls": {
"x86" => "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
"x64" => "https://server.name/downloads/trueconf_windows_client_x64_<base64_encoded_params>.exe",
     },
     "market_url": "",
     "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
 }
    {
    "name": "TrueConf Client",
    "type": "standalone",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows-legacy.html?lang=auto"
}
    {
    "name": "TrueConf Client",
    "type": "single-use",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
}
    {
    "name": "TrueConf Web",
    "type": "web",
    "platform": "webrtc",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru",
    "iframe": "<iframe src=\"https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru\" allowfullscreen=\"allowfullscreen\" allow=\"microphone; camera; autoplay; display-capture\" ><\\iframe>"
}

    Objects | Software client

    Client application object .

    object 
    SoftwareClient

    Permission: access_token

    Structure

    Field Type Description
    name String

    Client application name.
    type String

    Client application type:

    • standalone is a desktop application
    • Single-use is a one-time client application with hardwired conference and authentication data
    • web is a web application based on WebRTC technology
    platform String

    Client application launch platform:

    • macos
    • ios
    • android
    • linux
    • windows
    • webrtc
    download_url String

    URL for downloading client application.
    download_urls optional Object

    URL list for downloading client application.

    Default value: null
    market_url String

    URL for installing client application from the application store.
    web_url String

    WebRTC conferences or instructions on how to install a client application.
    iframe optional String

    HTML-code for WebRTC conferences integration.

    		 
    {
    "name": "TrueConf macOS",
    "type": "standalone",
    "platform": "macos",
    "download_url": "http://server.name/downloads/trueconf_client.dmg",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/osx.html?lang=auto"
}
    {
    "name": "TrueConf iOS",
    "type": "standalone",
    "platform": "ios",
    "download_url": "",
    "download_urls": null,
    "market_url": "https://itunes.apple.com/ru/app/trueconf/id536475636",
    "web_url": "https://trueconf.com/downloads/ios.html?lang=auto"
}
    {
    "name": "TrueConf Android",
    "type": "standalone",
    "platform": "android",
    "download_url": "https://server.name/downloads/trueconf_android_client.apk",
    "download_urls": null,
    "market_url": "https://play.google.com/store/apps/details?id=com.trueconf.videochat&hl=ru",
    "web_url": "https://trueconf.com/downloads/android.html?lang=auto"
}
    {
    "name": "TrueConf Linux",
    "type": "standalone",
    "platform": "linux",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.ru/tcs/installation-linux/?lang=auto&version=<tcs_version>"
}
    {
     "name": "TrueConf Windows",
     "type": "standalone",
     "platform": "windows",
     "download_url": "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
     "download_urls": {
"x86" => "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
"x64" => "https://server.name/downloads/trueconf_windows_client_x64_<base64_encoded_params>.exe",
     },
     "market_url": "",
     "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
 }
    {
    "name": "TrueConf Client",
    "type": "standalone",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows-legacy.html?lang=auto"
}
    {
    "name": "TrueConf Client",
    "type": "single-use",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
}
    {
    "name": "TrueConf Web",
    "type": "web",
    "platform": "webrtc",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru",
    "iframe": "<iframe src=\"https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru\" allowfullscreen=\"allowfullscreen\" allow=\"microphone; camera; autoplay; display-capture\" ><\\iframe>"
}

    Objects | Software client

    Client application object .

    object 
    SoftwareClient

    Permission: access_token

    Structure

    Field Type Description
    name String

    Client application name.
    type String

    Client application type:

    • standalone is a desktop application
    • Single-use is a one-time client application with hardwired conference and authentication data
    • web is a web application based on WebRTC technology
    platform String

    Client application launch platform:

    • macos
    • ios
    • android
    • linux
    • windows
    • webrtc
    download_url String

    URL for downloading client application.
    download_urls optional Object

    URL list for downloading client application.

    Default value: null
    market_url String

    URL for installing client application from the application store.
    web_url String

    WebRTC conferences or instructions on how to install a client application.
    iframe optional String

    HTML-code for WebRTC conferences integration.

    		 
    {
    "name": "TrueConf macOS",
    "type": "standalone",
    "platform": "macos",
    "download_url": "http://server.name/downloads/trueconf_client.dmg",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/osx.html?lang=auto"
}
    {
    "name": "TrueConf iOS",
    "type": "standalone",
    "platform": "ios",
    "download_url": "",
    "download_urls": null,
    "market_url": "https://itunes.apple.com/ru/app/trueconf/id536475636",
    "web_url": "https://trueconf.com/downloads/ios.html?lang=auto"
}
    {
    "name": "TrueConf Android",
    "type": "standalone",
    "platform": "android",
    "download_url": "https://server.name/downloads/trueconf_android_client.apk",
    "download_urls": null,
    "market_url": "https://play.google.com/store/apps/details?id=com.trueconf.videochat&hl=ru",
    "web_url": "https://trueconf.com/downloads/android.html?lang=auto"
}
    {
    "name": "TrueConf Linux",
    "type": "standalone",
    "platform": "linux",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.ru/tcs/installation-linux/?lang=auto&version=<tcs_version>"
}
    {
     "name": "TrueConf Windows",
     "type": "standalone",
     "platform": "windows",
     "download_url": "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
     "download_urls": {
"x86" => "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
"x64" => "https://server.name/downloads/trueconf_windows_client_x64_<base64_encoded_params>.exe",
     },
     "market_url": "",
     "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
 }
    {
    "name": "TrueConf Client",
    "type": "standalone",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows-legacy.html?lang=auto"
}
    {
    "name": "TrueConf Client",
    "type": "single-use",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
}
    {
    "name": "TrueConf Web",
    "type": "web",
    "platform": "webrtc",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru",
    "iframe": "<iframe src=\"https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru\" allowfullscreen=\"allowfullscreen\" allow=\"microphone; camera; autoplay; display-capture\" ><\\iframe>"
}

    Objects | Software client

    Client application object .

    object 
    SoftwareClient

    Permission: access_token

    Structure

    Field Type Description
    name String

    Client application name.
    type String

    Client application type:

    • standalone is a desktop application
    • Single-use is a one-time client application with hardwired conference and authentication data
    • web is a web application based on WebRTC technology
    platform String

    Client application launch platform:

    • macos
    • ios
    • android
    • linux
    • windows
    • webrtc
    download_url String

    URL for downloading client application.
    download_urls optional Object

    URL list for downloading client application.

    Default value: null
    market_url String

    URL for installing client application from the application store.
    web_url String

    WebRTC conferences or instructions on how to install a client application.
    iframe optional String

    HTML-code for WebRTC conferences integration.

    		 
    {
    "name": "TrueConf macOS",
    "type": "standalone",
    "platform": "macos",
    "download_url": "http://server.name/downloads/trueconf_client.dmg",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/osx.html?lang=auto"
}
    {
    "name": "TrueConf iOS",
    "type": "standalone",
    "platform": "ios",
    "download_url": "",
    "download_urls": null,
    "market_url": "https://itunes.apple.com/ru/app/trueconf/id536475636",
    "web_url": "https://trueconf.com/downloads/ios.html?lang=auto"
}
    {
    "name": "TrueConf Android",
    "type": "standalone",
    "platform": "android",
    "download_url": "https://server.name/downloads/trueconf_android_client.apk",
    "download_urls": null,
    "market_url": "https://play.google.com/store/apps/details?id=com.trueconf.videochat&hl=ru",
    "web_url": "https://trueconf.com/downloads/android.html?lang=auto"
}
    {
    "name": "TrueConf Linux",
    "type": "standalone",
    "platform": "linux",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.ru/tcs/installation-linux/?lang=auto&version=<tcs_version>"
}
    {
     "name": "TrueConf Windows",
     "type": "standalone",
     "platform": "windows",
     "download_url": "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
     "download_urls": {
"x86" => "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
"x64" => "https://server.name/downloads/trueconf_windows_client_x64_<base64_encoded_params>.exe",
     },
     "market_url": "",
     "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
 }
    {
    "name": "TrueConf Client",
    "type": "standalone",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows-legacy.html?lang=auto"
}
    {
    "name": "TrueConf Client",
    "type": "single-use",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
}
    {
    "name": "TrueConf Web",
    "type": "web",
    "platform": "webrtc",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru",
    "iframe": "<iframe src=\"https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru\" allowfullscreen=\"allowfullscreen\" allow=\"microphone; camera; autoplay; display-capture\" ><\\iframe>"
}

    Objects | Software client

    Client application object .

    object 
    SoftwareClient

    Permission: access_token

    Structure

    Field Type Description
    name String

    Client application name.
    type String

    Client application type:

    • standalone is a desktop application
    • Single-use is a one-time client application with hardwired conference and authentication data
    • web is a web application based on WebRTC technology
    platform String

    Client application launch platform:

    • macos
    • ios
    • android
    • linux
    • windows
    • webrtc
    download_url String

    URL for downloading client application.
    download_urls optional Object

    URL list for downloading client application.

    Default value: null
    market_url String

    URL for installing client application from the application store.
    web_url String

    WebRTC conferences or instructions on how to install a client application.
    iframe optional String

    HTML-code for WebRTC conferences integration.

    		 
    {
    "name": "TrueConf macOS",
    "type": "standalone",
    "platform": "macos",
    "download_url": "http://server.name/downloads/trueconf_client.dmg",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/osx.html?lang=auto"
}
    {
    "name": "TrueConf iOS",
    "type": "standalone",
    "platform": "ios",
    "download_url": "",
    "download_urls": null,
    "market_url": "https://itunes.apple.com/ru/app/trueconf/id536475636",
    "web_url": "https://trueconf.com/downloads/ios.html?lang=auto"
}
    {
    "name": "TrueConf Android",
    "type": "standalone",
    "platform": "android",
    "download_url": "https://server.name/downloads/trueconf_android_client.apk",
    "download_urls": null,
    "market_url": "https://play.google.com/store/apps/details?id=com.trueconf.videochat&hl=ru",
    "web_url": "https://trueconf.com/downloads/android.html?lang=auto"
}
    {
    "name": "TrueConf Linux",
    "type": "standalone",
    "platform": "linux",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.ru/tcs/installation-linux/?lang=auto&version=<tcs_version>"
}
    {
     "name": "TrueConf Windows",
     "type": "standalone",
     "platform": "windows",
     "download_url": "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
     "download_urls": {
"x86" => "https://server.name/downloads/trueconf_windows_client_x86_<base64_encoded_params>.exe",
"x64" => "https://server.name/downloads/trueconf_windows_client_x64_<base64_encoded_params>.exe",
     },
     "market_url": "",
     "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
 }
    {
    "name": "TrueConf Client",
    "type": "standalone",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows-legacy.html?lang=auto"
}
    {
    "name": "TrueConf Client",
    "type": "single-use",
    "platform": "windows",
    "download_url": "https://server.name/downloads/<file_name_with_base64_encoded_params>.exe",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/windows.html?lang=auto"
}
    {
    "name": "TrueConf Web",
    "type": "web",
    "platform": "webrtc",
    "download_url": "",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru",
    "iframe": "<iframe src=\"https://server.name/webrtc/<conference_id>#login=<user_login>&token=<user_token>&lang=ru\" allowfullscreen=\"allowfullscreen\" allow=\"microphone; camera; autoplay; display-capture\" ><\\iframe>"
}

    Objects | SoftwareClient

    Client application object .

    object 
    SoftwareClient

    Permission: access_token

    Structure

    Field Type Description
    name String

    Client application name.
    type String

    Client application type:

    • standalone is a desktop application
    • Single-use is a one-time client application with hardwired conference and authentication data
    • web is a web application based on WebRTC technology
    platform String

    Client application launch platform:

    • macos
    • ios
    • android
    • linux
    • windows
    • webrtc
    download_url String

    URL for downloading client application.
    download_urls optional Object

    URL list for downloading client application.

    Default value: null
    market_url String

    URL for installing client application from the application store.
    web_url String

    WebRTC conferences or instructions on how to install a client application.

    		 
    {
    "name": "TrueConf macOS",
    "type": "standalone",
    "platform": "macos",
    "download_url": "http://server.name/downloads/trueconf_client.dmg",
    "download_urls": null,
    "market_url": "",
    "web_url": "https://trueconf.com/downloads/osx.html?lang=auto"
}

    Objects | Translator

    Translator object

    object 
    Translator

    Structure

    Field Type Description
    languages Array

    POST | PUT The pair of languages for translation.

    		 
    {
    "languages": [
        "en",
        "ru"
    ]
}

    Objects | Translator

    Translator object

    object 
    Translator

    Structure

    Field Type Description
    languages Array

    POST | PUT The pair of languages for translation.

    		 
    {
    "languages": [
        "en",
        "ru"
    ]
}

    Objects | User

    User object.

    object 
    User

    Structure

    Field Type Description
    id String

    User unique identifier.
    uid String

    User unique identifier for calls.
    avatar String

    User avatar address. If there is no avatar, null is returned.
    login_name String

    POST User username.

    Size range: 1..32
    password String

    POST | PUT User password.

    Size range: 1..255
    email String

    POST | PUT User unique email address.

    Size range: 3..250
    display_name String

    POST | PUT User display name.

    Size range: 1..64
    first_name String

    POST | PUT User first name.

    Size range: 0..64
    last_name String

    POST | PUT User last name.

    Size range: 0..64
    company String

    POST | PUT User company.

    Size range: 0..64
    groups Object[]

    List of ObjectGroupMini.
    mobile_phone String

    POST | PUT User mobile phone.

    Size range: 0..50
    work_phone String

    POST | PUT User work phone.

    Size range: 0..50
    home_phone String

    POST | PUT User home phone.

    Size range: 0..50
    status Integer

    INVALID: -1, OFFLINE: 0, ONLINE: 1, BUSY: 2, MULTIHOST: 5 (The user is in the conference and is the conference owner), UNDEFINED: -127.
    is_active Integer

    POST | PUT Account status: 1 - enabled, 0 - disabled.

    		 
    {
     "id": "user",
     "uid": "user@server.name",
     "avatar": null,
     "login_name": "user",
     "email": "user@domain.name",
     "display_name": "Display Name",
     "first_name": "First",
     "last_name": "Last",
     "company": "Company",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "mobile_phone": "",
     "work_phone": "",
     "home_phone": "",
     "is_active" : 1,
     "status": 0
 }

    Objects | User

    User object.

    object 
    User

    Structure

    Field Type Description
    id String

    User unique identifier.
    uid String

    User unique identifier for calls.
    avatar String

    User avatar address. If there is no avatar, null is returned.
    login_name String

    POST User username.

    Size range: 1..32
    password String

    POST | PUT User password.

    Size range: 1..255
    email String

    POST | PUT User unique email address.

    Size range: 3..250
    display_name String

    POST | PUT User display name.

    Size range: 1..64
    first_name String

    POST | PUT User first name.

    Size range: 0..64
    last_name String

    POST | PUT User last name.

    Size range: 0..64
    company String

    POST | PUT User company.

    Size range: 0..64
    groups Object[]

    List of ObjectGroupMini.
    mobile_phone String

    POST | PUT User mobile phone.

    Size range: 0..50
    work_phone String

    POST | PUT User work phone.

    Size range: 0..50
    home_phone String

    POST | PUT User home phone.

    Size range: 0..50
    status Integer

    INVALID: -1, OFFLINE: 0, ONLINE: 1, BUSY: 2, MULTIHOST: 5 (The user is in the conference and is the conference owner), UNDEFINED: -127.
    is_active Integer

    POST | PUT Account status: 1 - enabled, 0 - disabled.

    		 
    {
     "id": "user",
     "uid": "user@server.name",
     "avatar": null,
     "login_name": "user",
     "email": "user@domain.name",
     "display_name": "Display Name",
     "first_name": "First",
     "last_name": "Last",
     "company": "Company",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "mobile_phone": "",
     "work_phone": "",
     "home_phone": "",
     "is_active" : 1,
     "status": 0
 }

    Objects | User

    User object.

    object 
    User

    Structure

    Field Type Description
    id String

    User unique identifier.
    uid String

    User unique identifier for calls.
    avatar String

    User avatar address. If there is no avatar, null is returned.
    login_name String

    POST User username.

    Size range: 1..32
    password String

    POST | PUT User password.

    Size range: 1..255
    email String

    POST | PUT User unique email address.

    Size range: 3..250
    display_name String

    POST | PUT User display name.

    Size range: 1..64
    first_name String

    POST | PUT User first name.

    Size range: 0..64
    last_name String

    POST | PUT User last name.

    Size range: 0..64
    company String

    POST | PUT User company.

    Size range: 0..64
    groups Object[]

    List of ObjectGroupMini.
    mobile_phone String

    POST | PUT User mobile phone.

    Size range: 0..50
    work_phone String

    POST | PUT User work phone.

    Size range: 0..50
    home_phone String

    POST | PUT User home phone.

    Size range: 0..50
    status Integer

    INVALID: -1, OFFLINE: 0, ONLINE: 1, BUSY: 2, MULTIHOST: 5 (The user is in the conference and is the conference owner), UNDEFINED: -127.
    is_active Integer

    POST | PUT Account status: 1 - enabled, 0 - disabled.

    		 
    {
     "id": "user",
     "uid": "user@server.name",
     "avatar": null,
     "login_name": "user",
     "email": "user@domain.name",
     "display_name": "Display Name",
     "first_name": "First",
     "last_name": "Last",
     "company": "Company",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "mobile_phone": "",
     "work_phone": "",
     "home_phone": "",
     "is_active" : 1,
     "status": 0
 }

    Objects | User

    User object.

    object 
    User

    Structure

    Field Type Description
    id String

    User unique identifier.
    uid String

    User unique identifier for calls.
    avatar String

    User avatar address. If there is no avatar, null is returned.
    login_name String

    POST User username.

    Size range: 1..32
    password String

    POST | PUT User password.

    Size range: 1..255
    email String

    POST | PUT User unique email address.

    Size range: 3..250
    display_name String

    POST | PUT User display name.

    Size range: 1..64
    first_name String

    POST | PUT User first name.

    Size range: 0..64
    last_name String

    POST | PUT User last name.

    Size range: 0..64
    company String

    POST | PUT User company.

    Size range: 0..64
    groups Object[]

    List of ObjectGroupMini.
    mobile_phone String

    POST | PUT User mobile phone.

    Size range: 0..50
    work_phone String

    POST | PUT User work phone.

    Size range: 0..50
    home_phone String

    POST | PUT User home phone.

    Size range: 0..50
    status Integer

    INVALID: -1, OFFLINE: 0, ONLINE: 1, BUSY: 2, MULTIHOST: 5 (The user is in the conference and is the conference owner), UNDEFINED: -127.
    is_active Integer

    POST | PUT Account status: 1 - enabled, 0 - disabled.

    		 
    {
     "id": "user",
     "uid": "user@server.name",
     "avatar": null,
     "login_name": "user",
     "email": "user@domain.name",
     "display_name": "Display Name",
     "first_name": "First",
     "last_name": "Last",
     "company": "Company",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "mobile_phone": "",
     "work_phone": "",
     "home_phone": "",
     "is_active" : 1,
     "status": 0
 }

    Objects | User

    User object.

    object 
    User

    Structure

    Field Type Description
    id String

    User unique identifier.
    uid String

    User unique identifier for calls.
    avatar String

    User avatar address. If there is no avatar, null is returned.
    login_name String

    POST User username.

    Size range: 1..32
    password String

    POST | PUT User password.

    Size range: 1..255
    email String

    POST | PUT User unique email address.

    Size range: 3..250
    display_name String

    POST | PUT User display name.

    Size range: 1..64
    first_name String

    POST | PUT User first name.

    Size range: 0..64
    last_name String

    POST | PUT User last name.

    Size range: 0..64
    company String

    POST | PUT User company.

    Size range: 0..64
    groups Object[]

    List of ObjectGroupMini.
    mobile_phone String

    POST | PUT User mobile phone.

    Size range: 0..50
    work_phone String

    POST | PUT User work phone.

    Size range: 0..50
    home_phone String

    POST | PUT User home phone.

    Size range: 0..50
    status Integer

    INVALID: -1, OFFLINE: 0, ONLINE: 1, BUSY: 2, MULTIHOST: 5 (The user is in the conference and is the conference owner), UNDEFINED: -127.
    is_active Integer

    POST | PUT Account status: 1 - enabled, 0 - disabled.

    		 
    {
     "id": "user",
     "uid": "user@server.name",
     "avatar": null,
     "login_name": "user",
     "email": "user@domain.name",
     "display_name": "Display Name",
     "first_name": "First",
     "last_name": "Last",
     "company": "Company",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "mobile_phone": "",
     "work_phone": "",
     "home_phone": "",
     "is_active" : 1,
     "status": 0
 }

    Objects | User

    User object.

    object 
    User

    Structure

    Field Type Description
    id String

    User unique identifier.
    uid String

    User unique identifier for calls.
    avatar String

    User avatar address. If there is no avatar, null is returned.
    login_name String

    POST User username.

    Size range: 1..32
    password String

    POST | PUT User password.

    Size range: 1..255
    email String

    POST | PUT User unique email address.

    Size range: 3..250
    display_name String

    POST | PUT User display name.

    Size range: 1..64
    first_name String

    POST | PUT User first name.

    Size range: 0..64
    last_name String

    POST | PUT User last name.

    Size range: 0..64
    company String

    POST | PUT User company.

    Size range: 0..64
    groups Object[]

    List of ObjectGroupMini.
    mobile_phone String

    POST | PUT User mobile phone.

    Size range: 0..50
    work_phone String

    POST | PUT User work phone.

    Size range: 0..50
    home_phone String

    POST | PUT User home phone.

    Size range: 0..50
    status Integer

    INVALID: -1, OFFLINE: 0, ONLINE: 1, BUSY: 2, MULTIHOST: 5 (The user is in the conference and is the conference owner), UNDEFINED: -127.
    is_active Integer

    POST | PUT Account status: 1 - enabled, 0 - disabled.

    		 
    {
     "id": "user",
     "uid": "user@server.name",
     "avatar": null,
     "login_name": "user",
     "email": "user@domain.name",
     "display_name": "Display Name",
     "first_name": "First",
     "last_name": "Last",
     "company": "Company",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "mobile_phone": "",
     "work_phone": "",
     "home_phone": "",
     "is_active" : 1,
     "status": 0
 }

    Objects | User

    User object.

    object 
    User

    Structure

    Field Type Description
    id String

    User unique identifier.
    uid String

    User unique identifier for calls.
    avatar String

    User avatar address. If there is no avatar, null is returned.
    login_name String

    POST User username.

    Size range: 1..32
    password String

    POST | PUT User password.

    Size range: 1..255
    email String

    POST | PUT User unique email address.

    Size range: 3..250
    display_name String

    POST | PUT User display name.

    Size range: 1..64
    first_name String

    POST | PUT User first name.

    Size range: 0..64
    last_name String

    POST | PUT User last name.

    Size range: 0..64
    company String

    POST | PUT User company.

    Size range: 0..64
    groups Object[]

    List of ObjectGroupMini.
    mobile_phone String

    POST | PUT User mobile phone.

    Size range: 0..50
    work_phone String

    POST | PUT User work phone.

    Size range: 0..50
    home_phone String

    POST | PUT User home phone.

    Size range: 0..50
    status Integer

    INVALID: -1, OFFLINE: 0, ONLINE: 1, BUSY: 2, MULTIHOST: 5 (The user is in the conference and is the conference owner), UNDEFINED: -127.
    is_active Integer

    POST | PUT Account status: 1 - enabled, 0 - disabled.

    		 
    {
     "id": "user",
     "uid": "user@server.name",
     "avatar": null,
     "login_name": "user",
     "email": "user@domain.name",
     "display_name": "Display Name",
     "first_name": "First",
     "last_name": "Last",
     "company": "Company",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "mobile_phone": "",
     "work_phone": "",
     "home_phone": "",
     "is_active" : 1,
     "status": 0
 }

    Objects | User

    User object.

    object 
    User

    Structure

    Field Type Description
    id String

    User unique identifier.
    uid String

    User unique identifier for calls.
    avatar String

    User avatar address. If there is no avatar, null is returned.
    login_name String

    POST User username.

    Size range: 1..32
    password String

    POST | PUT User password.

    Size range: 1..255
    email String

    POST | PUT User unique email address.

    Size range: 3..250
    display_name String

    POST | PUT User display name.

    Size range: 1..64
    first_name String

    POST | PUT User first name.

    Size range: 0..64
    last_name String

    POST | PUT User last name.

    Size range: 0..64
    company String

    POST | PUT User company.

    Size range: 0..64
    groups Object[]

    List of ObjectGroupMini.
    mobile_phone String

    POST | PUT User mobile phone.

    Size range: 0..50
    work_phone String

    POST | PUT User work phone.

    Size range: 0..50
    home_phone String

    POST | PUT User home phone.

    Size range: 0..50
    status Integer

    INVALID: -1, OFFLINE: 0, ONLINE: 1, BUSY: 2, MULTIHOST: 5 (The user is in the conference and is the conference owner), UNDEFINED: -127.
    is_active Integer

    POST | PUT Account status: 1 - enabled, 0 - disabled.

    		 
    {
     "id": "user",
     "uid": "user@server.name",
     "avatar": null,
     "login_name": "user",
     "email": "user@domain.name",
     "display_name": "Display Name",
     "first_name": "First",
     "last_name": "Last",
     "company": "Company",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "mobile_phone": "",
     "work_phone": "",
     "home_phone": "",
     "is_active" : 1,
     "status": 0
 }

    Objects | User

    User object.

    object 
    User

    Structure

    Field Type Description
    id String

    User unique identifier.
    uid String

    User unique identifier for calls.
    avatar String

    User avatar address. If there is no avatar, null is returned.
    login_name String

    POST User username.

    Size range: 1..32
    password String

    POST | PUT User password.

    Size range: 1..255
    email String

    POST | PUT User unique email address.

    Size range: 3..250
    display_name String

    POST | PUT User display name.

    Size range: 1..64
    first_name String

    POST | PUT User first name.

    Size range: 0..64
    last_name String

    POST | PUT User last name.

    Size range: 0..64
    company String

    POST | PUT User company.

    Size range: 0..64
    groups Object[]

    List of ObjectGroupMini.
    mobile_phone String

    POST | PUT User mobile phone.

    Size range: 0..50
    work_phone String

    POST | PUT User work phone.

    Size range: 0..50
    home_phone String

    POST | PUT User home phone.

    Size range: 0..50
    status Integer

    INVALID: -1, OFFLINE: 0, ONLINE: 1, BUSY: 2, MULTIHOST: 5 (The user is in the conference and is the conference owner), UNDEFINED: -127.
    is_active Integer

    POST | PUT Account status: 1 - enabled, 0 - disabled.

    		 
    {
     "id": "user",
     "uid": "user@server.name",
     "avatar": null,
     "login_name": "user",
     "email": "user@domain.name",
     "display_name": "Display Name",
     "first_name": "First",
     "last_name": "Last",
     "company": "Company",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "mobile_phone": "",
     "work_phone": "",
     "home_phone": "",
     "is_active" : 1,
     "status": 0
 }

    Objects | User

    User object.

    object 
    User

    Structure

    Field Type Description
    id String

    User unique identifier.
    uid String

    User unique identifier for calls.
    avatar String

    User avatar address. If there is no avatar, null is returned.
    login_name String

    POST User username.

    Size range: 1..32
    password String

    POST | PUT User password.

    Size range: 1..255
    email String

    POST | PUT User unique email address.

    Size range: 3..250
    display_name String

    POST | PUT User display name.

    Size range: 1..64
    first_name String

    POST | PUT User first name.

    Size range: 0..64
    last_name String

    POST | PUT User last name.

    Size range: 0..64
    company String

    POST | PUT User company.

    Size range: 0..64
    groups Object[]

    List of ObjectGroupMini.
    mobile_phone String

    POST | PUT User mobile phone.

    Size range: 0..50
    work_phone String

    POST | PUT User work phone.

    Size range: 0..50
    home_phone String

    POST | PUT User home phone.

    Size range: 0..50
    status Integer

    INVALID: -1, OFFLINE: 0, ONLINE: 1, BUSY: 2, MULTIHOST: 5 (The user is in the conference and is the conference owner), UNDEFINED: -127.
    is_active Integer

    POST | PUT Account status: 1 - enabled, 0 - disabled.

    		 
    {
     "id": "user",
     "uid": "user@server.name",
     "avatar": null,
     "login_name": "user",
     "email": "user@domain.name",
     "display_name": "Display Name",
     "first_name": "First",
     "last_name": "Last",
     "company": "Company",
     "groups": [
         {ObjectGroupMini},
         {ObjectGroupMini},
     ],
     "mobile_phone": "",
     "work_phone": "",
     "home_phone": "",
     "is_active" : 1,
     "status": 0
 }

    Objects | User

    User object.

    object 
    User

    Structure

    Field Type Description
    id String

    User unique identifier.
    avatar String

    User avatar address. If there is no avatar, null is returned.
    login_name String

    POST User username.

    Size range: 1..32
    password String

    POST | PUT User password.

    Size range: 1..255
    email String

    POST | PUT User unique email address.

    Size range: 3..250
    display_name String

    POST | PUT User display name.

    Size range: 1..64
    first_name String

    POST | PUT User first name.

    Size range: 0..64
    last_name String

    POST | PUT User last name.

    Size range: 0..64
    company String

    POST | PUT User company.

    Size range: 0..64
    groups String[]

    User group list.
    mobile_phone String

    POST | PUT User mobile phone.

    Size range: 0..50
    work_phone String

    POST | PUT User work phone.

    Size range: 0..50
    home_phone String

    POST | PUT User home phone.

    Size range: 0..50
    status Integer

    INVALID: -1, OFFLINE: 0, ONLINE: 1, BUSY: 2, MULTIHOST: 5 (The user is in the conference and is the conference owner), UNDEFINED: -127.
    is_active Integer

    POST | PUT Account status. 1 - enabled, 0 - disabled

    		 
    {
    "id": "user",
    "uid": "user@server.name",
    "avatar": null,
    "login_name": "user",
    "email": "user@domain.name",
    "display_name": "Display Name",
    "first_name": "First",
    "last_name": "Last",
    "company": "Company",
    "groups": [
        "@no_group"
    ],
    "mobile_phone": "",
    "work_phone": "",
    "home_phone": "",
    "is_active": 1,
    "status": 0
}

    Logs

    Logs | Get Call Invite List

    Read call invite list.
    Returns ObjectCallInvite list.

    get 
    /api/v3.10/logs/calls/{{$session_id}}/invites

    Permission: logs.calls.invites:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/logs/calls/{{$session_id}}/invites?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call invite object list. List of ObjectCallInvite.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallInvite},
        {ObjectCallInvite},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Invite List

    Read call invite list.
    Returns ObjectCallInvite list.

    get 
    /api/v3.9/logs/calls/{{$session_id}}/invites

    Permission: logs.calls.invites:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/logs/calls/{{$session_id}}/invites?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call invite object list. List of ObjectCallInvite.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallInvite},
        {ObjectCallInvite},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Invite List

    Read call invite list.
    Returns ObjectCallInvite list.

    get 
    /api/v3.8/logs/calls/{{$session_id}}/invites

    Permission: logs.calls.invites:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/logs/calls/{{$session_id}}/invites?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call invite object list. List of ObjectCallInvite.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallInvite},
        {ObjectCallInvite},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Invite List

    Read call invite list.
    Returns ObjectCallInvite list.

    get 
    /api/v3.7/logs/calls/{{$session_id}}/invites

    Permission: logs.calls.invites:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/logs/calls/{{$session_id}}/invites?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call invite object list. List of ObjectCallInvite.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallInvite},
        {ObjectCallInvite},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Invite List

    Read call invite list.
    Returns ObjectCallInvite list.

    get 
    /api/v3.6/logs/calls/{{$session_id}}/invites

    Permission: logs.calls.invites:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/logs/calls/{{$session_id}}/invites?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call invite object list. List of ObjectCallInvite.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallInvite},
        {ObjectCallInvite},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Invite List

    Read call invite list.
    Returns ObjectCallInvite list.

    get 
    /api/v3.5/logs/calls/{{$session_id}}/invites

    Permission: logs.calls.invites:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/logs/calls/{{$session_id}}/invites?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call invite object list. List of ObjectCallInvite.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallInvite},
        {ObjectCallInvite},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Invite List

    Read call invite list.
    Returns ObjectCallInvite list.

    get 
    /api/v3.4/logs/calls/{{$session_id}}/invites

    Permission: logs.calls.invites:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/logs/calls/{{$session_id}}/invites?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call invite object list. List of ObjectCallInvite.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallInvite},
        {ObjectCallInvite},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Invite List

    Read call invite list.
    Returns ObjectCallInvite list.

    get 
    /api/v3.3/logs/calls/{{$session_id}}/invites

    Permission: logs.calls.invites:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/logs/calls/{{$session_id}}/invites?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call invite object list. List of ObjectCallInvite.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallInvite},
        {ObjectCallInvite},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Invite List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read call invite list.
    Returns ObjectCallInvite list.

    get 
    /api/v3.2/logs/calls/{{$session_id}}/invites

    Permission: logs.calls.invites:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/logs/calls/{{$session_id}}/invites?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call invite object list. List of ObjectCallInvite.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallInvite},
        {ObjectCallInvite},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Invite List

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read call invite list.
    Returns ObjectCallInvite list.

    get 
    /api/v3.1/logs/calls/{{$session_id}}/invites

    Permission: logs.calls.invites:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/logs/calls/{{$session_id}}/invites?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call invite object list. List of ObjectCallInvite.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallInvite},
        {ObjectCallInvite},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call List

    Read call list.
    Returns ObjectCall list.
    Also you will be able to send fields from call object ObjectCall, which are marked with GET tag, as parameters.

    get 
    /api/v3.10/logs/calls

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/logs/calls?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call object list. List of ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCall},
        {ObjectCall},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call List

    Read call list.
    Returns ObjectCall list.
    Also you will be able to send fields from call object ObjectCall, which are marked with GET tag, as parameters.

    get 
    /api/v3.9/logs/calls

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/logs/calls?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call object list. List of ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCall},
        {ObjectCall},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call List

    Read call list.
    Returns ObjectCall list.
    Also you will be able to send fields from call object ObjectCall, which are marked with GET tag, as parameters.

    get 
    /api/v3.8/logs/calls

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/logs/calls?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call object list. List of ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCall},
        {ObjectCall},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call List

    Read call list.
    Returns ObjectCall list.
    Also you will be able to send fields from call object ObjectCall, which are marked with GET tag, as parameters.

    get 
    /api/v3.7/logs/calls

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/logs/calls?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call object list. List of ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCall},
        {ObjectCall},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call List

    Read call list.
    Returns ObjectCall list.
    Also you will be able to send fields from call object ObjectCall, which are marked with GET tag, as parameters.

    get 
    /api/v3.6/logs/calls

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/logs/calls?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call object list. List of ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCall},
        {ObjectCall},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call List

    Read call list.
    Returns ObjectCall list.
    Also you will be able to send fields from call object ObjectCall, which are marked with GET tag, as parameters.

    get 
    /api/v3.5/logs/calls

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/logs/calls?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call object list. List of ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCall},
        {ObjectCall},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call List

    Read call list.
    Returns ObjectCall list.
    Also you will be able to send fields from call object ObjectCall, which are marked with GET tag, as parameters.

    get 
    /api/v3.4/logs/calls

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/logs/calls?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call object list. List of ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCall},
        {ObjectCall},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call List

    Read call list.
    Returns ObjectCall list.
    Also you will be able to send fields from call object ObjectCall, which are marked with GET tag, as parameters.

    get 
    /api/v3.3/logs/calls

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/logs/calls?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call object list. List of ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCall},
        {ObjectCall},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read call list.
    Returns ObjectCall list.
    Also you will be able to send fields from call object ObjectCall, which are marked with GET tag, as parameters.

    get 
    /api/v3.2/logs/calls

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/logs/calls?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call object list. List of ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCall},
        {ObjectCall},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call List

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read call list.
    Returns ObjectCall list.
    Also you will be able to send fields from call object ObjectCall, which are marked with GET tag, as parameters.

    get 
    /api/v3.1/logs/calls

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/logs/calls?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call object list. List of ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCall},
        {ObjectCall},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Participant List

    Read call participant list.
    Returns ObjectCallParticipant list.

    get 
    /api/v3.10/logs/calls/{{$session_id}}/participants

    Permission: logs.calls.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/logs/calls/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call participant object list. List of ObjectCallParticipant.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallParticipant},
        {ObjectCallParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Participant List

    Read call participant list.
    Returns ObjectCallParticipant list.

    get 
    /api/v3.9/logs/calls/{{$session_id}}/participants

    Permission: logs.calls.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/logs/calls/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call participant object list. List of ObjectCallParticipant.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallParticipant},
        {ObjectCallParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Participant List

    Read call participant list.
    Returns ObjectCallParticipant list.

    get 
    /api/v3.8/logs/calls/{{$session_id}}/participants

    Permission: logs.calls.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/logs/calls/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call participant object list. List of ObjectCallParticipant.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallParticipant},
        {ObjectCallParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Participant List

    Read call participant list.
    Returns ObjectCallParticipant list.

    get 
    /api/v3.7/logs/calls/{{$session_id}}/participants

    Permission: logs.calls.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/logs/calls/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call participant object list. List of ObjectCallParticipant.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallParticipant},
        {ObjectCallParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Participant List

    Read call participant list.
    Returns ObjectCallParticipant list.

    get 
    /api/v3.6/logs/calls/{{$session_id}}/participants

    Permission: logs.calls.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/logs/calls/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call participant object list. List of ObjectCallParticipant.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallParticipant},
        {ObjectCallParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Participant List

    Read call participant list.
    Returns ObjectCallParticipant list.

    get 
    /api/v3.5/logs/calls/{{$session_id}}/participants

    Permission: logs.calls.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/logs/calls/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call participant object list. List of ObjectCallParticipant.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallParticipant},
        {ObjectCallParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Participant List

    Read call participant list.
    Returns ObjectCallParticipant list.

    get 
    /api/v3.4/logs/calls/{{$session_id}}/participants

    Permission: logs.calls.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/logs/calls/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call participant object list. List of ObjectCallParticipant.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallParticipant},
        {ObjectCallParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Participant List

    Read call participant list.
    Returns ObjectCallParticipant list.

    get 
    /api/v3.3/logs/calls/{{$session_id}}/participants

    Permission: logs.calls.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/logs/calls/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call participant object list. List of ObjectCallParticipant.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallParticipant},
        {ObjectCallParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Participant List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read call participant list.
    Returns ObjectCallParticipant list.

    get 
    /api/v3.2/logs/calls/{{$session_id}}/participants

    Permission: logs.calls.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/logs/calls/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call participant object list. List of ObjectCallParticipant.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallParticipant},
        {ObjectCallParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Participant List

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read call participant list.
    Returns ObjectCallParticipant list.

    get 
    /api/v3.1/logs/calls/{{$session_id}}/participants

    Permission: logs.calls.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/logs/calls/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    call_id optional String

    GET Filter by call participant identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Call participant object list. List of ObjectCallParticipant.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallParticipant},
        {ObjectCallParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Record List

    DEPRECATED use now Logs/GetRecordingList

    Read call record list.
    Returns ObjectCallRecord list.
    Also you will be able to send fields from record object ObjectCallRecord, which are marked with GET tag, as parameters.

    get 
    /api/v3.10/logs/records

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/logs/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    CallRecord object list. List of ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallRecord},
        {ObjectCallRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Record List

    DEPRECATED use now Logs/GetRecordingList

    Read call record list.
    Returns ObjectCallRecord list.
    Also you will be able to send fields from record object ObjectCallRecord, which are marked with GET tag, as parameters.

    get 
    /api/v3.9/logs/records

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/logs/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    CallRecord object list. List of ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallRecord},
        {ObjectCallRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Record List

    DEPRECATED use now Logs/GetRecordingList

    Read call record list.
    Returns ObjectCallRecord list.
    Also you will be able to send fields from record object ObjectCallRecord, which are marked with GET tag, as parameters.

    get 
    /api/v3.8/logs/records

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/logs/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    CallRecord object list. List of ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallRecord},
        {ObjectCallRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Record List

    DEPRECATED use now Logs/GetRecordingList

    Read call record list.
    Returns ObjectCallRecord list.
    Also you will be able to send fields from record object ObjectCallRecord, which are marked with GET tag, as parameters.

    get 
    /api/v3.7/logs/records

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/logs/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    CallRecord object list. List of ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallRecord},
        {ObjectCallRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Record List

    DEPRECATED use now Logs/GetRecordingList

    Read call record list.
    Returns ObjectCallRecord list.
    Also you will be able to send fields from record object ObjectCallRecord, which are marked with GET tag, as parameters.

    get 
    /api/v3.6/logs/records

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/logs/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    CallRecord object list. List of ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallRecord},
        {ObjectCallRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Record List

    DEPRECATED use now Logs/GetRecordingList

    Read call record list.
    Returns ObjectCallRecord list.
    Also you will be able to send fields from record object ObjectCallRecord, which are marked with GET tag, as parameters.

    get 
    /api/v3.5/logs/records

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/logs/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    CallRecord object list. List of ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallRecord},
        {ObjectCallRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Record List

    DEPRECATED use now Logs/GetRecordingList

    Read call record list.
    Returns ObjectCallRecord list.
    Also you will be able to send fields from record object ObjectCallRecord, which are marked with GET tag, as parameters.

    get 
    /api/v3.4/logs/records

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/logs/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    CallRecord object list. List of ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallRecord},
        {ObjectCallRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Record List

    DEPRECATED use now Logs/GetRecordingList

    Read call record list.
    Returns ObjectCallRecord list.
    Also you will be able to send fields from record object ObjectCallRecord, which are marked with GET tag, as parameters.

    get 
    /api/v3.3/logs/records

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/logs/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    CallRecord object list. List of ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallRecord},
        {ObjectCallRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Record List

    DEPRECATED use now Logs/GetRecordingList

    Read call record list.
    Returns ObjectCallRecord list.
    Also you will be able to send fields from record object ObjectCallRecord, which are marked with GET tag, as parameters.

    get 
    /api/v3.2/logs/records

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/logs/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    CallRecord object list. List of ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallRecord},
        {ObjectCallRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Record List

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read call record list.
    Returns ObjectCallRecord list.
    Also you will be able to send fields from record object ObjectCallRecord, which are marked with GET tag, as parameters.

    get 
    /api/v3.1/logs/records

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/logs/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    CallRecord object list. List of ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectCallRecord},
        {ObjectCallRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Call Record

    Read call record.
    Returns ObjectCallRecord.

    get 
    /api/v3.10/logs/records/{{$session_id}}

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/logs/records/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    ObjectCallRecord
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call Record

    Read call record.
    Returns ObjectCallRecord.

    get 
    /api/v3.9/logs/records/{{$session_id}}

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/logs/records/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    ObjectCallRecord
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call Record

    Read call record.
    Returns ObjectCallRecord.

    get 
    /api/v3.8/logs/records/{{$session_id}}

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/logs/records/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    ObjectCallRecord
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call Record

    Read call record.
    Returns ObjectCallRecord.

    get 
    /api/v3.7/logs/records/{{$session_id}}

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/logs/records/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    ObjectCallRecord
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call Record

    Read call record.
    Returns ObjectCallRecord.

    get 
    /api/v3.6/logs/records/{{$session_id}}

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/logs/records/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    ObjectCallRecord
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call Record

    Read call record.
    Returns ObjectCallRecord.

    get 
    /api/v3.5/logs/records/{{$session_id}}

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/logs/records/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    ObjectCallRecord
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call Record

    Read call record.
    Returns ObjectCallRecord.

    get 
    /api/v3.4/logs/records/{{$session_id}}

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/logs/records/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    ObjectCallRecord
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call Record

    Read call record.
    Returns ObjectCallRecord.

    get 
    /api/v3.3/logs/records/{{$session_id}}

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/logs/records/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    ObjectCallRecord
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call Record

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read call record.
    Returns ObjectCallRecord.

    get 
    /api/v3.2/logs/records/{{$session_id}}

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/logs/records/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    ObjectCallRecord
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call Record

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read call record.
    Returns ObjectCallRecord.

    get 
    /api/v3.1/logs/records/{{$session_id}}

    Permission: logs.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/logs/records/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCallRecord.

    		 
    HTTP/1.1 200 OK
{
    ObjectCallRecord
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call

    Read call.
    Returns ObjectCall.

    get 
    /api/v3.10/logs/calls/{{$session_id}}

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/logs/calls/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    ObjectCall
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call

    Read call.
    Returns ObjectCall.

    get 
    /api/v3.9/logs/calls/{{$session_id}}

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/logs/calls/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    ObjectCall
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call

    Read call.
    Returns ObjectCall.

    get 
    /api/v3.8/logs/calls/{{$session_id}}

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/logs/calls/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    ObjectCall
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call

    Read call.
    Returns ObjectCall.

    get 
    /api/v3.7/logs/calls/{{$session_id}}

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/logs/calls/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    ObjectCall
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call

    Read call.
    Returns ObjectCall.

    get 
    /api/v3.6/logs/calls/{{$session_id}}

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/logs/calls/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    ObjectCall
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call

    Read call.
    Returns ObjectCall.

    get 
    /api/v3.5/logs/calls/{{$session_id}}

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/logs/calls/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    ObjectCall
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call

    Read call.
    Returns ObjectCall.

    get 
    /api/v3.4/logs/calls/{{$session_id}}

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/logs/calls/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    ObjectCall
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call

    Read call.
    Returns ObjectCall.

    get 
    /api/v3.3/logs/calls/{{$session_id}}

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/logs/calls/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    ObjectCall
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read call.
    Returns ObjectCall.

    get 
    /api/v3.2/logs/calls/{{$session_id}}

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/logs/calls/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    ObjectCall
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Call

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read call.
    Returns ObjectCall.

    get 
    /api/v3.1/logs/calls/{{$session_id}}

    Permission: logs.calls:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/logs/calls/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0

    Success 200

    Field Type Description
    call Object

    ObjectCall.

    		 
    HTTP/1.1 200 OK
{
    ObjectCall
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Logs | Get Event List

    Read call list.
    Returns ObjectEvent list.

    get 
    /api/v3.10/logs/events

    Permission: logs.events:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/logs/events?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    object_type optional String

    GET Type of event source object.
    object_name optional String

    GET Name of event source object.
    event_type optional String

    GET Filter by event type.
    invoker_ip optional String

    GET Filter by IP address of the event initiator.
    severity optional String

    GET Filter by event severity.

    Allowed values: "low", "middle", "high"

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Event object list. List of ObjectEvent.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectEvent},
        {ObjectEvent},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Event List

    Read call list.
    Returns ObjectEvent list.

    get 
    /api/v3.9/logs/events

    Permission: logs.events:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/logs/events?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    object_type optional String

    GET Type of event source object.
    object_name optional String

    GET Name of event source object.
    event_type optional String

    GET Filter by event type.
    invoker_ip optional String

    GET Filter by IP address of the event initiator.
    severity optional String

    GET Filter by event severity.

    Allowed values: "low", "middle", "high"

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Event object list. List of ObjectEvent.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectEvent},
        {ObjectEvent},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Event List

    Read call list.
    Returns ObjectEvent list.

    get 
    /api/v3.8/logs/events

    Permission: logs.events:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/logs/events?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    object_type optional String

    GET Type of event source object.
    object_name optional String

    GET Name of event source object.
    event_type optional String

    GET Filter by event type.
    invoker_ip optional String

    GET Filter by IP address of the event initiator.
    severity optional String

    GET Filter by event severity.

    Allowed values: "low", "middle", "high"

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Event object list. List of ObjectEvent.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectEvent},
        {ObjectEvent},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Event List

    Read call list.
    Returns ObjectEvent list.

    get 
    /api/v3.7/logs/events

    Permission: logs.events:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/logs/events?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    object_type optional String

    GET Type of event source object.
    object_name optional String

    GET Name of event source object.
    event_type optional String

    GET Filter by event type.
    invoker_ip optional String

    GET Filter by IP address of the event initiator.
    severity optional String

    GET Filter by event severity.

    Allowed values: "low", "middle", "high"

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Event object list. List of ObjectEvent.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectEvent},
        {ObjectEvent},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Event List

    Read call list.
    Returns ObjectEvent list.

    get 
    /api/v3.6/logs/events

    Permission: logs.events:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/logs/events?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    object_type optional String

    GET Type of event source object.
    object_name optional String

    GET Name of event source object.
    event_type optional String

    GET Filter by event type.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Event object list. List of ObjectEvent.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectEvent},
        {ObjectEvent},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Event List

    Read call list.
    Returns ObjectEvent list.

    get 
    /api/v3.5/logs/events

    Permission: logs.events:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/logs/events?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    object_type optional String

    GET Type of event source object.
    object_name optional String

    GET Name of event source object.
    event_type optional String

    GET Filter by event type.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Event object list. List of ObjectEvent.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectEvent},
        {ObjectEvent},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Event List

    Read call list.
    Returns ObjectEvent list.

    get 
    /api/v3.4/logs/events

    Permission: logs.events:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/logs/events?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    object_type optional String

    GET Type of event source object.
    object_name optional String

    GET Name of event source object.
    event_type optional String

    GET Filter by event type.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Event object list. List of ObjectEvent.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectEvent},
        {ObjectEvent},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Event List

    Read call list.
    Returns ObjectEvent list.

    get 
    /api/v3.3/logs/events

    Permission: logs.events:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/logs/events?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    object_type optional String

    GET Type of event source object.
    object_name optional String

    GET Name of event source object.
    event_type optional String

    GET Filter by event type.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Event object list. List of ObjectEvent.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectEvent},
        {ObjectEvent},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Event List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read call list.
    Returns ObjectEvent list.

    get 
    /api/v3.2/logs/events

    Permission: logs.events:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/logs/events?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    object_type optional String

    GET Type of event source object.
    object_name optional String

    GET Name of event source object.
    event_type optional String

    GET Filter by event type.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Event object list. List of ObjectEvent.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectEvent},
        {ObjectEvent},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Event List

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read call list.
    Returns ObjectEvent list.

    get 
    /api/v3.1/logs/events

    Permission: logs.events:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/logs/events?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    object_type optional String

    GET Type of event source object.
    object_name optional String

    GET Name of event source object.
    event_type optional String

    GET Filter by event type.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Event object list. List of ObjectEvent.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectEvent},
        {ObjectEvent},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Message List

    Read call list.
    Returns ObjectMessage list.

    get 
    /api/v3.10/logs/messages

    Permission: logs.messages:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/logs/messages?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    from_call_id optional String

    GET Filter by message sender identifier.
    to_call_id optional String

    GET Filter by message recipient identifier.
    message optional String

    GET Filter by message that contained this text.
    conference_id optional String

    GET Filter by invited call session identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Message object list. List of ObjectMessage.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectMessage},
        {ObjectMessage},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Message List

    Read call list.
    Returns ObjectMessage list.

    get 
    /api/v3.9/logs/messages

    Permission: logs.messages:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/logs/messages?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    from_call_id optional String

    GET Filter by message sender identifier.
    to_call_id optional String

    GET Filter by message recipient identifier.
    message optional String

    GET Filter by message that contained this text.
    conference_id optional String

    GET Filter by invited call session identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Message object list. List of ObjectMessage.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectMessage},
        {ObjectMessage},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Message List

    Read call list.
    Returns ObjectMessage list.

    get 
    /api/v3.8/logs/messages

    Permission: logs.messages:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/logs/messages?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    from_call_id optional String

    GET Filter by message sender identifier.
    to_call_id optional String

    GET Filter by message recipient identifier.
    message optional String

    GET Filter by message that contained this text.
    conference_id optional String

    GET Filter by invited call session identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Message object list. List of ObjectMessage.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectMessage},
        {ObjectMessage},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Message List

    Read call list.
    Returns ObjectMessage list.

    get 
    /api/v3.7/logs/messages

    Permission: logs.messages:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/logs/messages?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    from_call_id optional String

    GET Filter by message sender identifier.
    to_call_id optional String

    GET Filter by message recipient identifier.
    message optional String

    GET Filter by message that contained this text.
    conference_id optional String

    GET Filter by invited call session identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Message object list. List of ObjectMessage.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectMessage},
        {ObjectMessage},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Message List

    Read call list.
    Returns ObjectMessage list.

    get 
    /api/v3.6/logs/messages

    Permission: logs.messages:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/logs/messages?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    from_call_id optional String

    GET Filter by message sender identifier.
    to_call_id optional String

    GET Filter by message recipient identifier.
    message optional String

    GET Filter by message that contained this text.
    conference_id optional String

    GET Filter by invited call session identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Message object list. List of ObjectMessage.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectMessage},
        {ObjectMessage},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Message List

    Read call list.
    Returns ObjectMessage list.

    get 
    /api/v3.5/logs/messages

    Permission: logs.messages:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/logs/messages?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    from_call_id optional String

    GET Filter by message sender identifier.
    to_call_id optional String

    GET Filter by message recipient identifier.
    message optional String

    GET Filter by message that contained this text.
    conference_id optional String

    GET Filter by invited call session identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Message object list. List of ObjectMessage.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectMessage},
        {ObjectMessage},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Message List

    Read call list.
    Returns ObjectMessage list.

    get 
    /api/v3.4/logs/messages

    Permission: logs.messages:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/logs/messages?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    from_call_id optional String

    GET Filter by message sender identifier.
    to_call_id optional String

    GET Filter by message recipient identifier.
    message optional String

    GET Filter by message that contained this text.
    conference_id optional String

    GET Filter by invited call session identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Message object list. List of ObjectMessage.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectMessage},
        {ObjectMessage},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Message List

    Read call list.
    Returns ObjectMessage list.

    get 
    /api/v3.3/logs/messages

    Permission: logs.messages:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/logs/messages?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    from_call_id optional String

    GET Filter by message sender identifier.
    to_call_id optional String

    GET Filter by message recipient identifier.
    message optional String

    GET Filter by message that contained this text.
    conference_id optional String

    GET Filter by invited call session identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Message object list. List of ObjectMessage.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectMessage},
        {ObjectMessage},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Message List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read call list.
    Returns ObjectMessage list.

    get 
    /api/v3.2/logs/messages

    Permission: logs.messages:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/logs/messages?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    from_call_id optional String

    GET Filter by message sender identifier.
    to_call_id optional String

    GET Filter by message recipient identifier.
    message optional String

    GET Filter by message that contained this text.
    conference_id optional String

    GET Filter by invited call session identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Message object list. List of ObjectMessage.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectMessage},
        {ObjectMessage},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Message List

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read call list.
    Returns ObjectMessage list.

    get 
    /api/v3.1/logs/messages

    Permission: logs.messages:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/logs/messages?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    from_call_id optional String

    GET Filter by message sender identifier.
    to_call_id optional String

    GET Filter by message recipient identifier.
    message optional String

    GET Filter by message that contained this text.
    conference_id optional String

    GET Filter by invited call session identifier.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Message object list. List of ObjectMessage.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectMessage},
        {ObjectMessage},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Recording List

    Read recording list.
    Returns ObjectRecording list.
    Also you will be able to send fields from recording object ObjectRecording, which are marked with GET tag, as parameters.

    get 
    /api/v3.10/logs/recordings

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/logs/recordings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.
    show_deleted optional bool

    GET Filter param for hiding/showing deleted entities.
    owner optional String

    GET Filter by Owner.
    topic optional String

    GET Filter by topic.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Recording object list. List of ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectRecording},
        {ObjectRecording},
        ...
    ]
}

    Logs | Get Recording List

    Read recording list.
    Returns ObjectRecording list.
    Also you will be able to send fields from recording object ObjectRecording, which are marked with GET tag, as parameters.

    get 
    /api/v3.9/logs/recordings

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/logs/recordings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.
    show_deleted optional bool

    GET Filter param for hiding/showing deleted entities.
    owner optional String

    GET Filter by Owner.
    topic optional String

    GET Filter by topic.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Recording object list. List of ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectRecording},
        {ObjectRecording},
        ...
    ]
}

    Logs | Get Recording List

    Read recording list.
    Returns ObjectRecording list.
    Also you will be able to send fields from recording object ObjectRecording, which are marked with GET tag, as parameters.

    get 
    /api/v3.8/logs/recordings

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/logs/recordings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.
    show_deleted optional bool

    GET Filter param for hiding/showing deleted entities.
    owner optional String

    GET Filter by Owner.
    topic optional String

    GET Filter by topic.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Recording object list. List of ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectRecording},
        {ObjectRecording},
        ...
    ]
}

    Logs | Get Recording List

    Read recording list.
    Returns ObjectRecording list.
    Also you will be able to send fields from recording object ObjectRecording, which are marked with GET tag, as parameters.

    get 
    /api/v3.7/logs/recordings

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/logs/recordings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.
    show_deleted optional bool

    GET Filter param for hiding/showing deleted entities.
    owner optional String

    GET Filter by Owner.
    topic optional String

    GET Filter by topic.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Recording object list. List of ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectRecording},
        {ObjectRecording},
        ...
    ]
}

    Logs | Get Recording List

    Read recording list.
    Returns ObjectRecording list.
    Also you will be able to send fields from recording object ObjectRecording, which are marked with GET tag, as parameters.

    get 
    /api/v3.6/logs/recordings

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/logs/recordings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.
    show_deleted optional bool

    GET Filter param for hiding/showing deleted entities.
    owner optional String

    GET Filter by Owner.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Recording object list. List of ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectRecording},
        {ObjectRecording},
        ...
    ]
}

    Logs | Get Recording List

    Read recording list.
    Returns ObjectRecording list.
    Also you will be able to send fields from recording object ObjectRecording, which are marked with GET tag, as parameters.

    get 
    /api/v3.5/logs/recordings

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/logs/recordings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.
    show_deleted optional bool

    GET Filter param for hiding/showing deleted entities.
    owner optional String

    GET Filter by Owner.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Recording object list. List of ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectRecording},
        {ObjectRecording},
        ...
    ]
}

    Logs | Get Recording List

    Read recording list.
    Returns ObjectRecording list.
    Also you will be able to send fields from recording object ObjectRecording, which are marked with GET tag, as parameters.

    get 
    /api/v3.4/logs/recordings

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/logs/recordings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.
    stream_id optional String

    GET Filter by invited call session identifier.
    show_deleted optional bool

    GET Filter param for hiding/showing deleted entities.
    owner optional String

    GET Filter by Owner.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Recording object list. List of ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectRecording},
        {ObjectRecording},
        ...
    ]
}

    Logs | Get Recording List

    Read recording list.
    Returns ObjectRecording list.
    Also you will be able to send fields from recording object ObjectRecording, which are marked with GET tag, as parameters.

    get 
    /api/v3.3/logs/recordings

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/logs/recordings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.
    show_deleted optional bool

    GET Filter param for hiding/showing deleted entities.
    owner optional String

    GET Filter by Owner.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Recording object list. List of ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectRecording},
        {ObjectRecording},
        ...
    ]
}

    Logs | Get Recording List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read recording list.
    Returns ObjectRecording list.
    Also you will be able to send fields from recording object ObjectRecording, which are marked with GET tag, as parameters.

    get 
    /api/v3.2/logs/recordings

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/logs/recordings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").
    class optional Integer

    GET Filter by call session class.
    named_conf_id optional String

    GET Filter by identifier of conference.
    show_deleted optional bool

    GET Filter param for hiding/showing deleted entities.
    owner optional String

    GET Filter by Owner.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Recording object list. List of ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectRecording},
        {ObjectRecording},
        ...
    ]
}

    Logs | Get Recording

    Read recording.
    Returns ObjectRecording.

    get 
    /api/v3.10/logs/recordings/{{$recording_id}}

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/logs/recordings/{{$recording_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    recording Object

    ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    ObjectRecording
}

    Errors

    Name Type Description
    recordingNotFound ObjectErrorDetail

    Recording recording_id is not found

    Logs | Get Recording

    Read recording.
    Returns ObjectRecording.

    get 
    /api/v3.9/logs/recordings/{{$recording_id}}

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/logs/recordings/{{$recording_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    recording Object

    ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    ObjectRecording
}

    Errors

    Name Type Description
    recordingNotFound ObjectErrorDetail

    Recording recording_id is not found

    Logs | Get Recording

    Read recording.
    Returns ObjectRecording.

    get 
    /api/v3.8/logs/recordings/{{$recording_id}}

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/logs/recordings/{{$recording_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    recording Object

    ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    ObjectRecording
}

    Errors

    Name Type Description
    recordingNotFound ObjectErrorDetail

    Recording recording_id is not found

    Logs | Get Recording

    Read recording.
    Returns ObjectRecording.

    get 
    /api/v3.7/logs/recordings/{{$recording_id}}

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/logs/recordings/{{$recording_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    recording Object

    ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    ObjectRecording
}

    Errors

    Name Type Description
    recordingNotFound ObjectErrorDetail

    Recording recording_id is not found

    Logs | Get Recording

    Read recording.
    Returns ObjectRecording.

    get 
    /api/v3.6/logs/recordings/{{$recording_id}}

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/logs/recordings/{{$recording_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    recording Object

    ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    ObjectRecording
}

    Errors

    Name Type Description
    recordingNotFound ObjectErrorDetail

    Recording recording_id is not found

    Logs | Get Recording

    Read recording.
    Returns ObjectRecording.

    get 
    /api/v3.5/logs/recordings/{{$recording_id}}

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/logs/recordings/{{$recording_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    recording Object

    ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    ObjectRecording
}

    Errors

    Name Type Description
    recordingNotFound ObjectErrorDetail

    Recording recording_id is not found

    Logs | Get Recording

    Read recording.
    Returns ObjectRecording.

    get 
    /api/v3.4/logs/recordings/{{$recording_id}}

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/logs/recordings/{{$recording_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    recording Object

    ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    ObjectRecording
}

    Errors

    Name Type Description
    recordingNotFound ObjectErrorDetail

    Recording recording_id is not found

    Logs | Get Recording

    Read recording.
    Returns ObjectRecording.

    get 
    /api/v3.3/logs/recordings/{{$recording_id}}

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/logs/recordings/{{$recording_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    recording Object

    ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    ObjectRecording
}

    Errors

    Name Type Description
    recordingNotFound ObjectErrorDetail

    Recording recording_id is not found

    Logs | Get Recording

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read recording.
    Returns ObjectRecording.

    get 
    /api/v3.2/logs/recordings/{{$recording_id}}

    Permission: logs.recordings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/logs/recordings/{{$recording_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    recording Object

    ObjectRecording.

    		 
    HTTP/1.1 200 OK
{
    ObjectRecording
}

    Errors

    Name Type Description
    recordingNotFound ObjectErrorDetail

    Recording recording_id is not found

    Logs | Get Setting List

    Read setting list.
    Returns ObjectSetting list
    . Also you will be able to send fields from call object ObjectSetting, which are marked with GET tag, as parameters.

    get 
    /api/v3.10/logs/settings

    Permission: logs.settings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/logs/settings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Setting object list. List of ObjectSetting.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectSetting},
        {ObjectSetting},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Setting List

    Read setting list.
    Returns ObjectSetting list
    . Also you will be able to send fields from call object ObjectSetting, which are marked with GET tag, as parameters.

    get 
    /api/v3.9/logs/settings

    Permission: logs.settings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/logs/settings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Setting object list. List of ObjectSetting.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectSetting},
        {ObjectSetting},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Setting List

    Read setting list.
    Returns ObjectSetting list
    . Also you will be able to send fields from call object ObjectSetting, which are marked with GET tag, as parameters.

    get 
    /api/v3.8/logs/settings

    Permission: logs.settings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/logs/settings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Setting object list. List of ObjectSetting.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectSetting},
        {ObjectSetting},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Setting List

    Read setting list.
    Returns ObjectSetting list
    . Also you will be able to send fields from call object ObjectSetting, which are marked with GET tag, as parameters.

    get 
    /api/v3.7/logs/settings

    Permission: logs.settings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/logs/settings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Setting object list. List of ObjectSetting.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectSetting},
        {ObjectSetting},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Setting List

    Read setting list.
    Returns ObjectSetting list
    . Also you will be able to send fields from call object ObjectSetting, which are marked with GET tag, as parameters.

    get 
    /api/v3.6/logs/settings

    Permission: logs.settings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/logs/settings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Setting object list. List of ObjectSetting.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectSetting},
        {ObjectSetting},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Setting List

    Read setting list.
    Returns ObjectSetting list
    . Also you will be able to send fields from call object ObjectSetting, which are marked with GET tag, as parameters.

    get 
    /api/v3.5/logs/settings

    Permission: logs.settings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/logs/settings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Setting object list. List of ObjectSetting.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectSetting},
        {ObjectSetting},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Setting List

    Read setting list.
    Returns ObjectSetting list
    . Also you will be able to send fields from call object ObjectSetting, which are marked with GET tag, as parameters.

    get 
    /api/v3.4/logs/settings

    Permission: logs.settings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/logs/settings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Setting object list. List of ObjectSetting.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectSetting},
        {ObjectSetting},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Setting List

    Read setting list.
    Returns ObjectSetting list
    . Also you will be able to send fields from call object ObjectSetting, which are marked with GET tag, as parameters.

    get 
    /api/v3.3/logs/settings

    Permission: logs.settings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/logs/settings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Setting object list. List of ObjectSetting.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectSetting},
        {ObjectSetting},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Setting List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read setting list.
    Returns ObjectSetting list
    . Also you will be able to send fields from call object ObjectSetting, which are marked with GET tag, as parameters.

    get 
    /api/v3.2/logs/settings

    Permission: logs.settings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/logs/settings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Setting object list. List of ObjectSetting.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectSetting},
        {ObjectSetting},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Logs | Get Setting List

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read setting list.
    Returns ObjectSetting list
    . Also you will be able to send fields from call object ObjectSetting, which are marked with GET tag, as parameters.

    get 
    /api/v3.1/logs/settings

    Permission: logs.settings:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/logs/settings?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    timezone optional Integer

    GET Filter by offset from UTC (in minutes).

    Default value: 0
    page_size optional Integer

    GET The required number of objects on one page.

    Default value: 20

    Allowed values: 1-1000

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    sort_field optional String

    GET Name of field for object list sorting.
    sort_order optional Integer

    GET Sort order (0 - ascending, 1 - descending).

    Default value: 1
    date_from optional String

    GET Filter by date interval start (Example: "2018-04-12+00:00:00").
    date_to optional String

    GET Filter by date interval end (Example: "2018-05-12+23:59:59").

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    list Object[]

    Setting object list. List of ObjectSetting.

    		 
    HTTP/1.1 200 OK
{
    "cnt": 3,
    "list": [
        {ObjectSetting},
        {ObjectSetting},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conferences

    Conferences | Conference Invite

    Invite participant list to conference.
    To invite participant list to a conference, indicate conference_id in your request.

    post 
    /api/v3.10/conferences/{{$conference_id}}/invite

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/invite?access_token={{$access_token}}'
    --data '{"invitations": [{"id": "user1", "display_name": "User 1"},{"id": "user2", "display_name": "User 2"}]}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    invitations Object[]

    POST Invitation list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    ongoingConferencesLimit ObjectErrorDetail

    Maximum number of ongoing conferences ('%max_limit%') has been reached

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "ongoingConferencesLimit",
                 "message": "Maximum number of ongoing conferences ('%max_limit%') has been reached"
             }
         ]
     }
}

    Conferences | Conference Invite

    Invite participant list to conference.
    To invite participant list to a conference, indicate conference_id in your request.

    post 
    /api/v3.9/conferences/{{$conference_id}}/invite

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/invite?access_token={{$access_token}}'
    --data '{"invitations": [{"id": "user1", "display_name": "User 1"},{"id": "user2", "display_name": "User 2"}]}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    invitations Object[]

    POST Invitation list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    ongoingConferencesLimit ObjectErrorDetail

    Maximum number of ongoing conferences ('%max_limit%') has been reached

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "ongoingConferencesLimit",
                 "message": "Maximum number of ongoing conferences ('%max_limit%') has been reached"
             }
         ]
     }
}

    Conferences | Conference Invite

    Invite participant list to conference.
    To invite participant list to a conference, indicate conference_id in your request.

    post 
    /api/v3.8/conferences/{{$conference_id}}/invite

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/invite?access_token={{$access_token}}'
    --data '{"invitations": [{"id": "user1", "display_name": "User 1"},{"id": "user2", "display_name": "User 2"}]}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    invitations Object[]

    POST Invitation list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    ongoingConferencesLimit ObjectErrorDetail

    Maximum number of ongoing conferences ('%max_limit%') has been reached

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "ongoingConferencesLimit",
                 "message": "Maximum number of ongoing conferences ('%max_limit%') has been reached"
             }
         ]
     }
}

    Conferences | Conference Invite

    Invite participant list to conference.
    To invite participant list to a conference, indicate conference_id in your request.

    post 
    /api/v3.7/conferences/{{$conference_id}}/invite

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/invite?access_token={{$access_token}}'
    --data '{"invitations": [{"id": "user1", "display_name": "User 1"},{"id": "user2", "display_name": "User 2"}]}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    invitations Object[]

    POST Invitation list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    ongoingConferencesLimit ObjectErrorDetail

    Maximum number of ongoing conferences ('%max_limit%') has been reached

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "ongoingConferencesLimit",
                 "message": "Maximum number of ongoing conferences ('%max_limit%') has been reached"
             }
         ]
     }
}

    Conferences | Conference Invite

    Invite participant list to conference.
    To invite participant list to a conference, indicate conference_id in your request.

    post 
    /api/v3.6/conferences/{{$conference_id}}/invite

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/invite?access_token={{$access_token}}'
    --data '{"invitations": [{"id": "user1", "display_name": "User 1"},{"id": "user2", "display_name": "User 2"}]}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    invitations Object[]

    POST Invitation list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    ongoingConferencesLimit ObjectErrorDetail

    Maximum number of ongoing conferences ('%max_limit%') has been reached

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "ongoingConferencesLimit",
                 "message": "Maximum number of ongoing conferences ('%max_limit%') has been reached"
             }
         ]
     }
}

    Conferences | Conference Invite

    Invite participant list to conference.
    To invite participant list to a conference, indicate conference_id in your request.

    post 
    /api/v3.5/conferences/{{$conference_id}}/invite

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/invite?access_token={{$access_token}}'
    --data '{"invitations": [{"id": "user1", "display_name": "User 1"},{"id": "user2", "display_name": "User 2"}]}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    invitations Object[]

    POST Invitation list. They are used to automatically invite to the conferences. List of ObjectInvitationMini.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    ongoingConferencesLimit ObjectErrorDetail

    Maximum number of ongoing conferences ('%max_limit%') has been reached

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "ongoingConferencesLimit",
                 "message": "Maximum number of ongoing conferences ('%max_limit%') has been reached"
             }
         ]
     }
}

    Conferences | Conference Invite

    Invite participant list to conference.
    To invite participant list to a conference, indicate conference_id in your request.

    post 
    /api/v3.4/conferences/{{$conference_id}}/invite

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/invite?access_token={{$access_token}}'
    --data '{"participants": ["user1", "user2", "user3"]}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participants String[]

    POST List of invited participant ids.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    ongoingConferencesLimit ObjectErrorDetail

    Maximum number of ongoing conferences ('%max_limit%') has been reached

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "ongoingConferencesLimit",
                 "message": "Maximum number of ongoing conferences ('%max_limit%') has been reached"
             }
         ]
     }
}

    Conferences | Conference Invite

    Invite participant list to conference.
    To invite participant list to a conference, indicate conference_id in your request.

    post 
    /api/v3.3/conferences/{{$conference_id}}/invite

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/invite?access_token={{$access_token}}'
    --data '{"participants": ["user1", "user2", "user3"]}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participants String[]

    POST List of invited participant ids.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Conference Invite

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Invite participant list to conference.
    To invite participant list to a conference, indicate conference_id in your request.

    post 
    /api/v3.2/conferences/{{$conference_id}}/invite

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/invite?access_token={{$access_token}}'
    --data '{"participants": ["user1", "user2", "user3"]}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participants String[]

    POST List of invited participant ids.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Conference Invite

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Invite participant list to conference.
    To invite participant list to a conference, indicate conference_id in your request.

    post 
    /api/v3.1/conferences/{{$conference_id}}/invite

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/invite?access_token={{$access_token}}'
    --data '{"participants": ["user1", "user2", "user3"]}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participants String[]

    POST List of invited participant ids.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Conference Notify

    Notify all conference participants by email.

    post 
    /api/v3.10/conference/{{$conference_id}}/notify

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/notify?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    result Boolean

    Result of the operation.

    		 
    HTTP/1.1 200 OK
{
    "result": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Conference Notify

    Notify all conference participants by email.

    post 
    /api/v3.9/conference/{{$conference_id}}/notify

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/notify?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    result Boolean

    Result of the operation.

    		 
    HTTP/1.1 200 OK
{
    "result": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Conference Notify

    Notify all conference participants by email.

    post 
    /api/v3.8/conference/{{$conference_id}}/notify

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/notify?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    result Boolean

    Result of the operation.

    		 
    HTTP/1.1 200 OK
{
    "result": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Conference Notify

    Notify all conference participants by email.

    post 
    /api/v3.7/conference/{{$conference_id}}/notify

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/notify?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    result Boolean

    Result of the operation.

    		 
    HTTP/1.1 200 OK
{
    "result": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Conference Notify

    Notify all conference participants by email.

    post 
    /api/v3.6/conference/{{$conference_id}}/notify

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/notify?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    result Boolean

    Result of the operation.

    		 
    HTTP/1.1 200 OK
{
    "result": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Conference Notify

    Notify all conference participants by email.

    post 
    /api/v3.5/conference/{{$conference_id}}/notify

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/notify?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    result Boolean

    Result of the operation.

    		 
    HTTP/1.1 200 OK
{
    "result": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Conference Notify

    Notify all conference participants by email.

    post 
    /api/v3.4/conference/{{$conference_id}}/notify

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/notify?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    result Boolean

    Result of the operation.

    		 
    HTTP/1.1 200 OK
{
    "result": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Conference Notify

    Notify all conference participants by email.

    post 
    /api/v3.3/conference/{{$conference_id}}/notify

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/notify?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    result Boolean

    Result of the operation.

    		 
    HTTP/1.1 200 OK
{
    "result": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Conference Record Pause

    Pause record of the conference.
    To Pause record of the conference., indicate conference_id in your request.

    post 
    /api/v3.10/conferences/{{$conference_id}}/pause-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/pause-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Pause

    Pause record of the conference.
    To Pause record of the conference., indicate conference_id in your request.

    post 
    /api/v3.9/conferences/{{$conference_id}}/pause-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/pause-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Pause

    Pause record of the conference.
    To Pause record of the conference., indicate conference_id in your request.

    post 
    /api/v3.8/conferences/{{$conference_id}}/pause-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/pause-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Pause

    Pause record of the conference.
    To Pause record of the conference., indicate conference_id in your request.

    post 
    /api/v3.7/conferences/{{$conference_id}}/pause-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/pause-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Pause

    Pause record of the conference.
    To Pause record of the conference., indicate conference_id in your request.

    post 
    /api/v3.6/conferences/{{$conference_id}}/pause-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/pause-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Pause

    Pause record of the conference.
    To Pause record of the conference., indicate conference_id in your request.

    post 
    /api/v3.5/conferences/{{$conference_id}}/pause-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/pause-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Pause

    Pause record of the conference.
    To Pause record of the conference., indicate conference_id in your request.

    post 
    /api/v3.4/conferences/{{$conference_id}}/pause-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/pause-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Pause

    Pause record of the conference.
    To Pause record of the conference., indicate conference_id in your request.

    post 
    /api/v3.3/conferences/{{$conference_id}}/pause-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/pause-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Pause

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Pause record of the conference.
    To Pause record of the conference., indicate conference_id in your request.

    post 
    /api/v3.2/conferences/{{$conference_id}}/pause-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/pause-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Pause

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Pause record of the conference.
    To Pause record of the conference., indicate conference_id in your request.

    post 
    /api/v3.1/conferences/{{$conference_id}}/pause-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/pause-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Start

    Start/continue record of the conference.
    To Start/continue record of the conference., indicate conference_id in your request.

    post 
    /api/v3.10/conferences/{{$conference_id}}/start-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/start-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Start

    Start/continue record of the conference.
    To Start/continue record of the conference., indicate conference_id in your request.

    post 
    /api/v3.9/conferences/{{$conference_id}}/start-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/start-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Start

    Start/continue record of the conference.
    To Start/continue record of the conference., indicate conference_id in your request.

    post 
    /api/v3.8/conferences/{{$conference_id}}/start-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/start-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Start

    Start/continue record of the conference.
    To Start/continue record of the conference., indicate conference_id in your request.

    post 
    /api/v3.7/conferences/{{$conference_id}}/start-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/start-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Start

    Start/continue record of the conference.
    To Start/continue record of the conference., indicate conference_id in your request.

    post 
    /api/v3.6/conferences/{{$conference_id}}/start-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/start-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Start

    Start/continue record of the conference.
    To Start/continue record of the conference., indicate conference_id in your request.

    post 
    /api/v3.5/conferences/{{$conference_id}}/start-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/start-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Start

    Start/continue record of the conference.
    To Start/continue record of the conference., indicate conference_id in your request.

    post 
    /api/v3.4/conferences/{{$conference_id}}/start-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/start-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Start

    Start/continue record of the conference.
    To Start/continue record of the conference., indicate conference_id in your request.

    post 
    /api/v3.3/conferences/{{$conference_id}}/start-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/start-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Start

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Start/continue record of the conference.
    To Start/continue record of the conference., indicate conference_id in your request.

    post 
    /api/v3.2/conferences/{{$conference_id}}/start-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/start-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Start

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Start/continue record of the conference.
    To Start/continue record of the conference., indicate conference_id in your request.

    post 
    /api/v3.1/conferences/{{$conference_id}}/start-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/start-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Stop

    Stop record of the conference.
    To Stop record of the conference., indicate conference_id in your request.

    post 
    /api/v3.10/conferences/{{$conference_id}}/stop-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/stop-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Stop

    Stop record of the conference.
    To Stop record of the conference., indicate conference_id in your request.

    post 
    /api/v3.9/conferences/{{$conference_id}}/stop-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/stop-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Stop

    Stop record of the conference.
    To Stop record of the conference., indicate conference_id in your request.

    post 
    /api/v3.8/conferences/{{$conference_id}}/stop-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/stop-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Stop

    Stop record of the conference.
    To Stop record of the conference., indicate conference_id in your request.

    post 
    /api/v3.7/conferences/{{$conference_id}}/stop-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/stop-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Stop

    Stop record of the conference.
    To Stop record of the conference., indicate conference_id in your request.

    post 
    /api/v3.6/conferences/{{$conference_id}}/stop-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/stop-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Stop

    Stop record of the conference.
    To Stop record of the conference., indicate conference_id in your request.

    post 
    /api/v3.5/conferences/{{$conference_id}}/stop-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/stop-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Stop

    Stop record of the conference.
    To Stop record of the conference., indicate conference_id in your request.

    post 
    /api/v3.4/conferences/{{$conference_id}}/stop-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/stop-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Stop

    Stop record of the conference.
    To Stop record of the conference., indicate conference_id in your request.

    post 
    /api/v3.3/conferences/{{$conference_id}}/stop-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/stop-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Stop

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Stop record of the conference.
    To Stop record of the conference., indicate conference_id in your request.

    post 
    /api/v3.2/conferences/{{$conference_id}}/stop-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/stop-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Conference Record Stop

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Stop record of the conference.
    To Stop record of the conference., indicate conference_id in your request.

    post 
    /api/v3.1/conferences/{{$conference_id}}/stop-record

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/stop-record?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 202 Accepted

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceIsNotRunning ObjectErrorDetail

    Conference conference_id is not running.

    Conferences | Create Conference

    Create video conference.
    To create a conference you will need to send an object with attributes ObjectConference, which are marked with POST tag.
    The conference owner must be included in the invitation list. If the conference has been created successfully, you will get full object ObjectConference.

    It is possible to create a conference based on a template by passing the 'template_id' parameter. Maximum number of conferences is limited by your server license.

    post 
    /api/v3.10/conferences

    Permission: conferences | conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.10/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    template_id optional String

    POST Identifier of conference template for new conference creating.

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    conferenceLimit ObjectErrorDetail

    You can't create more conferences, because the server has reached the maximum number of conferences.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    maxGuestsLimitReached ObjectErrorDetail

    Maximum number of guests (%max_guests%) has been reached
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.
    joinOptionsNotAllowedByLicense ObjectErrorDetail

    Join options specified in request are not allowed by license.
    mcuModeUnavailableWhenMulticastIsEnabled ObjectErrorDetail

    MCU mode is unavailable when multicast is enabled.
    joinOptionsNotEditableInMcuMode ObjectErrorDetail

    Join options are not editable when MCU mode is enabled.
    joinOptionsNotAllowedWhenMulticastIsEnabled ObjectErrorDetail

    Join options specified in request are not allowed when multicast is enabled.

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "maxGuestsLimitReached",
                 "message": "Maximum number of guests (%max_guests%) has been reached"
             }
         ]
     }
}

    Conferences | Create Conference

    Create video conference.
    To create a conference you will need to send an object with attributes ObjectConference, which are marked with POST tag.
    The conference owner must be included in the invitation list. If the conference has been created successfully, you will get full object ObjectConference.

    It is possible to create a conference based on a template by passing the 'template_id' parameter. Maximum number of conferences is limited by your server license.

    post 
    /api/v3.9/conferences

    Permission: conferences | conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.9/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    template_id optional String

    POST Identifier of conference template for new conference creating.

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    conferenceLimit ObjectErrorDetail

    You can't create more conferences, because the server has reached the maximum number of conferences.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    maxGuestsLimitReached ObjectErrorDetail

    Maximum number of guests (%max_guests%) has been reached
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "maxGuestsLimitReached",
                 "message": "Maximum number of guests (%max_guests%) has been reached"
             }
         ]
     }
}

    Conferences | Create Conference

    Create video conference.
    To create a conference you will need to send an object with attributes ObjectConference, which are marked with POST tag.
    The conference owner must be included in the invitation list. If the conference has been created successfully, you will get full object ObjectConference.

    It is possible to create a conference based on a template by passing the 'template_id' parameter. Maximum number of conferences is limited by your server license.

    post 
    /api/v3.8/conferences

    Permission: conferences | conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.8/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    template_id optional String

    POST Identifier of conference template for new conference creating.

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    conferenceLimit ObjectErrorDetail

    You can't create more conferences, because the server has reached the maximum number of conferences.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    maxGuestsLimitReached ObjectErrorDetail

    Maximum number of guests (%max_guests%) has been reached
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "maxGuestsLimitReached",
                 "message": "Maximum number of guests (%max_guests%) has been reached"
             }
         ]
     }
}

    Conferences | Create Conference

    Create video conference.
    To create a conference you will need to send an object with attributes ObjectConference, which are marked with POST tag.
    The conference owner must be included in the invitation list. If the conference has been created successfully, you will get full object ObjectConference.

    It is possible to create a conference based on a template by passing the 'template_id' parameter. Maximum number of conferences is limited by your server license.

    post 
    /api/v3.7/conferences

    Permission: conferences | conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.7/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    template_id optional String

    POST Identifier of conference template for new conference creating.

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    conferenceLimit ObjectErrorDetail

    You can't create more conferences, because the server has reached the maximum number of conferences.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    maxGuestsLimitReached ObjectErrorDetail

    Maximum number of guests (%max_guests%) has been reached
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "maxGuestsLimitReached",
                 "message": "Maximum number of guests (%max_guests%) has been reached"
             }
         ]
     }
}

    Conferences | Create Conference

    Create video conference.
    To create a conference you will need to send an object with attributes ObjectConference, which are marked with POST tag.
    The conference owner must be included in the invitation list. If the conference has been created successfully, you will get full object ObjectConference.

    It is possible to create a conference based on a template by passing the 'template_id' parameter. Maximum number of conferences is limited by your server license.

    post 
    /api/v3.6/conferences

    Permission: conferences | conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.6/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    template_id optional String

    POST Identifier of conference template for new conference creating.

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    conferenceLimit ObjectErrorDetail

    You can't create more conferences, because the server has reached the maximum number of conferences.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    maxGuestsLimitReached ObjectErrorDetail

    Maximum number of guests (%max_guests%) has been reached
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "maxGuestsLimitReached",
                 "message": "Maximum number of guests (%max_guests%) has been reached"
             }
         ]
     }
}

    Conferences | Create Conference

    Create video conference.
    To create a conference you will need to send an object with attributes ObjectConference, which are marked with POST tag.
    The conference owner must be included in the invitation list. If the conference has been created successfully, you will get full object ObjectConference.

    It is possible to create a conference based on a template by passing the 'template_id' parameter. Maximum number of conferences is limited by your server license.

    post 
    /api/v3.5/conferences

    Permission: conferences | conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.5/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    template_id optional String

    POST Identifier of conference template for new conference creating.

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    conferenceLimit ObjectErrorDetail

    You can't create more conferences, because the server has reached the maximum number of conferences.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    Conferences | Create Conference

    Create video conference.
    To create a conference you will need to send an object with attributes ObjectConference, which are marked with POST tag.
    The conference owner must be included in the invitation list. If the conference has been created successfully, you will get full object ObjectConference.

    It is possible to create a conference based on a template by passing the 'template_id' parameter. Maximum number of conferences is limited by your server license.

    post 
    /api/v3.4/conferences

    Permission: conferences | conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.4/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    template_id optional String

    POST Identifier of conference template for new conference creating.

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    conferenceLimit ObjectErrorDetail

    You can't create more conferences, because the server has reached the maximum number of conferences.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    Conferences | Create Conference

    Create video conference.
    To create a conference you will need to send an object with attributes ObjectConference, which are marked with POST tag.
    If the conference has been created successfully, you will get full object ObjectConference.

    It is possible to create a conference based on a template by passing the 'template_id' parameter. Maximum number of conferences is limited by your server license.

    post 
    /api/v3.3/conferences

    Permission: conferences | conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.3/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    template_id optional String

    POST Identifier of conference template for new conference creating.

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    conferenceLimit ObjectErrorDetail

    You can't create more conferences, because the server has reached the maximum number of conferences.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    Conferences | Create Conference

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Create video conference.
    To create a conference you will need to send an object with attributes ObjectConference, which are marked with POST tag.
    The conference owner must be included in the invitation list. If the conference has been created successfully, you will get full object ObjectConference.

    It is possible to create a conference based on a template by passing the 'template_id' parameter. Maximum number of conferences is limited by your server license.

    post 
    /api/v3.2/conferences

    Permission: conferences | conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.2/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    template_id optional String

    POST Identifier of conference template for new conference creating.

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    conferenceLimit ObjectErrorDetail

    You can't create more conferences, because the server has reached the maximum number of conferences.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    Conferences | Create Conference

    DEPRECATED Starting from TrueConf Server 5.0.3, this endpoint will return an empty array of conferences. Use version 3.2 of this endpoint (or above).

    Create video conference.
    To create a conference you will need to send an object with attributes ObjectConference, which are marked with POST tag.
    The conference owner must be included in the invitation list. If the conference has been created successfully, you will get full object ObjectConference.

    It is possible to create a conference based on a template by passing the 'template_id' parameter. Maximum number of conferences is limited by your server license.

    post 
    /api/v3.1/conferences

    Permission: conferences | conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.1/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    template_id optional String

    POST Identifier of conference template for new conference creating.

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    conferenceLimit ObjectErrorDetail

    You can't create more conferences, because the server has reached the maximum number of conferences.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    Conferences | Create Conference

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Create video conference.
    To create a conference you will need to send an object with attributes ObjectConference, which are marked with POST tag.
    If the conference has been created successfully, you will get full object ObjectConference.

    Maximum number of conferences is limited by your server license.

    post 
    /api/v3/conferences

    Permission: conferences 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    conferenceLimit ObjectErrorDetail

    You can't create more conferences, because the server has reached the maximum number of conferences.

    Conferences | Delete Conference

    Remove conference.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.10/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference.

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences | Delete Conference

    Remove conference.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.9/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference.

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences | Delete Conference

    Remove conference.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.8/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference.

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences | Delete Conference

    Remove conference.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.7/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference.

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences | Delete Conference

    Remove conference.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.6/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference.

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences | Delete Conference

    Remove conference.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.5/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference.

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences | Delete Conference

    Remove conference.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.4/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference.

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences | Delete Conference

    Remove conference.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.3/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference.

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences | Delete Conference

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Remove conference.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.2/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference.

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences | Delete Conference

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Remove conference.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.1/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference.

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences | Delete Conference

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Remove conference.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3/conferences/{{$conference_id}}

    Permission: conferences 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences | Edit Conference

    Edit conference.
    To edit a conference you will need to send an object with attributes ObjectConference, which are marked with PUT tag.
    Only field "description" can be edited during a conference call. If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.10/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    conferenceFieldUnavailableForChange ObjectErrorDetail

    Conference field unavailable for change during conference call.
    maxGuestsLimitReached ObjectErrorDetail

    Maximum number of guests (%max_guests%) has been reached
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.
    joinOptionsNotAllowedByLicense ObjectErrorDetail

    Join options specified in request are not allowed by license.
    mcuModeUnavailableWhenMulticastIsEnabled ObjectErrorDetail

    MCU mode is unavailable when multicast is enabled.
    joinOptionsNotEditableInMcuMode ObjectErrorDetail

    Join options are not editable when MCU mode is enabled.
    joinOptionsNotAllowedWhenMulticastIsEnabled ObjectErrorDetail

    Join options specified in request are not allowed when multicast is enabled.

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "conferenceFieldUnavailableForChange",
                 "message": "Conference field unavailable for change during conference call."
             }
         ]
     }
}
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "maxGuestsLimitReached",
                 "message": "Maximum number of guests (%max_guests%) has been reached"
             }
         ]
     }
}

    Conferences | Edit Conference

    Edit conference.
    To edit a conference you will need to send an object with attributes ObjectConference, which are marked with PUT tag.
    Only field "description" can be edited during a conference call. If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.9/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    conferenceFieldUnavailableForChange ObjectErrorDetail

    Conference field unavailable for change during conference call.
    maxGuestsLimitReached ObjectErrorDetail

    Maximum number of guests (%max_guests%) has been reached
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "conferenceFieldUnavailableForChange",
                 "message": "Conference field unavailable for change during conference call."
             }
         ]
     }
}
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "maxGuestsLimitReached",
                 "message": "Maximum number of guests (%max_guests%) has been reached"
             }
         ]
     }
}

    Conferences | Edit Conference

    Edit conference.
    To edit a conference you will need to send an object with attributes ObjectConference, which are marked with PUT tag.
    Only field "description" can be edited during a conference call. If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.8/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    conferenceFieldUnavailableForChange ObjectErrorDetail

    Conference field unavailable for change during conference call.
    maxGuestsLimitReached ObjectErrorDetail

    Maximum number of guests (%max_guests%) has been reached
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "conferenceFieldUnavailableForChange",
                 "message": "Conference field unavailable for change during conference call."
             }
         ]
     }
}
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "maxGuestsLimitReached",
                 "message": "Maximum number of guests (%max_guests%) has been reached"
             }
         ]
     }
}

    Conferences | Edit Conference

    Edit conference.
    To edit a conference you will need to send an object with attributes ObjectConference, which are marked with PUT tag.
    Only field "description" can be edited during a conference call. If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.7/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    conferenceFieldUnavailableForChange ObjectErrorDetail

    Conference field unavailable for change during conference call.
    maxGuestsLimitReached ObjectErrorDetail

    Maximum number of guests (%max_guests%) has been reached
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "conferenceFieldUnavailableForChange",
                 "message": "Conference field unavailable for change during conference call."
             }
         ]
     }
}
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "maxGuestsLimitReached",
                 "message": "Maximum number of guests (%max_guests%) has been reached"
             }
         ]
     }
}

    Conferences | Edit Conference

    Edit conference.
    To edit a conference you will need to send an object with attributes ObjectConference, which are marked with PUT tag.
    Only field "description" can be edited during a conference call. If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.6/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    conferenceFieldUnavailableForChange ObjectErrorDetail

    Conference field unavailable for change during conference call.
    maxGuestsLimitReached ObjectErrorDetail

    Maximum number of guests (%max_guests%) has been reached
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "conferenceFieldUnavailableForChange",
                 "message": "Conference field unavailable for change during conference call."
             }
         ]
     }
}
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "maxGuestsLimitReached",
                 "message": "Maximum number of guests (%max_guests%) has been reached"
             }
         ]
     }
}

    Conferences | Edit Conference

    Edit conference.
    To edit a conference you will need to send an object with attributes ObjectConference, which are marked with PUT tag.
    Only field "description" can be edited during a conference call. If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.5/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    conferenceFieldUnavailableForChange ObjectErrorDetail

    Conference field unavailable for change during conference call.
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "conferenceFieldUnavailableForChange",
                 "message": "Conference field unavailable for change during conference call."
             }
         ]
     }
}

    Conferences | Edit Conference

    Edit conference.
    To edit a conference you will need to send an object with attributes ObjectConference, which are marked with PUT tag.
    Only field "description" can be edited during a conference call. If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.4/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceFieldUnavailableForChange ObjectErrorDetail

    Conference field unavailable for change during conference call.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "conferenceFieldUnavailableForChange",
                 "message": "Conference field unavailable for change during conference call."
             }
         ]
     }
}

    Conferences | Edit Conference

    Edit conference.
    To edit a conference you will need to send an object with attributes ObjectConference, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.3/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    Conferences | Edit Conference

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Edit conference.
    To edit a conference you will need to send an object with attributes ObjectConference, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.2/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    Conferences | Edit Conference

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Edit conference.
    To edit a conference you will need to send an object with attributes ObjectConference, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.1/conferences/{{$conference_id}}

    Permission: conferences | conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.
    conferenceMaxInvitationsLimit ObjectErrorDetail

    Conference conference_id invitations maximum (max_participants) reached.
    conferenceOwnerNotInInvitationsList ObjectErrorDetail

    The conference owner must be included in the invitation list.

    Conferences | Edit Conference

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Edit conference.
    To edit a conference you will need to send an object with attributes ObjectConference, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3/conferences/{{$conference_id}}

    Permission: conferences 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3/conferences/{{$conference_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConference.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences | Get Conference Calendars

    Get conference calendars.
    To get a conference calendars, indicate conference_id in your request.

    get 
    /api/v3.10/conferences/{{$conference_id}}/calendars

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/calendars?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    lang optional String

    GET Lang param to generate Web server links.

    Default value: value_from_TCS_installer_settings

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he 

    HTTP/1.1 200 OK
{
    "calendars": {
        "google": "http://www.google.com/calendar/event?action=TEMPLATE&dates=20180613T184800%2F20180613T214800&text=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&details=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.&recur=RRULE%3AFREQ%3DWEEKLY%3BINTERVAL%3D1%3BBYDAY%3D&ctz=Europe%2FMoscow",
        "outlook": "https://outlook.live.com/owa/?path=/calendar/action/compose&rru=addevent&startdt=20180613T154800&enddt=20180613T184800&subject=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&body=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.",
        "other": "https://<host>/api/v3.10/conferences/<conference_id>/ics"
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Calendars

    Get conference calendars.
    To get a conference calendars, indicate conference_id in your request.

    get 
    /api/v3.9/conferences/{{$conference_id}}/calendars

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/calendars?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    lang optional String

    GET Lang param to generate Web server links.

    Default value: value_from_TCS_installer_settings

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he 

    HTTP/1.1 200 OK
{
    "calendars": {
        "google": "http://www.google.com/calendar/event?action=TEMPLATE&dates=20180613T184800%2F20180613T214800&text=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&details=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.&recur=RRULE%3AFREQ%3DWEEKLY%3BINTERVAL%3D1%3BBYDAY%3D&ctz=Europe%2FMoscow",
        "outlook": "https://outlook.live.com/owa/?path=/calendar/action/compose&rru=addevent&startdt=20180613T154800&enddt=20180613T184800&subject=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&body=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.",
        "other": "https://<host>/api/v3.9/conferences/<conference_id>/ics"
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Calendars

    Get conference calendars.
    To get a conference calendars, indicate conference_id in your request.

    get 
    /api/v3.8/conferences/{{$conference_id}}/calendars

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/calendars?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    lang optional String

    GET Lang param to generate Web server links.

    Default value: value_from_TCS_installer_settings

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he 

    HTTP/1.1 200 OK
{
    "calendars": {
        "google": "http://www.google.com/calendar/event?action=TEMPLATE&dates=20180613T184800%2F20180613T214800&text=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&details=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.&recur=RRULE%3AFREQ%3DWEEKLY%3BINTERVAL%3D1%3BBYDAY%3D&ctz=Europe%2FMoscow",
        "outlook": "https://outlook.live.com/owa/?path=/calendar/action/compose&rru=addevent&startdt=20180613T154800&enddt=20180613T184800&subject=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&body=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.",
        "other": "https://<host>/api/v3.8/conferences/<conference_id>/ics"
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Calendars

    Get conference calendars.
    To get a conference calendars, indicate conference_id in your request.

    get 
    /api/v3.7/conferences/{{$conference_id}}/calendars

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/calendars?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    lang optional String

    GET Lang param to generate Web server links.

    Default value: value_from_TCS_installer_settings

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he 

    HTTP/1.1 200 OK
{
    "calendars": {
        "google": "http://www.google.com/calendar/event?action=TEMPLATE&dates=20180613T184800%2F20180613T214800&text=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&details=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.&recur=RRULE%3AFREQ%3DWEEKLY%3BINTERVAL%3D1%3BBYDAY%3D&ctz=Europe%2FMoscow",
        "outlook": "https://outlook.live.com/owa/?path=/calendar/action/compose&rru=addevent&startdt=20180613T154800&enddt=20180613T184800&subject=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&body=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.",
        "other": "https://<host>/api/v3.7/conferences/<conference_id>/ics"
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Calendars

    Get conference calendars.
    To get a conference calendars, indicate conference_id in your request.

    get 
    /api/v3.6/conferences/{{$conference_id}}/calendars

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/calendars?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    lang optional String

    GET Lang param to generate Web server links.

    Default value: value_from_TCS_installer_settings

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he 

    HTTP/1.1 200 OK
{
    "calendars": {
        "google": "http://www.google.com/calendar/event?action=TEMPLATE&dates=20180613T184800%2F20180613T214800&text=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&details=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.&recur=RRULE%3AFREQ%3DWEEKLY%3BINTERVAL%3D1%3BBYDAY%3D&ctz=Europe%2FMoscow",
        "outlook": "https://outlook.live.com/owa/?path=/calendar/action/compose&rru=addevent&startdt=20180613T154800&enddt=20180613T184800&subject=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&body=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.",
        "other": "https://<host>/api/v3.6/conferences/<conference_id>/ics"
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Calendars

    Get conference calendars.
    To get a conference calendars, indicate conference_id in your request.

    get 
    /api/v3.5/conferences/{{$conference_id}}/calendars

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/calendars?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    lang optional String

    GET Lang param to generate Web server links.

    Default value: value_from_TCS_installer_settings

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he 

    HTTP/1.1 200 OK
{
    "calendars": {
        "google": "http://www.google.com/calendar/event?action=TEMPLATE&dates=20180613T184800%2F20180613T214800&text=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&details=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.&recur=RRULE%3AFREQ%3DWEEKLY%3BINTERVAL%3D1%3BBYDAY%3D&ctz=Europe%2FMoscow",
        "outlook": "https://outlook.live.com/owa/?path=/calendar/action/compose&rru=addevent&startdt=20180613T154800&enddt=20180613T184800&subject=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&body=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.",
        "other": "https://<host>/api/v3.5/conferences/<conference_id>/ics"
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Calendars

    Get conference calendars.
    To get a conference calendars, indicate conference_id in your request.

    get 
    /api/v3.4/conferences/{{$conference_id}}/calendars

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/calendars?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    lang optional String

    GET Lang param to generate Web server links.

    Default value: value_from_TCS_installer_settings

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he 

    HTTP/1.1 200 OK
{
    "calendars": {
        "google": "http://www.google.com/calendar/event?action=TEMPLATE&dates=20180613T184800%2F20180613T214800&text=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&details=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.&recur=RRULE%3AFREQ%3DWEEKLY%3BINTERVAL%3D1%3BBYDAY%3D&ctz=Europe%2FMoscow",
        "outlook": "https://outlook.live.com/owa/?path=/calendar/action/compose&rru=addevent&startdt=20180613T154800&enddt=20180613T184800&subject=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&body=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.",
        "other": "https://<host>/api/v3.4/conferences/<conference_id>/ics"
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Calendars

    Get conference calendars.
    To get a conference calendars, indicate conference_id in your request.

    get 
    /api/v3.3/conferences/{{$conference_id}}/calendars

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/calendars?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    lang optional String

    GET Lang param to generate Web server links.

    Default value: value_from_TCS_installer_settings

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he 

    HTTP/1.1 200 OK
{
    "calendars": {
        "google": "http://www.google.com/calendar/event?action=TEMPLATE&dates=20180613T184800%2F20180613T214800&text=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&details=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.&recur=RRULE%3AFREQ%3DWEEKLY%3BINTERVAL%3D1%3BBYDAY%3D&ctz=Europe%2FMoscow",
        "outlook": "https://outlook.live.com/owa/?path=/calendar/action/compose&rru=addevent&startdt=20180613T154800&enddt=20180613T184800&subject=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&body=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.",
        "other": "https://<host>/api/v3.3/conferences/<conference_id>/ics"
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Calendars

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Get conference calendars.
    To get a conference calendars, indicate conference_id in your request.

    get 
    /api/v3.2/conferences/{{$conference_id}}/calendars

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/calendars?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    lang optional String

    GET Lang param to generate Web server links.

    Default value: value_from_TCS_installer_settings

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he 

    HTTP/1.1 200 OK
{
    "calendars": {
        "google": "http://www.google.com/calendar/event?action=TEMPLATE&dates=20180613T184800%2F20180613T214800&text=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&details=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.&recur=RRULE%3AFREQ%3DWEEKLY%3BINTERVAL%3D1%3BBYDAY%3D&ctz=Europe%2FMoscow",
        "outlook": "https://outlook.live.com/owa/?path=/calendar/action/compose&rru=addevent&startdt=20180613T154800&enddt=20180613T184800&subject=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&body=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.",
        "other": "https://<host>/api/v3.2/conferences/<conference_id>/ics"
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Calendars

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Get conference calendars.
    To get a conference calendars, indicate conference_id in your request.

    get 
    /api/v3.1/conferences/{{$conference_id}}/calendars

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/calendars?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    lang optional String

    GET Lang param to generate Web server links.

    Default value: value_from_TCS_installer_settings

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he 

    HTTP/1.1 200 OK
{
    "calendars": {
        "google": "http://www.google.com/calendar/event?action=TEMPLATE&dates=20180613T184800%2F20180613T214800&text=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&details=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.&recur=RRULE%3AFREQ%3DWEEKLY%3BINTERVAL%3D1%3BBYDAY%3D&ctz=Europe%2FMoscow",
        "outlook": "https://outlook.live.com/owa/?path=/calendar/action/compose&rru=addevent&startdt=20180613T154800&enddt=20180613T184800&subject=Video%20conference%20d23d2d23d23d&location=https%3A%2F%2F<host>%2Fc%2F<conference_id>&body=Click%20the%20link%20below%20to%20join%20the%20web%20conference%20at%20the%20specific%20time%20and%20date%3A%0Ahttps%3A%2F%2F<host>%2Fc%2F<conference_id>%0AConference%20is%20hosted%20by%20%22TrueConf%22%20organisation%20video%20conferencing%20service%20powered%20by%20TrueConf%20Server.",
        "other": "https://<host>/api/v3.1/conferences/<conference_id>/ics"
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference ICS

    Get conference ICS-file.
    To get a conference ICS-file, indicate conference_id in your request.

    get 
    /api/v3.10/conferences/{{$conference_id}}/ics

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/ics?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 200 OK


BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//<host>//NONSGML kigkonsult.se iCalcreator 2.24//
CALSCALE:GREGORIAN
METHOD:REQUEST
X-WR-CALNAME:TrueConf
X-WR-CALDESC:Events calendar
X-WR-TIMEZONE:Z
BEGIN:VEVENT
UID:<conference_id>
DTSTAMP:20180607T151812Z
CLASS:PUBLIC
DESCRIPTION:Join the video conference "<conference_name>":
https://<host>/c/<conference_id>
DTSTART:20180613T154800Z
DTEND:20180613T184800Z
PRIORITY:3
SEQUENCE:1528384692
SUMMARY:Video conference 'conference_name'
TRANSP:OPAQUE
BEGIN:VALARM
ACTION:DISPLAY
DESCRIPTION:Join the video conference "conference_name":
https://<host>/c/<conference_id>
TRIGGER:-PT1H0M0S
END:VALARM
END:VEVENT
END:VCALENDAR

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference ICS

    Get conference ICS-file.
    To get a conference ICS-file, indicate conference_id in your request.

    get 
    /api/v3.9/conferences/{{$conference_id}}/ics

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/ics?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 200 OK


BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//<host>//NONSGML kigkonsult.se iCalcreator 2.24//
CALSCALE:GREGORIAN
METHOD:REQUEST
X-WR-CALNAME:TrueConf
X-WR-CALDESC:Events calendar
X-WR-TIMEZONE:Z
BEGIN:VEVENT
UID:<conference_id>
DTSTAMP:20180607T151812Z
CLASS:PUBLIC
DESCRIPTION:Join the video conference "<conference_name>":
https://<host>/c/<conference_id>
DTSTART:20180613T154800Z
DTEND:20180613T184800Z
PRIORITY:3
SEQUENCE:1528384692
SUMMARY:Video conference 'conference_name'
TRANSP:OPAQUE
BEGIN:VALARM
ACTION:DISPLAY
DESCRIPTION:Join the video conference "conference_name":
https://<host>/c/<conference_id>
TRIGGER:-PT1H0M0S
END:VALARM
END:VEVENT
END:VCALENDAR

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference ICS

    Get conference ICS-file.
    To get a conference ICS-file, indicate conference_id in your request.

    get 
    /api/v3.8/conferences/{{$conference_id}}/ics

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/ics?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 200 OK


BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//<host>//NONSGML kigkonsult.se iCalcreator 2.24//
CALSCALE:GREGORIAN
METHOD:REQUEST
X-WR-CALNAME:TrueConf
X-WR-CALDESC:Events calendar
X-WR-TIMEZONE:Z
BEGIN:VEVENT
UID:<conference_id>
DTSTAMP:20180607T151812Z
CLASS:PUBLIC
DESCRIPTION:Join the video conference "<conference_name>":
https://<host>/c/<conference_id>
DTSTART:20180613T154800Z
DTEND:20180613T184800Z
PRIORITY:3
SEQUENCE:1528384692
SUMMARY:Video conference 'conference_name'
TRANSP:OPAQUE
BEGIN:VALARM
ACTION:DISPLAY
DESCRIPTION:Join the video conference "conference_name":
https://<host>/c/<conference_id>
TRIGGER:-PT1H0M0S
END:VALARM
END:VEVENT
END:VCALENDAR

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference ICS

    Get conference ICS-file.
    To get a conference ICS-file, indicate conference_id in your request.

    get 
    /api/v3.7/conferences/{{$conference_id}}/ics

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/ics?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 200 OK


BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//<host>//NONSGML kigkonsult.se iCalcreator 2.24//
CALSCALE:GREGORIAN
METHOD:REQUEST
X-WR-CALNAME:TrueConf
X-WR-CALDESC:Events calendar
X-WR-TIMEZONE:Z
BEGIN:VEVENT
UID:<conference_id>
DTSTAMP:20180607T151812Z
CLASS:PUBLIC
DESCRIPTION:Join the video conference "<conference_name>":
https://<host>/c/<conference_id>
DTSTART:20180613T154800Z
DTEND:20180613T184800Z
PRIORITY:3
SEQUENCE:1528384692
SUMMARY:Video conference 'conference_name'
TRANSP:OPAQUE
BEGIN:VALARM
ACTION:DISPLAY
DESCRIPTION:Join the video conference "conference_name":
https://<host>/c/<conference_id>
TRIGGER:-PT1H0M0S
END:VALARM
END:VEVENT
END:VCALENDAR

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference ICS

    Get conference ICS-file.
    To get a conference ICS-file, indicate conference_id in your request.

    get 
    /api/v3.6/conferences/{{$conference_id}}/ics

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/ics?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 200 OK


BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//<host>//NONSGML kigkonsult.se iCalcreator 2.24//
CALSCALE:GREGORIAN
METHOD:REQUEST
X-WR-CALNAME:TrueConf
X-WR-CALDESC:Events calendar
X-WR-TIMEZONE:Z
BEGIN:VEVENT
UID:<conference_id>
DTSTAMP:20180607T151812Z
CLASS:PUBLIC
DESCRIPTION:Join the video conference "<conference_name>":
https://<host>/c/<conference_id>
DTSTART:20180613T154800Z
DTEND:20180613T184800Z
PRIORITY:3
SEQUENCE:1528384692
SUMMARY:Video conference 'conference_name'
TRANSP:OPAQUE
BEGIN:VALARM
ACTION:DISPLAY
DESCRIPTION:Join the video conference "conference_name":
https://<host>/c/<conference_id>
TRIGGER:-PT1H0M0S
END:VALARM
END:VEVENT
END:VCALENDAR

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference ICS

    Get conference ICS-file.
    To get a conference ICS-file, indicate conference_id in your request.

    get 
    /api/v3.5/conferences/{{$conference_id}}/ics

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/ics?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 200 OK


BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//<host>//NONSGML kigkonsult.se iCalcreator 2.24//
CALSCALE:GREGORIAN
METHOD:REQUEST
X-WR-CALNAME:TrueConf
X-WR-CALDESC:Events calendar
X-WR-TIMEZONE:Z
BEGIN:VEVENT
UID:<conference_id>
DTSTAMP:20180607T151812Z
CLASS:PUBLIC
DESCRIPTION:Join the video conference "<conference_name>":
https://<host>/c/<conference_id>
DTSTART:20180613T154800Z
DTEND:20180613T184800Z
PRIORITY:3
SEQUENCE:1528384692
SUMMARY:Video conference 'conference_name'
TRANSP:OPAQUE
BEGIN:VALARM
ACTION:DISPLAY
DESCRIPTION:Join the video conference "conference_name":
https://<host>/c/<conference_id>
TRIGGER:-PT1H0M0S
END:VALARM
END:VEVENT
END:VCALENDAR

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference ICS

    Get conference ICS-file.
    To get a conference ICS-file, indicate conference_id in your request.

    get 
    /api/v3.5/conferences/{{$conference_id}}/ics

    Permission: conferences | conferences:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/ics?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    lang optional String

    GET Lang param to generate Web server links.

    Default value: value_from_TCS_installer_settings

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he 

    HTTP/1.1 200 OK


BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//<host>//NONSGML kigkonsult.se iCalcreator 2.24//
CALSCALE:GREGORIAN
METHOD:REQUEST
X-WR-CALNAME:TrueConf
X-WR-CALDESC:Events calendar
X-WR-TIMEZONE:Z
BEGIN:VEVENT
UID:<conference_id>
DTSTAMP:20180607T151812Z
CLASS:PUBLIC
DESCRIPTION:Join the video conference "<conference_name>":
https://<host>/c/<conference_id>
DTSTART:20180613T154800Z
DTEND:20180613T184800Z
PRIORITY:3
SEQUENCE:1528384692
SUMMARY:Video conference 'conference_name'
TRANSP:OPAQUE
BEGIN:VALARM
ACTION:DISPLAY
DESCRIPTION:Join the video conference "conference_name":
https://<host>/c/<conference_id>
TRIGGER:-PT1H0M0S
END:VALARM
END:VEVENT
END:VCALENDAR

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference ICS

    Get conference ICS-file.
    To get a conference ICS-file, indicate conference_id in your request.

    get 
    /api/v3.4/conferences/{{$conference_id}}/ics

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/ics?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 200 OK


BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//<host>//NONSGML kigkonsult.se iCalcreator 2.24//
CALSCALE:GREGORIAN
METHOD:REQUEST
X-WR-CALNAME:TrueConf
X-WR-CALDESC:Events calendar
X-WR-TIMEZONE:Z
BEGIN:VEVENT
UID:<conference_id>
DTSTAMP:20180607T151812Z
CLASS:PUBLIC
DESCRIPTION:Join the video conference "<conference_name>":
https://<host>/c/<conference_id>
DTSTART:20180613T154800Z
DTEND:20180613T184800Z
PRIORITY:3
SEQUENCE:1528384692
SUMMARY:Video conference 'conference_name'
TRANSP:OPAQUE
BEGIN:VALARM
ACTION:DISPLAY
DESCRIPTION:Join the video conference "conference_name":
https://<host>/c/<conference_id>
TRIGGER:-PT1H0M0S
END:VALARM
END:VEVENT
END:VCALENDAR

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference ICS

    Get conference ICS-file.
    To get a conference ICS-file, indicate conference_id in your request.

    get 
    /api/v3.3/conferences/{{$conference_id}}/ics

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/ics?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 200 OK


BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//<host>//NONSGML kigkonsult.se iCalcreator 2.24//
CALSCALE:GREGORIAN
METHOD:REQUEST
X-WR-CALNAME:TrueConf
X-WR-CALDESC:Events calendar
X-WR-TIMEZONE:Z
BEGIN:VEVENT
UID:<conference_id>
DTSTAMP:20180607T151812Z
CLASS:PUBLIC
DESCRIPTION:Join the video conference "<conference_name>":
https://<host>/c/<conference_id>
DTSTART:20180613T154800Z
DTEND:20180613T184800Z
PRIORITY:3
SEQUENCE:1528384692
SUMMARY:Video conference 'conference_name'
TRANSP:OPAQUE
BEGIN:VALARM
ACTION:DISPLAY
DESCRIPTION:Join the video conference "conference_name":
https://<host>/c/<conference_id>
TRIGGER:-PT1H0M0S
END:VALARM
END:VEVENT
END:VCALENDAR

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference ICS

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Get conference ICS-file.
    To get a conference ICS-file, indicate conference_id in your request.

    get 
    /api/v3.2/conferences/{{$conference_id}}/ics

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/ics?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 200 OK


BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//<host>//NONSGML kigkonsult.se iCalcreator 2.24//
CALSCALE:GREGORIAN
METHOD:REQUEST
X-WR-CALNAME:TrueConf
X-WR-CALDESC:Events calendar
X-WR-TIMEZONE:Z
BEGIN:VEVENT
UID:<conference_id>
DTSTAMP:20180607T151812Z
CLASS:PUBLIC
DESCRIPTION:Join the video conference "<conference_name>":
https://<host>/c/<conference_id>
DTSTART:20180613T154800Z
DTEND:20180613T184800Z
PRIORITY:3
SEQUENCE:1528384692
SUMMARY:Video conference 'conference_name'
TRANSP:OPAQUE
BEGIN:VALARM
ACTION:DISPLAY
DESCRIPTION:Join the video conference "conference_name":
https://<host>/c/<conference_id>
TRIGGER:-PT1H0M0S
END:VALARM
END:VEVENT
END:VCALENDAR

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference ICS

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Get conference ICS-file.
    To get a conference ICS-file, indicate conference_id in your request.

    get 
    /api/v3.1/conferences/{{$conference_id}}/ics

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/ics?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
    HTTP/1.1 200 OK


BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//<host>//NONSGML kigkonsult.se iCalcreator 2.24//
CALSCALE:GREGORIAN
METHOD:REQUEST
X-WR-CALNAME:TrueConf
X-WR-CALDESC:Events calendar
X-WR-TIMEZONE:Z
BEGIN:VEVENT
UID:<conference_id>
DTSTAMP:20180607T151812Z
CLASS:PUBLIC
DESCRIPTION:Join the video conference "<conference_name>":
https://<host>/c/<conference_id>
DTSTART:20180613T154800Z
DTEND:20180613T184800Z
PRIORITY:3
SEQUENCE:1528384692
SUMMARY:Video conference 'conference_name'
TRANSP:OPAQUE
BEGIN:VALARM
ACTION:DISPLAY
DESCRIPTION:Join the video conference "conference_name":
https://<host>/c/<conference_id>
TRIGGER:-PT1H0M0S
END:VALARM
END:VEVENT
END:VCALENDAR

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference List

    Read conference list.
    Returns ObjectConference list.
    Also you will be able to send fields from call object ObjectConference, which are marked with GET tag, as parameters.

    get 
    /api/v3.10/conferences

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    tag optional String

    GET Tag of required conferences.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    conferences Object[]

    List of ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conferences": [
        {ObjectConference},
        {ObjectConference},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conferences | Get Conference List

    Read conference list.
    Returns ObjectConference list.
    Also you will be able to send fields from call object ObjectConference, which are marked with GET tag, as parameters.

    get 
    /api/v3.9/conferences

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    tag optional String

    GET Tag of required conferences.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    conferences Object[]

    List of ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conferences": [
        {ObjectConference},
        {ObjectConference},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conferences | Get Conference List

    Read conference list.
    Returns ObjectConference list.
    Also you will be able to send fields from call object ObjectConference, which are marked with GET tag, as parameters.

    get 
    /api/v3.8/conferences

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    tag optional String

    GET Tag of required conferences.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    conferences Object[]

    List of ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conferences": [
        {ObjectConference},
        {ObjectConference},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conferences | Get Conference List

    Read conference list.
    Returns ObjectConference list.
    Also you will be able to send fields from call object ObjectConference, which are marked with GET tag, as parameters.

    get 
    /api/v3.7/conferences

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    tag optional String

    GET Tag of required conferences.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    conferences Object[]

    List of ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conferences": [
        {ObjectConference},
        {ObjectConference},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conferences | Get Conference List

    Read conference list.
    Returns ObjectConference list.
    Also you will be able to send fields from call object ObjectConference, which are marked with GET tag, as parameters.

    get 
    /api/v3.6/conferences

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    tag optional String

    GET Tag of required conferences.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    conferences Object[]

    List of ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conferences": [
        {ObjectConference},
        {ObjectConference},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conferences | Get Conference List

    Read conference list.
    Returns ObjectConference list.
    Also you will be able to send fields from call object ObjectConference, which are marked with GET tag, as parameters.

    get 
    /api/v3.5/conferences

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    tag optional String

    GET Tag of required conferences.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    conferences Object[]

    List of ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conferences": [
        {ObjectConference},
        {ObjectConference},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conferences | Get Conference List

    Read conference list.
    Returns ObjectConference list.
    Also you will be able to send fields from call object ObjectConference, which are marked with GET tag, as parameters.

    get 
    /api/v3.4/conferences

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    tag optional String

    GET Tag of required conferences.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    conferences Object[]

    List of ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conferences": [
        {ObjectConference},
        {ObjectConference},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conferences | Get Conference List

    Read conference list.
    Returns ObjectConference list.
    Also you will be able to send fields from call object ObjectConference, which are marked with GET tag, as parameters.

    get 
    /api/v3.3/conferences

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    tag optional String

    GET Tag of required conferences.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    conferences Object[]

    List of ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conferences": [
        {ObjectConference},
        {ObjectConference},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conferences | Get Conference List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read conference list.
    Returns ObjectConference list.
    Also you will be able to send fields from call object ObjectConference, which are marked with GET tag, as parameters.

    get 
    /api/v3.2/conferences

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    tag optional String

    GET Tag of required conferences.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    conferences Object[]

    List of ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conferences": [
        {ObjectConference},
        {ObjectConference},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conferences | Get Conference List

    DEPRECATED Starting from TrueConf Server 5.0.3, this endpoint will return an empty array of conferences. Use version 3.2 of this endpoint (or above).

    Read conference list.
    Returns ObjectConference list.
    Also you will be able to send fields from call object ObjectConference, which are marked with GET tag, as parameters.

    get 
    /api/v3.1/conferences

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    tag optional String

    GET Tag of required conferences.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    conferences Object[]

    List of ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conferences": [
        {ObjectConference},
        {ObjectConference},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conferences | Get Conference List

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Read conference list.
    Returns ObjectConference list

    get 
    /api/v3/conferences

    Permission: conferences 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    cnt Integer

    Count of objects in list.
    conferences Object[]

    List of ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conferences": [
        {ObjectConference},
        {ObjectConference},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conferences | Get Conference Owner

    Get conference owner.
    To get a conference owner, indicate conference_id in your request.

    get 
    /api/v3.10/conferences/{{$conference_id}}/owner

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/owner?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    owner String

    User ID of conference owner.

    		 
    HTTP/1.1 200 OK
{
    "owner": "<user_id>"
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Owner

    Get conference owner.
    To get a conference owner, indicate conference_id in your request.

    get 
    /api/v3.9/conferences/{{$conference_id}}/owner

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/owner?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    owner String

    User ID of conference owner.

    		 
    HTTP/1.1 200 OK
{
    "owner": "<user_id>"
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Owner

    Get conference owner.
    To get a conference owner, indicate conference_id in your request.

    get 
    /api/v3.8/conferences/{{$conference_id}}/owner

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/owner?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    owner String

    User ID of conference owner.

    		 
    HTTP/1.1 200 OK
{
    "owner": "<user_id>"
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Owner

    Get conference owner.
    To get a conference owner, indicate conference_id in your request.

    get 
    /api/v3.7/conferences/{{$conference_id}}/owner

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/owner?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    owner String

    User ID of conference owner.

    		 
    HTTP/1.1 200 OK
{
    "owner": "<user_id>"
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Owner

    Get conference owner.
    To get a conference owner, indicate conference_id in your request.

    get 
    /api/v3.6/conferences/{{$conference_id}}/owner

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/owner?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    owner String

    User ID of conference owner.

    		 
    HTTP/1.1 200 OK
{
    "owner": "<user_id>"
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Owner

    Get conference owner.
    To get a conference owner, indicate conference_id in your request.

    get 
    /api/v3.5/conferences/{{$conference_id}}/owner

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/owner?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    owner String

    User ID of conference owner.

    		 
    HTTP/1.1 200 OK
{
    "owner": "<user_id>"
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Owner

    Get conference owner.
    To get a conference owner, indicate conference_id in your request.

    get 
    /api/v3.4/conferences/{{$conference_id}}/owner

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/owner?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    owner String

    User ID of conference owner.

    		 
    HTTP/1.1 200 OK
{
    "owner": "<user_id>"
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Owner

    Get conference owner.
    To get a conference owner, indicate conference_id in your request.

    get 
    /api/v3.3/conferences/{{$conference_id}}/owner

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/owner?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    owner String

    User ID of conference owner.

    		 
    HTTP/1.1 200 OK
{
    "owner": "<user_id>"
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Owner

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Get conference owner.
    To get a conference owner, indicate conference_id in your request.

    get 
    /api/v3.2/conferences/{{$conference_id}}/owner

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/owner?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    owner String

    User ID of conference owner.

    		 
    HTTP/1.1 200 OK
{
    "owner": "<user_id>"
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference Owner

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Get conference owner.
    To get a conference owner, indicate conference_id in your request.

    get 
    /api/v3.1/conferences/{{$conference_id}}/owner

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/owner?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    owner String

    User ID of conference owner.

    		 
    HTTP/1.1 200 OK
{
    "owner": "<user_id>"
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference

    Read conference.
    Returns ObjectConference.

    get 
    /api/v3.10/conferences/{{$conference_id}}

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference

    Read conference.
    Returns ObjectConference.

    get 
    /api/v3.9/conferences/{{$conference_id}}

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference

    Read conference.
    Returns ObjectConference.

    get 
    /api/v3.8/conferences/{{$conference_id}}

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference

    Read conference.
    Returns ObjectConference.

    get 
    /api/v3.7/conferences/{{$conference_id}}

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference

    Read conference.
    Returns ObjectConference.

    get 
    /api/v3.6/conferences/{{$conference_id}}

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference

    Read conference.
    Returns ObjectConference.

    get 
    /api/v3.5/conferences/{{$conference_id}}

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference

    Read conference.
    Returns ObjectConference.

    get 
    /api/v3.4/conferences/{{$conference_id}}

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference

    Read conference.
    Returns ObjectConference.

    get 
    /api/v3.3/conferences/{{$conference_id}}

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read conference.
    Returns ObjectConference.

    get 
    /api/v3.2/conferences/{{$conference_id}}

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read conference.
    Returns ObjectConference.

    get 
    /api/v3.1/conferences/{{$conference_id}}

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Get Conference

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Read conference.
    Returns ObjectConference

    get 
    /api/v3/conferences/{{$conference_id}}

    Permission: conferences 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/conferences/{{$conference_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    ObjectConference.

    		 
    HTTP/1.1 200 OK
{
    "conference": {ObjectConference}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Run Conference

    Launch conference.
    To launch a conference, indicate conference_id in your request.

    post 
    /api/v3.10/conferences/{{$conference_id}}/run

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/run?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "running", "starting" 

    HTTP/1.1 200 OK
{
    "state": "starting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    ongoingConferencesLimit ObjectErrorDetail

    Maximum number of ongoing conferences ('%max_limit%') has been reached
    conferenceIsFinished ObjectErrorDetail

    The conference is finished.

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "ongoingConferencesLimit",
                 "message": "Maximum number of ongoing conferences ('%max_limit%') has been reached"
             }
         ]
     }
}
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "conferenceIsFinished",
                 "message": "The conference is finished"
             }
         ]
     }
}

    Conferences | Run Conference

    Launch conference.
    To launch a conference, indicate conference_id in your request.

    post 
    /api/v3.9/conferences/{{$conference_id}}/run

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/run?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "running", "starting" 

    HTTP/1.1 200 OK
{
    "state": "starting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    ongoingConferencesLimit ObjectErrorDetail

    Maximum number of ongoing conferences ('%max_limit%') has been reached
    conferenceIsFinished ObjectErrorDetail

    The conference is finished.

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "ongoingConferencesLimit",
                 "message": "Maximum number of ongoing conferences ('%max_limit%') has been reached"
             }
         ]
     }
}
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "conferenceIsFinished",
                 "message": "The conference is finished"
             }
         ]
     }
}

    Conferences | Run Conference

    Launch conference.
    To launch a conference, indicate conference_id in your request.

    post 
    /api/v3.8/conferences/{{$conference_id}}/run

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/run?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "running", "starting" 

    HTTP/1.1 200 OK
{
    "state": "starting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    ongoingConferencesLimit ObjectErrorDetail

    Maximum number of ongoing conferences ('%max_limit%') has been reached

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "ongoingConferencesLimit",
                 "message": "Maximum number of ongoing conferences ('%max_limit%') has been reached"
             }
         ]
     }
}

    Conferences | Run Conference

    Launch conference.
    To launch a conference, indicate conference_id in your request.

    post 
    /api/v3.7/conferences/{{$conference_id}}/run

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/run?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "running", "starting" 

    HTTP/1.1 200 OK
{
    "state": "starting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    ongoingConferencesLimit ObjectErrorDetail

    Maximum number of ongoing conferences ('%max_limit%') has been reached

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "ongoingConferencesLimit",
                 "message": "Maximum number of ongoing conferences ('%max_limit%') has been reached"
             }
         ]
     }
}

    Conferences | Run Conference

    Launch conference.
    To launch a conference, indicate conference_id in your request.

    post 
    /api/v3.6/conferences/{{$conference_id}}/run

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/run?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "running", "starting" 

    HTTP/1.1 200 OK
{
    "state": "starting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    ongoingConferencesLimit ObjectErrorDetail

    Maximum number of ongoing conferences ('%max_limit%') has been reached

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "ongoingConferencesLimit",
                 "message": "Maximum number of ongoing conferences ('%max_limit%') has been reached"
             }
         ]
     }
}

    Conferences | Run Conference

    Launch conference.
    To launch a conference, indicate conference_id in your request.

    post 
    /api/v3.5/conferences/{{$conference_id}}/run

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/run?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "running", "starting" 

    HTTP/1.1 200 OK
{
    "state": "starting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    ongoingConferencesLimit ObjectErrorDetail

    Maximum number of ongoing conferences ('%max_limit%') has been reached

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "ongoingConferencesLimit",
                 "message": "Maximum number of ongoing conferences ('%max_limit%') has been reached"
             }
         ]
     }
}

    Conferences | Run Conference

    Launch conference.
    To launch a conference, indicate conference_id in your request.

    post 
    /api/v3.4/conferences/{{$conference_id}}/run

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/run?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "running", "starting" 

    HTTP/1.1 200 OK
{
    "state": "starting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    ongoingConferencesLimit ObjectErrorDetail

    Maximum number of ongoing conferences ('%max_limit%') has been reached

    		 
    HTTP/1.1 400 Bad Request
{
     "error": {
         "code": 400,
         "message": "Bad Request",
         "errors": [
             {
                 "reason": "ongoingConferencesLimit",
                 "message": "Maximum number of ongoing conferences ('%max_limit%') has been reached"
             }
         ]
     }
}

    Conferences | Run Conference

    Launch conference.
    To launch a conference, indicate conference_id in your request.

    post 
    /api/v3.3/conferences/{{$conference_id}}/run

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/run?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "running", "starting" 

    HTTP/1.1 200 OK
{
    "state": "starting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Run Conference

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Launch conference.
    To launch a conference, indicate conference_id in your request.

    post 
    /api/v3.2/conferences/{{$conference_id}}/run

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/run?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "running", "starting" 

    HTTP/1.1 200 OK
{
    "state": "starting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Run Conference

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Launch conference.
    To launch a conference, indicate conference_id in your request.

    post 
    /api/v3.1/conferences/{{$conference_id}}/run

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/run?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "running", "starting" 

    HTTP/1.1 200 OK
{
    "state": "starting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Run Conference

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Launch conference.
    To launch a conference, indicate conference_id in your request.

    post 
    /api/v3/conferences/{{$conference_id}}/run

    Permission: conferences 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/conferences/{{$conference_id}}/run?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference

    Allowed values: "running", "starting" 

    HTTP/1.1 200 OK
{
    "state": "starting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Share Conference

    Share conference.
    To share a conference, indicate conference_id in your request.

    get 
    /api/v3.10/conferences/{{$conference_id}}/shared

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/shared?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
         HTTP/1.1 200 OK
     {
         "embedded": {
"webrtc": ""<iframe allowfullscreen=\"allowfullscreen\" width=\"720\" height=\"405\" allow=\"microphone; camera; autoplay; display-capture\" src=\"https://<host>/c/<conference_id>\"></iframe>",
"cdn_video": null
},
"rtsp_url": null
     }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Share Conference

    Share conference.
    To share a conference, indicate conference_id in your request.

    get 
    /api/v3.9/conferences/{{$conference_id}}/shared

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/shared?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
         HTTP/1.1 200 OK
     {
         "embedded": {
"webrtc": ""<iframe allowfullscreen=\"allowfullscreen\" width=\"720\" height=\"405\" allow=\"microphone; camera; autoplay; display-capture\" src=\"https://<host>/c/<conference_id>\"></iframe>",
"cdn_video": null
},
"rtsp_url": null
     }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Share Conference

    Share conference.
    To share a conference, indicate conference_id in your request.

    get 
    /api/v3.8/conferences/{{$conference_id}}/shared

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/shared?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
         HTTP/1.1 200 OK
     {
         "embedded": {
"webrtc": ""<iframe allowfullscreen=\"allowfullscreen\" width=\"720\" height=\"405\" allow=\"microphone; camera; autoplay; display-capture\" src=\"https://<host>/c/<conference_id>\"></iframe>",
"cdn_video": null
},
"rtsp_url": null
     }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Share Conference

    Share conference.
    To share a conference, indicate conference_id in your request.

    get 
    /api/v3.7/conferences/{{$conference_id}}/shared

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/shared?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
         HTTP/1.1 200 OK
     {
         "embedded": {
"webrtc": ""<iframe allowfullscreen=\"allowfullscreen\" width=\"720\" height=\"405\" allow=\"microphone; camera; autoplay; display-capture\" src=\"https://<host>/c/<conference_id>\"></iframe>",
"cdn_video": null
},
"rtsp_url": null
     }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Share Conference

    Share conference.
    To share a conference, indicate conference_id in your request.

    get 
    /api/v3.6/conferences/{{$conference_id}}/shared

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/shared?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
         HTTP/1.1 200 OK
     {
         "embedded": {
"webrtc": ""<iframe allowfullscreen=\"allowfullscreen\" width=\"720\" height=\"405\" allow=\"microphone; camera; autoplay; display-capture\" src=\"https://<host>/c/<conference_id>\"></iframe>",
"cdn_video": null
},
"rtsp_url": null
     }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Share Conference

    Share conference.
    To share a conference, indicate conference_id in your request.

    get 
    /api/v3.5/conferences/{{$conference_id}}/shared

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/shared?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
         HTTP/1.1 200 OK
     {
         "embedded": {
"webrtc": ""<iframe allowfullscreen=\"allowfullscreen\" width=\"720\" height=\"405\" allow=\"microphone; camera; autoplay; display-capture\" src=\"https://<host>/c/<conference_id>\"></iframe>",
"cdn_video": null
},
"rtsp_url": null
     }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Share Conference

    Share conference.
    To share a conference, indicate conference_id in your request.

    get 
    /api/v3.4/conferences/{{$conference_id}}/shared

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/shared?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
         HTTP/1.1 200 OK
     {
         "embedded": {
"webrtc": ""<iframe allowfullscreen=\"allowfullscreen\" width=\"720\" height=\"405\" allow=\"microphone; camera; autoplay; display-capture\" src=\"https://<host>/c/<conference_id>\"></iframe>",
"cdn_video": null
},
"rtsp_url": null
     }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Share Conference

    Share conference.
    To share a conference, indicate conference_id in your request.

    get 
    /api/v3.3/conferences/{{$conference_id}}/shared

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/shared?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
         HTTP/1.1 200 OK
     {
         "embedded": {
"webrtc": ""<iframe allowfullscreen=\"allowfullscreen\" width=\"720\" height=\"405\" allow=\"microphone; camera; autoplay; display-capture\" src=\"https://<host>/c/<conference_id>\"></iframe>",
"cdn_video": null
},
"rtsp_url": null
     }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Share Conference

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Share conference.
    To share a conference, indicate conference_id in your request.

    get 
    /api/v3.2/conferences/{{$conference_id}}/shared

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/shared?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
         HTTP/1.1 200 OK
     {
         "embedded": {
"webrtc": ""<iframe allowfullscreen=\"allowfullscreen\" width=\"720\" height=\"405\" allow=\"microphone; camera; autoplay; display-capture\" src=\"https://<host>/c/<conference_id>\"></iframe>",
"cdn_video": null
},
"rtsp_url": null
     }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Share Conference

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Share conference.
    To share a conference, indicate conference_id in your request.

    get 
    /api/v3.1/conferences/{{$conference_id}}/shared

    Permission: conferences | conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/shared?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    		 
         HTTP/1.1 200 OK
     {
         "embedded": {
"webrtc": ""<iframe allowfullscreen=\"allowfullscreen\" width=\"720\" height=\"405\" allow=\"microphone; camera; autoplay; display-capture\" src=\"https://<host>/c/<conference_id>\"></iframe>",
"cdn_video": null
},
"rtsp_url": null
     }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Stop Conference

    Stops conference.
    To stop a conference, indicate conference_id in your request.

    post 
    /api/v3.10/conferences/{{$conference_id}}/stop

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/stop?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "stopping", "stopped" 

    HTTP/1.1 200 OK
{
    "state": "stopping",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Stop Conference

    Stops conference.
    To stop a conference, indicate conference_id in your request.

    post 
    /api/v3.9/conferences/{{$conference_id}}/stop

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/stop?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "stopping", "stopped" 

    HTTP/1.1 200 OK
{
    "state": "stopping",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Stop Conference

    Stops conference.
    To stop a conference, indicate conference_id in your request.

    post 
    /api/v3.8/conferences/{{$conference_id}}/stop

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/stop?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "stopping", "stopped" 

    HTTP/1.1 200 OK
{
    "state": "stopping",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Stop Conference

    Stops conference.
    To stop a conference, indicate conference_id in your request.

    post 
    /api/v3.7/conferences/{{$conference_id}}/stop

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/stop?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "stopping", "stopped" 

    HTTP/1.1 200 OK
{
    "state": "stopping",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Stop Conference

    Stops conference.
    To stop a conference, indicate conference_id in your request.

    post 
    /api/v3.6/conferences/{{$conference_id}}/stop

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/stop?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "stopping", "stopped" 

    HTTP/1.1 200 OK
{
    "state": "stopping",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Stop Conference

    Stops conference.
    To stop a conference, indicate conference_id in your request.

    post 
    /api/v3.5/conferences/{{$conference_id}}/stop

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/stop?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "stopping", "stopped" 

    HTTP/1.1 200 OK
{
    "state": "stopping",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Stop Conference

    Stops conference.
    To stop a conference, indicate conference_id in your request.

    post 
    /api/v3.4/conferences/{{$conference_id}}/stop

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/stop?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "stopping", "stopped" 

    HTTP/1.1 200 OK
{
    "state": "stopping",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Stop Conference

    Stops conference.
    To stop a conference, indicate conference_id in your request.

    post 
    /api/v3.3/conferences/{{$conference_id}}/stop

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/stop?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "stopping", "stopped" 

    HTTP/1.1 200 OK
{
    "state": "stopping",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Stop Conference

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Stops conference.
    To stop a conference, indicate conference_id in your request.

    post 
    /api/v3.2/conferences/{{$conference_id}}/stop

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/stop?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "stopping", "stopped" 

    HTTP/1.1 200 OK
{
    "state": "stopping",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Stop Conference

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Stops conference.
    To stop a conference, indicate conference_id in your request.

    post 
    /api/v3.1/conferences/{{$conference_id}}/stop

    Permission: conferences | conferences:write 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/stop?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference.

    Allowed values: "stopping", "stopped" 

    HTTP/1.1 200 OK
{
    "state": "stopping",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences | Stop Conference

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Stops conference.
    To stop a conference, indicate conference_id in your request.

    post 
    /api/v3/conferences/{{$conference_id}}/stop

    Permission: conferences 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/conferences/{{$conference_id}}/stop?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of conference

    Allowed values: "stopping", "stopped" 

    HTTP/1.1 200 OK
{
    "state": "stopping",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    serviceUnavailable ObjectErrorDetail

    Service Unavailable
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Users

    Users | Create Avatar

    Create User Avatar.

    post 
    /api/v3.10/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.10/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: multipart/form-data' \
    --form "image=@/path/to/image"

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Create Avatar

    Create User Avatar.

    post 
    /api/v3.9/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.9/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: multipart/form-data' \
    --form "image=@/path/to/image"

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Create Avatar

    Create User Avatar.

    post 
    /api/v3.8/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.8/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: multipart/form-data' \
    --form "image=@/path/to/image"

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Create Avatar

    Create User Avatar.

    post 
    /api/v3.7/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.7/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: multipart/form-data' \
    --form "image=@/path/to/image"

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Create Avatar

    Create User Avatar.

    post 
    /api/v3.6/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.6/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: multipart/form-data' \
    --form "image=@/path/to/image"

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Create Avatar

    Create User Avatar.

    post 
    /api/v3.5/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.5/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: multipart/form-data' \
    --form "image=@/path/to/image"

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Create Avatar

    Create User Avatar.

    post 
    /api/v3.4/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.4/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: multipart/form-data' \
    --form "image=@/path/to/image"

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Create Avatar

    Create User Avatar.

    post 
    /api/v3.3/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.3/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: multipart/form-data' \
    --form "image=@/path/to/image"

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Create Avatar

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Create User Avatar.

    post 
    /api/v3.2/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.2/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: multipart/form-data' \
    --form "image=@/path/to/image"

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Create User

    Create user.
    To create a user you will need to send an object with attributes ObjectUser, which are marked with POST tag.
    If the user has been successfully created, you'll get full object ObjectUser.

    The maximum number of users is limited by the server license.

    post 
    /api/v3.10/users

    Permission: users | users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.10/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    maxUsers ObjectErrorDetail

    The server has reached the maximum number of users.

    Users | Create User

    Create user.
    To create a user you will need to send an object with attributes ObjectUser, which are marked with POST tag.
    If the user has been successfully created, you'll get full object ObjectUser.

    The maximum number of users is limited by the server license.

    post 
    /api/v3.9/users

    Permission: users | users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.9/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    maxUsers ObjectErrorDetail

    The server has reached the maximum number of users.

    Users | Create User

    Create user.
    To create a user you will need to send an object with attributes ObjectUser, which are marked with POST tag.
    If the user has been successfully created, you'll get full object ObjectUser.

    The maximum number of users is limited by the server license.

    post 
    /api/v3.8/users

    Permission: users | users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.8/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    maxUsers ObjectErrorDetail

    The server has reached the maximum number of users.

    Users | Create User

    Create user.
    To create a user you will need to send an object with attributes ObjectUser, which are marked with POST tag.
    If the user has been successfully created, you'll get full object ObjectUser.

    The maximum number of users is limited by the server license.

    post 
    /api/v3.7/users

    Permission: users | users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.7/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    maxUsers ObjectErrorDetail

    The server has reached the maximum number of users.

    Users | Create User

    Create user.
    To create a user you will need to send an object with attributes ObjectUser, which are marked with POST tag.
    If the user has been successfully created, you'll get full object ObjectUser.

    The maximum number of users is limited by the server license.

    post 
    /api/v3.6/users

    Permission: users | users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.6/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    maxUsers ObjectErrorDetail

    The server has reached the maximum number of users.

    Users | Create User

    Create user.
    To create a user you will need to send an object with attributes ObjectUser, which are marked with POST tag.
    If the user has been successfully created, you'll get full object ObjectUser.

    The maximum number of users is limited by the server license.

    post 
    /api/v3.5/users

    Permission: users | users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.5/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    maxUsers ObjectErrorDetail

    The server has reached the maximum number of users.

    Users | Create User

    Create user.
    To create a user you will need to send an object with attributes ObjectUser, which are marked with POST tag.
    If the user has been successfully created, you'll get full object ObjectUser.

    The maximum number of users is limited by the server license.

    post 
    /api/v3.4/users

    Permission: users | users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.4/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    maxUsers ObjectErrorDetail

    The server has reached the maximum number of users.

    Users | Create User

    Create user.
    To create a user you will need to send an object with attributes ObjectUser, which are marked with POST tag.
    If the user has been successfully created, you'll get full object ObjectUser.

    The maximum number of users is limited by the server license.

    post 
    /api/v3.3/users

    Permission: users | users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.3/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    maxUsers ObjectErrorDetail

    The server has reached the maximum number of users.

    Users | Create User

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Create user.
    To create a user you will need to send an object with attributes ObjectUser, which are marked with POST tag.
    If the user has been successfully created, you'll get full object ObjectUser.

    The maximum number of users is limited by the server license.

    post 
    /api/v3.2/users

    Permission: users | users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.2/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    maxUsers ObjectErrorDetail

    The server has reached the maximum number of users.

    Users | Create User

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Create user.
    To create a user you will need to send an object with attributes ObjectUser, which are marked with POST tag.
    If the user has been successfully created, you'll get full object ObjectUser.

    The maximum number of users is limited by the server license.

    post 
    /api/v3.1/users

    Permission: users | users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.1/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    maxUsers ObjectErrorDetail

    The server has reached the maximum number of users.

    Users | Create User

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Create user.
    To create a user you will need to send an object with attributes ObjectUser, which are marked with POST tag.
    If the user has been successfully created, you'll get full object ObjectUser.

    The maximum number of users is limited by the server license.

    post 
    /api/v3/users

    Permission: users 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    maxUsers ObjectErrorDetail

    The server has reached the maximum number of users.

    Users | Delete Avatar

    Delete User Avatar.

    delete 
    /api/v3.10/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request DELETE \
    --url 'https://{{$server_name}}/api/v3.10/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'
    HTTP/1.1 200 OK
{
    "avatar": null
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Delete Avatar

    Delete User Avatar.

    delete 
    /api/v3.9/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request DELETE \
    --url 'https://{{$server_name}}/api/v3.9/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'
    HTTP/1.1 200 OK
{
    "avatar": null
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Delete Avatar

    Delete User Avatar.

    delete 
    /api/v3.8/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request DELETE \
    --url 'https://{{$server_name}}/api/v3.8/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'
    HTTP/1.1 200 OK
{
    "avatar": null
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Delete Avatar

    Delete User Avatar.

    delete 
    /api/v3.7/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request DELETE \
    --url 'https://{{$server_name}}/api/v3.7/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'
    HTTP/1.1 200 OK
{
    "avatar": null
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Delete Avatar

    Delete User Avatar.

    delete 
    /api/v3.6/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request DELETE \
    --url 'https://{{$server_name}}/api/v3.6/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'
    HTTP/1.1 200 OK
{
    "avatar": null
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Delete Avatar

    Delete User Avatar.

    delete 
    /api/v3.5/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request DELETE \
    --url 'https://{{$server_name}}/api/v3.5/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'
    HTTP/1.1 200 OK
{
    "avatar": null
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Delete Avatar

    Delete User Avatar.

    delete 
    /api/v3.4/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request DELETE \
    --url 'https://{{$server_name}}/api/v3.4/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'
    HTTP/1.1 200 OK
{
    "avatar": null
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Delete Avatar

    Delete User Avatar.

    delete 
    /api/v3.3/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request DELETE \
    --url 'https://{{$server_name}}/api/v3.3/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'
    HTTP/1.1 200 OK
{
    "avatar": null
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Delete Avatar

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Delete User Avatar.

    delete 
    /api/v3.2/users/{{$user_id}}/avatar

    Permission: users.avatar:write 

    curl --request DELETE \
    --url 'https://{{$server_name}}/api/v3.2/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'
    HTTP/1.1 200 OK
{
    "avatar": null
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Delete User

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    delete 
    /api/v3.10/users/{{$user_id}}

    Permission: users | users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Delete User

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    delete 
    /api/v3.9/users/{{$user_id}}

    Permission: users | users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Delete User

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    delete 
    /api/v3.8/users/{{$user_id}}

    Permission: users | users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Delete User

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    delete 
    /api/v3.7/users/{{$user_id}}

    Permission: users | users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Delete User

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    delete 
    /api/v3.6/users/{{$user_id}}

    Permission: users | users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Delete User

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    delete 
    /api/v3.5/users/{{$user_id}}

    Permission: users | users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Delete User

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    delete 
    /api/v3.4/users/{{$user_id}}

    Permission: users | users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Delete User

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    delete 
    /api/v3.3/users/{{$user_id}}

    Permission: users | users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Delete User

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    delete 
    /api/v3.2/users/{{$user_id}}

    Permission: users | users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Delete User

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    delete 
    /api/v3.1/users/{{$user_id}}

    Permission: users | users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Delete User

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    delete 
    /api/v3/users/{{$user_id}}

    Permission: users 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6d7",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Disconnect User

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    post 
    /api/v3.10/users/{{$user_id}}/disconnect

    Permission: users | (users:read & users:write) 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/users/{{$user_id}}/disconnect?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of user connection

    Allowed values: "disconnecting", "disconnected" 

    HTTP/1.1 200 OK
{
    "state": "disconnecting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Disconnect User

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    post 
    /api/v3.9/users/{{$user_id}}/disconnect

    Permission: users | (users:read & users:write) 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/users/{{$user_id}}/disconnect?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of user connection

    Allowed values: "disconnecting", "disconnected" 

    HTTP/1.1 200 OK
{
    "state": "disconnecting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Disconnect User

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    post 
    /api/v3.8/users/{{$user_id}}/disconnect

    Permission: users | (users:read & users:write) 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/users/{{$user_id}}/disconnect?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of user connection

    Allowed values: "disconnecting", "disconnected" 

    HTTP/1.1 200 OK
{
    "state": "disconnecting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Disconnect User

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    post 
    /api/v3.7/users/{{$user_id}}/disconnect

    Permission: users | (users:read & users:write) 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/users/{{$user_id}}/disconnect?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of user connection

    Allowed values: "disconnecting", "disconnected" 

    HTTP/1.1 200 OK
{
    "state": "disconnecting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Disconnect User

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    post 
    /api/v3.6/users/{{$user_id}}/disconnect

    Permission: users | (users:read & users:write) 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/users/{{$user_id}}/disconnect?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of user connection

    Allowed values: "disconnecting", "disconnected" 

    HTTP/1.1 200 OK
{
    "state": "disconnecting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Disconnect User

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    post 
    /api/v3.5/users/{{$user_id}}/disconnect

    Permission: users | (users:read & users:write) 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/users/{{$user_id}}/disconnect?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of user connection

    Allowed values: "disconnecting", "disconnected" 

    HTTP/1.1 200 OK
{
    "state": "disconnecting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Disconnect User

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    post 
    /api/v3.4/users/{{$user_id}}/disconnect

    Permission: users | (users:read & users:write) 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/users/{{$user_id}}/disconnect?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of user connection

    Allowed values: "disconnecting", "disconnected" 

    HTTP/1.1 200 OK
{
    "state": "disconnecting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Disconnect User

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    post 
    /api/v3.3/users/{{$user_id}}/disconnect

    Permission: users | (users:read & users:write) 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/users/{{$user_id}}/disconnect?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of user connection

    Allowed values: "disconnecting", "disconnected" 

    HTTP/1.1 200 OK
{
    "state": "disconnecting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Disconnect User

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    post 
    /api/v3.2/users/{{$user_id}}/disconnect

    Permission: users | (users:read & users:write) 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/users/{{$user_id}}/disconnect?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of user connection

    Allowed values: "disconnecting", "disconnected" 

    HTTP/1.1 200 OK
{
    "state": "disconnecting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Disconnect User

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Remove user.
    If the user has been removed successfully, you'll get object ID.

    post 
    /api/v3.1/users/{{$user_id}}/disconnect

    Permission: users | (users:read & users:write) 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/users/{{$user_id}}/disconnect?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    state String

    state of user connection

    Allowed values: "disconnecting", "disconnected" 

    HTTP/1.1 200 OK
{
    "state": "disconnecting",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Edit User

    Edit user.
    To edit a contact you will need to send an object with attributes ObjectUser, which are marked with PUT tag.
    If the contact has been edited successfully, you'll get full object ObjectUser.

    put 
    /api/v3.10/users/{{$user_id}}

    Permission: users | users:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.10/users/{{$user_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Edit User

    Edit user.
    To edit a contact you will need to send an object with attributes ObjectUser, which are marked with PUT tag.
    If the contact has been edited successfully, you'll get full object ObjectUser.

    put 
    /api/v3.9/users/{{$user_id}}

    Permission: users | users:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.9/users/{{$user_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Edit User

    Edit user.
    To edit a contact you will need to send an object with attributes ObjectUser, which are marked with PUT tag.
    If the contact has been edited successfully, you'll get full object ObjectUser.

    put 
    /api/v3.8/users/{{$user_id}}

    Permission: users | users:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.8/users/{{$user_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Edit User

    Edit user.
    To edit a contact you will need to send an object with attributes ObjectUser, which are marked with PUT tag.
    If the contact has been edited successfully, you'll get full object ObjectUser.

    put 
    /api/v3.7/users/{{$user_id}}

    Permission: users | users:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.7/users/{{$user_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Edit User

    Edit user.
    To edit a contact you will need to send an object with attributes ObjectUser, which are marked with PUT tag.
    If the contact has been edited successfully, you'll get full object ObjectUser.

    put 
    /api/v3.6/users/{{$user_id}}

    Permission: users | users:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.6/users/{{$user_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Edit User

    Edit user.
    To edit a contact you will need to send an object with attributes ObjectUser, which are marked with PUT tag.
    If the contact has been edited successfully, you'll get full object ObjectUser.

    put 
    /api/v3.5/users/{{$user_id}}

    Permission: users | users:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.5/users/{{$user_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Edit User

    Edit user.
    To edit a contact you will need to send an object with attributes ObjectUser, which are marked with PUT tag.
    If the contact has been edited successfully, you'll get full object ObjectUser.

    put 
    /api/v3.4/users/{{$user_id}}

    Permission: users | users:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.4/users/{{$user_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Edit User

    Edit user.
    To edit a contact you will need to send an object with attributes ObjectUser, which are marked with PUT tag.
    If the contact has been edited successfully, you'll get full object ObjectUser.

    put 
    /api/v3.3/users/{{$user_id}}

    Permission: users | users:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.3/users/{{$user_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Edit User

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Edit user.
    To edit a contact you will need to send an object with attributes ObjectUser, which are marked with PUT tag.
    If the contact has been edited successfully, you'll get full object ObjectUser.

    put 
    /api/v3.2/users/{{$user_id}}

    Permission: users | users:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.2/users/{{$user_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Edit User

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Edit user.
    To edit a contact you will need to send an object with attributes ObjectUser, which are marked with PUT tag.
    If the contact has been edited successfully, you'll get full object ObjectUser.

    put 
    /api/v3.1/users/{{$user_id}}

    Permission: users | users:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.1/users/{{$user_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Edit User

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Edit user.
    To edit a contact you will need to send an object with attributes ObjectUser, which are marked with PUT tag.
    If the contact has been edited successfully, you'll get full object ObjectUser.

    put 
    /api/v3/users/{{$user_id}}

    Permission: users 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3/users/{{$user_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectUser.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get Avatar

    Get User Avatar.

    get 
    /api/v3.10/users/{{$user_id}}/avatar

    Permission: users.avatar:read 

    curl --request GET \
    --url 'https://{{$server_name}}/api/v3.10/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar|null}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get Avatar

    Get User Avatar.

    get 
    /api/v3.9/users/{{$user_id}}/avatar

    Permission: users.avatar:read 

    curl --request GET \
    --url 'https://{{$server_name}}/api/v3.9/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar|null}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get Avatar

    Get User Avatar.

    get 
    /api/v3.8/users/{{$user_id}}/avatar

    Permission: users.avatar:read 

    curl --request GET \
    --url 'https://{{$server_name}}/api/v3.8/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar|null}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get Avatar

    Get User Avatar.

    get 
    /api/v3.7/users/{{$user_id}}/avatar

    Permission: users.avatar:read 

    curl --request GET \
    --url 'https://{{$server_name}}/api/v3.7/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar|null}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get Avatar

    Get User Avatar.

    get 
    /api/v3.6/users/{{$user_id}}/avatar

    Permission: users.avatar:read 

    curl --request GET \
    --url 'https://{{$server_name}}/api/v3.6/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar|null}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get Avatar

    Get User Avatar.

    get 
    /api/v3.5/users/{{$user_id}}/avatar

    Permission: users.avatar:read 

    curl --request GET \
    --url 'https://{{$server_name}}/api/v3.5/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar|null}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get Avatar

    Get User Avatar.

    get 
    /api/v3.4/users/{{$user_id}}/avatar

    Permission: users.avatar:read 

    curl --request GET \
    --url 'https://{{$server_name}}/api/v3.4/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar|null}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Get Avatar

    Get User Avatar.

    get 
    /api/v3.3/users/{{$user_id}}/avatar

    Permission: users.avatar:read 

    curl --request GET \
    --url 'https://{{$server_name}}/api/v3.3/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar|null}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Get Avatar

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Get User Avatar.

    get 
    /api/v3.2/users/{{$user_id}}/avatar

    Permission: users.avatar:read 

    curl --request GET \
    --url 'https://{{$server_name}}/api/v3.2/users/{{$user_id}}/avatar?access_token={{$access_token}}' \
    --header 'content-type: application/json'

    Success 200

    Field Type Description
    User Object

    Avatar ObjectAvatar.

    		 
    HTTP/1.1 200 OK
{
    "avatar": {ObjectAvatar|null}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Get User List

    Read user list.
    Returns ObjectUser list.

    get 
    /api/v3.10/users

    Permission: users | users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Get User List

    Read user list.
    Returns ObjectUser list.

    get 
    /api/v3.9/users

    Permission: users | users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Get User List

    Read user list.
    Returns ObjectUser list.

    get 
    /api/v3.8/users

    Permission: users | users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Get User List

    Read user list.
    Returns ObjectUser list.

    get 
    /api/v3.7/users

    Permission: users | users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Get User List

    Read user list.
    Returns ObjectUser list.

    get 
    /api/v3.6/users

    Permission: users | users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Get User List

    Read user list.
    Returns ObjectUser list.

    get 
    /api/v3.5/users

    Permission: users | users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Get User List

    Read user list.
    Returns ObjectUser list.

    get 
    /api/v3.4/users

    Permission: users | users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Get User List

    Read user list.
    Returns ObjectUser list.

    get 
    /api/v3.3/users

    Permission: users | users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Get User List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read user list.
    Returns ObjectUser list.

    get 
    /api/v3.2/users

    Permission: users | users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Get User List

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read user list.
    Returns ObjectUser list.

    get 
    /api/v3.1/users

    Permission: users | users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Get User List

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Read user list.
    Returns ObjectUser list

    get 
    /api/v3/users

    Permission: users 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users | Get User

    Read user.
    Returns ObjectUser.

    get 
    /api/v3.10/users/{{$user_id}}

    Permission: users | users:write 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get User

    Read user.
    Returns ObjectUser.

    get 
    /api/v3.9/users/{{$user_id}}

    Permission: users | users:write 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get User

    Read user.
    Returns ObjectUser.

    get 
    /api/v3.8/users/{{$user_id}}

    Permission: users | users:write 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get User

    Read user.
    Returns ObjectUser.

    get 
    /api/v3.7/users/{{$user_id}}

    Permission: users | users:write 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get User

    Read user.
    Returns ObjectUser.

    get 
    /api/v3.6/users/{{$user_id}}

    Permission: users | users:write 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get User

    Read user.
    Returns ObjectUser.

    get 
    /api/v3.5/users/{{$user_id}}

    Permission: users | users:write 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get User

    Read user.
    Returns ObjectUser.

    get 
    /api/v3.4/users/{{$user_id}}

    Permission: users | users:write 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get User

    Read user.
    Returns ObjectUser.

    get 
    /api/v3.3/users/{{$user_id}}

    Permission: users | users:write 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get User

    DEPRECATED Use version 3.3 of this endpoint (or above). Returns ObjectUser.

    Read user.

    get 
    /api/v3.2/users/{{$user_id}}

    Permission: users | users:write 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get User

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read user.
    Returns ObjectUser.

    get 
    /api/v3.1/users/{{$user_id}}

    Permission: users | users:write 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users | Get User

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Read user.
    Returns ObjectUser

    get 
    /api/v3/users/{{$user_id}}

    Permission: users 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups

    Groups | Create Group

    Create a group.
    To create a group you will need to send an object with attributes ObjectGroup, which are marked with POST tag.
    If the group has been successfully created, you will get full object ObjectGroup.

    post 
    /api/v3.10/groups

    Permission: groups | groups:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.10/groups?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Create Group

    Create a group.
    To create a group you will need to send an object with attributes ObjectGroup, which are marked with POST tag.
    If the group has been successfully created, you will get full object ObjectGroup.

    post 
    /api/v3.9/groups

    Permission: groups | groups:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.9/groups?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Create Group

    Create a group.
    To create a group you will need to send an object with attributes ObjectGroup, which are marked with POST tag.
    If the group has been successfully created, you will get full object ObjectGroup.

    post 
    /api/v3.8/groups

    Permission: groups | groups:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.8/groups?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Create Group

    Create a group.
    To create a group you will need to send an object with attributes ObjectGroup, which are marked with POST tag.
    If the group has been successfully created, you will get full object ObjectGroup.

    post 
    /api/v3.7/groups

    Permission: groups | groups:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.7/groups?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Create Group

    Create a group.
    To create a group you will need to send an object with attributes ObjectGroup, which are marked with POST tag.
    If the group has been successfully created, you will get full object ObjectGroup.

    post 
    /api/v3.6/groups

    Permission: groups | groups:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.6/groups?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Create Group

    Create a group.
    To create a group you will need to send an object with attributes ObjectGroup, which are marked with POST tag.
    If the group has been successfully created, you will get full object ObjectGroup.

    post 
    /api/v3.5/groups

    Permission: groups | groups:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.5/groups?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Create Group

    Create a group.
    To create a group you will need to send an object with attributes ObjectGroup, which are marked with POST tag.
    If the group has been successfully created, you will get full object ObjectGroup.

    post 
    /api/v3.4/groups

    Permission: groups | groups:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.4/groups?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Create Group

    Create a group.
    To create a group you will need to send an object with attributes ObjectGroup, which are marked with POST tag.
    If the group has been successfully created, you will get full object ObjectGroup.

    post 
    /api/v3.3/groups

    Permission: groups | groups:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.3/groups?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Create Group

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Create a group.
    To create a group you will need to send an object with attributes ObjectGroup, which are marked with POST tag.
    If the group has been successfully created, you will get full object ObjectGroup.

    post 
    /api/v3.2/groups

    Permission: groups | groups:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.2/groups?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Create Group

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Create a group.
    To create a group you will need to send an object with attributes ObjectGroup, which are marked with POST tag.
    If the group has been successfully created, you will get full object ObjectGroup.

    post 
    /api/v3.1/groups

    Permission: groups | groups:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.1/groups?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Create Group

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Create a group.
    To create a group you will need to send an object with attributes ObjectGroup, which are marked with POST tag.
    If the group has been successfully created, you will get full object ObjectGroup.

    post 
    /api/v3/groups

    Permission: groups 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3/groups?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Delete Group

    Remove group.
    If you have successfully removed group, you will get object ID.

    delete 
    /api/v3.10/groups/{{$group_id}}

    Permission: groups | groups:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Delete Group

    Remove group.
    If you have successfully removed group, you will get object ID.

    delete 
    /api/v3.9/groups/{{$group_id}}

    Permission: groups | groups:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Delete Group

    Remove group.
    If you have successfully removed group, you will get object ID.

    delete 
    /api/v3.8/groups/{{$group_id}}

    Permission: groups | groups:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Delete Group

    Remove group.
    If you have successfully removed group, you will get object ID.

    delete 
    /api/v3.7/groups/{{$group_id}}

    Permission: groups | groups:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Delete Group

    Remove group.
    If you have successfully removed group, you will get object ID.

    delete 
    /api/v3.6/groups/{{$group_id}}

    Permission: groups | groups:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Delete Group

    Remove group.
    If you have successfully removed group, you will get object ID.

    delete 
    /api/v3.5/groups/{{$group_id}}

    Permission: groups | groups:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Delete Group

    Remove group.
    If you have successfully removed group, you will get object ID.

    delete 
    /api/v3.4/groups/{{$group_id}}

    Permission: groups | groups:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Delete Group

    Remove group.
    If you have successfully removed group, you will get object ID.

    delete 
    /api/v3.3/groups/{{$group_id}}

    Permission: groups | groups:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Delete Group

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Remove group.
    If you have successfully removed group, you will get object ID.

    delete 
    /api/v3.2/groups/{{$group_id}}

    Permission: groups | groups:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Delete Group

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Remove group.
    If you have successfully removed group, you will get object ID.

    delete 
    /api/v3.1/groups/{{$group_id}}

    Permission: groups | groups:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Delete Group

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Remove group.
    If you have successfully removed group, you will get object ID.

    delete 
    /api/v3/groups/{{$group_id}}

    Permission: groups 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Edit Group

    Edit group.
    To edit a group you will need to send an object with attributes ObjectGroup, which are marked with PUT tag.
    If you have successfully edited group, you will get full object ObjectGroup.

    put 
    /api/v3.10/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.10/groups/{{$group_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Edit Group

    Edit group.
    To edit a group you will need to send an object with attributes ObjectGroup, which are marked with PUT tag.
    If you have successfully edited group, you will get full object ObjectGroup.

    put 
    /api/v3.9/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.9/groups/{{$group_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Edit Group

    Edit group.
    To edit a group you will need to send an object with attributes ObjectGroup, which are marked with PUT tag.
    If you have successfully edited group, you will get full object ObjectGroup.

    put 
    /api/v3.8/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.8/groups/{{$group_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Edit Group

    Edit group.
    To edit a group you will need to send an object with attributes ObjectGroup, which are marked with PUT tag.
    If you have successfully edited group, you will get full object ObjectGroup.

    put 
    /api/v3.7/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.7/groups/{{$group_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Edit Group

    Edit group.
    To edit a group you will need to send an object with attributes ObjectGroup, which are marked with PUT tag.
    If you have successfully edited group, you will get full object ObjectGroup.

    put 
    /api/v3.6/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.6/groups/{{$group_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Edit Group

    Edit group.
    To edit a group you will need to send an object with attributes ObjectGroup, which are marked with PUT tag.
    If you have successfully edited group, you will get full object ObjectGroup.

    put 
    /api/v3.5/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.5/groups/{{$group_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Edit Group

    Edit group.
    To edit a group you will need to send an object with attributes ObjectGroup, which are marked with PUT tag.
    If you have successfully edited group, you will get full object ObjectGroup.

    put 
    /api/v3.4/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.4/groups/{{$group_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Edit Group

    Edit group.
    To edit a group you will need to send an object with attributes ObjectGroup, which are marked with PUT tag.
    If you have successfully edited group, you will get full object ObjectGroup.

    put 
    /api/v3.3/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.3/groups/{{$group_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Edit Group

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Edit group.
    To edit a group you will need to send an object with attributes ObjectGroup, which are marked with PUT tag.
    If you have successfully edited group, you will get full object ObjectGroup.

    put 
    /api/v3.2/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.2/groups/{{$group_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Edit Group

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Edit group.
    To edit a group you will need to send an object with attributes ObjectGroup, which are marked with PUT tag.
    If you have successfully edited group, you will get full object ObjectGroup.

    put 
    /api/v3.1/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.1/groups/{{$group_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Edit Group

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Edit group.
    To edit a group you will need to send an object with attributes ObjectGroup, which are marked with PUT tag.
    If you have successfully edited group, you will get full object ObjectGroup.

    put 
    /api/v3/groups/{{$group_id}}

    Permission: groups 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3/groups/{{$group_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectGroup.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Get Group List

    Read group list. Returns ObjectGroup list.

    get 
    /api/v3.10/groups

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/groups?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    next_page_id Integer

    Next page ID. If next_page_id value is -1, next page does not exist.
    groups Object[]

    List of ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "next_page_id": 4172
    "groups": [
        {ObjectGroup},
        {ObjectGroup},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Get Group List

    Read group list. Returns ObjectGroup list.

    get 
    /api/v3.9/groups

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/groups?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    next_page_id Integer

    Next page ID. If next_page_id value is -1, next page does not exist.
    groups Object[]

    List of ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "next_page_id": 4172
    "groups": [
        {ObjectGroup},
        {ObjectGroup},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Get Group List

    Read group list. Returns ObjectGroup list.

    get 
    /api/v3.8/groups

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/groups?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    next_page_id Integer

    Next page ID. If next_page_id value is -1, next page does not exist.
    groups Object[]

    List of ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "next_page_id": 4172
    "groups": [
        {ObjectGroup},
        {ObjectGroup},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Get Group List

    Read group list. Returns ObjectGroup list.

    get 
    /api/v3.7/groups

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/groups?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    next_page_id Integer

    Next page ID. If next_page_id value is -1, next page does not exist.
    groups Object[]

    List of ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "next_page_id": 4172
    "groups": [
        {ObjectGroup},
        {ObjectGroup},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Get Group List

    Read group list. Returns ObjectGroup list.

    get 
    /api/v3.6/groups

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/groups?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    next_page_id Integer

    Next page ID. If next_page_id value is -1, next page does not exist.
    groups Object[]

    List of ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "next_page_id": 4172
    "groups": [
        {ObjectGroup},
        {ObjectGroup},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Get Group List

    Read group list. Returns ObjectGroup list.

    get 
    /api/v3.5/groups

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/groups?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    next_page_id Integer

    Next page ID. If next_page_id value is -1, next page does not exist.
    groups Object[]

    List of ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "next_page_id": 4172
    "groups": [
        {ObjectGroup},
        {ObjectGroup},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Get Group List

    Read group list. Returns ObjectGroup list.

    get 
    /api/v3.4/groups

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/groups?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    next_page_id Integer

    Next page ID. If next_page_id value is -1, next page does not exist.
    groups Object[]

    List of ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "next_page_id": 4172
    "groups": [
        {ObjectGroup},
        {ObjectGroup},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Get Group List

    Read group list. Returns ObjectGroup list.

    get 
    /api/v3.3/groups

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/groups?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    next_page_id Integer

    Next page ID. If next_page_id value is -1, next page does not exist.
    groups Object[]

    List of ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "next_page_id": 4172
    "groups": [
        {ObjectGroup},
        {ObjectGroup},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Get Group List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read group list. Returns ObjectGroup list.

    get 
    /api/v3.2/groups

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/groups?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    next_page_id Integer

    Next page ID. If next_page_id value is -1, next page does not exist.
    groups Object[]

    List of ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "next_page_id": 4172
    "groups": [
        {ObjectGroup},
        {ObjectGroup},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Get Group List

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read group list. Returns ObjectGroup list.

    get 
    /api/v3.1/groups

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/groups?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    next_page_id Integer

    Next page ID. If next_page_id value is -1, next page does not exist.
    groups Object[]

    List of ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "next_page_id": 4172
    "groups": [
        {ObjectGroup},
        {ObjectGroup},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Get Group List

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Read group list. Returns ObjectGroup list

    get 
    /api/v3/groups

    Permission: groups 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/groups?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    next_page_id Integer

    Next page ID. If next_page_id value is -1, next page does not exist.
    groups Object[]

    List of ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "next_page_id": 4172
    "groups": [
        {ObjectGroup},
        {ObjectGroup},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Groups | Get Group

    Read group.
    Returns ObjectGroup.

    get 
    /api/v3.10/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Get Group

    Read group.
    Returns ObjectGroup.

    get 
    /api/v3.9/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Get Group

    Read group.
    Returns ObjectGroup.

    get 
    /api/v3.8/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Get Group

    Read group.
    Returns ObjectGroup.

    get 
    /api/v3.7/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Get Group

    Read group.
    Returns ObjectGroup.

    get 
    /api/v3.6/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Get Group

    Read group.
    Returns ObjectGroup.

    get 
    /api/v3.5/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Get Group

    Read group.
    Returns ObjectGroup.

    get 
    /api/v3.4/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Get Group

    Read group.
    Returns ObjectGroup.

    get 
    /api/v3.3/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Get Group

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read group.
    Returns ObjectGroup.

    get 
    /api/v3.2/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Get Group

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read group.
    Returns ObjectGroup.

    get 
    /api/v3.1/groups/{{$group_id}}

    Permission: groups | groups:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups | Get Group

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Read group.
    Returns ObjectGroup

    get 
    /api/v3/groups/{{$group_id}}

    Permission: groups 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/groups/{{$group_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    group Object

    ObjectGroup.

    		 
    HTTP/1.1 200 OK
{
    "group": {ObjectGroup}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Presets

    Presets | Create Preset

    Create preset.
    To create a preset you will need to send an object with attributes ObjectPreset, which are marked with POST tag.
    If the preset has been created successfully, you will get full object ObjectPreset.

    post 
    /api/v3.10/broadcast/presets

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.10/broadcast/presets?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectPreset.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Presets | Create Preset

    Create preset.
    To create a preset you will need to send an object with attributes ObjectPreset, which are marked with POST tag.
    If the preset has been created successfully, you will get full object ObjectPreset.

    post 
    /api/v3.9/broadcast/presets

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.9/broadcast/presets?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectPreset.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Presets | Create Preset

    Create preset.
    To create a preset you will need to send an object with attributes ObjectPreset, which are marked with POST tag.
    If the preset has been created successfully, you will get full object ObjectPreset.

    post 
    /api/v3.8/broadcast/presets

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.8/broadcast/presets?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectPreset.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Presets | Create Preset

    Create preset.
    To create a preset you will need to send an object with attributes ObjectPreset, which are marked with POST tag.
    If the preset has been created successfully, you will get full object ObjectPreset.

    post 
    /api/v3.7/broadcast/presets

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.7/broadcast/presets?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectPreset.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Presets | Create Preset

    Create preset.
    To create a preset you will need to send an object with attributes ObjectPreset, which are marked with POST tag.
    If the preset has been created successfully, you will get full object ObjectPreset.

    post 
    /api/v3.6/broadcast/presets

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.6/broadcast/presets?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectPreset.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Presets | Create Preset

    Create preset.
    To create a preset you will need to send an object with attributes ObjectPreset, which are marked with POST tag.
    If the preset has been created successfully, you will get full object ObjectPreset.

    post 
    /api/v3.5/broadcast/presets

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.5/broadcast/presets?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectPreset.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Presets | Create Preset

    Create preset.
    To create a preset you will need to send an object with attributes ObjectPreset, which are marked with POST tag.
    If the preset has been created successfully, you will get full object ObjectPreset.

    post 
    /api/v3.4/broadcast/presets

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.4/broadcast/presets?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectPreset.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Presets | Create Preset

    Create preset.
    To create a preset you will need to send an object with attributes ObjectPreset, which are marked with POST tag.
    If the preset has been created successfully, you will get full object ObjectPreset.

    post 
    /api/v3.3/broadcast/presets

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.3/broadcast/presets?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectPreset.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Presets | Delete Preset

    Remove preset.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.10/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of preset.

    		 
    HTTP/1.1 200 OK
{
    "id": "cfa59a",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Delete Preset

    Remove preset.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.9/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of preset.

    		 
    HTTP/1.1 200 OK
{
    "id": "cfa59a",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Delete Preset

    Remove preset.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.8/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of preset.

    		 
    HTTP/1.1 200 OK
{
    "id": "cfa59a",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Delete Preset

    Remove preset.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.7/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of preset.

    		 
    HTTP/1.1 200 OK
{
    "id": "cfa59a",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Delete Preset

    Remove preset.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.6/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of preset.

    		 
    HTTP/1.1 200 OK
{
    "id": "cfa59a",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Delete Preset

    Remove preset.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.5/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of preset.

    		 
    HTTP/1.1 200 OK
{
    "id": "cfa59a",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Delete Preset

    Remove preset.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.4/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of preset.

    		 
    HTTP/1.1 200 OK
{
    "id": "cfa59a",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Delete Preset

    Remove preset.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.3/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of preset.

    		 
    HTTP/1.1 200 OK
{
    "id": "cfa59a",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Edit Preset

    Edit preset.
    To edit a preset you will need to send an object with attributes ObjectPreset, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectPreset.

    put 
    /api/v3.10/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.10/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectPreset.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Edit Preset

    Edit preset.
    To edit a preset you will need to send an object with attributes ObjectPreset, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectPreset.

    put 
    /api/v3.9/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.9/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectPreset.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Edit Preset

    Edit preset.
    To edit a preset you will need to send an object with attributes ObjectPreset, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectPreset.

    put 
    /api/v3.8/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.8/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectPreset.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Edit Preset

    Edit preset.
    To edit a preset you will need to send an object with attributes ObjectPreset, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectPreset.

    put 
    /api/v3.7/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.7/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectPreset.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Edit Preset

    Edit preset.
    To edit a preset you will need to send an object with attributes ObjectPreset, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectPreset.

    put 
    /api/v3.6/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.6/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectPreset.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Edit Preset

    Edit preset.
    To edit a preset you will need to send an object with attributes ObjectPreset, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectPreset.

    put 
    /api/v3.5/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.5/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectPreset.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Edit Preset

    Edit preset.
    To edit a preset you will need to send an object with attributes ObjectPreset, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectPreset.

    put 
    /api/v3.4/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.4/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectPreset.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Edit Preset

    Edit preset.
    To edit a preset you will need to send an object with attributes ObjectPreset, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectPreset.

    put 
    /api/v3.3/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.3/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectPreset.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Get Preset List

    Read preset list.
    Returns ObjectPreset list.

    get 
    /api/v3.10/broadcast/presets

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/broadcast/presets?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    presets Object[]

    List of ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "presets": [
        {ObjectPreset},
        {ObjectPreset},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Presets | Get Preset List

    Read preset list.
    Returns ObjectPreset list.

    get 
    /api/v3.9/broadcast/presets

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/broadcast/presets?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    presets Object[]

    List of ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "presets": [
        {ObjectPreset},
        {ObjectPreset},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Presets | Get Preset List

    Read preset list.
    Returns ObjectPreset list.

    get 
    /api/v3.8/broadcast/presets

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/broadcast/presets?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    presets Object[]

    List of ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "presets": [
        {ObjectPreset},
        {ObjectPreset},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Presets | Get Preset List

    Read preset list.
    Returns ObjectPreset list.

    get 
    /api/v3.7/broadcast/presets

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/broadcast/presets?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    presets Object[]

    List of ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "presets": [
        {ObjectPreset},
        {ObjectPreset},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Presets | Get Preset List

    Read preset list.
    Returns ObjectPreset list.

    get 
    /api/v3.6/broadcast/presets

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/broadcast/presets?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    presets Object[]

    List of ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "presets": [
        {ObjectPreset},
        {ObjectPreset},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Presets | Get Preset List

    Read preset list.
    Returns ObjectPreset list.

    get 
    /api/v3.5/broadcast/presets

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/broadcast/presets?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    presets Object[]

    List of ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "presets": [
        {ObjectPreset},
        {ObjectPreset},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Presets | Get Preset List

    Read preset list.
    Returns ObjectPreset list.

    get 
    /api/v3.4/broadcast/presets

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/broadcast/presets?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    presets Object[]

    List of ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "presets": [
        {ObjectPreset},
        {ObjectPreset},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Presets | Get Preset List

    Read preset list.
    Returns ObjectPreset list.

    get 
    /api/v3.3/broadcast/presets

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/broadcast/presets?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    page_size optional Integer

    Default value: 200

    Allowed values: 1-1000

    page_id optional Integer

    Default value: 1
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    presets Object[]

    List of ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "presets": [
        {ObjectPreset},
        {ObjectPreset},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Presets | Get Preset

    Get preset by id.
    Returns ObjectPreset

    get 
    /api/v3.10/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    preset_id String

    POST Preset ID.
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Get Preset

    Get preset by id.
    Returns ObjectPreset

    get 
    /api/v3.9/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    preset_id String

    POST Preset ID.
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Get Preset

    Get preset by id.
    Returns ObjectPreset

    get 
    /api/v3.8/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    preset_id String

    POST Preset ID.
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Get Preset

    Get preset by id.
    Returns ObjectPreset

    get 
    /api/v3.7/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    preset_id String

    POST Preset ID.
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Get Preset

    Get preset by id.
    Returns ObjectPreset

    get 
    /api/v3.6/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    preset_id String

    POST Preset ID.
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Get Preset

    Get preset by id.
    Returns ObjectPreset

    get 
    /api/v3.5/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    preset_id String

    POST Preset ID.
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Get Preset

    Get preset by id.
    Returns ObjectPreset

    get 
    /api/v3.4/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    preset_id String

    POST Preset ID.
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Presets | Get Preset

    Get preset by id.
    Returns ObjectPreset

    get 
    /api/v3.3/broadcast/presets/{{$preset_id}}

    Permission: conferences.broadcast_presets | conferences.broadcast_presets:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/broadcast/presets/{{$preset_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    preset_id String

    POST Preset ID.
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    preset Object

    ObjectPreset.

    		 
    HTTP/1.1 200 OK
{
    "preset": {ObjectPreset}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    presetNotFound ObjectErrorDetail

    Preset preset_id is not found.

    Conference Sessions

    Conference Sessions | Get Conference Session Participants

    Read conference session participant list.
    Returns ConferenceSessionParticipant list.
    Keep in mind that conference session is accessible for API only when the conference is running.

    get 
    /api/v3.10/conference-sessions/{{$session_id}}/participants

    Permission: conferences.sessions.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conference-sessions/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    count Integer

    Count of participants in list
    participants Object[]

    List of ConferenceSessionParticipant.

    		 
    HTTP/1.1 200 OK
{
    "count": 5,
    "participants": {
        {ObjectConferenceSessionParticipant},
        {ObjectConferenceSessionParticipant},
        ...
  }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.

    Conference Sessions | Get Conference Session Participants

    Read conference session participant list.
    Returns ConferenceSessionParticipant list.
    Keep in mind that conference session is accessible for API only when the conference is running.

    get 
    /api/v3.9/conference-sessions/{{$session_id}}/participants

    Permission: conferences.sessions.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conference-sessions/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    count Integer

    Count of participants in list
    participants Object[]

    List of ConferenceSessionParticipant.

    		 
    HTTP/1.1 200 OK
{
    "count": 5,
    "participants": {
        {ObjectConferenceSessionParticipant},
        {ObjectConferenceSessionParticipant},
        ...
  }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.

    Conference Sessions | Get Conference Session Participants

    Read conference session participant list.
    Returns ConferenceSessionParticipant list.
    Keep in mind that conference session is accessible for API only when the conference is running.

    get 
    /api/v3.8/conference-sessions/{{$session_id}}/participants

    Permission: conferences.sessions.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conference-sessions/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    count Integer

    Count of participants in list
    participants Object[]

    List of ConferenceSessionParticipant.

    		 
    HTTP/1.1 200 OK
{
    "count": 5,
    "participants": {
        {ObjectConferenceSessionParticipant},
        {ObjectConferenceSessionParticipant},
        ...
  }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.

    Conference Sessions | Get Conference Session Participants

    Read conference session participant list.
    Returns ConferenceSessionParticipant list.
    Keep in mind that conference session is accessible for API only when the conference is running.

    get 
    /api/v3.7/conference-sessions/{{$session_id}}/participants

    Permission: conferences.sessions.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conference-sessions/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    count Integer

    Count of participants in list
    participants Object[]

    List of ConferenceSessionParticipant.

    		 
    HTTP/1.1 200 OK
{
    "count": 5,
    "participants": {
        {ObjectConferenceSessionParticipant},
        {ObjectConferenceSessionParticipant},
        ...
  }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.

    Conference Sessions | Get Conference Session Participants

    Read conference session participant list.
    Returns ConferenceSessionParticipant list.
    Keep in mind that conference session is accessible for API only when the conference is running.

    get 
    /api/v3.6/conference-sessions/{{$session_id}}/participants

    Permission: conferences.sessions.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conference-sessions/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    count Integer

    Count of participants in list
    participants Object[]

    List of ConferenceSessionParticipant.

    		 
    HTTP/1.1 200 OK
{
    "count": 5,
    "participants": {
        {ObjectConferenceSessionParticipant},
        {ObjectConferenceSessionParticipant},
        ...
  }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.

    Conference Sessions | Get Conference Session Participants

    Read conference session participant list.
    Returns ConferenceSessionParticipant list.
    Keep in mind that conference session is accessible for API only when the conference is running.

    get 
    /api/v3.5/conference-sessions/{{$session_id}}/participants

    Permission: conferences.sessions.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conference-sessions/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    count Integer

    Count of participants in list
    participants Object[]

    List of ConferenceSessionParticipant.

    		 
    HTTP/1.1 200 OK
{
    "count": 5,
    "participants": {
        {ObjectConferenceSessionParticipant},
        {ObjectConferenceSessionParticipant},
        ...
  }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.

    Conference Sessions | Get Conference Session Participants

    Read conference session participant list.
    Returns ConferenceSessionParticipant list.
    Keep in mind that conference session is accessible for API only when the conference is running.

    get 
    /api/v3.4/conference-sessions/{{$session_id}}/participants

    Permission: conferences.sessions.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conference-sessions/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    count Integer

    Count of participants in list
    participants Object[]

    List of ConferenceSessionParticipant.

    		 
    HTTP/1.1 200 OK
{
    "count": 5,
    "participants": {
        {ObjectConferenceSessionParticipant},
        {ObjectConferenceSessionParticipant},
        ...
  }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.

    Conference Sessions | Get Conference Session Participants

    Read conference session participant list.
    Returns ConferenceSessionParticipant list.
    Keep in mind that conference session is accessible for API only when the conference is running.

    get 
    /api/v3.3/conference-sessions/{{$session_id}}/participants

    Permission: conferences.sessions.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conference-sessions/{{$session_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    count Integer

    Count of participants in list
    participants Object[]

    List of ConferenceSessionParticipant.

    		 
    HTTP/1.1 200 OK
{
    "count": 5,
    "participants": {
        {ObjectConferenceSessionParticipant},
        {ObjectConferenceSessionParticipant},
        ...
  }

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.

    Conference Sessions | Get Conference Session

    Read conference session by id.
    Returns ConferenceSession list.
    Keep in mind that conference session is accessible for API only when the conference is running.

    get 
    /api/v3.10/conference-sessions/{{$session_id}}

    Permission: conferences.sessions:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conference-sessions/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    session Object

    ConferenceSession.

    		 
    HTTP/1.1 200 OK
{
    "session": {
        {ObjectConferenceSession}
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.

    Conference Sessions | Get Conference Session

    Read conference session by id.
    Returns ConferenceSession list.
    Keep in mind that conference session is accessible for API only when the conference is running.

    get 
    /api/v3.9/conference-sessions/{{$session_id}}

    Permission: conferences.sessions:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conference-sessions/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    session Object

    ConferenceSession.

    		 
    HTTP/1.1 200 OK
{
    "session": {
        {ObjectConferenceSession}
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.

    Conference Sessions | Get Conference Session

    Read conference session by id.
    Returns ConferenceSession list.
    Keep in mind that conference session is accessible for API only when the conference is running.

    get 
    /api/v3.8/conference-sessions/{{$session_id}}

    Permission: conferences.sessions:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conference-sessions/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    session Object

    ConferenceSession.

    		 
    HTTP/1.1 200 OK
{
    "session": {
        {ObjectConferenceSession}
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.

    Conference Sessions | Get Conference Session

    Read conference session by id.
    Returns ConferenceSession list.
    Keep in mind that conference session is accessible for API only when the conference is running.

    get 
    /api/v3.7/conference-sessions/{{$session_id}}

    Permission: conferences.sessions:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conference-sessions/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    session Object

    ConferenceSession.

    		 
    HTTP/1.1 200 OK
{
    "session": {
        {ObjectConferenceSession}
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.

    Conference Sessions | Get Conference Session

    Read conference session by id.
    Returns ConferenceSession list.
    Keep in mind that conference session is accessible for API only when the conference is running.

    get 
    /api/v3.6/conference-sessions/{{$session_id}}

    Permission: conferences.sessions:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conference-sessions/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    session Object

    ConferenceSession.

    		 
    HTTP/1.1 200 OK
{
    "session": {
        {ObjectConferenceSession}
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.

    Conference Sessions | Get Conference Session

    Read conference session by id.
    Returns ConferenceSession list.
    Keep in mind that conference session is accessible for API only when the conference is running.

    get 
    /api/v3.5/conference-sessions/{{$session_id}}

    Permission: conferences.sessions:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conference-sessions/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    session Object

    ConferenceSession.

    		 
    HTTP/1.1 200 OK
{
    "session": {
        {ObjectConferenceSession}
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.

    Conference Sessions | Get Conference Session

    Read conference session by id.
    Returns ConferenceSession list.
    Keep in mind that conference session is accessible for API only when the conference is running.

    get 
    /api/v3.4/conference-sessions/{{$session_id}}

    Permission: conferences.sessions:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conference-sessions/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    session Object

    ConferenceSession.

    		 
    HTTP/1.1 200 OK
{
    "session": {
        {ObjectConferenceSession}
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.

    Conference Sessions | Get Conference Session

    Read conference session by id.
    Returns ConferenceSession list.
    Keep in mind that conference session is accessible for API only when the conference is running.

    get 
    /api/v3.3/conference-sessions/{{$session_id}}

    Permission: conferences.sessions:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conference-sessions/{{$session_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    session Object

    ConferenceSession.

    		 
    HTTP/1.1 200 OK
{
    "session": {
        {ObjectConferenceSession}
    }
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.

    Conference Sessions | Invite participant to stand on a podium

    Invite participant to stand on a podium.
    Keep in mind that conference session is accessible for API only when the conference is running.

    post 
    /api/v3.10/conference-sessions/{{$session_id}}/podiums/participants

    Permission: conferences.sessions.podiums.participants:write | conferences.sessions.podiums.participants:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conference-sessions/{{$session_id}}/podiums/participants?access_token={{$access_token}}' \
    --data '{"participant_id":"user1","force":true}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    force optional boolean

    POST If parameter is true, the participant is automatically added to the podium without confirmation.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conference Sessions | Invite participant to stand on a podium

    Invite participant to stand on a podium.
    Keep in mind that conference session is accessible for API only when the conference is running.

    post 
    /api/v3.9/conference-sessions/{{$session_id}}/podiums/participants

    Permission: conferences.sessions.podiums.participants:write | conferences.sessions.podiums.participants:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conference-sessions/{{$session_id}}/podiums/participants?access_token={{$access_token}}' \
    --data '{"participant_id":"user1","force":true}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    force optional boolean

    POST If parameter is true, the participant is automatically added to the podium without confirmation.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conference Sessions | Invite participant to stand on a podium

    Invite participant to stand on a podium.
    Keep in mind that conference session is accessible for API only when the conference is running.

    post 
    /api/v3.8/conference-sessions/{{$session_id}}/podiums/participants

    Permission: conferences.sessions.podiums.participants:write | conferences.sessions.podiums.participants:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conference-sessions/{{$session_id}}/podiums/participants?access_token={{$access_token}}' \
    --data '{"participant_id":"user1","force":true}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    force optional boolean

    POST If parameter is true, the participant is automatically added to the podium without confirmation.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conference Sessions | Invite participant to stand on a podium

    Invite participant to stand on a podium.
    Keep in mind that conference session is accessible for API only when the conference is running.

    post 
    /api/v3.7/conference-sessions/{{$session_id}}/podiums/participants

    Permission: conferences.sessions.podiums.participants:write | conferences.sessions.podiums.participants:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conference-sessions/{{$session_id}}/podiums/participants?access_token={{$access_token}}' \
    --data '{"participant_id":"user1","force":true}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    force optional boolean

    POST If parameter is true, the participant is automatically added to the podium without confirmation.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conference Sessions | Invite participant to stand on a podium

    Invite participant to stand on a podium.
    Keep in mind that conference session is accessible for API only when the conference is running.

    post 
    /api/v3.6/conference-sessions/{{$session_id}}/podiums/participants

    Permission: conferences.sessions.podiums.participants:write | conferences.sessions.podiums.participants:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conference-sessions/{{$session_id}}/podiums/participants?access_token={{$access_token}}' \
    --data '{"participant_id":"user1","force":true}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    force optional boolean

    POST If parameter is true, the participant is automatically added to the podium without confirmation.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conference Sessions | Invite participant to stand on a podium

    Invite participant to stand on a podium.
    Keep in mind that conference session is accessible for API only when the conference is running.

    post 
    /api/v3.5/conference-sessions/{{$session_id}}/podiums/participants

    Permission: conferences.sessions.podiums.participants:write | conferences.sessions.podiums.participants:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conference-sessions/{{$session_id}}/podiums/participants?access_token={{$access_token}}' \
    --data '{"participant_id":"user1","force":true}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    force optional boolean

    POST If parameter is true, the participant is automatically added to the podium without confirmation.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conference Sessions | Invite participant to stand on a podium

    Invite participant to stand on a podium.
    Keep in mind that conference session is accessible for API only when the conference is running.

    post 
    /api/v3.4/conference-sessions/{{$session_id}}/podiums/participants

    Permission: conferences.sessions.podiums.participants:write | conferences.sessions.podiums.participants:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conference-sessions/{{$session_id}}/podiums/participants?access_token={{$access_token}}' \
    --data '{"participant_id":"user1","force":true}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    force optional boolean

    POST If parameter is true, the participant is automatically added to the podium without confirmation.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conference Sessions | Invite participant to stand on a podium

    Invite participant to stand on a podium.
    Keep in mind that conference session is accessible for API only when the conference is running.

    post 
    /api/v3.3/conference-sessions/{{$session_id}}/podiums/participants

    Permission: conferences.sessions.podiums.participants:write | conferences.sessions.podiums.participants:read 

    curl --request POST \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conference-sessions/{{$session_id}}/podiums/participants?access_token={{$access_token}}' \
    --data '{"participant_id":"user1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.

    Success 200

    Field Type Description
    invite String

    Has participant been invited.

    		 
    HTTP/1.1 200 OK
{
    "invite": true
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conference Sessions | Kick participant

    Kick participant from the conference.
    If removing has been successful, object ID will be sent to you in response. Keep in mind that conference session is accessible for API only when the conference is running.

    delete 
    /api/v3.10/conference-sessions/{{$session_id}}/participants/{{$participant_id}}

    Permission: conferences.sessions.participants:read 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conference-sessions/{{$session_id}}/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    participant_id String

    id of participant

    		 
    HTTP/1.1 200 OK
{
    "participant_id": "user_id@server_name/instance",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conference Sessions | Kick participant

    Kick participant from the conference.
    If removing has been successful, object ID will be sent to you in response. Keep in mind that conference session is accessible for API only when the conference is running.

    delete 
    /api/v3.9/conference-sessions/{{$session_id}}/participants/{{$participant_id}}

    Permission: conferences.sessions.participants:read 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conference-sessions/{{$session_id}}/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    participant_id String

    id of participant

    		 
    HTTP/1.1 200 OK
{
    "participant_id": "user_id@server_name/instance",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conference Sessions | Remove participant from a podium

    Remove participant from a podium.
    If removing has been successful, object ID will be sent to you in response. Keep in mind that conference session is accessible for API only when the conference is running.

    delete 
    /api/v3.10/conference-sessions/{{$session_id}}/podiums/participants/{{$participant_id}}

    Permission: conferences.sessions.podiums.participants:write | conferences.sessions.podiums.participants:read 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conference-sessions/{{$session_id}}/podiums/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    participant_id String

    id of participant

    		 
    HTTP/1.1 200 OK
{
    "participant_id": "user_id@server_name/instance",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conference Sessions | Remove participant from a podium

    Remove participant from a podium.
    If removing has been successful, object ID will be sent to you in response. Keep in mind that conference session is accessible for API only when the conference is running.

    delete 
    /api/v3.9/conference-sessions/{{$session_id}}/podiums/participants/{{$participant_id}}

    Permission: conferences.sessions.podiums.participants:write | conferences.sessions.podiums.participants:read 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conference-sessions/{{$session_id}}/podiums/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    participant_id String

    id of participant

    		 
    HTTP/1.1 200 OK
{
    "participant_id": "user_id@server_name/instance",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conference Sessions | Remove participant from a podium

    Remove participant from a podium.
    If removing has been successful, object ID will be sent to you in response. Keep in mind that conference session is accessible for API only when the conference is running.

    delete 
    /api/v3.8/conference-sessions/{{$session_id}}/podiums/participants/{{$participant_id}}

    Permission: conferences.sessions.podiums.participants:write | conferences.sessions.podiums.participants:read 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conference-sessions/{{$session_id}}/podiums/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    participant_id String

    id of participant

    		 
    HTTP/1.1 200 OK
{
    "participant_id": "user_id@server_name/instance",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conference Sessions | Remove participant from a podium

    Remove participant from a podium.
    If removing has been successful, object ID will be sent to you in response. Keep in mind that conference session is accessible for API only when the conference is running.

    delete 
    /api/v3.7/conference-sessions/{{$session_id}}/podiums/participants/{{$participant_id}}

    Permission: conferences.sessions.podiums.participants:write | conferences.sessions.podiums.participants:read 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conference-sessions/{{$session_id}}/podiums/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    participant_id String

    id of participant

    		 
    HTTP/1.1 200 OK
{
    "participant_id": "user_id@server_name/instance",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conference Sessions | Remove participant from a podium

    Remove participant from a podium.
    If removing has been successful, object ID will be sent to you in response. Keep in mind that conference session is accessible for API only when the conference is running.

    delete 
    /api/v3.6/conference-sessions/{{$session_id}}/podiums/participants/{{$participant_id}}

    Permission: conferences.sessions.podiums.participants:write | conferences.sessions.podiums.participants:read 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conference-sessions/{{$session_id}}/podiums/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    participant_id String

    id of participant

    		 
    HTTP/1.1 200 OK
{
    "participant_id": "user_id@server_name/instance",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conference Sessions | Remove participant from a podium

    Remove participant from a podium.
    If removing has been successful, object ID will be sent to you in response. Keep in mind that conference session is accessible for API only when the conference is running.

    delete 
    /api/v3.5/conference-sessions/{{$session_id}}/podiums/participants/{{$participant_id}}

    Permission: conferences.sessions.podiums.participants:write | conferences.sessions.podiums.participants:read 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conference-sessions/{{$session_id}}/podiums/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    participant_id String

    id of participant

    		 
    HTTP/1.1 200 OK
{
    "participant_id": "user_id@server_name/instance",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conference Sessions | Remove participant from a podium

    Remove participant from a podium.
    If removing has been successful, object ID will be sent to you in response. Keep in mind that conference session is accessible for API only when the conference is running.

    delete 
    /api/v3.4/conference-sessions/{{$session_id}}/podiums/participants/{{$participant_id}}

    Permission: conferences.sessions.podiums.participants:write | conferences.sessions.podiums.participants:read 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conference-sessions/{{$session_id}}/podiums/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    participant_id String

    id of participant

    		 
    HTTP/1.1 200 OK
{
    "participant_id": "user_id@server_name/instance",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conference Sessions | Remove participant from a podium

    Remove participant from a podium.
    If removing has been successful, object ID will be sent to you in response. Keep in mind that conference session is accessible for API only when the conference is running.

    delete 
    /api/v3.3/conference-sessions/{{$session_id}}/podiums/participants/{{$participant_id}}

    Permission: conferences.sessions.podiums.participants:write | conferences.sessions.podiums.participants:read 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conference-sessions/{{$session_id}}/podiums/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    participant_id String

    id of participant

    		 
    HTTP/1.1 200 OK
{
    "participant_id": "user_id@server_name/instance",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceSessionNotFound ObjectErrorDetail

    Conference session session_id not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conference Templates

    Conference Templates | Create Conference Template

    Create template of video conference.
    To create a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with POST tag.
    If the conference template has been created successfully, you will get full object ObjectConferenceTemplate.

    post 
    /api/v3.10/templates/conferences

    Permission: templates.conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.10/templates/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Conference Templates | Create Conference Template

    Create template of video conference.
    To create a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with POST tag.
    If the conference template has been created successfully, you will get full object ObjectConferenceTemplate.

    post 
    /api/v3.9/templates/conferences

    Permission: templates.conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.9/templates/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Conference Templates | Create Conference Template

    Create template of video conference.
    To create a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with POST tag.
    If the conference template has been created successfully, you will get full object ObjectConferenceTemplate.

    post 
    /api/v3.8/templates/conferences

    Permission: templates.conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.8/templates/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Conference Templates | Create Conference Template

    Create template of video conference.
    To create a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with POST tag.
    If the conference template has been created successfully, you will get full object ObjectConferenceTemplate.

    post 
    /api/v3.7/templates/conferences

    Permission: templates.conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.7/templates/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Conference Templates | Create Conference Template

    Create template of video conference.
    To create a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with POST tag.
    If the conference template has been created successfully, you will get full object ObjectConferenceTemplate.

    post 
    /api/v3.6/templates/conferences

    Permission: templates.conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.6/templates/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Conference Templates | Create Conference Template

    Create template of video conference.
    To create a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with POST tag.
    If the conference template has been created successfully, you will get full object ObjectConferenceTemplate.

    post 
    /api/v3.5/templates/conferences

    Permission: templates.conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.5/templates/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Conference Templates | Create Conference Template

    Create template of video conference.
    To create a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with POST tag.
    If the conference template has been created successfully, you will get full object ObjectConferenceTemplate.

    post 
    /api/v3.4/templates/conferences

    Permission: templates.conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.4/templates/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Conference Templates | Create Conference Template

    Create template of video conference.
    To create a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with POST tag.
    If the conference template has been created successfully, you will get full object ObjectConferenceTemplate.

    post 
    /api/v3.3/templates/conferences

    Permission: templates.conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.3/templates/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Conference Templates | Create Conference Template

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Create template of video conference.
    To create a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with POST tag.
    If the conference template has been created successfully, you will get full object ObjectConferenceTemplate.

    post 
    /api/v3.2/templates/conferences

    Permission: templates.conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.2/templates/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Conference Templates | Create Conference Template

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Create template of video conference.
    To create a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with POST tag.
    If the conference template has been created successfully, you will get full object ObjectConferenceTemplate.

    post 
    /api/v3.1/templates/conferences

    Permission: templates.conferences:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.1/templates/conferences?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Conference Templates | Delete Conference Template

    Remove conference template.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.10/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference template

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Delete Conference Template

    Remove conference template.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.9/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference template

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Delete Conference Template

    Remove conference template.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.8/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference template

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Delete Conference Template

    Remove conference template.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.7/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference template

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Delete Conference Template

    Remove conference template.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.6/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference template

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Delete Conference Template

    Remove conference template.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.5/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference template

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Delete Conference Template

    Remove conference template.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.4/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference template

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Delete Conference Template

    Remove conference template.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.3/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference template

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Delete Conference Template

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Remove conference template.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.2/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference template

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Delete Conference Template

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Remove conference template.
    If removing has been successful, object ID will be sent to you in response.

    delete 
    /api/v3.1/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of conference template

    		 
    HTTP/1.1 200 OK
{
    "id": "f80dc3a6",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Edit Conference Template

    Edit conference template.
    To edit a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.10/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.10/templates/conferences/{{$template_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Edit Conference Template

    Edit conference template.
    To edit a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.9/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.9/templates/conferences/{{$template_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Edit Conference Template

    Edit conference template.
    To edit a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.8/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.8/templates/conferences/{{$template_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Edit Conference Template

    Edit conference template.
    To edit a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.7/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.7/templates/conferences/{{$template_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Edit Conference Template

    Edit conference template.
    To edit a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.6/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.6/templates/conferences/{{$template_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Edit Conference Template

    Edit conference template.
    To edit a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.5/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.5/templates/conferences/{{$template_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Edit Conference Template

    Edit conference template.
    To edit a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.4/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.4/templates/conferences/{{$template_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Edit Conference Template

    Edit conference template.
    To edit a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.3/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.3/templates/conferences/{{$template_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Edit Conference Template

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Edit conference template.
    To edit a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.2/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.2/templates/conferences/{{$template_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Edit Conference Template

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Edit conference template.
    To edit a conference template you will need to send an object with attributes ObjectConferenceTemplate, which are marked with PUT tag.
    If editing has been successful, you will get full object ObjectConference.

    put 
    /api/v3.1/templates/conferences/{{$template_id}}

    Permission: templates.conferences:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.1/templates/conferences/{{$template_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectConferenceTemplate.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Get Conference Template List

    Read conference template list.
    Returns ObjectConferenceTemplate list.

    get 
    /api/v3.10/templates/conferences

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/templates/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    sort_by optional String

    GET Name of field for object list sorting.

    Allowed values: "name", "created_at", "updated_at", "creator_id"

    sort_type optional String

    GET Sort order ("desc" - descending, "asc" - ascending).

    Allowed values: "asc", "desc"

    Success 200

    Field Type Description
    conference Object[]

    templates. List of ObjectConferenceTemplate.

    		 
    HTTP/1.1 200 OK
{
    "templates": [
        {ObjectConferenceTemplate},
        {ObjectConferenceTemplate},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conference Templates | Get Conference Template List

    Read conference template list.
    Returns ObjectConferenceTemplate list.

    get 
    /api/v3.9/templates/conferences

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/templates/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    sort_by optional String

    GET Name of field for object list sorting.

    Allowed values: "name", "created_at", "updated_at", "creator_id"

    sort_type optional String

    GET Sort order ("desc" - descending, "asc" - ascending).

    Allowed values: "asc", "desc"

    Success 200

    Field Type Description
    conference Object[]

    templates. List of ObjectConferenceTemplate.

    		 
    HTTP/1.1 200 OK
{
    "templates": [
        {ObjectConferenceTemplate},
        {ObjectConferenceTemplate},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conference Templates | Get Conference Template List

    Read conference template list.
    Returns ObjectConferenceTemplate list.

    get 
    /api/v3.8/templates/conferences

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/templates/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    sort_by optional String

    GET Name of field for object list sorting.

    Allowed values: "name", "created_at", "updated_at", "creator_id"

    sort_type optional String

    GET Sort order ("desc" - descending, "asc" - ascending).

    Allowed values: "asc", "desc"

    Success 200

    Field Type Description
    conference Object[]

    templates. List of ObjectConferenceTemplate.

    		 
    HTTP/1.1 200 OK
{
    "templates": [
        {ObjectConferenceTemplate},
        {ObjectConferenceTemplate},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conference Templates | Get Conference Template List

    Read conference template list.
    Returns ObjectConferenceTemplate list.

    get 
    /api/v3.7/templates/conferences

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/templates/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    sort_by optional String

    GET Name of field for object list sorting.

    Allowed values: "name", "created_at", "updated_at", "creator_id"

    sort_type optional String

    GET Sort order ("desc" - descending, "asc" - ascending).

    Allowed values: "asc", "desc"

    Success 200

    Field Type Description
    conference Object[]

    templates. List of ObjectConferenceTemplate.

    		 
    HTTP/1.1 200 OK
{
    "templates": [
        {ObjectConferenceTemplate},
        {ObjectConferenceTemplate},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conference Templates | Get Conference Template List

    Read conference template list.
    Returns ObjectConferenceTemplate list.

    get 
    /api/v3.6/templates/conferences

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/templates/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    sort_by optional String

    GET Name of field for object list sorting.

    Allowed values: "name", "created_at", "updated_at", "creator_id"

    sort_type optional String

    GET Sort order ("desc" - descending, "asc" - ascending).

    Allowed values: "asc", "desc"

    Success 200

    Field Type Description
    conference Object[]

    templates. List of ObjectConferenceTemplate.

    		 
    HTTP/1.1 200 OK
{
    "templates": [
        {ObjectConferenceTemplate},
        {ObjectConferenceTemplate},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conference Templates | Get Conference Template List

    Read conference template list.
    Returns ObjectConferenceTemplate list.

    get 
    /api/v3.5/templates/conferences

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/templates/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    sort_by optional String

    GET Name of field for object list sorting.

    Allowed values: "name", "created_at", "updated_at", "creator_id"

    sort_type optional String

    GET Sort order ("desc" - descending, "asc" - ascending).

    Allowed values: "asc", "desc"

    Success 200

    Field Type Description
    conference Object[]

    templates. List of ObjectConferenceTemplate.

    		 
    HTTP/1.1 200 OK
{
    "templates": [
        {ObjectConferenceTemplate},
        {ObjectConferenceTemplate},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conference Templates | Get Conference Template List

    Read conference template list.
    Returns ObjectConferenceTemplate list.

    get 
    /api/v3.4/templates/conferences

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/templates/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    sort_by optional String

    GET Name of field for object list sorting.

    Allowed values: "name", "created_at", "updated_at", "creator_id"

    sort_type optional String

    GET Sort order ("desc" - descending, "asc" - ascending).

    Allowed values: "asc", "desc"

    Success 200

    Field Type Description
    conference Object[]

    templates. List of ObjectConferenceTemplate.

    		 
    HTTP/1.1 200 OK
{
    "templates": [
        {ObjectConferenceTemplate},
        {ObjectConferenceTemplate},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conference Templates | Get Conference Template List

    Read conference template list.
    Returns ObjectConferenceTemplate list.

    get 
    /api/v3.3/templates/conferences

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/templates/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    sort_by optional String

    GET Name of field for object list sorting.

    Allowed values: "name", "created_at", "updated_at", "creator_id"

    sort_type optional String

    GET Sort order ("desc" - descending, "asc" - ascending).

    Allowed values: "asc", "desc"

    Success 200

    Field Type Description
    conference Object[]

    templates. List of ObjectConferenceTemplate.

    		 
    HTTP/1.1 200 OK
{
    "templates": [
        {ObjectConferenceTemplate},
        {ObjectConferenceTemplate},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conference Templates | Get Conference Template List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read conference template list.
    Returns ObjectConferenceTemplate list.

    get 
    /api/v3.2/templates/conferences

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/templates/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    sort_by optional String

    GET Name of field for object list sorting.

    Allowed values: "name", "created_at", "updated_at", "creator_id"

    sort_type optional String

    GET Sort order ("desc" - descending, "asc" - ascending).

    Allowed values: "asc", "desc"

    Success 200

    Field Type Description
    conference Object[]

    templates. List of ObjectConferenceTemplate.

    		 
    HTTP/1.1 200 OK
{
    "templates": [
        {ObjectConferenceTemplate},
        {ObjectConferenceTemplate},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conference Templates | Get Conference Template List

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read conference template list.
    Returns ObjectConferenceTemplate list.

    get 
    /api/v3.1/templates/conferences

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/templates/conferences?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    sort_by optional String

    GET Name of field for object list sorting.

    Allowed values: "name", "created_at", "updated_at", "creator_id"

    sort_type optional String

    GET Sort order ("desc" - descending, "asc" - ascending).

    Allowed values: "asc", "desc"

    Success 200

    Field Type Description
    conference Object[]

    templates. List of ObjectConferenceTemplate.

    		 
    HTTP/1.1 200 OK
{
    "templates": [
        {ObjectConferenceTemplate},
        {ObjectConferenceTemplate},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Conference Templates | Get Conference Template

    Read conference template.
    Returns ObjectConferenceTemplate.

    get 
    /api/v3.10/templates/conferences/{{$template_id}}

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Get Conference Template

    Read conference template.
    Returns ObjectConferenceTemplate.

    get 
    /api/v3.9/templates/conferences/{{$template_id}}

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Get Conference Template

    Read conference template.
    Returns ObjectConferenceTemplate.

    get 
    /api/v3.8/templates/conferences/{{$template_id}}

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Get Conference Template

    Read conference template.
    Returns ObjectConferenceTemplate.

    get 
    /api/v3.7/templates/conferences/{{$template_id}}

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Get Conference Template

    Read conference template.
    Returns ObjectConferenceTemplate.

    get 
    /api/v3.6/templates/conferences/{{$template_id}}

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Get Conference Template

    Read conference template.
    Returns ObjectConferenceTemplate.

    get 
    /api/v3.5/templates/conferences/{{$template_id}}

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Get Conference Template

    Read conference template.
    Returns ObjectConferenceTemplate.

    get 
    /api/v3.4/templates/conferences/{{$template_id}}

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Get Conference Template

    Read conference template.
    Returns ObjectConferenceTemplate.

    get 
    /api/v3.3/templates/conferences/{{$template_id}}

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Get Conference Template

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read conference template.
    Returns ObjectConferenceTemplate.

    get 
    /api/v3.2/templates/conferences/{{$template_id}}

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conference Templates | Get Conference Template

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read conference template.
    Returns ObjectConferenceTemplate.

    get 
    /api/v3.1/templates/conferences/{{$template_id}}

    Permission: templates.conferences:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/templates/conferences/{{$template_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    conference Object

    template ObjectConferenceTemplate

    		 
    HTTP/1.1 200 OK
{
    "template": {ObjectConferenceTemplate}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceTemplateNotFound ObjectErrorDetail

    Conference template template_id is not found.

    Conferences Invitations

    Conferences Invitations | Add Invitation

    Add a user into the list of participants invited to the conference.
    To add an invitation you will need to send an object with attributes ObjectInvitation, which are marked with POST tag.
    If you have successfully added invitation, you will get full object ObjectInvitation.

    post 
    /api/v3.10/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    id String

    POST Invited participant ID.

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Add Invitation

    Add a user into the list of participants invited to the conference.
    To add an invitation you will need to send an object with attributes ObjectInvitation, which are marked with POST tag.
    If you have successfully added invitation, you will get full object ObjectInvitation.

    post 
    /api/v3.9/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    id String

    POST Invited participant ID.

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Add Invitation

    Add a user into the list of participants invited to the conference.
    To add an invitation you will need to send an object with attributes ObjectInvitation, which are marked with POST tag.
    If you have successfully added invitation, you will get full object ObjectInvitation.

    post 
    /api/v3.8/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    id String

    POST Invited participant ID.

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Add Invitation

    Add a user into the list of participants invited to the conference.
    To add an invitation you will need to send an object with attributes ObjectInvitation, which are marked with POST tag.
    If you have successfully added invitation, you will get full object ObjectInvitation.

    post 
    /api/v3.7/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    id String

    POST Invited participant ID.

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Add Invitation

    Add a user into the list of participants invited to the conference.
    To add an invitation you will need to send an object with attributes ObjectInvitation, which are marked with POST tag.
    If you have successfully added invitation, you will get full object ObjectInvitation.

    post 
    /api/v3.6/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    id String

    POST Invited participant ID.

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Add Invitation

    Add a user into the list of participants invited to the conference.
    To add an invitation you will need to send an object with attributes ObjectInvitation, which are marked with POST tag.
    If you have successfully added invitation, you will get full object ObjectInvitation.

    post 
    /api/v3.5/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    id String

    POST Invited participant ID.

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Add Invitation

    Add a user into the list of participants invited to the conference.
    To add an invitation you will need to send an object with attributes ObjectInvitation, which are marked with POST tag.
    If you have successfully added invitation, you will get full object ObjectInvitation.

    post 
    /api/v3.4/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    id String

    POST Invited participant ID.

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Add Invitation

    Add a user into the list of participants invited to the conference.
    To add an invitation you will need to send an object with attributes ObjectInvitation, which are marked with POST tag.
    If you have successfully added invitation, you will get full object ObjectInvitation.

    post 
    /api/v3.3/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    id String

    POST Invited participant ID.

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Add Invitation

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Add a user into the list of participants invited to the conference.
    To add an invitation you will need to send an object with attributes ObjectInvitation, which are marked with POST tag.
    If you have successfully added invitation, you will get full object ObjectInvitation.

    post 
    /api/v3.2/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    id String

    POST Invited participant ID.

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Add Invitation

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Add a user into the list of participants invited to the conference.
    To add an invitation you will need to send an object with attributes ObjectInvitation, which are marked with POST tag.
    If you have successfully added invitation, you will get full object ObjectInvitation.

    post 
    /api/v3.1/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    id String

    POST Invited participant ID.

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Add Invitation

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Add a user into the list of participants invited to the conference.
    To add an invitation you will need to send an object with attributes ObjectInvitation, which are marked with POST tag.
    If you have successfully added invitation, you will get full object ObjectInvitation.

    post 
    /api/v3/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    id String

    POST Invited participant ID.

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Delete Invitation

    Remove invitation.
    If you have successfully removed invitation, you will get object ID.

    delete 
    /api/v3.10/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "invitation_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Delete Invitation

    Remove invitation.
    If you have successfully removed invitation, you will get object ID.

    delete 
    /api/v3.9/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "invitation_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Delete Invitation

    Remove invitation.
    If you have successfully removed invitation, you will get object ID.

    delete 
    /api/v3.8/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "invitation_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Delete Invitation

    Remove invitation.
    If you have successfully removed invitation, you will get object ID.

    delete 
    /api/v3.7/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "invitation_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Delete Invitation

    Remove invitation.
    If you have successfully removed invitation, you will get object ID.

    delete 
    /api/v3.6/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "invitation_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Delete Invitation

    Remove invitation.
    If you have successfully removed invitation, you will get object ID.

    delete 
    /api/v3.5/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "invitation_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Delete Invitation

    Remove invitation.
    If you have successfully removed invitation, you will get object ID.

    delete 
    /api/v3.4/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "invitation_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Delete Invitation

    Remove invitation.
    If you have successfully removed invitation, you will get object ID.

    delete 
    /api/v3.3/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "invitation_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Delete Invitation

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Remove invitation.
    If you have successfully removed invitation, you will get object ID.

    delete 
    /api/v3.2/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "invitation_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Delete Invitation

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Remove invitation.
    If you have successfully removed invitation, you will get object ID.

    delete 
    /api/v3.1/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "invitation_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Delete Invitation

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Remove invitation.
    If you have successfully removed invitation, you will get object ID.

    delete 
    /api/v3/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "invitation_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Edit Invitation

    Edit invitation.
    To edit invitation you will need to send an object with attributes ObjectInvitation, which are marked with PUT tag.
    If you have successfully edited invitation, you will get full object. ObjectInvitation.

    put 
    /api/v3.10/conferences/{{$conference_id}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Edit Invitation

    Edit invitation.
    To edit invitation you will need to send an object with attributes ObjectInvitation, which are marked with PUT tag.
    If you have successfully edited invitation, you will get full object. ObjectInvitation.

    put 
    /api/v3.9/conferences/{{$conference_id}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Edit Invitation

    Edit invitation.
    To edit invitation you will need to send an object with attributes ObjectInvitation, which are marked with PUT tag.
    If you have successfully edited invitation, you will get full object. ObjectInvitation.

    put 
    /api/v3.8/conferences/{{$conference_id}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Edit Invitation

    Edit invitation.
    To edit invitation you will need to send an object with attributes ObjectInvitation, which are marked with PUT tag.
    If you have successfully edited invitation, you will get full object. ObjectInvitation.

    put 
    /api/v3.7/conferences/{{$conference_id}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Edit Invitation

    Edit invitation.
    To edit invitation you will need to send an object with attributes ObjectInvitation, which are marked with PUT tag.
    If you have successfully edited invitation, you will get full object. ObjectInvitation.

    put 
    /api/v3.6/conferences/{{$conference_id}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Edit Invitation

    Edit invitation.
    To edit invitation you will need to send an object with attributes ObjectInvitation, which are marked with PUT tag.
    If you have successfully edited invitation, you will get full object. ObjectInvitation.

    put 
    /api/v3.5/conferences/{{$conference_id}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Edit Invitation

    Edit invitation.
    To edit invitation you will need to send an object with attributes ObjectInvitation, which are marked with PUT tag.
    If you have successfully edited invitation, you will get full object. ObjectInvitation.

    put 
    /api/v3.4/conferences/{{$conference_id}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Edit Invitation

    Edit invitation.
    To edit invitation you will need to send an object with attributes ObjectInvitation, which are marked with PUT tag.
    If you have successfully edited invitation, you will get full object. ObjectInvitation.

    put 
    /api/v3.3/conferences/{{$conference_id}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Edit Invitation

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Edit invitation.
    To edit invitation you will need to send an object with attributes ObjectInvitation, which are marked with PUT tag.
    If you have successfully edited invitation, you will get full object. ObjectInvitation.

    put 
    /api/v3.2/conferences/{{$conference_id}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Edit Invitation

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Edit invitation.
    To edit invitation you will need to send an object with attributes ObjectInvitation, which are marked with PUT tag.
    If you have successfully edited invitation, you will get full object. ObjectInvitation.

    put 
    /api/v3.1/conferences/{{$conference_id}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Edit Invitation

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Edit invitation.
    To edit invitation you will need to send an object with attributes ObjectInvitation, which are marked with PUT tag.
    If you have successfully edited invitation, you will get full object. ObjectInvitation.

    put 
    /api/v3/conferences/{{$conference_id}/invitations/{{$invitation_id}}

    Permission: conferences.invitations 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '@ObjectInvitation.json'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    conferenceUnavailableForChange ObjectErrorDetail

    A running conference conference_id unavailable for editing.

    Conferences Invitations | Get Invitation List

    Read the list of conference invitations.
    Returns ObjectInvitation list.

    get 
    /api/v3.10/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitations Object[]

    List of ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitations": [
        {ObjectInvitation},
        {ObjectInvitation},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation List

    Read the list of conference invitations.
    Returns ObjectInvitation list.

    get 
    /api/v3.9/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitations Object[]

    List of ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitations": [
        {ObjectInvitation},
        {ObjectInvitation},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation List

    Read the list of conference invitations.
    Returns ObjectInvitation list.

    get 
    /api/v3.8/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitations Object[]

    List of ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitations": [
        {ObjectInvitation},
        {ObjectInvitation},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation List

    Read the list of conference invitations.
    Returns ObjectInvitation list.

    get 
    /api/v3.7/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitations Object[]

    List of ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitations": [
        {ObjectInvitation},
        {ObjectInvitation},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation List

    Read the list of conference invitations.
    Returns ObjectInvitation list.

    get 
    /api/v3.6/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitations Object[]

    List of ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitations": [
        {ObjectInvitation},
        {ObjectInvitation},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation List

    Read the list of conference invitations.
    Returns ObjectInvitation list.

    get 
    /api/v3.5/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitations Object[]

    List of ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitations": [
        {ObjectInvitation},
        {ObjectInvitation},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation List

    Read the list of conference invitations.
    Returns ObjectInvitation list.

    get 
    /api/v3.4/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitations Object[]

    List of ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitations": [
        {ObjectInvitation},
        {ObjectInvitation},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation List

    Read the list of conference invitations.
    Returns ObjectInvitation list.

    get 
    /api/v3.3/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitations Object[]

    List of ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitations": [
        {ObjectInvitation},
        {ObjectInvitation},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read the list of conference invitations.
    Returns ObjectInvitation list.

    get 
    /api/v3.2/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitations Object[]

    List of ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitations": [
        {ObjectInvitation},
        {ObjectInvitation},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation List

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read the list of conference invitations.
    Returns ObjectInvitation list.

    get 
    /api/v3.1/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitations Object[]

    List of ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitations": [
        {ObjectInvitation},
        {ObjectInvitation},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation List

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Read the list of conference invitations.
    Returns ObjectInvitation list

    get 
    /api/v3/conferences/{{$conference_id}}/invitations

    Permission: conferences.invitations 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/conferences/{{$conference_id}}/invitations?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    invitations Object[]

    List of ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitations": [
        {ObjectInvitation},
        {ObjectInvitation},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation

    Read invitation.
    Returns ObjectInvitation.

    get 
    /api/v3.10/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation

    Read invitation.
    Returns ObjectInvitation.

    get 
    /api/v3.9/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation

    Read invitation.
    Returns ObjectInvitation.

    get 
    /api/v3.8/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation

    Read invitation.
    Returns ObjectInvitation.

    get 
    /api/v3.7/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation

    Read invitation.
    Returns ObjectInvitation.

    get 
    /api/v3.6/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation

    Read invitation.
    Returns ObjectInvitation.

    get 
    /api/v3.5/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation

    Read invitation.
    Returns ObjectInvitation.

    get 
    /api/v3.4/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation

    Read invitation.
    Returns ObjectInvitation.

    get 
    /api/v3.3/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read invitation.
    Returns ObjectInvitation.

    get 
    /api/v3.2/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read invitation.
    Returns ObjectInvitation.

    get 
    /api/v3.1/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations | conferences.invitations:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Invitations | Get Invitation

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Read invitation.
    Returns ObjectInvitation

    get 
    /api/v3/conferences/{{$conference_id}}/invitations/{{$invitation_id}}

    Permission: conferences.invitations 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/conferences/{{$conference_id}}/invitations/{{$invitation_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    invitation Object

    ObjectInvitation.

    		 
    HTTP/1.1 200 OK
{
    "invitation": {ObjectInvitation}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Participants

    Conferences Participants | Get Participant List

    Get the list of active conference participants.
    Returns ObjectParticipant list.

    get 
    /api/v3.10/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participants Object[]

    List of ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participants": [
        {ObjectParticipant},
        {ObjectParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conferences Participants | Get Participant List

    Get the list of active conference participants.
    Returns ObjectParticipant list.

    get 
    /api/v3.9/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participants Object[]

    List of ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participants": [
        {ObjectParticipant},
        {ObjectParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conferences Participants | Get Participant List

    Get the list of active conference participants.
    Returns ObjectParticipant list.

    get 
    /api/v3.8/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participants Object[]

    List of ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participants": [
        {ObjectParticipant},
        {ObjectParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conferences Participants | Get Participant List

    Get the list of active conference participants.
    Returns ObjectParticipant list.

    get 
    /api/v3.7/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participants Object[]

    List of ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participants": [
        {ObjectParticipant},
        {ObjectParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conferences Participants | Get Participant List

    Get the list of active conference participants.
    Returns ObjectParticipant list.

    get 
    /api/v3.6/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participants Object[]

    List of ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participants": [
        {ObjectParticipant},
        {ObjectParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conferences Participants | Get Participant List

    Get the list of active conference participants.
    Returns ObjectParticipant list.

    get 
    /api/v3.5/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participants Object[]

    List of ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participants": [
        {ObjectParticipant},
        {ObjectParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conferences Participants | Get Participant List

    Get the list of active conference participants.
    Returns ObjectParticipant list.

    get 
    /api/v3.4/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participants Object[]

    List of ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participants": [
        {ObjectParticipant},
        {ObjectParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conferences Participants | Get Participant List

    Get the list of active conference participants.
    Returns ObjectParticipant list.

    get 
    /api/v3.3/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participants Object[]

    List of ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participants": [
        {ObjectParticipant},
        {ObjectParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conferences Participants | Get Participant List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Get the list of active conference participants.
    Returns ObjectParticipant list.

    get 
    /api/v3.2/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participants Object[]

    List of ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participants": [
        {ObjectParticipant},
        {ObjectParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conferences Participants | Get Participant List

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Get the list of active conference participants.
    Returns ObjectParticipant list.

    get 
    /api/v3.1/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participants Object[]

    List of ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participants": [
        {ObjectParticipant},
        {ObjectParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conferences Participants | Get Participant List

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Get the list of active conference participants.
    Returns ObjectParticipant list

    get 
    /api/v3/conferences/{{$conference_id}}/participants

    Permission: conferences.participants 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/conferences/{{$conference_id}}/participants?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    participants Object[]

    List of ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participants": [
        {ObjectParticipant},
        {ObjectParticipant},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantNotFound ObjectErrorDetail

    Participant participant_id is not found.

    Conferences Participants | Get Participant

    Read participant.
    Returns ObjectParticipant.

    get 
    /api/v3.10/conferences/{{$conference_id}}/participants/{{$participant_id}}

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Participants | Get Participant

    Read participant.
    Returns ObjectParticipant.

    get 
    /api/v3.9/conferences/{{$conference_id}}/participants/{{$participant_id}}

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Participants | Get Participant

    Read participant.
    Returns ObjectParticipant.

    get 
    /api/v3.8/conferences/{{$conference_id}}/participants/{{$participant_id}}

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Participants | Get Participant

    Read participant.
    Returns ObjectParticipant.

    get 
    /api/v3.7/conferences/{{$conference_id}}/participants/{{$participant_id}}

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Participants | Get Participant

    Read participant.
    Returns ObjectParticipant.

    get 
    /api/v3.6/conferences/{{$conference_id}}/participants/{{$participant_id}}

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Participants | Get Participant

    Read participant.
    Returns ObjectParticipant.

    get 
    /api/v3.5/conferences/{{$conference_id}}/participants/{{$participant_id}}

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Participants | Get Participant

    Read participant.
    Returns ObjectParticipant.

    get 
    /api/v3.4/conferences/{{$conference_id}}/participants/{{$participant_id}}

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Participants | Get Participant

    Read participant.
    Returns ObjectParticipant.

    get 
    /api/v3.3/conferences/{{$conference_id}}/participants/{{$participant_id}}

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Participants | Get Participant

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read participant.
    Returns ObjectParticipant.

    get 
    /api/v3.2/conferences/{{$conference_id}}/participants/{{$participant_id}}

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Participants | Get Participant

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read participant.
    Returns ObjectParticipant.

    get 
    /api/v3.1/conferences/{{$conference_id}}/participants/{{$participant_id}}

    Permission: conferences.participants | conferences.participants:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/participants/{{$participant_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Participants | Invite Participant

    Invite user to the conference.
    Returns ObjectParticipant.

    post 
    /api/v3.10/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/participants?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"participant_id":"user_id1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantIsUnavailable ObjectErrorDetail

    Participant participant_id is unavailable.
    participantAlreadyInConference ObjectErrorDetail

    Participant participant_id already in conference.

    Conferences Participants | Invite Participant

    Invite user to the conference.
    Returns ObjectParticipant.

    post 
    /api/v3.9/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/participants?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"participant_id":"user_id1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantIsUnavailable ObjectErrorDetail

    Participant participant_id is unavailable.
    participantAlreadyInConference ObjectErrorDetail

    Participant participant_id already in conference.

    Conferences Participants | Invite Participant

    Invite user to the conference.
    Returns ObjectParticipant.

    post 
    /api/v3.8/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/participants?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"participant_id":"user_id1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantIsUnavailable ObjectErrorDetail

    Participant participant_id is unavailable.
    participantAlreadyInConference ObjectErrorDetail

    Participant participant_id already in conference.

    Conferences Participants | Invite Participant

    Invite user to the conference.
    Returns ObjectParticipant.

    post 
    /api/v3.7/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/participants?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"participant_id":"user_id1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantIsUnavailable ObjectErrorDetail

    Participant participant_id is unavailable.
    participantAlreadyInConference ObjectErrorDetail

    Participant participant_id already in conference.

    Conferences Participants | Invite Participant

    Invite user to the conference.
    Returns ObjectParticipant.

    post 
    /api/v3.6/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/participants?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"participant_id":"user_id1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantIsUnavailable ObjectErrorDetail

    Participant participant_id is unavailable.
    participantAlreadyInConference ObjectErrorDetail

    Participant participant_id already in conference.

    Conferences Participants | Invite Participant

    Invite user to the conference.
    Returns ObjectParticipant.

    post 
    /api/v3.5/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/participants?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"participant_id":"user_id1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantIsUnavailable ObjectErrorDetail

    Participant participant_id is unavailable.
    participantAlreadyInConference ObjectErrorDetail

    Participant participant_id already in conference.

    Conferences Participants | Invite Participant

    Invite user to the conference.
    Returns ObjectParticipant.

    post 
    /api/v3.4/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/participants?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"participant_id":"user_id1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantIsUnavailable ObjectErrorDetail

    Participant participant_id is unavailable.
    participantAlreadyInConference ObjectErrorDetail

    Participant participant_id already in conference.

    Conferences Participants | Invite Participant

    Invite user to the conference.
    Returns ObjectParticipant.

    post 
    /api/v3.3/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/participants?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"participant_id":"user_id1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantIsUnavailable ObjectErrorDetail

    Participant participant_id is unavailable.
    participantAlreadyInConference ObjectErrorDetail

    Participant participant_id already in conference.

    Conferences Participants | Invite Participant

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Invite user to the conference.
    Returns ObjectParticipant.

    post 
    /api/v3.2/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/participants?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"participant_id":"user_id1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantIsUnavailable ObjectErrorDetail

    Participant participant_id is unavailable.
    participantAlreadyInConference ObjectErrorDetail

    Participant participant_id already in conference.

    Conferences Participants | Invite Participant

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Invite user to the conference.
    Returns ObjectParticipant.

    post 
    /api/v3.1/conferences/{{$conference_id}}/participants

    Permission: conferences.participants | conferences.participants:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/participants?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"participant_id":"user_id1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantIsUnavailable ObjectErrorDetail

    Participant participant_id is unavailable.
    participantAlreadyInConference ObjectErrorDetail

    Participant participant_id already in conference.

    Conferences Participants | Invite Participant

    DEPRECATED Use version 3.1 of this endpoint (or above). Returns ObjectParticipant

    Invite user to the conference.

    post 
    /api/v3/conferences/{{$conference_id}}/participants

    Permission: conferences.participants 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3/conferences/{{$conference_id}}/participants?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"participant_id":"user_id1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    participant_id String

    POST Invited participant ID.

    Success 200

    Field Type Description
    participant Object

    ObjectParticipant.

    		 
    HTTP/1.1 200 OK
{
    "participant": {ObjectParticipant}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    participantIsUnavailable ObjectErrorDetail

    Participant participant_id is unavailable.
    participantAlreadyInConference ObjectErrorDetail

    Participant participant_id already in conference.

    Conferences Records

    Conferences Records | Download Record

    Download conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.10/conferences/{{$conference_id}}/records/{{$record_id}}/download

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/records/{{$record_id}}/download?access_token={{$access_token}}'

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Download Record

    Download conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.9/conferences/{{$conference_id}}/records/{{$record_id}}/download

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/records/{{$record_id}}/download?access_token={{$access_token}}'

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Download Record

    Download conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.8/conferences/{{$conference_id}}/records/{{$record_id}}/download

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/records/{{$record_id}}/download?access_token={{$access_token}}'

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Download Record

    Download conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.7/conferences/{{$conference_id}}/records/{{$record_id}}/download

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/records/{{$record_id}}/download?access_token={{$access_token}}'

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Download Record

    Download conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.6/conferences/{{$conference_id}}/records/{{$record_id}}/download

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/records/{{$record_id}}/download?access_token={{$access_token}}'

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Download Record

    Download conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.5/conferences/{{$conference_id}}/records/{{$record_id}}/download

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/records/{{$record_id}}/download?access_token={{$access_token}}'

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Download Record

    Download conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.4/conferences/{{$conference_id}}/records/{{$record_id}}/download

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/records/{{$record_id}}/download?access_token={{$access_token}}'

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Download Record

    Download conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.3/conferences/{{$conference_id}}/records/{{$record_id}}/download

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/records/{{$record_id}}/download?access_token={{$access_token}}'

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Download Record

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Download conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.2/conferences/{{$conference_id}}/records/{{$record_id}}/download

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/records/{{$record_id}}/download?access_token={{$access_token}}'

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Download Record

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Download conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.1/conferences/{{$conference_id}}/records/{{$record_id}}/download

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/records/{{$record_id}}/download?access_token={{$access_token}}'

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Download Record

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Download conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3/conferences/{{$conference_id}}/records/{{$record_id}}/download
    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/conferences/{{$conference_id}}/records/{{$record_id}}/download?access_token={{$access_token}}'

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Get Record List

    Get information about conference recordings.

    get 
    /api/v3.10/conferences/{{$conference_id}}/records

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    records Object[]

    List of ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "records": [
        {ObjectRecord},
        {ObjectRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Records | Get Record List

    Get information about conference recordings.

    get 
    /api/v3.9/conferences/{{$conference_id}}/records

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    records Object[]

    List of ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "records": [
        {ObjectRecord},
        {ObjectRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Records | Get Record List

    Get information about conference recordings.

    get 
    /api/v3.8/conferences/{{$conference_id}}/records

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    records Object[]

    List of ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "records": [
        {ObjectRecord},
        {ObjectRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Records | Get Record List

    Get information about conference recordings.

    get 
    /api/v3.7/conferences/{{$conference_id}}/records

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    records Object[]

    List of ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "records": [
        {ObjectRecord},
        {ObjectRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Records | Get Record List

    Get information about conference recordings.

    get 
    /api/v3.6/conferences/{{$conference_id}}/records

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    records Object[]

    List of ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "records": [
        {ObjectRecord},
        {ObjectRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Records | Get Record List

    Get information about conference recordings.

    get 
    /api/v3.5/conferences/{{$conference_id}}/records

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    records Object[]

    List of ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "records": [
        {ObjectRecord},
        {ObjectRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Records | Get Record List

    Get information about conference recordings.

    get 
    /api/v3.4/conferences/{{$conference_id}}/records

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    records Object[]

    List of ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "records": [
        {ObjectRecord},
        {ObjectRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Records | Get Record List

    Get information about conference recordings.

    get 
    /api/v3.3/conferences/{{$conference_id}}/records

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    records Object[]

    List of ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "records": [
        {ObjectRecord},
        {ObjectRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Records | Get Record List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Get information about conference recordings.

    get 
    /api/v3.2/conferences/{{$conference_id}}/records

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    records Object[]

    List of ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "records": [
        {ObjectRecord},
        {ObjectRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Records | Get Record List

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Get information about conference recordings.

    get 
    /api/v3.1/conferences/{{$conference_id}}/records

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    records Object[]

    List of ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "records": [
        {ObjectRecord},
        {ObjectRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Records | Get Record List

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Get information about conference recordings.

    get 
    /api/v3/conferences/{{$conference_id}}/records
    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/conferences/{{$conference_id}}/records?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    records Object[]

    List of ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "records": [
        {ObjectRecord},
        {ObjectRecord},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.

    Conferences Records | Get Record

    Get information about the conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.10/conferences/{{$conference_id}}/records/{{$record_id}}

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/conferences/{{$conference_id}}/records/{{$record_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    record Object

    ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "record": {ObjectRecord}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Get Record

    Get information about the conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.9/conferences/{{$conference_id}}/records/{{$record_id}}

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/conferences/{{$conference_id}}/records/{{$record_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    record Object

    ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "record": {ObjectRecord}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Get Record

    Get information about the conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.8/conferences/{{$conference_id}}/records/{{$record_id}}

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/conferences/{{$conference_id}}/records/{{$record_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    record Object

    ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "record": {ObjectRecord}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Get Record

    Get information about the conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.7/conferences/{{$conference_id}}/records/{{$record_id}}

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/conferences/{{$conference_id}}/records/{{$record_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    record Object

    ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "record": {ObjectRecord}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Get Record

    Get information about the conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.6/conferences/{{$conference_id}}/records/{{$record_id}}

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/conferences/{{$conference_id}}/records/{{$record_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    record Object

    ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "record": {ObjectRecord}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Get Record

    Get information about the conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.5/conferences/{{$conference_id}}/records/{{$record_id}}

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/conferences/{{$conference_id}}/records/{{$record_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    record Object

    ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "record": {ObjectRecord}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Get Record

    Get information about the conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.4/conferences/{{$conference_id}}/records/{{$record_id}}

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/conferences/{{$conference_id}}/records/{{$record_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    record Object

    ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "record": {ObjectRecord}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Get Record

    Get information about the conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.3/conferences/{{$conference_id}}/records/{{$record_id}}

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/conferences/{{$conference_id}}/records/{{$record_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    record Object

    ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "record": {ObjectRecord}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Get Record

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Get information about the conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.2/conferences/{{$conference_id}}/records/{{$record_id}}

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/conferences/{{$conference_id}}/records/{{$record_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    record Object

    ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "record": {ObjectRecord}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Get Record

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Get information about the conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3.1/conferences/{{$conference_id}}/records/{{$record_id}}

    Permission: conferences.records | conferences.records:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/conferences/{{$conference_id}}/records/{{$record_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    record Object

    ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "record": {ObjectRecord}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Conferences Records | Get Record

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Get information about the conference recording. {{$record_id}} should be the value of a "name" property in ObjectRecord.

    get 
    /api/v3/conferences/{{$conference_id}}/records/{{$record_id}}
    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/conferences/{{$conference_id}}/records/{{$record_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    record Object

    ObjectRecord.

    		 
    HTTP/1.1 200 OK
{
    "record": {ObjectRecord}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    conferenceNotFound ObjectErrorDetail

    Conference conference_id is not found.
    recordNotFound ObjectErrorDetail

    Record record_id is not found.

    Groups Users

    Groups Users | Add User

    Add a user into the group.
    To add user to the group you will need to send user_id.
    If the user has been successfully added to the group, you will get full object ObjectUser.

    post 
    /api/v3.10/groups/{{$group_id}}/users

    Permission: groups.users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.10/groups/{{$group_id}}/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"user_id": "user1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Add User

    Add a user into the group.
    To add user to the group you will need to send user_id.
    If the user has been successfully added to the group, you will get full object ObjectUser.

    post 
    /api/v3.9/groups/{{$group_id}}/users

    Permission: groups.users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.9/groups/{{$group_id}}/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"user_id": "user1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Add User

    Add a user into the group.
    To add user to the group you will need to send user_id.
    If the user has been successfully added to the group, you will get full object ObjectUser.

    post 
    /api/v3.8/groups/{{$group_id}}/users

    Permission: groups.users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.8/groups/{{$group_id}}/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"user_id": "user1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Add User

    Add a user into the group.
    To add user to the group you will need to send user_id.
    If the user has been successfully added to the group, you will get full object ObjectUser.

    post 
    /api/v3.7/groups/{{$group_id}}/users

    Permission: groups.users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.7/groups/{{$group_id}}/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"user_id": "user1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Add User

    Add a user into the group.
    To add user to the group you will need to send user_id.
    If the user has been successfully added to the group, you will get full object ObjectUser.

    post 
    /api/v3.6/groups/{{$group_id}}/users

    Permission: groups.users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.6/groups/{{$group_id}}/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"user_id": "user1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Add User

    Add a user into the group.
    To add user to the group you will need to send user_id.
    If the user has been successfully added to the group, you will get full object ObjectUser.

    post 
    /api/v3.5/groups/{{$group_id}}/users

    Permission: groups.users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.5/groups/{{$group_id}}/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"user_id": "user1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Add User

    Add a user into the group.
    To add user to the group you will need to send user_id.
    If the user has been successfully added to the group, you will get full object ObjectUser.

    post 
    /api/v3.4/groups/{{$group_id}}/users

    Permission: groups.users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.4/groups/{{$group_id}}/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"user_id": "user1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Add User

    Add a user into the group.
    To add user to the group you will need to send user_id.
    If the user has been successfully added to the group, you will get full object ObjectUser.

    post 
    /api/v3.3/groups/{{$group_id}}/users

    Permission: groups.users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.3/groups/{{$group_id}}/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"user_id": "user1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Add User

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Add a user into the group.
    To add user to the group you will need to send user_id.
    If the user has been successfully added to the group, you will get full object ObjectUser.

    post 
    /api/v3.2/groups/{{$group_id}}/users

    Permission: groups.users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.2/groups/{{$group_id}}/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"user_id": "user1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Add User

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Add a user into the group.
    To add user to the group you will need to send user_id.
    If the user has been successfully added to the group, you will get full object ObjectUser.

    post 
    /api/v3.1/groups/{{$group_id}}/users

    Permission: groups.users:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.1/groups/{{$group_id}}/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"user_id": "user1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Add User

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Add a user into the group.
    To add user to the group you will need to send user_id.
    If the user has been successfully added to the group, you will get full object ObjectUser.

    post 
    /api/v3/groups/{{$group_id}}/users

    Permission: groups.users 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3/groups/{{$group_id}}/users?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"user_id": "user1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Delete User

    Remove user from the group.
    If the user has been removed successfully, you will get object ID.

    delete 
    /api/v3.10/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user.

    		 
    HTTP/1.1 200 OK
{
    "id": "user_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Delete User

    Remove user from the group.
    If the user has been removed successfully, you will get object ID.

    delete 
    /api/v3.9/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user.

    		 
    HTTP/1.1 200 OK
{
    "id": "user_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Delete User

    Remove user from the group.
    If the user has been removed successfully, you will get object ID.

    delete 
    /api/v3.8/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user.

    		 
    HTTP/1.1 200 OK
{
    "id": "user_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Delete User

    Remove user from the group.
    If the user has been removed successfully, you will get object ID.

    delete 
    /api/v3.7/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user.

    		 
    HTTP/1.1 200 OK
{
    "id": "user_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Delete User

    Remove user from the group.
    If the user has been removed successfully, you will get object ID.

    delete 
    /api/v3.6/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user.

    		 
    HTTP/1.1 200 OK
{
    "id": "user_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Delete User

    Remove user from the group.
    If the user has been removed successfully, you will get object ID.

    delete 
    /api/v3.5/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user.

    		 
    HTTP/1.1 200 OK
{
    "id": "user_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Delete User

    Remove user from the group.
    If the user has been removed successfully, you will get object ID.

    delete 
    /api/v3.4/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user.

    		 
    HTTP/1.1 200 OK
{
    "id": "user_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Delete User

    Remove user from the group.
    If the user has been removed successfully, you will get object ID.

    delete 
    /api/v3.3/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user.

    		 
    HTTP/1.1 200 OK
{
    "id": "user_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Delete User

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Remove user from the group.
    If the user has been removed successfully, you will get object ID.

    delete 
    /api/v3.2/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user.

    		 
    HTTP/1.1 200 OK
{
    "id": "user_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Delete User

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Remove user from the group.
    If the user has been removed successfully, you will get object ID.

    delete 
    /api/v3.1/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user.

    		 
    HTTP/1.1 200 OK
{
    "id": "user_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Delete User

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Remove user from the group.
    If the user has been removed successfully, you will get object ID.

    delete 
    /api/v3/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of user

    		 
    HTTP/1.1 200 OK
{
    "id": "user_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Get User List

    Get group user list.
    Returns ObjectUser list.

    get 
    /api/v3.10/groups/{{$group_id}}/users

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/groups/{{$group_id}}/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups Users | Get User List

    Get group user list.
    Returns ObjectUser list.

    get 
    /api/v3.9/groups/{{$group_id}}/users

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/groups/{{$group_id}}/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups Users | Get User List

    Get group user list.
    Returns ObjectUser list.

    get 
    /api/v3.8/groups/{{$group_id}}/users

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/groups/{{$group_id}}/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups Users | Get User List

    Get group user list.
    Returns ObjectUser list.

    get 
    /api/v3.7/groups/{{$group_id}}/users

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/groups/{{$group_id}}/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups Users | Get User List

    Get group user list.
    Returns ObjectUser list.

    get 
    /api/v3.6/groups/{{$group_id}}/users

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/groups/{{$group_id}}/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups Users | Get User List

    Get group user list.
    Returns ObjectUser list.

    get 
    /api/v3.5/groups/{{$group_id}}/users

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/groups/{{$group_id}}/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups Users | Get User List

    Get group user list.
    Returns ObjectUser list.

    get 
    /api/v3.4/groups/{{$group_id}}/users

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/groups/{{$group_id}}/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups Users | Get User List

    Get group user list.
    Returns ObjectUser list.

    get 
    /api/v3.3/groups/{{$group_id}}/users

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/groups/{{$group_id}}/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups Users | Get User List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Get group user list.
    Returns ObjectUser list.

    get 
    /api/v3.2/groups/{{$group_id}}/users

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/groups/{{$group_id}}/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups Users | Get User List

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Get group user list.
    Returns ObjectUser list.

    get 
    /api/v3.1/groups/{{$group_id}}/users

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/groups/{{$group_id}}/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups Users | Get User List

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Get group user list.
    Returns ObjectUser list

    get 
    /api/v3/groups/{{$group_id}}/users

    Permission: groups.users 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/groups/{{$group_id}}/users?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    login_name optional String

    GET Filter by Login Name.
    display_name optional String

    GET Filter by Display Name.
    first_name optional String

    GET Filter by First Name.
    last_name optional String

    GET Filter by Last Name.
    email optional String

    GET Filter by Email Name.

    Success 200

    Field Type Description
    users Object[]

    List of ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "users": [
        {ObjectUser},
        {ObjectUser},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.

    Groups Users | Get User

    Get group user.
    Returns ObjectUser.

    get 
    /api/v3.10/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Get User

    Get group user.
    Returns ObjectUser.

    get 
    /api/v3.9/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Get User

    Get group user.
    Returns ObjectUser.

    get 
    /api/v3.8/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Get User

    Get group user.
    Returns ObjectUser.

    get 
    /api/v3.7/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Get User

    Get group user.
    Returns ObjectUser.

    get 
    /api/v3.6/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Get User

    Get group user.
    Returns ObjectUser.

    get 
    /api/v3.5/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Get User

    Get group user.
    Returns ObjectUser.

    get 
    /api/v3.4/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Get User

    Get group user.
    Returns ObjectUser.

    get 
    /api/v3.3/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Get User

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Get group user.
    Returns ObjectUser.

    get 
    /api/v3.2/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Get User

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Get group user.
    Returns ObjectUser.

    get 
    /api/v3.1/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users | groups.users:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Groups Users | Get User

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Get group user.
    Returns ObjectUser

    get 
    /api/v3/groups/{{$group_id}}/users/{{$user_id}}

    Permission: groups.users 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/groups/{{$group_id}}/users/{{$user_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    user Object

    ObjectUser.

    		 
    HTTP/1.1 200 OK
{
    "user": {ObjectUser}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    groupNotFound ObjectErrorDetail

    Group conference_id is not found.
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Software Clients

    Software Clients | Get Client List

    Read client applications list. Returns Client object list.

    get 
    /api/v3.10/software/clients

    Permission: any 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/software/clients?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    call_id optional String

    GET Conference ID for creating join URLs.
    access_token String

    GET Secret key used to access API.
    user optional String

    GET User ID. It generates authentication details for the user indicated.
    Available formats:

    • user=user1 - receives authorization parameters for the server user with user1 username.
    • user=$Alexander - receives authorization parameters for the guest with Alexander username and random user ID.
    • user=2$guest_id*Alexander - receives authorization parameters for the guest with Alexander username and #guest2:guest_id@server.name user ID.
    case optional String

    GET Case name to generate deeplinks.

    Default value: download

    Allowed values: "download", "join_conference_button", "join_conference_roaming"

    lang optional String

    GET Lang param to generate Web server links.

    Default value: en

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he

    Success 200

    Field Type Description
       Object[]

    List of Client object.

    		 
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&encrypt=0",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Software Clients | Get Client List

    Read client applications list. Returns Client object list.

    get 
    /api/v3.9/software/clients

    Permission: any 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/software/clients?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    call_id optional String

    GET Conference ID for creating join URLs.
    access_token String

    GET Secret key used to access API.
    user optional String

    GET User ID. It generates authentication details for the user indicated.
    Available formats:

    • user=user1 - receives authorization parameters for the server user with user1 username.
    • user=$Alexander - receives authorization parameters for the guest with Alexander username and random user ID.
    • user=2$guest_id*Alexander - receives authorization parameters for the guest with Alexander username and #guest2:guest_id@server.name user ID.
    case optional String

    GET Case name to generate deeplinks.

    Default value: download

    Allowed values: "download", "join_conference_button", "join_conference_roaming"

    lang optional String

    GET Lang param to generate Web server links.

    Default value: en

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he

    Success 200

    Field Type Description
       Object[]

    List of Client object.

    		 
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&encrypt=0",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Software Clients | Get Client List

    Read client applications list. Returns Client object list.

    get 
    /api/v3.8/software/clients

    Permission: any 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/software/clients?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    call_id optional String

    GET Conference ID for creating join URLs.
    access_token String

    GET Secret key used to access API.
    user optional String

    GET User ID. It generates authentication details for the user indicated.
    Available formats:

    • user=user1 - receives authorization parameters for the server user with user1 username.
    • user=$Alexander - receives authorization parameters for the guest with Alexander username and random user ID.
    • user=2$guest_id*Alexander - receives authorization parameters for the guest with Alexander username and #guest2:guest_id@server.name user ID.
    case optional String

    GET Case name to generate deeplinks.

    Default value: download

    Allowed values: "download", "join_conference_button", "join_conference_roaming"

    lang optional String

    GET Lang param to generate Web server links.

    Default value: en

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he

    Success 200

    Field Type Description
       Object[]

    List of Client object.

    		 
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&encrypt=0",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Software Clients | Get Client List

    Read client applications list. Returns Client object list.

    get 
    /api/v3.7/software/clients

    Permission: any 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/software/clients?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    call_id optional String

    GET Conference ID for creating join URLs.
    access_token String

    GET Secret key used to access API.
    user optional String

    GET User ID. It generates authentication details for the user indicated.
    Available formats:

    • user=user1 - receives authorization parameters for the server user with user1 username.
    • user=$Alexander - receives authorization parameters for the guest with Alexander username and random user ID.
    • user=2$guest_id*Alexander - receives authorization parameters for the guest with Alexander username and #guest2:guest_id@server.name user ID.
    case optional String

    GET Case name to generate deeplinks.

    Default value: download

    Allowed values: "download", "join_conference_button", "join_conference_roaming"

    lang optional String

    GET Lang param to generate Web server links.

    Default value: en

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he

    Success 200

    Field Type Description
       Object[]

    List of Client object.

    		 
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&encrypt=0",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Software Clients | Get Client List

    Read client applications list. Returns Client object list.

    get 
    /api/v3.6/software/clients

    Permission: any 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/software/clients?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    call_id optional String

    GET Conference ID for creating join URLs.
    access_token String

    GET Secret key used to access API.
    user optional String

    GET User ID. It generates authentication details for the user indicated.
    Available formats:

    • user=user1 - receives authorization parameters for the server user with user1 username.
    • user=$Alexander - receives authorization parameters for the guest with Alexander username and random user ID.
    • user=2$guest_id*Alexander - receives authorization parameters for the guest with Alexander username and #guest2:guest_id@server.name user ID.
    case optional String

    GET Case name to generate deeplinks.

    Default value: download

    Allowed values: "download", "join_conference_button", "join_conference_roaming"

    lang optional String

    GET Lang param to generate Web server links.

    Default value: en

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he

    Success 200

    Field Type Description
       Object[]

    List of Client object.

    		 
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&encrypt=0",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Software Clients | Get Client List

    Read client applications list. Returns Client object list.

    get 
    /api/v3.5/software/clients

    Permission: any 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/software/clients?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    call_id optional String

    GET Conference ID for creating join URLs.
    access_token String

    GET Secret key used to access API.
    user optional String

    GET User ID. It generates authentication details for the user indicated.
    Available formats:

    • user=user1 - receives authorization parameters for the server user with user1 username.
    • user=$Alexander - receives authorization parameters for the guest with Alexander username and random user ID.
    • user=2$guest_id*Alexander - receives authorization parameters for the guest with Alexander username and #guest2:guest_id@server.name user ID.
    case optional String

    GET Case name to generate deeplinks.

    Default value: download

    Allowed values: "download", "join_conference_button", "join_conference_roaming"

    lang optional String

    GET Lang param to generate Web server links.

    Default value: en

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he

    Success 200

    Field Type Description
       Object[]

    List of Client object.

    		 
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&encrypt=0",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Software Clients | Get Client List

    Read client applications list. Returns Client object list.

    get 
    /api/v3.4/software/clients

    Permission: any 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/software/clients?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    call_id optional String

    GET Conference ID for creating join URLs.
    access_token String

    GET Secret key used to access API.
    user optional String

    GET User ID. It generates authentication details for the user indicated.
    Available formats:

    • user=user1 - receives authorization parameters for the server user with user1 username.
    • user=$Alexander - receives authorization parameters for the guest with Alexander username and random user ID.
    • user=2$guest_id*Alexander - receives authorization parameters for the guest with Alexander username and #guest2:guest_id@server.name user ID.
    case optional String

    GET Case name to generate deeplinks.

    Default value: download

    Allowed values: "download", "join_conference_button", "join_conference_roaming"

    lang optional String

    GET Lang param to generate Web server links.

    Default value: en

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he

    Success 200

    Field Type Description
       Object[]

    List of Client object.

    		 
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&encrypt=0",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Software Clients | Get Client List

    Read client applications list. Returns Client object list.

    get 
    /api/v3.3/software/clients

    Permission: any 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/software/clients?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    call_id optional String

    GET Conference ID for creating join URLs.
    access_token String

    GET Secret key used to access API.
    user optional String

    GET User ID. It generates authentication details for the user indicated.
    Available formats:

    • user=user1 - receives authorization parameters for the server user with user1 username.
    • user=$Alexander - receives authorization parameters for the guest with Alexander username and random user ID.
    • user=2$guest_id*Alexander - receives authorization parameters for the guest with Alexander username and #guest2:guest_id@server.name user ID.
    case optional String

    GET Case name to generate deeplinks.

    Default value: download

    Allowed values: "download", "join_conference_button", "join_conference_roaming"

    lang optional String

    GET Lang param to generate Web server links.

    Default value: en

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he

    Success 200

    Field Type Description
       Object[]

    List of Client object.

    		 
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&encrypt=0",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Software Clients | Get Client List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Read client applications list. Returns Client object list.

    get 
    /api/v3.2/software/clients

    Permission: any 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/software/clients?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    call_id optional String

    GET Conference ID for creating join URLs.
    access_token String

    GET Secret key used to access API.
    user optional String

    GET User ID. It generates authentication details for the user indicated.
    Available formats:

    • user=user1 - receives authorization parameters for the server user with user1 username.
    • user=$Alexander - receives authorization parameters for the guest with Alexander username and random user ID.
    • user=2$guest_id*Alexander - receives authorization parameters for the guest with Alexander username and #guest2:guest_id@server.name user ID.
    case optional String

    GET Case name to generate deeplinks.

    Default value: download

    Allowed values: "download", "join_conference_button", "join_conference_roaming"

    lang optional String

    GET Lang param to generate Web server links.

    Default value: en

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he

    Success 200

    Field Type Description
       Object[]

    List of Client object.

    		 
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&encrypt=0",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Software Clients | Get Client List

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Read client applications list. Returns Client object list.

    get 
    /api/v3.1/software/clients

    Permission: any 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/software/clients?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    call_id optional String

    GET Conference ID for creating join URLs.
    access_token String

    GET Secret key used to access API.
    user optional String

    GET User ID. It generates authentication details for the user indicated.
    Available formats:

    • user=user1 - receives authorization parameters for the server user with user1 username.
    • user=$Alexander - receives authorization parameters for the guest with Alexander username and random user ID.
    • user=2$guest_id*Alexander - receives authorization parameters for the guest with Alexander username and #guest2:guest_id@server.name user ID.
    case optional String

    GET Case name to generate deeplinks.

    Default value: download

    Allowed values: "download", "join_conference_button", "join_conference_roaming"

    lang optional String

    GET Lang param to generate Web server links.

    Default value: en

    Allowed values: ru, de, es, fa, fr, it, ja, cs, pl, pt, ko, uk, vi, zh, zht, tr, he

    Success 200

    Field Type Description
       Object[]

    List of Client object.

    		 
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&encrypt=0",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Software Clients | Get Client List

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Read client applications list. Returns Client object list

    get 
    /api/v3/software/clients
    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/software/clients?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    call_id optional String

    GET Conference ID for creating join URLs.
    access_token String

    GET Secret key used to access API.
    user optional String

    GET User ID. It generates authentication details for the user indicated.
    Available formats:

    • user=user1 - receives authorization parameters for the server user with user1 username.
    • user=$Alexander - receives authorization parameters for the guest with Alexander username and random user ID
    • user=$guest_id*Alexander - receives authorization parameters for the guest with Alexander username and #guest2:guest_id@server.name user ID.

    Success 200

    Field Type Description
       Object[]

    List of Client object.

    		 
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&encrypt=0",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}
    HTTP/1.1 200 OK
{
    "clients": [
        {ObjectClient},
        {ObjectClient},
        ...
    ],
    "deeplinks": [
        "default": "trueconf:{conference_id}@{server_name}%23vcs&conftype=multi&h={host_ip}&login={user_login}&password={user_temporary_password}&encrypt=0&force=1",
        "android": "intent:{conference_id}%40{server_name}%23vcs%26conftype%3dmulti%26h%3d{host_ip}%26login={user_login}&password={user_temporary_password}%26encrypt%3d0%26force%3d1#Intent;scheme=visicall;package=com.trueconf.videochat;end"
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden

    Users Contacts

    Users Contacts | Add Contact

    Add a contact to the user address book.
    To add a contact you will need to send an object with attributes ObjectContact, which are marked with POST tag.
    If the contact has been added successfully, you will get full object ObjectContact.

    post 
    /api/v3.10/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.10/users/{{$user_id}}/addressbook?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Add Contact

    Add a contact to the user address book.
    To add a contact you will need to send an object with attributes ObjectContact, which are marked with POST tag.
    If the contact has been added successfully, you will get full object ObjectContact.

    post 
    /api/v3.9/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.9/users/{{$user_id}}/addressbook?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Add Contact

    Add a contact to the user address book.
    To add a contact you will need to send an object with attributes ObjectContact, which are marked with POST tag.
    If the contact has been added successfully, you will get full object ObjectContact.

    post 
    /api/v3.8/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.8/users/{{$user_id}}/addressbook?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Add Contact

    Add a contact to the user address book.
    To add a contact you will need to send an object with attributes ObjectContact, which are marked with POST tag.
    If the contact has been added successfully, you will get full object ObjectContact.

    post 
    /api/v3.7/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.7/users/{{$user_id}}/addressbook?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Add Contact

    Add a contact to the user address book.
    To add a contact you will need to send an object with attributes ObjectContact, which are marked with POST tag.
    If the contact has been added successfully, you will get full object ObjectContact.

    post 
    /api/v3.6/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.6/users/{{$user_id}}/addressbook?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Add Contact

    Add a contact to the user address book.
    To add a contact you will need to send an object with attributes ObjectContact, which are marked with POST tag.
    If the contact has been added successfully, you will get full object ObjectContact.

    post 
    /api/v3.5/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.5/users/{{$user_id}}/addressbook?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Add Contact

    Add a contact to the user address book.
    To add a contact you will need to send an object with attributes ObjectContact, which are marked with POST tag.
    If the contact has been added successfully, you will get full object ObjectContact.

    post 
    /api/v3.4/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.4/users/{{$user_id}}/addressbook?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Add Contact

    Add a contact to the user address book.
    To add a contact you will need to send an object with attributes ObjectContact, which are marked with POST tag.
    If the contact has been added successfully, you will get full object ObjectContact.

    post 
    /api/v3.3/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.3/users/{{$user_id}}/addressbook?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Add Contact

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Add a contact to the user address book.
    To add a contact you will need to send an object with attributes ObjectContact, which are marked with POST tag.
    If the contact has been added successfully, you will get full object ObjectContact.

    post 
    /api/v3.2/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.2/users/{{$user_id}}/addressbook?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Add Contact

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Add a contact to the user address book.
    To add a contact you will need to send an object with attributes ObjectContact, which are marked with POST tag.
    If the contact has been added successfully, you will get full object ObjectContact.

    post 
    /api/v3.1/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:write 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3.1/users/{{$user_id}}/addressbook?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Add Contact

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Add a contact to the user address book.
    To add a contact you will need to send an object with attributes ObjectContact, which are marked with POST tag.
    If the contact has been added successfully, you will get full object ObjectContact.

    post 
    /api/v3/users/{{$user_id}}/addressbook

    Permission: users.addressbook 

    curl --request POST \
    --url 'https://{{$server_name}}/api/v3/users/{{$user_id}}/addressbook?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Delete Contact

    Remove contacts from the address book .
    If the contact has been removed successfully, you will get an object ID.

    delete 
    /api/v3.10/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "contact_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Delete Contact

    Remove contacts from the address book .
    If the contact has been removed successfully, you will get an object ID.

    delete 
    /api/v3.9/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "contact_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Delete Contact

    Remove contacts from the address book .
    If the contact has been removed successfully, you will get an object ID.

    delete 
    /api/v3.8/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "contact_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Delete Contact

    Remove contacts from the address book .
    If the contact has been removed successfully, you will get an object ID.

    delete 
    /api/v3.7/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "contact_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Delete Contact

    Remove contacts from the address book .
    If the contact has been removed successfully, you will get an object ID.

    delete 
    /api/v3.6/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "contact_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Delete Contact

    Remove contacts from the address book .
    If the contact has been removed successfully, you will get an object ID.

    delete 
    /api/v3.5/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "contact_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Delete Contact

    Remove contacts from the address book .
    If the contact has been removed successfully, you will get an object ID.

    delete 
    /api/v3.4/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "contact_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Delete Contact

    Remove contacts from the address book .
    If the contact has been removed successfully, you will get an object ID.

    delete 
    /api/v3.3/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "contact_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Delete Contact

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Remove contacts from the address book .
    If the contact has been removed successfully, you will get an object ID.

    delete 
    /api/v3.2/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "contact_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Delete Contact

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Remove contacts from the address book .
    If the contact has been removed successfully, you will get an object ID.

    delete 
    /api/v3.1/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "contact_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Delete Contact

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Remove contacts from the address book .
    If the contact has been removed successfully, you will get an object ID.

    delete 
    /api/v3/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook 

    curl --request DELETE \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    id String

    id of invitation

    		 
    HTTP/1.1 200 OK
{
    "id": "contact_id",
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Edit Contact

    Edit contact from the user address book.
    To edit a contact you will need to send an object with attributes ObjectContact, which are marked with PUT tag.
    If the contact has been edited successfully, you will get full object ObjectContact.

    put 
    /api/v3.10/users/{{$user_id}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.10/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Edit Contact

    Edit contact from the user address book.
    To edit a contact you will need to send an object with attributes ObjectContact, which are marked with PUT tag.
    If the contact has been edited successfully, you will get full object ObjectContact.

    put 
    /api/v3.9/users/{{$user_id}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.9/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Edit Contact

    Edit contact from the user address book.
    To edit a contact you will need to send an object with attributes ObjectContact, which are marked with PUT tag.
    If the contact has been edited successfully, you will get full object ObjectContact.

    put 
    /api/v3.8/users/{{$user_id}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.8/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Edit Contact

    Edit contact from the user address book.
    To edit a contact you will need to send an object with attributes ObjectContact, which are marked with PUT tag.
    If the contact has been edited successfully, you will get full object ObjectContact.

    put 
    /api/v3.7/users/{{$user_id}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.7/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Edit Contact

    Edit contact from the user address book.
    To edit a contact you will need to send an object with attributes ObjectContact, which are marked with PUT tag.
    If the contact has been edited successfully, you will get full object ObjectContact.

    put 
    /api/v3.6/users/{{$user_id}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.6/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Edit Contact

    Edit contact from the user address book.
    To edit a contact you will need to send an object with attributes ObjectContact, which are marked with PUT tag.
    If the contact has been edited successfully, you will get full object ObjectContact.

    put 
    /api/v3.5/users/{{$user_id}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.5/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Edit Contact

    Edit contact from the user address book.
    To edit a contact you will need to send an object with attributes ObjectContact, which are marked with PUT tag.
    If the contact has been edited successfully, you will get full object ObjectContact.

    put 
    /api/v3.4/users/{{$user_id}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.4/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Edit Contact

    Edit contact from the user address book.
    To edit a contact you will need to send an object with attributes ObjectContact, which are marked with PUT tag.
    If the contact has been edited successfully, you will get full object ObjectContact.

    put 
    /api/v3.3/users/{{$user_id}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.3/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Edit Contact

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Edit contact from the user address book.
    To edit a contact you will need to send an object with attributes ObjectContact, which are marked with PUT tag.
    If the contact has been edited successfully, you will get full object ObjectContact.

    put 
    /api/v3.2/users/{{$user_id}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.2/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Edit Contact

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Edit contact from the user address book.
    To edit a contact you will need to send an object with attributes ObjectContact, which are marked with PUT tag.
    If the contact has been edited successfully, you will get full object ObjectContact.

    put 
    /api/v3.1/users/{{$user_id}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:write 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3.1/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Edit Contact

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Edit contact from the user address book.
    To edit a contact you will need to send an object with attributes ObjectContact, which are marked with PUT tag.
    If the contact has been edited successfully, you will get full object ObjectContact.

    put 
    /api/v3/users/{{$user_id}/addressbook/{{$contact_id}}

    Permission: users.addressbook 

    curl --request PUT \
    --url 'https://{{$server_name}}/api/v3/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}' \
    --header 'content-type: application/json' \
    --data '{"contact_id": "user1", "display_name": "User 1"}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Get Contact List

    Get user contact list.
    Returns ObjectContact list.

    get 
    /api/v3.10/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contacts Object[]

    List of ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contacts": [
        {ObjectContact},
        {ObjectContact},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Get Contact List

    Get user contact list.
    Returns ObjectContact list.

    get 
    /api/v3.9/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contacts Object[]

    List of ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contacts": [
        {ObjectContact},
        {ObjectContact},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Get Contact List

    Get user contact list.
    Returns ObjectContact list.

    get 
    /api/v3.8/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contacts Object[]

    List of ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contacts": [
        {ObjectContact},
        {ObjectContact},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Get Contact List

    Get user contact list.
    Returns ObjectContact list.

    get 
    /api/v3.7/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contacts Object[]

    List of ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contacts": [
        {ObjectContact},
        {ObjectContact},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Get Contact List

    Get user contact list.
    Returns ObjectContact list.

    get 
    /api/v3.6/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contacts Object[]

    List of ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contacts": [
        {ObjectContact},
        {ObjectContact},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Get Contact List

    Get user contact list.
    Returns ObjectContact list.

    get 
    /api/v3.5/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/users/{{$user_id}}/addressbook?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contacts Object[]

    List of ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contacts": [
        {ObjectContact},
        {ObjectContact},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Get Contact List

    Get user contact list.
    Returns ObjectContact list.

    get 
    /api/v3.4/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/users/{{$user_id}}/addressbook?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contacts Object[]

    List of ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contacts": [
        {ObjectContact},
        {ObjectContact},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Get Contact List

    Get user contact list.
    Returns ObjectContact list.

    get 
    /api/v3.3/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/users/{{$user_id}}/addressbook?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contacts Object[]

    List of ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contacts": [
        {ObjectContact},
        {ObjectContact},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Get Contact List

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Get user contact list.
    Returns ObjectContact list.

    get 
    /api/v3.2/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/users/{{$user_id}}/addressbook?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contacts Object[]

    List of ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contacts": [
        {ObjectContact},
        {ObjectContact},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Get Contact List

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Get user contact list.
    Returns ObjectContact list.

    get 
    /api/v3.1/users/{{$user_id}}/addressbook

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/users/{{$user_id}}/addressbook?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contacts Object[]

    List of ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contacts": [
        {ObjectContact},
        {ObjectContact},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Get Contact List

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Get user contact list.
    Returns ObjectContact list

    get 
    /api/v3/users/{{$user_id}}/addressbook

    Permission: users.addressbook 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/users/{{$user_id}}/addressbook?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    page_id optional Integer

    GET Object list page ID.

    Default value: 1
    page_size optional Integer

    GET Page size.

    Default value: 200

    Allowed values: 1-1000

    Success 200

    Field Type Description
    contacts Object[]

    List of ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contacts": [
        {ObjectContact},
        {ObjectContact},
        ...
    ]
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.

    Users Contacts | Get Contact

    Get user contact from the address book.
    Returns ObjectContact.

    get 
    /api/v3.10/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.10/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Get Contact

    Get user contact from the address book.
    Returns ObjectContact.

    get 
    /api/v3.9/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.9/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Get Contact

    Get user contact from the address book.
    Returns ObjectContact.

    get 
    /api/v3.8/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.8/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Get Contact

    Get user contact from the address book.
    Returns ObjectContact.

    get 
    /api/v3.7/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.7/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Get Contact

    Get user contact from the address book.
    Returns ObjectContact.

    get 
    /api/v3.6/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.6/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Get Contact

    Get user contact from the address book.
    Returns ObjectContact.

    get 
    /api/v3.5/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.5/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Get Contact

    Get user contact from the address book.
    Returns ObjectContact.

    get 
    /api/v3.4/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.4/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Get Contact

    Get user contact from the address book.
    Returns ObjectContact.

    get 
    /api/v3.3/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.3/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Get Contact

    DEPRECATED Use version 3.3 of this endpoint (or above).

    Get user contact from the address book.
    Returns ObjectContact.

    get 
    /api/v3.2/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.2/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Get Contact

    DEPRECATED Use version 3.2 of this endpoint (or above).

    Get user contact from the address book.
    Returns ObjectContact.

    get 
    /api/v3.1/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook | users.addressbook:read 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3.1/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.
    url_type optional String

    GET Type of URL to Web-configurator.

    Default value: dynamic

    Allowed values: "dynamic", "fixed"

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Users Contacts | Get Contact

    DEPRECATED Use version 3.1 of this endpoint (or above).

    Get user contact from the address book.
    Returns ObjectContact

    get 
    /api/v3/users/{{$user_id}}/addressbook/{{$contact_id}}

    Permission: users.addressbook 

    curl --request GET \
    --header 'content-type: application/json' \
    --url 'https://{{$server_name}}/api/v3/users/{{$user_id}}/addressbook/{{$contact_id}}?access_token={{$access_token}}'

    Header

    Field Type Description
    Content-Type String

    application/json

    Parameter

    Field Type Description
    access_token String

    GET Secret key used to access API.

    Success 200

    Field Type Description
    contact Object

    ObjectContact.

    		 
    HTTP/1.1 200 OK
{
    "contact": {ObjectContact}
}

    Errors

    Name Type Description
    forbidden ObjectErrorDetail

    Forbidden
    userNotFound ObjectErrorDetail

    User user_id is not found.
    contactNotFound ObjectErrorDetail

    Contact contact_id is not found.

    Generated with apidoc 1.2.0 - Tue Feb 18 2025 16:03:59 GMT+0300 (Москва, стандартное время)