User Meet Me Conferencing conferences

The Meet-Me Conferencing service allows to setup and organise conference bridges

Retrieve a user’s conference bridges list

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/meet_me_confs/bridges/

Retrieve the list of a user’s meet me conferencing bridges.

Authorization rights: minimum End User.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/meet_me_confs/bridges/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
  "conference_bridges": [
      {
          "bridgeId": "APIOTestMeetMeConfBridge@sip.netaxis.be",
          "name": "APIO Test Meet Me Conf Bridge",
          "phoneNumber": "+3225126780",
          "extension": "9999",
          "allocatedPorts": {
              "unlimited": false,
              "quantity": 2
          },
          "active": true
      }
  ]
}
Response JSON Object:
Status Codes:

Retrieve an user’s conferences list

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/meet_me_confs/conferences/

Retrieve the list of meet me conferencing conferences of an user.

Authorization rights: minimum End User.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/meet_me_confs/conferences/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
  "conferences": [
      {
          "bridgeId": "APIOTestMeetMeConfBridge@sip.netaxis.be",
          "conferenceId": "820034",
          "title": "APIO Conference Test Valid",
          "bridgeName": "APIO Test Meet Me Conf Bridge",
          "status": "Active",
          "type": "Reservationless",
          "startTime": "2024-08-01T15:00:00:000+0200",
          "lastName": "Test",
          "firstName": "Test",
          "hostId": "ApioUserTest@sip.netaxis.be"
      }
  ]
}
Response JSON Object:
Status Codes:

Retrieve a conferences list of a conference bridge

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/meet_me_confs/bridges/(string: instance_name)/conferences/

Retrieve the list of meet me conferencing conferences of a conference bridge.

Authorization rights: minimum End User.

Example request:

GET /api/v1/tenants/foo/groups/foogroup/users/foouser/services/meet_me_confs/bridges/bridgeid/conferences/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
  "conferences": [
      {
          "bridgeId": "APIOTestMeetMeConfBridge@sip.netaxis.be",
          "conferenceId": "820034",
          "title": "APIO Conference Test Valid",
          "bridgeName": "APIO Test Meet Me Conf Bridge",
          "status": "Active",
          "type": "Reservationless",
          "startTime": "2024-08-01T15:00:00:000+0200",
          "lastName": "Test",
          "firstName": "Test",
          "hostId": "ApioUserTest@sip.netaxis.be"
      }
  ]
}
Response JSON Object:
Status Codes:

Create Conference instance

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/meet_me_confs/bridges/(string: instance_name)/conferences/

Create a new meet me conferencing conference in a conference bridge.

Authorization rights: minimum End User.

Example request:

POST /api/v1/tenants/foo/groups/foogroup/users/foouser/services/meet_me_confs/bridges/bridgeid/conferences/ HTTP/1.1
Host: example.com

{
  "title": "TestConference",
  "restrictParticipants": false,
  "muteAllAttendeesOnEntry": false,
  "endConferenceOnModeratorExit": false,
  "moderatorRequired": false,
  "requireSecurityPin": false,
  "allowUniqueIdentifier": false,
  "attendeeNotification": "Play Tone",
  "conferenceSchedule": {
      "scheduleRecurring": {
          "startTime": "2022-01-07T00:00:00.000+01:00",
          "duration": {
              "hours": 1,
              "minutes": 0
          },
          "recurrence": {
              "recurDaily": {
                  "recurInterval": 5
              },
              "recurForEver": false,
              "recurEndDate": "2025-09-08"
          }
      }
  }
}
Request JSON Object:

Example response:

HTTP/1.1 200 OK

{
  "title": "APIO Conference Test Valid",
  "restrictParticipants": false,
  "muteAllAttendeesOnEntry": false,
  "endConferenceOnModeratorExit": false,
  "moderatorRequired": false,
  "requireSecurityPin": true,
  "securityPin": "156521",
  "allowUniqueIdentifier": false,
  "attendeeNotification": "Play Tone",
  "conferenceSchedule": {
      "scheduleRecurring": {
          "startTime": "2022-01-07T00:00:00.000+01:00",
          "duration": {
              "hours": 1,
              "minutes": 0
          },
          "recurrence": {
              "recurDaily": {
                  "recurInterval": 5
              },
              "recurForEver": false,
              "recurEndDate": "2025-09-08"
          }
      }
  },
  "moderatorPin": "633890",
  "hostTimeZone": "Europe/Brussels",
  "conferenceId": "327893"
}
Response JSON Object:
Status Codes:

Update the Conference instance

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/meet_me_confs/bridges/(string: instance_name)/conferences/(string: sub_instance_name)/

