Create admin interaction token
POSThttps://api.one.blendvision.com/bv/cms/v1/lives/:id/interaction/tokens:admin
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
Deprecated. Use CreateChatroomToken instead. Provides an admin token tailored for managing the chatroom and polls of a specific live. If the chatroom and polls are disabled, an empty token will be returned.
- Returns a
404
/NotFound
error if the requested live session is not found.
Request
Path Parameters
Required. The unique id of the live.
Header Parameters
To invoke this API using api_token
, you need to set the x-bv-org-id
header to specify the organization for which you want to perform the action.
- application/json
Body
required
object
Responses
- 200
- 400
- 401
- 403
- 500
- default
A successful response.
- application/json
- Schema
- Example (from schema)
Schema
Output only. The access token for chatroom. It'll be empty if chatroom is disabled.
Output only. The access token for poll management. It'll be empty if poll is disabled.
Output only. The access token for sticker management. It'll be empty if chatroom is disabled.
Output only. The access token for word filter management. It'll be empty if chatroom is disabled.
{
"chatroom_token": "string",
"poll_token": "string",
"sticker_token": "string",
"word_filter_token": "string"
}
A bad request response.
The code
is 3
means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A unauthenticated response.
The header authorization
was missing or unidentified.
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A forbidden response.
It means that the provided authorization
did not have enough permission to access the resource or the API.
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
A server error response. There are more HTTP status code mappings listed on here.
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
- application/json
- Schema
- Example (from schema)
Schema
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Authorization: authorization
name: authorizationtype: apiKeydescription: Enter the token with Bearer schema prefix, eg. `Bearer <token-string>`in: header
- curl
- python
- go
- nodejs
- php
- CURL
curl -L 'https://api.one.blendvision.com/bv/cms/v1/lives/:id/interaction/tokens:admin' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'authorization: <API_KEY_VALUE>' \
-d '{}'