API Call Methods

POST
/rest/recording/notifications






 To create a recording notification that configures how the user should be notified after a recording is created.

Send Parameters: Please refer to "Send example" below.
Response Parameters: Please refer to "Response example" below.

For information on parameter description, please refer to the "Data Structure" below.
GET
/rest/recording/notifications



 To retrieve existing notifications.


Send Parameters: Parameters not required.
Response Parameters: Please refer to "Response example" below.


For information on parameter description, please refer to the "Data Structure" below.
PUT
/rest/recording/notifications



 To update an existing notification that belongs to the user.
Please note that Update will only work if there is an existing notification setting.


Send Parameters: Please refer to "Send example" below.
Response Parameters: Please refer to "Response example" below.


For information on parameter description, please refer to the "Data Structure" below.



SEND Example
{
    "notify": true,
    "url": "https://site.com/events",
    "email": "a@b.com,b@c.com",
    "s3Arn": "arn:aws:s3:region::folder_name/objectpath",
    "s3AccessKeyId": "akewjdwifuendjf",
    "s3SecretAccessKey": "iewmdfuasfwnwksd"
}



RESPONSE Example
{
    "status": 1,
    "content": {
        "data": {
            "username": "temasys",
            "notify": true,
            "url": "https://site.com/events",
            "email": [
                "a@b.com",
                "b@c.com"
            ], 
            "s3Settings": {
                "s3Arn": "arn:aws:s3:region::bucketname/objectpath",
                "s3AccessKeyId": "akewjdwifuendjf",
                "s3SecretAccessKey": "iewmdfuasfwnwksd"
            }
        }
    }
}


Data Structure


Parameters:
  • notify: Boolean
    • Enable / Disable notification for every recording made
    • Example values: true, false, 1, 0
  • url: String (optional)
Data structure

Once a recording/mixing is completed by Temasys's servers, the metadata relevant to the mixed video will be sent to this URL.
  • meetingId : containing the meetingId of the recording.
  • apiKey: apiKey used for the recording.
  • unixTime: unix time of the mixing completion of the recording file.
  • roomId: the room name
  • participants: the number max of participants in the call
  • startTime: time at which the recorded call started UTC format
  • endTime: time at which the recorded call ended UTC format
  • retrievalUrl: download link generated by Amazon S3 servers to download the recording file.
  • email: String
  • s3Arn: String
    • The S3 arn (Amazon Resource Name) url to be used by the recording server
    • The pattern should be something like this:
      • arn:{partition}:{service}:{region}:{account-id}:{resourcetype}/{resource}
      • Parameters:
        • partition: String
          • The partition that the resource is in. 
          • For standard AWS regions, the partition is aws. 
          • If you have resources in other partitions, the partition is aws-partitionname.
        • service: String
          • The service namespace that identifies the AWS product which in our case, s3.
        • region: String
          • The region the resource resides in. 
          • Note that the ARNs for some resources do not require a region, so this component might be omitted.
        • account: String
          • The ID of the AWS account that owns the resource, without the hyphens. For example, 123456789012. 
          • Note that the ARNs for some resources don't require an account number, so this component might be omitted.

        • resource, resourcetype:resource, or resourcetype/resource: String

          • The content of this part of the ARN varies by service. 
          • It often includes an indicator of the type of resource, followed by a slash (/) or a colon (:), followed by the resource name itself.
      • Example values:
        • arn:aws:s3:region::bucketname/objectpath
    • Required if the other two S3 settings requirements are included:
      • s3AccessKeyId
      • s3SecretAccessKey
    • Optional only if the other two S3 settings requirements are also not included:
      • s3AccessKeyId
      • s3SecretAccessKey
  • s3AccessKeyId: String
    • The S3 access key id to be used by the recording server
    • Required if the other two S3 settings requirements are included:
      • s3Arn
      • s3SecretAccessKey
    • Optional only if the other two S3 settings requirements are also not included:
      • s3Arn
      • s3SecretAccessKey
  • s3SecretAccessKey: String
    • The S3 access key id to be used by the recording server
    • Required if the other two S3 settings requirements are included:
      • s3Arn
      • s3AccessKeyId
    • Optional only if the other two S3 settings requirements are also not included:
      • s3Arn
      • s3AccessKeyId



Glossary


  • status - Result status
    • 1 - Successful
    • 0 - Failed
    • -1 - Not authorized
  • username - The owner of the notification
  • notify - If user wants to be notified
  • url - A url that will receive events from recording via HTTP POST method
    • In a GET request the url field will not be listed if it has no value.
  • email - An array of emails that will receive the notification email when a recording has been made
  • s3Settings - User S3 settings. Sometimes this will not show because user does not have an S3 setting which means recording server will upload on its default S3 settings.
    • s3Arn - The S3 arn to be used by recording server for uploading by the recording server
    • s3AccessKeyId - The S3 access key id
    • s3SecretAccessKey - The S3 secret access key