Update the meet me conferencing conference in a conference bridge.

Authorization rights: minimum End User.

Example request:

PUT /api/v1/tenants/fooTenant/groups/foogroup/users/foouser/services/meet_me_confs/bridges/bridgeid/conferences/conferenceid/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
  "title": "TestConference",
  "restrictParticipants": false,
  "muteAllAttendeesOnEntry": false,
  "endConferenceOnModeratorExit": false,
  "moderatorRequired": false,
  "requireSecurityPin": false,
  "allowUniqueIdentifier": false,
  "attendeeNotification": "Play Tone",
  "conferenceSchedule": {
      "scheduleRecurring": {
          "startTime": "2022-01-07T00:00:00.000+01:00",
          "duration": {
              "hours": 1,
              "minutes": 0
          },
          "recurrence": {
              "recurDaily": {
                  "recurInterval": 5
              },
              "recurForEver": false,
              "recurEndDate": "2025-09-08"
          }
      }
  }
}
Request JSON Object:

Example response:

Response:

Similar to GET instance method response.

Status Codes:

Retrieve conference instance

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/meet_me_confs/bridges/(string: instance_name)/conferences/(string: sub_instance_name)/

Retrieve a meet me conferencing conference.

Authorization rights: minimum End User.

Example request:

GET /api/v1/fooTenant/groups/foogroup/users/foouser/services/meet_me_confs/bridges/bridgeid/conferences/conferenceid/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
  "title": "TestConference",
  "restrictParticipants": false,
  "muteAllAttendeesOnEntry": false,
  "endConferenceOnModeratorExit": false,
  "moderatorRequired": false,
  "requireSecurityPin": true,
  "securityPin": "725429",
  "allowUniqueIdentifier": false,
  "attendeeNotification": "Play Tone",
  "conferenceSchedule": {
      "scheduleRecurring": {
          "startTime": "2022-01-07T00:00:00.000+01:00",
          "duration": {
              "hours": 1,
              "minutes": 0
          },
          "recurrence": {
              "recurDaily": {
                  "recurInterval": 5
              },
              "recurForEver": false,
              "recurEndDate": "2025-09-08"
          }
      }
  },
  "moderatorPin": "755271",
  "hostTimeZone": "Europe/Brussels"
}
Response JSON Object:
Status Codes:

Delete conference instance

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/meet_me_confs/bridges/(string: instance_name)/conferences/(string: sub_instance_name)/

Delete a conference.

Authorization rights: minimum End User.

Example request:

DELETE /api/v1/tenants/fooTenant/groups/foogroup/users/foouser/services/meet_me_confs/bridges/bridgeid/conferences/conferenceid/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK
Status Codes:

  • 200 OK – instance delete. Note that if the conference id does not exist, the response will not return an error.

Retrieve conference greeting announcements

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/meet_me_confs/bridges/(string: instance_name)/conferences/(string: sub_instance_name)/announcements/

Retrieve the meet me conferencing conference greeting announcements.

Authorization rights: minimum End User.

Example request:

GET /api/v1/fooTenant/groups/foogroup/users/foouser/services/meet_me_confs/bridges/bridgeid/conferences/conferenceid/announcements/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
  "playEntranceGreeting": true,
  "entranceGreetingFile": {
      "name": "APIO User Test Announcement",
      "mediaType": "WAV"
  }
}
Response JSON Object:

  • playEntranceGreeting (boolean) – Specify if to play or not an entrance greeting.

  • entranceGreetingFile (object) – The entrance greeting to be played. An object as defined as Conference greeting announcement.

Status Codes:

  • 200 OK – no error

  • 400 Bad Request –

    invalid request due to invalid parameters, with possible sub error codes:

    • 7 UNAUTHORIZED_BY_NE, User is not authorized to modify delegates for this conference. May also occur if the conference does not exist.

Update the Conference greeting settings

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/meet_me_confs/bridges/(string: instance_name)/conferences/(string: sub_instance_name)/announcements/

Update the meet me conferencing conference greeting settings.

Authorization rights: minimum End User.

Example request:

PUT /api/v1/tenants/fooTenant/groups/foogroup/users/foouser/services/meet_me_confs/bridges/bridgeid/conferences/conferenceid/announcements/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
  "playEntranceGreeting": true,
  "entranceGreetingFile": {
      "name": "APIO User Test Announcement",
      "mediaType": "WAV"
  }
}
Request JSON Object:

  • playEntranceGreeting (boolean) – Specify if to play or not an entrance greeting.

  • entranceGreetingFile (object) – The entrance greeting to be played. An object as defined as Conference greeting announcement.

