The Avaya Spaces socket server will emit this socket event when a SEND_MEDIA_SESSION_EVENTS socket event was sent by another member of the channel.

Payload Parameters

NameDescriptionJSON type
_idUnique identifier of the event.string
messageIdUnique identifier of the message.string
topicIdUnique identifier of the space.string
senderThe user that sent the SEND_MEDIA_SESSION_EVENTS.
  • _id: unique identifier of the sender
  • username: the username of the sender
  • displayname: the display name of the sender
  • picture_url: URL linking to the profile picture of the user
  • type: default is "spaceserver"
string
content
  • endTime: (null/string) used for a category of events that emit when a process is finished (e.g. 'app.event.meeting.ended', 'app.event.recording.ended') and defines the time when it happened
  • mediaMode: (string) either 'video' or 'audio'
  • virtualEndTime: (null/string) goes hand in hand with 'endTime' - when they are both null, the meeting is fully active.
  • meetingStatus: (string) meeting status at the time of the event, either 'active' or 'inactive'
  • bodyText: (string) message text received
  • attendees: (array) array of attendees in a given space
  • attendee: (object) returned in 'app.event.atendee' category responses
  • startTime: (string) date when the event has started
  • recordings: (array) array of available recordings in the given space
  • data: (array) array of possible objects provided by user input like files, images, links, recordings
object
modifieddate when the object of the event (e.g. 'recording' in 'app.event.recording') has been modified(null/string)
categoryThe type of media session event.string

Media Session Event Categories

NameDescription
app.event.meeting.startedThe meeting has started
app.event.meeting.endedThe meeting has ended
app.event.attendee.addedAn attendee was added to the meeting
app.event.attendee.leftAn attendee has left the meeting
app.event.recording.startedMeeting recording has started
app.event.recording.endedMeeting recording was stopped
app.event.recording.readyMeeting recording is ready to be viewed/downloaded

Authorization

Subscribed to the channel.

Example

socketConnection.on('MEDIA_SESSION_RESPONSE', callback(payload));

Payload ('app.event.meeting.started')

{
   "_id":"5f2906969c72f30f3c1e1fb5",
   "messageId":"5f2906969c72f30f3c1e1fb5",
   "topicId":"5f06c25e574ca36b51cb4cdf",
   "sender":{
      "_id":"5f06c25e574ca36b51cb4cdf",
      "type":"spaceserver"
   },
   "content":{
      "endTime":null,
      "mediaMode":"video",
      "virtualEndTime":null,
      "meetingStatus":"active",
      "bodyText":"",
      "attendees":[

      ],
      "startTime":"2020-08-04T06:56:22.182Z",
      "recordings":[

      ],
      "data":[

      ]
   },
   "modified":null,
   "category":"app.event.meeting.started"
}

Payload ('app.event.attendee.added')

{
   "_id":"5f2906969c72f30f3c1e1fb5",
   "messageId":"5f2906969c72f30f3c1e1fb5",
   "topicId":"5f06c25e574ca36b51cb4cdf",
   "sender":{
      "_id":"5f06c25e574ca36b51cb4cdf",
      "type":"spaceserver"
   },
   "content":{
      "attendee":{
         "_id":"5f04251caa4a347af9946e06",
         "type":"user",
         "username":"test@user.com",
         "displayname":"Test User",
         "picture_url":"https://storage.googleapis.com/onesna/pictures/pfpic_test_34cb97bd-0151-449d-84b0-48e07853b49f",
         "joinTime":1596524183685
      },
      "startTime":"2020-08-04T06:56:22.182Z",
      "endTime":null
   },
   "modified":null,
   "category":"app.event.attendee.added"
}

Payload ('app.event.attendee.left')

{
   "_id":"5f2906969c72f30f3c1e1fb5",
   "messageId":"5f2906969c72f30f3c1e1fb5",
   "topicId":"5f06c25e574ca36b51cb4cdf",
   "sender":{
      "_id":"5f06c25e574ca36b51cb4cdf",
      "type":"spaceserver"
   },
   "content":{
      "attendee":{
         "_id":"5f04251caa4a347af9946e06",
         "type":"user",
         "username":"test@user.com",
         "displayname":"Test User",
         "picture_url":"https://storage.googleapis.com/onesna/pictures/pfpic_test_34cb97bd-0151-449d-84b0-48e07853b49f"
      }
   },
   "modified":null,
   "category":"app.event.attendee.left"
}

