Video conference management

Conference enables, planned or instant, multi-party video call sessions.

A conference in the Apizee API represents a real-time communication session between participants. These endpoints allow you to create, manage, and retrieve conference data, as well as access related resources like media.

Create and Manage a Conference

Create a Conference

Endpoint: POST /api/v3/conferences Create a new conference session by providing required details (participants, configuration, etc.). The API returns the conference ID and connection information.

When to use:

Setting up a meeting room for real-time communication.
Preparing a conference for a scheduled session.

Create a conference.

post

/api/v3/conferences

This endpoint requires a specific feature. Please contact-us at https://apirtc.com/contact-us/ to enable it.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

participantsstringRequired

A list of email address or mobile phone (a comma separated list)

namestring · min: 2 · max: 255Optional

The name for the conference.

messagestring · max: 300Optional

The message of the invitation.

passwordstring · max: 255Optional

The password for the conference (permitted: numbers {0-9}, asterisk {*}, hash key {#}).

moderationbooleanOptional

Enable guest moderation (activate waiting room).

entryModestring · enumOptional

Set the conference entry mode.

Possible values:

startTimestringOptional

When the conference will take place. A given ISO 8601 compliant UTC date (format: 2020-01-01T15:00:00Z).

openbooleanOptional

Let this conference open.

durationinteger · min: 1Optional

Set a duration (in minutes).

reminderinteger · min: 1 · max: 60Optional

Activate an email invite reminder (in minutes).

templateIdintegerOptional

The notification template ID.

languagestring · enumOptional

Set the language of the notification template.

Possible values:

invitebooleanOptional

Send invitations to participants.

Default: true

moderatorstringOptional

Set the moderator for the conference (User ID or username).

service_keystringOptional

Set the service in which the conference will be associated (key format: sfa6mdbzx9vigfvryihfokt9khux8qan).

scopestringOptional

An optional, comma-separated list of required scopes (available: sso).

Responses

200

Good case

application/json

Responseany

post

/api/v3/conferences

POST /api/v3/conferences?participants=text HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Good case

{
  "id": 1000,
  "service_key": "sfa6mdbzx9vigfvryihfokt9khux8qan",
  "name": "Conference-2020-01-01 12:30:00 (GMT +01:00)",
  "created": "2020-01-01T11:30:00+00:00",
  "modified": "2020-01-01T11:30:00+00:00",
  "status": "scheduled",
  "room_name": "26b89ccd94d308cbe32b639997cd0a:044603c4bf9adde19ba77b6d0d25c9",
  "url": "https://www.meet.apizee.com/private/26b89ccd94d308cbe32b639997cd0a/044603c4bf9adde19ba77b6d0d25c9",
  "short_url": "https://s.apizee.com/pNPZ9a38kUbXOJoHw",
  "organizer": {
    "id": 1000,
    "name": "John Doe"
  },
  "created_by": {
    "id": 1001,
    "name": "Jane Doe"
  },
  "sip_phone_number": "0970000000",
  "sip_dtmf_code": "00000",
  "start_time": "2020-01-02T17:00:00+00:00",
  "end_time": "2020-01-02T17:30:00+00:00"
}

Update a Conference

Endpoint: PUT /api/v3/conferences/{conferenceId} Modify the properties of an existing conference, such as its configuration or participant list.

When to use:

Adjusting conference settings before or during the session.
Adding or removing participants.

Update a conference by ID.

put

/api/v3/conferences/{conferenceId}

Use to update a conference a user by ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

conferenceIdstringRequired

The Conference ID.

Query parameters

participantsstringOptional

A list of email address or mobile phone (a comma separated list)

namestring · min: 2 · max: 255Optional

The name for the conference.

messagestring · max: 300Optional

The message of the invitation.

passwordstring · max: 255Optional

The password for the conference (permitted: numbers {0-9}, asterisk {*}, hash key {#}).

moderationbooleanOptional

Send invitations to participants.

Default: true

moderatorstringOptional

Set the moderator for the conference (User ID or username).

scopestringOptional

An optional, comma-separated list of required scopes (available: sso).

entryModestring · enumOptional

Set the conference entry mode.

Possible values:

startTimestringOptional

When the conference will take place. A given ISO 8601 compliant UTC date (format: 2020-01-01T15:00:00Z).

openbooleanOptional

Let this conference open.

durationinteger · min: 1Optional

Set a duration (in minutes).

reminderinteger · min: 1 · max: 60Optional

Activate an email invite reminder (in minutes).

templateIdintegerOptional

The notification template ID.

languagestring · enumOptional

Set the language of the notification template.

Possible values:

invitebooleanOptional

Send invitations to participants.

Default: true

Responses

200

Good case

application/json

Responseany

put

/api/v3/conferences/{conferenceId}

PUT /api/v3/conferences/{conferenceId} HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Good case

{
  "application/json": {
    "id": 1000,
    "name": "Conference-2020-01-01 12:30:00 (GMT +01:00)",
    "created": "2020-01-01T11:30:00+00:00",
    "modified": "2020-01-01T11:30:00+00:00",
    "start_time": "2020-01-02T17:00:00+00:00",
    "end_time": "2020-01-02T17:30:00+00:00",
    "status": "scheduled",
    "room_name": "26b89ccd94d308cbe32b639997cd0a:044603c4bf9adde19ba77b6d0d25c9",
    "url": "https://www.meet.apizee.com/private/26b89ccd94d308cbe32b639997cd0a/044603c4bf9adde19ba77b6d0d25c9",
    "short_url": "https://s.apizee.com/pNPZ9a38kUbXOJoHw",
    "sip_phone_number": "0970000000",
    "sip_dtmf_code": "00000",
    "organizer": {
      "id": 1000,
      "name": "John Doe"
    },
    "created_by": {
      "id": 1001,
      "name": "Jane Doe"
    },
    "service_key": "sfa6mdbzx9vigfvryihfokt9khux8qan",
    "sso_url": "https://cloud.apizee.com/?enterprise_connect=yJ0eXAiOiJKV1QiLCJhbGcOiJIUzI1NiJ9.eyJpcOiJjbG91ZC5hcl6ZWUueWFuIiwiaWF0IjoxNTk3OTk0Mzg3LCJzdWIiOiJbUxCeHJ6UnFadjYiLCJleHAiOjE1OTc5OTc5ODd.rI5ek2BzsQpOm-_6xpXpZFIqbzk-NJDHQ2SJjK5tY&redirect_url=https%3A%2F%2Fizeeconf.apizee.com%2Fprivate%2Fdbb5405f742703571539592b4c41ba86%2F8106e143d605c2bda5b8a9dfb90bg9ce"
  }
}

Delete a Conference

Endpoint: DELETE /api/v3/conferences/{conferenceId} Permanently remove a conference record from the system. This cannot be undone.

When to use:

Cleaning up test or expired conferences.
Removing sensitive data from the system.

Delete a conference by ID.

delete

/api/v3/conferences/{conferenceId}

Use to delete a conference a user by ID.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

conferenceIdstringRequired

The Conference ID.

Responses

200

Good case

application/json

Responseany

delete

/api/v3/conferences/{conferenceId}

DELETE /api/v3/conferences/{conferenceId} HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Good case

{
  "id": 1000,
  "room_name": "26b89ccd94d308cbe32b639997cd0a:044603c4bf9adde19ba77b6d0d25c9"
}

Retrieve Conference Information

List Conferences

Endpoint: GET /api/v3/conferences Retrieve a paginated list of conferences. Supports optional filters (by date, status, participants, etc.).

When to use:

Building an admin dashboard of active or past conferences.
Reporting and analytics on usage patterns.

This call returns a list of conference.

get

/api/v3/conferences

This endpoint requires a specific feature. Please contact-us at https://apirtc.com/contact-us/ to enable it.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

statusstring · enumOptional

Limit result set to conferences assigned one status.

Possible values:

offsetintegerOptional

Offset the result set by a specific number of items.

limitintegerOptional

Maximum number of items to be returned in result set.

Default: 100

sincestringOptional

Limit response to conference planned after a given ISO 8601 compliant UTC date (format: 2020-01-01T15:00:00Z).

untilstringOptional

Limit response to conference planned before a given ISO 8601 compliant UTC date (format: 2020-01-01T16:00:00Z).

searchstringOptional

Limit results to those matching a string.

orderbystring · enumOptional

Sort collection by object attribute.

Default: datePossible values:

orderstring · enumOptional

Order sort attribute ascending or descending.

Default: descPossible values:

tagsstringOptional

Limit result set to conference assigned to specifics tags (comma-separated list of IDs or terms).

moderatorstringOptional

Limit result set to conference attached to a specific user ID (set 'all' to limit result to the enterprise, admin role required).

userintegerOptional

Limit result set to conference attached to a specific user ID (as moderator or participant).

scopesstringOptional

An optional, comma-separated list of required scopes (available: participant, media).

service_keystringOptional

Limit results to a given service (key format: sfa6mdbzx9vigfvryihfokt9khux8qan).

Responses

200

Good case

application/json

Responseany

get

/api/v3/conferences

GET /api/v3/conferences HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Good case

{
  "application/json": {
    "total": 200,
    "next_offset": 10,
    "data": [
      {
        "id": 1000,
        "service_key": "sfa6mdbzx9vigfvryihfokt9khux8qan",
        "name": "Conference-2020-01-01 12:30:00 (GMT +01:00)",
        "created": "2020-01-01T11:30:00+00:00",
        "modified": "2020-01-01T11:30:00+00:00",
        "status": "scheduled",
        "room_name": "26b89ccd94d308cbe32b639997cd0a:044603c4bf9adde19ba77b6d0d25c9",
        "url": "https://www.meet.apizee.com/private/26b89ccd94d308cbe32b639997cd0a/044603c4bf9adde19ba77b6d0d25c9",
        "short_url": "https://s.apizee.com/pNPZ9a38kUbXOJoHw",
        "organizer": {
          "id": 1000,
          "name": "John Doe"
        },
        "created_by": {
          "id": 1001,
          "name": "Jane Doe"
        },
        "sip_phone_number": "0970000000",
        "sip_dtmf_code": "00000",
        "start_time": "2020-01-02T17:00:00+00:00",
        "end_time": "2020-01-02T17:30:00+00:00"
      }
    ]
  }
}

Get Conference by ID or by room name

Endpoint: GET /api/v3/conferences/{conferenceId} or /{roomName} Retrieve detailed information about a specific conference using its unique ID or its room name.

When to use:

Displaying conference details in your app.
Checking the status or configuration of an ongoing or past conference.

Get a conference by ID.

get

/api/v3/conferences/{conferenceId}

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

conferenceIdstringRequired

The Conference ID.

Query parameters

scopestringOptional

An optional, comma-separated list of required scopes (available: sso).

Responses

200

Good case

application/json

Responseany

get

/api/v3/conferences/{conferenceId}

GET /api/v3/conferences/{conferenceId} HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Good case

{
  "id": 1000,
  "service_key": "sfa6mdbzx9vigfvryihfokt9khux8qan",
  "name": "Conference-2020-01-01 12:30:00 (GMT +01:00)",
  "created": "2020-01-01T11:30:00+00:00",
  "modified": "2020-01-01T11:30:00+00:00",
  "status": "scheduled",
  "room_name": "26b89ccd94d308cbe32b639997cd0a:044603c4bf9adde19ba77b6d0d25c9",
  "url": "https://www.meet.apizee.com/private/26b89ccd94d308cbe32b639997cd0a/044603c4bf9adde19ba77b6d0d25c9",
  "short_url": "https://s.apizee.com/pNPZ9a38kUbXOJoHw",
  "organizer": {
    "id": 1000,
    "name": "John Doe"
  },
  "created_by": {
    "id": 1001,
    "name": "Jane Doe"
  },
  "sip_phone_number": "0970000000",
  "sip_dtmf_code": "00000",
  "start_time": "2020-01-02T17:00:00+00:00",
  "end_time": "2020-01-02T17:30:00+00:00",
  "sso_url": "https://cloud.apizee.com/?enterprise_connect=yJ0eXAiOiJKV1QiLCJhbGcOiJIUzI1NiJ9.eyJpcOiJjbG91ZC5hcl6ZWUueWFuIiwiaWF0IjoxNTk3OTk0Mzg3LCJzdWIiOiJbUxCeHJ6UnFadjYiLCJleHAiOjE1OTc5OTc5ODd.rI5ek2BzsQpOm-_6xpXpZFIqbzk-NJDHQ2SJjK5tY&redirect_url=https%3A%2F%2Fizeeconf.apizee.com%2Fprivate%2Fdbb5405f742703571539592b4c41ba86%2F8106e143d605c2bda5b8a9dfb90bg9ce"
}

Get Conference Medias

Endpoint: GET /api/v3/conferences/{conferenceId}/medias Retrieve the list of all media items associated with a specific conference, such as snapshots or recordings.

When to use:

Reviewing visual evidence from a session.
Accessing stored recordings for compliance or training.

Get a media list by ID conference.

get

/api/v3/conferences/{conferenceId}/medias

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

conferenceIdintegerRequired

Set the ID of the conference that you want to return medias.

Query parameters

statusstring · enumOptional

Limit result set to posts assigned one or more statuses.

Default: completedPossible values:

offsetintegerOptional

Offset the result set by a specific number of items.

limitintegerOptional

Maximum number of items to be returned in result set.

Default: 10

sincestringOptional

Limit response to media created after a given ISO 8601 compliant UTC date (format: 2020-01-01T15:00:00Z).

untilstringOptional

Limit response to media created before a given ISO 8601 compliant UTC date (format: 2020-01-01T16:00:00Z).

searchstringOptional

Limit results to those matching a string.

orderbystring · enumOptional

Sort collection by object attribute.

Default: datePossible values:

orderstring · enumOptional

Order sort attribute ascending or descending.

Default: descPossible values:

media_typestring · enumOptional

Limit result set to attachments of a particular media type.

Possible values:

tagstringOptional

Limit result set to media assigned to a specific tag.

userstringOptional

Limit result set to media attached to a specific user ID (set 'all' to limit result to the enterprise, admin role required).

user_groupintegerOptional

Limit result set to media attached to a specific user group ID.

source_typeinteger · enumOptional

Limit result set to attachments of a particular source type.

Possible values:

Responses

200

Good case

application/json

Responseany

get

/api/v3/conferences/{conferenceId}/medias

GET /api/v3/conferences/{conferenceId}/medias HTTP/1.1
Host: cloud.apizee.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Good case

{
  "total": 200,
  "next_offset": 10,
  "data": [
    {
      "id": 1,
      "hash": "effd54e0-4dbb-11ea-884d-5df05d0af01",
      "created": "2020-01-01T00:00:00+00:00",
      "owner": {
        "id": 1000,
        "name": "John Doe"
      },
      "title": "media-3npGq6km5jx2s4ct-1538745137",
      "filename": "media-3npGq6km5jx2s4ct-1538745137.png",
      "status": "completed",
      "media_type": "image",
      "source_type": "unknown",
      "filesize": 122619,
      "thumbnail_url": "https://cloud.apizee.com/media/showVideo/1/hash/effd54e0-4dbb-11ea-884d-5df05d0af01?thumbnail=1",
      "url": "https://cloud.apizee.com/media/showVideo/1/hash/effd54e0-4dbb-11ea-884d-5df05d0af01"
    }
  ]
}

PreviousTicket session events API NextEnterprises, users and user groups management

Last updated 1 month ago