Status Codes:

  • 200 OK – no error

  • 400 Bad Request –

    invalid request due to invalid parameters, with possible sub error codes:

    • 7 UNAUTHORIZED_BY_NE, User is not authorized to modify delegates for this conference. May also occur if the conference does not exist.

Retrieve a user’s conference recordings

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/meet_me_confs/recordings/

Retrieve a user’s recording list.

Authorization rights: minimum End User.

Example request:

GET /api/v1/fooTenant/groups/foogroup/users/foouser/services/meet_me_confs/recordings/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
  "conference_recordings": [
      {
          "bridgeId": "APIOTestMeetMeConfBridge@sip.netaxis.be",
          "conferenceId": "444752",
          "title": "TestConference",
          "bridgeName": "APIO Test Meet Me Conf Bridge",
          "startTime": "2020-08-01T11:00:00.000+0200",
          "fileSize": "78",
          "url": "http://fileadmin:1234567@sfocps.netaxis.be:80/foorecordingfilename.wav",
      }
  ]
}
Response JSON Object:

  • bridgeId (string) – The unique bridge id.

  • conferenceId (string) – The unique conference id.

  • title (string) – The conference title.

  • bridgeName (string) – The name of the bridge.

  • startTime (dateTime) – The start time of the conference. Is in the format “yyyy-MM-dd’T’HH:mm:ss:SSSZ”. Example: 2010-10-01T09:30:00:000-0400.

  • fileSize (string) – The file size. TODO: is represented in MB?

  • url (string) – The file url for download.

Status Codes:

Delete a user’s conference recordings

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/meet_me_confs/recordings/

Delete a user’s recording list.

Authorization rights: minimum End User.

Example request:

DELETE /api/v1/tenants/fooTenant/groups/foogroup/users/foouser/services/meet_me_confs/bridges/bridgeid/conferences/conferenceid/ HTTP/1.1
Host: example.com

{
  "conference_recordings": [
      {
          "bridgeId": "APIOTestMeetMeConfBridge@sip.netaxis.be",
          "conferenceId": "444752",
          "startTime": "2020-08-01T11:00:00.000+0200"
      },
      {
          "bridgeId": "APIOTestMeetMeConfBridge@sip.netaxis.be",
          "conferenceId": "444752",
          "startTime": "2020-08-01T11:00:00.000+0200"
      }
  ]
}
Request JSON Object:

Example response:

HTTP/1.1 200 OK
Status Codes:

  • 200 OK – instance delete. Note that if the recording does not exist, the response will not return an error.

Retrieve a conference’s available delegates

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/meet_me_confs/bridges/(string: instance_name)/conferences/(string: sub_instance_name)/delegates/available/

Retrieve a conference’s available delegates.

Authorization rights: minimum End User.

Example request:

GET /api/v1/fooTenant/groups/foogroup/users/foouser/services/meet_me_confs/bridges/bridgeid/conferences/conferenceid/delegates/available/ HTTP/1.1
Host: example.com

{
   "sensitiveUserIdStarts": "Apio"
}
Request JSON Object:

  • sensitiveUserIdStarts (string) – See sensitiveUserIdStarts from Search criteria.

  • sensitiveUserIdContains (string) – See sensitiveUserIdContains from Search criteria.

  • sensitiveUserIdEquals (string) – See sensitiveUserIdEquals from Search criteria.

  • insensitiveUserIdStarts (string) – See insensitiveUserIdStarts from Search criteria.

  • insensitiveUserIdContains (string) – See insensitiveUserIdContains from Search criteria.

  • insensitiveUserIdEquals (string) – See insensitiveUserIdEquals from Search criteria.

  • sensitiveUserLastNameStarts (string) – See sensitiveUserLastNameStarts from Search criteria.

  • sensitiveUserLastNameContains (string) – See sensitiveUserLastNameContains from Search criteria.

  • sensitiveUserLastNameEquals (string) – See sensitiveUserLastNameEquals from Search criteria.

  • insensitiveUserLastNameStarts (string) – See insensitiveUserLastNameStarts from Search criteria.

  • insensitiveUserLastNameContains (string) – See insensitiveUserLastNameContains from Search criteria.

  • insensitiveUserLastNameEquals (string) – See insensitiveUserLastNameEquals from Search criteria.

  • sensitiveUserFirstNameStarts (string) – See sensitiveUserFirstNameStarts from Search criteria.

  • sensitiveUserFirstNameContains (string) – See sensitiveUserFirstNameContains from Search criteria.

  • sensitiveUserFirstNameEquals (string) – See sensitiveUserFirstNameEquals from Search criteria.

  • insensitiveUserFirstNameStarts (string) – See insensitiveUserFirstNameStarts from Search criteria.

  • insensitiveUserFirstNameContains (string) – See insensitiveUserFirstNameContains from Search criteria.

  • insensitiveUserFirstNameEquals (string) – See insensitiveUserFirstNameEquals from Search criteria.

  • sensitiveEmailAddressStarts (string) – See sensitiveEmailAddressStarts from Search criteria.

  • sensitiveEmailAddressContains (string) – See sensitiveEmailAddressContains from Search criteria.

  • sensitiveEmailAddressEquals (string) – See sensitiveEmailAddressEquals from Search criteria.

  • insensitiveEmailAddressStarts (string) – See insensitiveEmailAddressStarts from Search criteria.

  • insensitiveEmailAddressContains (string) – See insensitiveEmailAddressContains from Search criteria.

  • insensitiveEmailAddressEquals (string) – See insensitiveEmailAddressEquals from Search criteria.

  • insensitiveExtensionStarts (string) – See insensitiveExtensionStarts from Search criteria.

  • insensitiveExtensionContains (string) – See insensitiveExtensionContains from Search criteria.

  • insensitiveExtensionEquals (string) – See insensitiveExtensionEquals from Search criteria.

  • insensitiveDnStarts (string) – See insensitiveDnStarts from Search criteria.

  • insensitiveDnContains (string) – See insensitiveDnContains from Search criteria.

  • insensitiveDnEquals (string) – See insensitiveDnEquals from Search criteria.

  • sensitiveUserDepartmentEquals (string) – See sensitiveDepartmentEquals from Search criteria.

  • responseSizeLimit (integer) – See responseSizeLimit from Search criteria.