Payload ('app.event.meeting.ended')

{
   "_id":"5f2906969c72f30f3c1e1fb5",
   "messageId":"5f2906969c72f30f3c1e1fb5",
   "topicId":"5f06c25e574ca36b51cb4cdf",
   "sender":{
      "_id":"5f06c25e574ca36b51cb4cdf",
      "type":"spaceserver"
   },
   "content":{
      "endTime":"2020-08-04T06:56:55.106Z",
      "mediaMode":"video",
      "virtualEndTime":"2020-08-04T06:56:55.106Z",
      "meetingStatus":"inactive",
      "bodyText":"",
      "attendees":[
         {
            "joinTime":"2020-08-04T06:56:23.685Z",
            "_id":"5f04251caa4a347af9946e06",
            "type":"user",
            "username":"test@user.com",
            "displayname":"Test User",
            "picture_url":"https://storage.googleapis.com/onesna/pictures/pfpic_test_34cb97bd-0151-449d-84b0-48e07853b49f"
         }
      ],
      "startTime":"2020-08-04T06:56:22.182Z",
      "recordings":[

      ],
      "data":[

      ]
   },
   "modified":null,
   "category":"app.event.meeting.ended"
}

Payload ('app.event.recording.started')

{
   "_id":"5f290ac5201bd2ff5f4599d1",
   "messageId":"5f290ac5201bd2ff5f4599d1",
   "topicId":"5f06c25e574ca36b51cb4cdf",
   "sender":{
      "_id":"5f06c25e574ca36b51cb4cdf",
      "type":"spaceserver"
   },
   "content":{
      "recordings":[
         {
            "startedBy":{
               "_id":"5f04251caa4a347af9946e06",
               "type":"user",
               "username":"test@user.com",
               "displayname":"Test User",
               "picture_url":"https://storage.googleapis.com/onesna/pictures/pfpic_test_34cb97bd-0151-449d-84b0-48e07853b49f"
            },
            "status":0,
            "endTime":null,
            "startTime":"2020-08-04T07:14:19.974Z",
            "_id":"5f290acaf64a873553a7f4f3",
            "externalRefId":"ee7bea36-f39f-4d13-a030-94339e58e264"
         }
      ]
   },
   "modified":null,
   "category":"app.event.recording.started"
}

Payload ('app.event.recording.ended')

{
   "_id":"5f290ac5201bd2ff5f4599d1",
   "messageId":"5f290ac5201bd2ff5f4599d1",
   "topicId":"5f06c25e574ca36b51cb4cdf",
   "sender":{
      "_id":"5f06c25e574ca36b51cb4cdf",
      "type":"spaceserver"
   },
   "content":{
      "recordings":[
         {
            "startedBy":{
               "_id":"5f04251caa4a347af9946e06",
               "type":"user",
               "username":"test@user.com",
               "displayname":"Test User",
               "picture_url":"https://storage.googleapis.com/onesna/pictures/pfpic_test_34cb97bd-0151-449d-84b0-48e07853b49f"
            },
            "endedBy":{
               "_id":"5f04251caa4a347af9946e06",
               "type":"user",
               "username":"test@user.com",
               "displayname":"Test User",
               "picture_url":"https://storage.googleapis.com/onesna/pictures/pfpic_test_34cb97bd-0151-449d-84b0-48e07853b49f"
            },
            "status":0,
            "endTime":"2020-08-04T07:14:27.063Z",
            "startTime":"2020-08-04T07:14:19.974Z",
            "_id":"5f290acaf64a873553a7f4f3",
            "externalRefId":"ee7bea36-f39f-4d13-a030-94339e58e264"
         }
      ]
   },
   "modified":null,
   "category":"app.event.recording.ended"
}

Payload ('app.event.recording.ready')

