im/Accounts
Collection of IM (Instant Messaging) accounts. The collection is created and used by the 'im' microservice.
Accounts are created bound to an instant messaging channel that sets common processing scripts.
Storage type: category.
| Field | Description |
|---|---|
|
Identifier. |
|
Account name. |
|
Instant messaging channel type. The value corresponds to the code of an existing im channel. Accounts For an account of type 'whatsapp', 'vk', or 'max' in For convenience, when creating a 'whatsapp', 'vk', or 'max' account, a messenger channel /rest/v1/uc/imchannels and an integration channel /rest/v1/service/integration_points are created automatically. The information useful for webhook registration is automatically placed in the 'webhookInfo' field. |
|
Account switch. |
|
Additional arbitrary account options by channel types. For Telegram:
For Whatsapp business:
For VK:
For MAX:
Secret ( |
|
Status message. Populated by the system when failures are detected in interaction scripts. |
|
System platform account (for example, the administrator bot, administrator bot). Product services do not use such accounts. Default |
Field into which the system automatically enters data for registration on the provider side: the webhook page and verification token.
Example value
{
"url": "/api/im/v1/0123456789abcdef0123456789abcdef",
"verifyToken": "d4012683-0191-a406-c746-7cd30a921f58"
}
When registering the system to receive webhooks, the scheme and host name by which the server is accessible must be appended to the provided page. For example, 'https://my-public-domain.org:443', so that it becomes 'https://my-public-domain.org:443/api/im/v1/…'. |