Get Custom User (Team Member) Token

This page contains the information on the API to get the access token of the team user's.

This endpoint generates a permanent token for a specified user based on their email and user type.

Request URL

https://api.v7.botpenguin.com/ext/get-user-token

Request Method

GET

Request Headers

HeaderValue

Authorization

Bearer [Your Access Token]

authtype

Key

Request Parameters

ParameterDescriptionTypeRequiredAllowed Values

email

Email address of the user

string

Yes

type

Type of user

string

Yes

AGENT, CUSTOM_USER, CUSTOMER

Allowed values for the Type query parameter

AGENT: For team users with default agent role

CUSTOM_USER: For team members with a custom role

CUSTOMER: For the main customer role

Sample Request

curl --location 'https://api.v7.botpenguin.com/ext/get-user-token?email=[Team member's Email]&type=CUSTOM_USER' \
--header 'Authorization: Bearer [Your Access Token]' \
--header 'authtype: Key'

Sample Response

{
    "success": true,
    "message": "",
    "data": {
        "permanentToken": {
            "key": "[Agent's Token]",
            "active": true
        }
    },
    "code": 200
}

Response Attributes

AttributeDescription

success

Indicates if the request was successful.

message

Additional information or error message.

data

Object containing the permanent token.

code

HTTP status code of the response.

Data Attributes

AttributeDescription

permanentToken

Object containing the permanent token details.

key

The generated permanent token key.

active

Flag indicating if the token is active.

Note:

  • Make sure to replace [Your Access Token] with your actual access token.

  • Mask confidential details such as access tokens before sharing or storing this documentation.

Last updated