Get Telegram Integration

Endpoint used to get a Telegram integration.

Request Example

curl --request GET \
  --url https://chat.api.toolzz.com.br/api/v1/telegram/integration/{integrationId} \
  --header 'Authorization: Bearer TOKEN_HERE'

Response Example

{
    "id": "uuid",
    "botId": "uuid",
    "unitId": "uuid",
    "title": "<string>",
    "isActive": true,
    "botToken": "<string>",
    "isTokenMasked": true,
    "scope": "<string>",
    "welcomeMessage": "<string>",
    "createdAt": "<timestamp>",
    "updatedAt": "<timestamp>",
    "deletedAt": null
}

---

Request description

Access Token

Parameter	Type	Description	Required
Authorization	String	Access token (“Bearer” must be before the token)	Yes

URL Parameters

Parameter	Type	Description	Required
integrationId	String	Telegram integration ID	Yes

Response description

Key	Type	Description
id	UUID	Unique identifier of the integration configuration in the database.
botId	UUID	Identifier of the bot associated within the Toolzz AI platform.
unitId	UUID	Unique identifier of the owning organizational unit.
title	String	Integration identifier name (e.g., “TelegramAI”).
isActive	Boolean	Defines if the integration is active and enabled to respond.
botToken	String	Telegram authentication token (API Key), displayed in a masked form.
isTokenMasked	Boolean	Signals if the token returned in the response is hidden for security.
scope	String	Bot’s scope of action (e.g., both, private, group).
welcomeMessage	String	Automatic greeting text sent when starting a conversation.
createdAt	String	Original record creation date and time (ISO 8601).
updatedAt	String	Date and time of the last modification in the configuration fields.
deletedAt	String/Null	Logical deletion date (Soft Delete), if the record was removed.

---

Security

To access this endpoint, it is necessary to send a valid access token through the authorization header (Authorization) of the request. Additionally, the API is protected by other security measures to safeguard user data.

To access your access token, follow these steps:

1. Log in to the ToolzzAI platform
2. Click on “Settings”
3. Click on “Access Token”
4. Copy the access token