{
   "_id":"5f290ac5201bd2ff5f4599d1",
   "messageId":"5f290ac5201bd2ff5f4599d1",
   "topicId":"5f06c25e574ca36b51cb4cdf",
   "sender":{
      "_id":"5f06c25e574ca36b51cb4cdf",
      "type":"spaceserver"
   },
   "content":{
      "endTime":"2020-08-04T07:15:00.076Z",
      "mediaMode":"video",
      "virtualEndTime":"2020-08-04T07:15:00.076Z",
      "meetingStatus":"inactive",
      "bodyText":"",
      "attendees":[
         {
            "joinTime":"2020-08-04T07:14:14.815Z",
            "_id":"5f04251caa4a347af9946e06",
            "type":"user",
            "username":"test@user.com",
            "displayname":"Test User",
            "picture_url":"https://storage.googleapis.com/onesna/pictures/pfpic_test_34cb97bd-0151-449d-84b0-48e07853b49f"
         }
      ],
      "startTime":"2020-08-04T07:14:13.102Z",
      "recordings":[
         {
            "startedBy":{
               "_id":"5f04251caa4a347af9946e06",
               "type":"user",
               "username":"test@user.com",
               "displayname":"Test User",
               "picture_url":"https://storage.googleapis.com/onesna/pictures/pfpic_test_34cb97bd-0151-449d-84b0-48e07853b49f"
            },
            "endedBy":{
               "_id":"5f04251caa4a347af9946e06",
               "type":"user",
               "username":"test@user.com",
               "displayname":"Test User",
               "picture_url":"https://storage.googleapis.com/onesna/pictures/pfpic_test_34cb97bd-0151-449d-84b0-48e07853b49f"
            },
            "status":0,
            "endTime":"2020-08-04T07:14:27.063Z",
            "startTime":"2020-08-04T07:14:19.974Z",
            "_id":"5f290acaf64a873553a7f4f3",
            "externalRefId":"ee7bea36-f39f-4d13-a030-94339e58e264"
         }
      ],
      "data":[
         {
            "metaData":{
               "paging":0,
               "prvwProvd":"gcs",
               "stgeProvd":"gcs"
            },
            "keywords":[

            ],
            "convertStatus":0,
            "convertStart":null,
            "nextSchedule":null,
            "pages":0,
            "recordingId":"5f290acaf64a873553a7f4f3",
            "type":"recording",
            "provider":"native",
            "fileId":"mpaas/TOPIC_5f06c25e574ca36b51cb4cdf/MESSAGE_5f290ac5201bd2ff5f4599d1/recordings/RECORDING_5f290acaf64a873553a7f4f3",
            "name":"RECORDING_5f290acaf64a873553a7f4f3.mp4",
            "providerFileType":"video/mp4",
            "fileType":"video",
            "fileSize":2776387,
            "path":"https://storage.googleapis.com/spaces2020/logan%2Fmpaas%2FTOPIC_5f06c25e574ca36b51cb4cdf%2FMESSAGE_5f290ac5201bd2ff5f4599d1%2Frecordings%2FRECORDING_5f290acaf64a873553a7f4f3?GoogleAccessId=spaces2020@spaces-2018.iam.gserviceaccount.com&Expires=1596532505&Signature=MAOoIh%2FQwMC5YxazbrgOq7q1KhurYik%2FcYAccAEj8u3k3lJvb%2BSC0mY9hFpt6CeoibTOMsl6ezPS12DNpB4lU312aRw6egulGhbPHPXs4VCb0cgPm01YuuRqLgdV2IHWTVWj0Jf4B8ogUW3whpMkK9mZg7r41xRj825wqr%2BqKYb5WV8ZeNQZNhU3wi9Ar65BRcSr1%2FOjRbmATSr5dAaxojW0M%2FBpVDe8PEpUJyZvEzGm42MXPwhFVkC8iD3P3OA8VuKQBQAa0tScAh3FkAPKyVfHlRI6rQf%2BPVA1nDb%2BBfW5vnMJ5shcsU%2FuDJ2NNnpTstGSox5H7v1XXuq%2Fzh0Aqg%3D%3D&response-content-disposition=attachment%3B%20filename%3D%22RECORDING_5f290acaf64a873553a7f4f3.mp4%22"
         }
      ]
   },
   "modified":null,
   "category":"app.event.recording.ready"
}