Example response:

HTTP/1.1 200 OK

{
  "available_delegates": [
      {
          "userId": "ApioUserTest1@sip.netaxis.be",
          "lastName": "Test1",
          "firstName": "Test1",
          "phoneNumber": "+3225126778",
          "extension": "5001",
          "department": {
              "tenantId": "ApioSpTest",
              "groupId": "ApioGrpTest",
              "departmentName": "test_department_initial",
              "fullPathName": "test_department_parent_1 \\ test_department_initial"
          },
          "emailAddress": ""
      }
  ]
}
Response JSON Object:
Status Codes:

  • 200 OK – no error

  • 400 Bad Request –

    invalid request due to invalid parameters, with possible sub-error codes:

    • 7 UNAUTHORIZED_BY_NE, User is not authorized to modify delegates for this conference. May also occur if the conference does not exist.

Replace the delegates list of a conference

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/meet_me_confs/bridges/(string: instance_name)/conferences/(string: sub_instance_name)/delegates/

Replace the meet me conferencing conference delegates list.

Authorization rights: minimum End User.

Example request:

PUT /api/v1/tenants/fooTenant/groups/foogroup/users/foouser/services/meet_me_confs/bridges/bridgeid/conferences/conferenceid/delegates/ HTTP/1.1
Host: example.com
Content-Type: "application/json"

{
  "conference_delegates": [
      {
          "userId": "ApioUserTest2@sip.netaxis.be"
      }
  ]
}
Request JSON Object:
Status Codes:

  • 200 OK – no error

  • 400 Bad Request –

    invalid request due to invalid parameters, with possible sub error codes:

    • 7 UNAUTHORIZED_BY_NE, User is not authorized to modify delegates for this conference. May also occur if the conference does not exist.

Retrieve the delegates list of a conference

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/users/(string: user_id)/services/meet_me_confs/bridges/(string: instance_name)/conferences/(string: sub_instance_name)/delegates/

Retrieve the meet me conferencing conference delegates list.

Authorization rights: minimum End User.

Example request:

GET /api/v1/fooTenant/groups/foogroup/users/foouser/services/meet_me_confs/bridges/bridgeid/conferences/conferenceid/delegates/ HTTP/1.1
Host: example.com

Example response:

HTTP/1.1 200 OK

{
  "conference_delegates": [
      {
          "userId": "ApioUserTest1@sip.netaxis.be",
          "lastName": "Test1",
          "firstName": "Test1",
          "phoneNumber": "+3225126778",
          "extension": "5001",
          "department": {
              "tenantId": "ApioSpTest",
              "groupId": "ApioGrpTest",
              "departmentName": "test_department_initial",
              "fullPathName": "test_department_parent_1 \\ test_department_initial"
          },
          "emailAddress": ""
      },
  ]
}
Response JSON Object:
Status Codes:

  • 200 OK – no error

  • 400 Bad Request –

    invalid request due to invalid parameters, with possible sub error codes:

    • 7 UNAUTHORIZED_BY_NE, User is not authorized to modify delegates for this conference. May also occur if the conference does not exist.