Suggestions

close search

Account Management

Account administrators can use the OpenTok REST API to create and manage individual projects in their OpenTok account.

For example, you may want to create different projects that correspond to different customers. Separate projects enable OpenTok to track usage individually for each customers.

Each project has its own unique OpenTok project API key and project API secret.

For example, a customer — Acme — is using your service. You can use the OpenTok REST API to create an OpenTok project API key and project API secret for that customer.

You can use the OpenTok REST API to do the following:

For the following REST API calls, use the account API key and secret, provided at the top of your TokBox Account page, when creating the authentication token) you use in the REST API call:

The account API key and secret is only available to the registered administrator of your OpenTok account.

For the archive-related REST API calls, use the API key and secret for the specific project in your account. These are provided on the Project page of your TokBox Account.

Project details object

Many responses to the REST API calls include a project details object. This part of the JSON response includes details on the project. It is in the following format:

{
  "id":  "12312",
  "secret":  "567890",
  "status": "ACTIVE",
  "name": "Joe Montana",
  "environment": "standard",
  "createdAt": 1414642898000 // A UNIX timestamp (in milliseconds)
}

The project details object has the following properties:

Please disregard any other properties in the project details object.