Token creation

POST https://video-agent.8x8.com//api/v1/tokens

This API endpoint allows the creation of a bearer token. The API endpoint can also be used to create a new room, once a room is created, participants can join it, creating a conference. Once a room is created, the validity period is 15 minutes. More example on this API usages can be found here.

Authentication:

  • 8x8 Video Interaction API utilizes an 8x8 API Key for authentication.
    • You can create a API key directly from the Connect Portal. The process to create an API key is documented here and a direct link to the API Keys page can be found here.
    • You need to include the following header in your requests: Authorization: Bearer {API key}
  • NB: (replace the {API key} placeholder with your API key from Connect)

Request

Header Parameters

    Content-Type stringrequired
    Default value: application/json
    authorization stringrequired
    Default value: Bearer {YourApiKey}

Body

This API endpoint can be used in multiple ways:

  • An empty request body will generate a token that can be used to log in an Agent using the iFrame mechanism but without creating a room.
  • With a request body (see below) you are getting a token and creating a room. This will allow you to log in the agents later on and to have a room already created after log in.

If you provide a phone number, we will send the link via SMS to the phone number, when an agent logins with the token. If you want to send the link yourself, do not provide a phone number (you can still provide a Call Reference).

    create_roomboolean

    "create_room" is an optional parameter, default is false. If you want to create a room while getting the token, you need to set this parameter to ‘true’.

    Example: true
    phone_numberstring

    “phone_number” is an optional parameter, it should be an international phone number

    Example: +6512345678
    call_referencestring

    “call_reference” is an optional parameter, it should be a string of min 8 characters and max 20 characters.

    Example: 123abcde

Here is an example of successful response:

Schema

    string
{
"":"string"
}

Schema

{
"auth_token":"[...]E5B87qPWXyNNDHBx_LftaHarc"
}

Source: https://developer.8x8.com/connect/reference/management-api · 8x8 CPaaS Developer Docs. Synced for support deflection.

Was this article helpful?
or
0 out of 0 found this helpful
Avatar
Stephen - 8x8 Technical Support Level 2

0 Comments

Please sign in to leave a comment.

Didn't find what you were looking for?

Submit a request