{"id":29897644,"url":"https://github.com/green-api/green-api-chat","last_synced_at":"2025-08-09T16:23:36.199Z","repository":{"id":306253651,"uuid":"1012472235","full_name":"green-api/green-api-chat","owner":"green-api","description":null,"archived":false,"fork":false,"pushed_at":"2025-07-31T13:35:24.000Z","size":1323,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-08-01T10:49:34.772Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/green-api.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-07-02T11:39:24.000Z","updated_at":"2025-07-29T05:48:06.000Z","dependencies_parsed_at":"2025-07-24T17:08:35.345Z","dependency_job_id":null,"html_url":"https://github.com/green-api/green-api-chat","commit_stats":null,"previous_names":["green-api/green-api-chat"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/green-api/green-api-chat","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fgreen-api-chat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fgreen-api-chat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fgreen-api-chat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fgreen-api-chat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/green-api","download_url":"https://codeload.github.com/green-api/green-api-chat/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/green-api%2Fgreen-api-chat/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268231130,"owners_count":24217029,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-01T02:00:08.611Z","response_time":67,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-08-01T10:19:37.324Z","updated_at":"2025-08-09T16:23:36.191Z","avatar_url":"https://github.com/green-api.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# πŸ“¦ sw-console-chat\n\nChat module for personal accounts using [GREEN-API](https://green-api.com/en).\n\n## πŸ“₯ Installation\n\nTo install dependencies:\n\n```bash\nnpm install\n```\n\n## πŸš€ Development Mode\n\nStart the development server:\n\n```bash\nnpm run dev\n```\n\n## πŸ“¦ Production Build\n\nBuild the app for production:\n\n```bash\nnpm run build\n```\n\nCompiled files will be located in the `dist/` directory.\n\n---\n\n## πŸ” Authorization Methods\n\nYou can provide authorization data to the chat module using either **postMessage** or **URL query parameters**.\n\n---\n\n### 1. Authorization via `postMessage`\n\nTo send authorization data from a parent window to an embedded iframe, use the `postMessage` API.\n\n#### Example:\n\n```ts\niframeReference.current?.contentWindow?.postMessage(\n {\n type: MessageEventTypeEnum.INIT,\n payload: {\n login: login,\n apiTokenUser: apiTokenUser,\n idUser: idUser,\n idInstance: instanceData.idInstance,\n apiTokenInstance: instanceData.apiTokenInstance,\n apiUrl: instanceData.apiUrl,\n mediaUrl: instanceData.mediaUrl,\n tariff: instanceData.tariff,\n locale: resolvedLanguage,\n theme: currentTheme,\n platform: platform,\n projectId: projectId,\n\n // customization\n brandDescription: 'Welcome to our support chat!',\n logo: 'https://example.com/logo.png',\n },\n },\n CHAT_APP_URL // Replace with the actual iframe URL\n);\n```\n\n#### Payload Fields\n\n| Field | Type | Description |\n| ------------------ | --------------------- | ------------------------------------------- |\n| `login` | `string` | User login |\n| `apiTokenUser` | `string` | User API token |\n| `idUser` | `string` | User ID |\n| `idInstance` | `number` | Instance ID |\n| `apiTokenInstance` | `string` | API token for the instance |\n| `apiUrl` | `string` | Base API URL |\n| `mediaUrl` | `string` | Media upload URL |\n| `tariff` | `TariffsEnum` | Tariff plan (see below) |\n| `locale` | `string \\| undefined` | Optional language code (e.g., `en`, `ru`) |\n| `theme` | `ThemesEnum` | Theme mode (see below) |\n| `platform` | `string` | Platform ID (e.g., `web`, `android`, `ios`) |\n| `projectId` | `string` | Project identifier |\n| `brandDescription` | `string` | Welcome message when no chat is selected |\n| `logo` | `string` | Image/logo URL above the description |\n\n#### TariffsEnum\n\n```ts\nexport const enum TariffsEnum {\n Developer = 'DEVELOPER',\n Business = 'BUSINESS',\n BusinessUSD = 'BUSINESS_USD',\n BusinessKZT = 'BUSINESS_KZT',\n}\n```\n\n#### ThemesEnum\n\n```ts\nexport const enum ThemesEnum {\n Default = 'default',\n Dark = 'dark',\n}\n```\n\n---\n\n### 2. Authorization via URL Query Parameters\n\nYou can also pass authorization and customization data via the URL:\n\n```\nhttp://localhost:5173/?idInstance=YOUR_ID\u0026apiTokenInstance=YOUR_API_TOKEN\u0026apiUrl=https://api.green-api.com/\u0026mediaUrl=https://media.green-api.com/\u0026lng=ru\u0026dsc=Π”ΠΎΠ±Ρ€ΠΎ%20ΠΏΠΎΠΆΠ°Π»ΠΎΠ²Π°Ρ‚ΡŒ%20Π²%20Ρ‡Π°Ρ‚\u0026logo=https://example.com/logo.png\n```\n\n#### Required Query Parameters\n\n| Parameter | Description |\n| ------------------ | -------------------------- |\n| `idInstance` | Instance ID |\n| `apiTokenInstance` | API token for the instance |\n| `apiUrl` | Base API URL |\n| `mediaUrl` | Media API URL |\n\n#### Optional Customization Parameters\n\n| Parameter | Description |\n|-----------|----------------------------------------------------------|\n| `lng` | Language (`ru`, `en`, `he`) |\n| `dsc` | Description text on home screen when no chat is selected |\n| `logo` | Image/logo URL shown above the description |\n| `chatId` | If you need only one chat. In format XXXXXXXXXXX@c.us |\n\n## πŸ“„ License\n\nMIT License\n\n---\n\n# πŸ“¦ sw-console-chat\n\nΠœΠΎΠ΄ΡƒΠ»ΡŒ Ρ‡Π°Ρ‚Π° с использованиСм [GREEN-API](https://green-api.com/).\n\n## πŸ“₯ Установка\n\nДля установки зависимостСй:\n\n```bash\nnpm install\n```\n\n## πŸš€ Π Π΅ΠΆΠΈΠΌ Ρ€Π°Π·Ρ€Π°Π±ΠΎΡ‚ΠΊΠΈ\n\nЗапуск сСрвСра Ρ€Π°Π·Ρ€Π°Π±ΠΎΡ‚ΠΊΠΈ:\n\n```bash\nnpm run dev\n```\n\n## πŸ“¦ Π‘Π±ΠΎΡ€ΠΊΠ° для ΠΏΡ€ΠΎΠ΄Π°ΠΊΡˆΠ΅Π½Π°\n\nΠ‘Π±ΠΎΡ€ΠΊΠ° прилоТСния для ΠΏΡ€ΠΎΠ΄Π°ΠΊΡˆΠ΅Π½Π°:\n\n```bash\nnpm run build\n```\n\nΠ‘ΠΊΠΎΠΌΠΏΠΈΠ»ΠΈΡ€ΠΎΠ²Π°Π½Π½Ρ‹Π΅ Ρ„Π°ΠΉΠ»Ρ‹ Π±ΡƒΠ΄ΡƒΡ‚ Π½Π°Ρ…ΠΎΠ΄ΠΈΡ‚ΡŒΡΡ Π² Π΄ΠΈΡ€Π΅ΠΊΡ‚ΠΎΡ€ΠΈΠΈ `dist/`.\n\n---\n\n## πŸ” ΠœΠ΅Ρ‚ΠΎΠ΄Ρ‹ Π°Π²Ρ‚ΠΎΡ€ΠΈΠ·Π°Ρ†ΠΈΠΈ\n\nΠ’Ρ‹ ΠΌΠΎΠΆΠ΅Ρ‚Π΅ ΠΏΠ΅Ρ€Π΅Π΄Π°Ρ‚ΡŒ Π΄Π°Π½Π½Ρ‹Π΅ Π°Π²Ρ‚ΠΎΡ€ΠΈΠ·Π°Ρ†ΠΈΠΈ Π² ΠΌΠΎΠ΄ΡƒΠ»ΡŒ Ρ‡Π°Ρ‚Π° с ΠΏΠΎΠΌΠΎΡ‰ΡŒΡŽ **postMessage** ΠΈΠ»ΠΈ **ΠΏΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€ΠΎΠ² URL**.\n\n---\n\n### 1. Авторизация Ρ‡Π΅Ρ€Π΅Π· `postMessage`\n\nΠ§Ρ‚ΠΎΠ±Ρ‹ ΠΎΡ‚ΠΏΡ€Π°Π²ΠΈΡ‚ΡŒ Π΄Π°Π½Π½Ρ‹Π΅ Π°Π²Ρ‚ΠΎΡ€ΠΈΠ·Π°Ρ†ΠΈΠΈ ΠΈΠ· Ρ€ΠΎΠ΄ΠΈΡ‚Π΅Π»ΡŒΡΠΊΠΎΠ³ΠΎ ΠΎΠΊΠ½Π° Π² встроСнный iframe, ΠΈΡΠΏΠΎΠ»ΡŒΠ·ΡƒΠΉΡ‚Π΅ API `postMessage`.\n\n#### ΠŸΡ€ΠΈΠΌΠ΅Ρ€:\n\n```ts\niframeReference.current?.contentWindow?.postMessage(\n {\n type: MessageEventTypeEnum.INIT,\n payload: {\n login: login,\n apiTokenUser: apiTokenUser,\n idUser: idUser,\n idInstance: instanceData.idInstance,\n apiTokenInstance: instanceData.apiTokenInstance,\n apiUrl: instanceData.apiUrl,\n mediaUrl: instanceData.mediaUrl,\n tariff: instanceData.tariff,\n locale: resolvedLanguage,\n theme: currentTheme,\n platform: platform,\n projectId: projectId,\n\n // кастомизация\n brandDescription: 'Π”ΠΎΠ±Ρ€ΠΎ ΠΏΠΎΠΆΠ°Π»ΠΎΠ²Π°Ρ‚ΡŒ Π² наш Ρ‡Π°Ρ‚ ΠΏΠΎΠ΄Π΄Π΅Ρ€ΠΆΠΊΠΈ!',\n logo: 'https://example.com/logo.png',\n },\n },\n CHAT_APP_URL // Π—Π°ΠΌΠ΅Π½ΠΈΡ‚Π΅ Π½Π° фактичСский URL iframe\n);\n```\n\n#### Поля payload\n\n| ПолС | Π’ΠΈΠΏ | ОписаниС |\n| ------------------ | --------------------- | ----------------------------------------------------- |\n| `login` | `string` | Π›ΠΎΠ³ΠΈΠ½ ΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚Π΅Π»Ρ |\n| `apiTokenUser` | `string` | API Ρ‚ΠΎΠΊΠ΅Π½ ΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚Π΅Π»Ρ |\n| `idUser` | `string` | ID ΠΏΠΎΠ»ΡŒΠ·ΠΎΠ²Π°Ρ‚Π΅Π»Ρ |\n| `idInstance` | `number` | ID инстанса |\n| `apiTokenInstance` | `string` | API Ρ‚ΠΎΠΊΠ΅Π½ инстанса |\n| `apiUrl` | `string` | Π‘Π°Π·ΠΎΠ²Ρ‹ΠΉ URL API |\n| `mediaUrl` | `string` | URL для Π·Π°Π³Ρ€ΡƒΠ·ΠΊΠΈ ΠΌΠ΅Π΄ΠΈΠ° |\n| `tariff` | `TariffsEnum` | Π’Π°Ρ€ΠΈΡ„Π½Ρ‹ΠΉ ΠΏΠ»Π°Π½ (см. Π½ΠΈΠΆΠ΅) |\n| `locale` | `string \\| undefined` | ΠΠ΅ΠΎΠ±ΡΠ·Π°Ρ‚Π΅Π»ΡŒΠ½Ρ‹ΠΉ ΠΊΠΎΠ΄ языка (Π½Π°ΠΏΡ€ΠΈΠΌΠ΅Ρ€, `en`, `ru`, `he`) |\n| `theme` | `ThemesEnum` | Π’Π΅ΠΌΠ° интСрфСйса (см. Π½ΠΈΠΆΠ΅) |\n| `platform` | `string` | ΠŸΠ»Π°Ρ‚Ρ„ΠΎΡ€ΠΌΠ° (`web`, `android`, `ios`) |\n| `projectId` | `string` | Π˜Π΄Π΅Π½Ρ‚ΠΈΡ„ΠΈΠΊΠ°Ρ‚ΠΎΡ€ ΠΏΡ€ΠΎΠ΅ΠΊΡ‚Π° |\n| `brandDescription` | `string` | ВСкст привСтствия, ΠΊΠΎΠ³Π΄Π° Ρ‡Π°Ρ‚ Π½Π΅ Π²Ρ‹Π±Ρ€Π°Π½ |\n| `logo` | `string` | Бсылка Π½Π° Π»ΠΎΠ³ΠΎΡ‚ΠΈΠΏ, ΠΎΡ‚ΠΎΠ±Ρ€Π°ΠΆΠ°Π΅ΠΌΡ‹ΠΉ Π½Π°Π΄ описаниСм |\n\n#### TariffsEnum\n\n```ts\nexport const enum TariffsEnum {\n Developer = 'DEVELOPER',\n Business = 'BUSINESS',\n BusinessUSD = 'BUSINESS_USD',\n BusinessKZT = 'BUSINESS_KZT',\n}\n```\n\n#### ThemesEnum\n\n```ts\nexport const enum ThemesEnum {\n Default = 'default',\n Dark = 'dark',\n}\n```\n\n---\n\n### 2. Авторизация Ρ‡Π΅Ρ€Π΅Π· ΠΏΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€Ρ‹ URL\n\nΠ’Ρ‹ Ρ‚Π°ΠΊΠΆΠ΅ ΠΌΠΎΠΆΠ΅Ρ‚Π΅ ΠΏΠ΅Ρ€Π΅Π΄Π°Ρ‚ΡŒ Π΄Π°Π½Π½Ρ‹Π΅ Π°Π²Ρ‚ΠΎΡ€ΠΈΠ·Π°Ρ†ΠΈΠΈ ΠΈ кастомизации Ρ‡Π΅Ρ€Π΅Π· ΠΏΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€Ρ‹ URL ΠΏΡ€ΠΈ Π·Π°Π³Ρ€ΡƒΠ·ΠΊΠ΅ прилоТСния:\n\n```\nhttp://localhost:5173/?idInstance=YOUR_ID\u0026apiTokenInstance=YOUR_API_TOKEN\u0026apiUrl=https://api.green-api.com/\u0026mediaUrl=https://media.green-api.com/\u0026lng=ru\u0026dsc=Π”ΠΎΠ±Ρ€ΠΎ%20ΠΏΠΎΠΆΠ°Π»ΠΎΠ²Π°Ρ‚ΡŒ%20Π²%20Ρ‡Π°Ρ‚\u0026logo=https://example.com/logo.png\n```\n\n#### ΠžΠ±ΡΠ·Π°Ρ‚Π΅Π»ΡŒΠ½Ρ‹Π΅ ΠΏΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€Ρ‹\n\n| ΠŸΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€ | ОписаниС |\n| ------------------ | ---------------------------- |\n| `idInstance` | ID инстанса |\n| `apiTokenInstance` | API Ρ‚ΠΎΠΊΠ΅Π½ инстанса |\n| `apiUrl` | Π‘Π°Π·ΠΎΠ²Ρ‹ΠΉ URL API |\n| `mediaUrl` | URL для Π·Π°Π³Ρ€ΡƒΠ·ΠΊΠΈ ΠΌΠ΅Π΄ΠΈΠ°Ρ„Π°ΠΉΠ»ΠΎΠ² |\n\n#### ΠΠ΅ΠΎΠ±ΡΠ·Π°Ρ‚Π΅Π»ΡŒΠ½Ρ‹Π΅ ΠΏΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€Ρ‹ кастомизации\n\n| ΠŸΠ°Ρ€Π°ΠΌΠ΅Ρ‚Ρ€ | ОписаниС |\n|----------|-----------------------------------------------------------------|\n| `lng` | Π―Π·Ρ‹ΠΊ интСрфСйса (`ru`, `en`, `he`) |\n| `dsc` | ОписаниС, ΠΎΡ‚ΠΎΠ±Ρ€Π°ΠΆΠ°Π΅ΠΌΠΎΠ΅ Π½Π° Π³Π»Π°Π²Π½ΠΎΠΉ страницС, ΠΊΠΎΠ³Π΄Π° Ρ‡Π°Ρ‚ Π½Π΅ Π²Ρ‹Π±Ρ€Π°Π½ |\n| `logo` | Бсылка Π½Π° ΠΈΠ·ΠΎΠ±Ρ€Π°ΠΆΠ΅Π½ΠΈΠ΅/Π»ΠΎΠ³ΠΎΡ‚ΠΈΠΏ, ΠΎΡ‚ΠΎΠ±Ρ€Π°ΠΆΠ°Π΅ΠΌΠΎΠ΅ Π½Π°Π΄ описаниСм |\n| `chatId` | Если Π²Π°ΠΌ Π½ΡƒΠΆΠ΅Π½ Ρ‚ΠΎΠ»ΡŒΠΊΠΎ ΠΎΠ΄ΠΈΠ½ Ρ‡Π°Ρ‚. Π€ΠΎΡ€ΠΌΠ°Ρ‚ XXXXXXXXXXX@c.us |\n\n## πŸ“„ ЛицСнзия\n\nЛицСнзия MIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreen-api%2Fgreen-api-chat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreen-api%2Fgreen-api-chat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreen-api%2Fgreen-api-chat/lists"}