Wazzup

https://wazzup24.ru/help/
Admin
Wazzup is a service that provides a knowledge base to help users get started and find information.
Tokens:333,187
Snippets:2,001
Trust Score:8.9
Update:9 months ago
Show doc for...
Tokens:
Raw
### GET /websites/wazzup24_ru_help

Source: https://wazzup24.ru/help/api/shablony-whatsapp-business-api

Retrieves a list of help templates or specific template details. The example response shows a detailed structure for a single template.

```APIDOC
## GET /websites/wazzup24_ru_help

### Description
Retrieves a list of help templates or specific template details. The example response shows a detailed structure for a single template.

### Method
GET

### Endpoint
/websites/wazzup24_ru_help

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Request Example
```json
{
  "example": "No request body for GET"
}
```

### Response
#### Success Response (200)
- **templateGuid** (string) - Unique identifier for the template.
- **accountId** (integer) - The ID of the account associated with the template.
- **title** (string) - The title of the template.
- **channels** (array of strings) - List of channel IDs the template is associated with.
- **order** (integer) - The display order of the template.
- **category** (string) - The category of the template (e.g., MARKETING).
- **language** (string) - The language of the template (e.g., 'ru').
- **components** (array of objects) - An array of template components (e.g., HEADER, BODY).
  - **text** (string) - The text content of the component.
  - **type** (string) - The type of the component (e.g., HEADER, BODY).
  - **format** (string) - The format of the component's text (e.g., TEXT).
  - **example** (object) - Example data for the component.
    - **header_text** (array of strings) - Example header texts.
    - **body_text** (array of arrays of strings) - Example body texts.
- **waba** (object) - WhatsApp Business Account details.
  - **wabaId** (string) - The WhatsApp Business Account ID.
  - **wabaName** (string) - The WhatsApp Business Account name.
- **name** (string) - The name of the template as sent to Facebook.
- **namespace** (string) - The namespace for the template.
- **publishedAt** (string or null) - The timestamp when the template was published.
- **isTrickyTemplate** (boolean) - Indicates if it's a tricky template.
- **trickyTemplatesPriority** (any or null) - Priority for tricky templates.
- **createdAt** (string) - The timestamp when the template was created.
- **updatedAt** (string) - The timestamp when the template was last updated.
- **componentsDefaults** (object) - Default values for components.
- **tags** (any or null) - Tags associated with the template.
- **templateCode** (string) - The code representation of the template.

#### Response Example
```json
[
 {
  "templateGuid": "8d255e5d-aefd-44dc-8131-c3ad6c3ab28c",
  "accountId": 70789196,
  "title": "Название шаблона",
  "channels": ["e9a268e4-44af-41cd-9b63-2524a4ad653e"],
  "order": 0,
  "category": "MARKETING",
  "language": "ru",
  "components": [
    {
     "text": "Привет, !",
     "type": "HEADER",
     "format": "TEXT",
     "example": {
     "header_text": ["header-example-1"]
      }
    },
    {
     "text": "Обновление сервиса.",
     "type": "BODY",
     "example": {
      "body_text": [["body-example-1"]]
     }
    }
 ],
  "waba": {
   "wabaId": "194388939529290",
   "wabaName": "Wazzup LLC"
 },
 "name": "Имя шаблона, которое отправляется в Facebook",
 "namespace": "c8ae5f90_307a_ca4c_b8f6_d1e2a2573574",
 "publishedAt": null,
 "isTrickyTemplate": false,
 "trickyTemplatesPriority": null,
 "createdAt": "2023-12-31T23:55:42.504Z",
 "updatedAt": "2023-12-31T23:55:08.857Z",
 "componentsDefaults": {},
 "tags": null,
 "templateCode": "@template: fe03cddf-dec1-4c19-aede-e16190abca46 { [[headerVar1]]; [[bodyVar1]] }"
 }
]
```
```

--------------------------------

### Webhook Configuration Response Example

Source: https://wazzup24.ru/help/ru/webhooks-2

This is an example of a successful response when retrieving the Wazzup API webhook configuration via a GET request. It details the 'webhooksUri' and the 'subscriptions' object, indicating which event types are currently enabled.

```json
HTTP/1.1 200 OK
{
"webhooksUri": "https://example.com/webhooks",
"subscriptions": {
"messagesAndStatuses": "true",
"contactsAndDealsCreation": "true"
}
}
```

--------------------------------

### Template with Media: Image URL Example

Source: https://wazzup24.ru/help/how-to-configurate/how-to-work-with-waba-templates-in-salesbot

This example shows a direct URL for an image file that can be used in a Wazzup24 template. Ensure the URL points directly to the media file and not a cloud storage link.

```text
https://store.wazzup24.com/c4d2f98d9b3d75d1a8e8d760343c26cc66495ea4
```

--------------------------------

### Working with STOCRM

Source: https://wazzup24.ru/help/eshhe-crm-2/kak-rabotat-s-wazzup-v-stocrm

Instructions on how to connect and work with Wazzup in STOCRM, designed for quick setup.

```APIDOC
## How to work with Wazzup in STOCRM

### Description
This guide provides step-by-step instructions to set up Wazzup within STOCRM quickly and easily.

### Method
N/A (This is a configuration guide, not an API endpoint)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A

### Setup Instructions
Follow the instructions provided within STOCRM to connect your Wazzup account. The process is designed to take only a few minutes.
```

--------------------------------

### Example HTTP Response JSON

Source: https://wazzup24.ru/help/api-ru/shablony-whatsapp-business-api

This snippet shows an example of an HTTP 200 OK response, containing a JSON object that details a message template. It includes fields for template GUID, account ID, title, channels, category, language, components (header and body with examples), WABA details, name, namespace, creation and update timestamps, and a template code.

```json
HTTP/1.1 200 OK
[
 {
  "templateGuid": "8d255e5d-aefd-44dc-8131-c3ad6c3ab28c",
  "accountId": 70789196,
  "title": "Название шаблона",
  "channels": ["e9a268e4-44af-41cd-9b63-2524a4ad653e"],
  "order": 0,
  "category": "MARKETING",
  "language": "ru",
  "components": [
    {
     "text": "Привет, !",
     "type": "HEADER",
     "format": "TEXT",
     "example": {
     "header_text": ["header-example-1"]
      }
    },
    {
     "text": "Обновление сервиса.",
     "type": "BODY",
     "example": {
      "body_text": [["body-example-1"]]
     }
 }
 ],
  "waba": {
   "wabaId": "194388939529290",
   "wabaName": "Wazzup LLC"
 },
 "name": "Имя шаблона, которое отправляется в Facebook",
 "namespace": "c8ae5f90_307a_ca4c_b8f6_d1e2a2573574",
 "publishedAt": null,
 "isTrickyTemplate": false,
 "trickyTemplatesPriority": null,
 "createdAt": "2023-12-31T23:55:42.504Z",
 "updatedAt": "2023-12-31T23:55:08.857Z",
 "componentsDefaults": {},
 "tags": null,
 "templateCode": "@template: fe03cddf-dec1-4c19-aede-e16190abca46 { [[headerVar1]]; [[bodyVar1]] }"
}
]
```

--------------------------------

### Wazzup Integration Response Example

Source: https://wazzup24.ru/help/api/wauth

This code snippet demonstrates a successful HTTP response from the Wazzup API after a successful integration setup. It includes the HTTP status code and a JSON body containing a generated apiKey.

```HTTP
HTTP/1.1 200 OK
{
  "data": "1365e2e9119c4d889ca467cc4a9e6a48"
}
```

--------------------------------

### WAuth Integration Setup

Source: https://wazzup24.ru/help/api/wauth

This section details the WAuth system, inspired by OAuth2.0, for partners to integrate their applications into the Wazzup marketplace. It outlines the user connection flow and the necessary steps for setting up WAuth.

```APIDOC
## WAuth

Cистема вдохновлена OAuth2.0, но формально ей не является. Этот способ подключения должен использовать каждый партнер, который хочет опубликовать в нашем маркетплейсе свою интеграцию.
WAuth нужен, чтобы пользователь мог подключить интеграцию «по кнопке», а не возился с ключом API.

**Как пользователь подключает интеграцию из нашего маркетплейса:**
1. Пользователь выбирает CRM в маркетплейсе интеграций Wazzup.
2. Кликает «Подключить».
3. Пользователя редиректит в CRM.
4. Он авторизуется в CRM и подтверждает, что хочет подключить интеграцию.
5. Готово — пользователь подключил интеграцию между Wazzup и CRM.

#### Настройка WAuth

Когда все шапы по созданию интеграции выполнены, можно приступать к WAuth.

**Этап 1.** Вызовите **POST v3/marketplace** , чтобы передать значения полей:

| Параметр | Тип | Описание |
|---|---|---|
| crmCode | String | Служит для внутренней идентификации CRM. Строка из латинских букв, цифр. Можно использовать дефис и нижнее подчеркивание. Уникальное в рамках Wazzup |
| authRedirectUri | String | Ссылка на аккаунт CRM. Адрес, на который будем редиректить клиента для подтверждения авторизации. Если у каждого клиента уникальный адрес и редиректить на одну страницу нельзя — оставьте этот параметр пустым. Тогда, когда клиент выберет CRM в Wazzup, мы попросим его указать ссылку самостоятельно |
| secret | String | Ключ (токен), который нужен при подтверждении установки интеграции. Участвует только в запросах «сервер — сервер», клиенту никогда не отсылается |

Эти параметры будут использованы, когда ваш клиент выберет в маркетплейсе Wazzup CRM и нажмет «Подключить». В этот момент:
  * сгенерируется **state** , в котором будут закодированы **crmCode** и **accountId** ;
  * в _query string_ **authRedirectUri** добавляем **state** и переводим пользователя по этой ссылке. Если в параметре authRedirectUri пусто, попросим клиента самостоятельно указать его уникальную ссылку в CRM и перенаправим по указанной ссылке.

По ссылке клиент пройдет авторизацию на стороне CRM.

**Этап 2**. Если клиент смог авторизоваться, CRM должна сделать запрос:

`POST https://api.wazzup24.com/v3/connect/`

Метод имеет нестандартную авторизацию: определяем пользователя по свойству **secret** в теле запроса

В теле запроса должен быть JSON со значениями параметров:

| Параметр | Тип | Описание |
|---|---|---|
| state | String | Сгенерированный и подписанный на стороне Wazzup ключ. Генерируем, когда пользователь выбрал CRM в маркетплейсе и жамкнул «Подключить» |
| secret | String | Ключ, введённый администратором маркетплейсной CRM |
| crmKey | String | Сгенерированный партнером ключ, по которому можно определить, к какому клиенту относятся вебхуки. Ключ будет приходить в заголовке { Authorization: \"Bearer {wazzupKey}\" } при отправке вебхуков |
| name | String | Название интеграции. Например, домен клиента в CRM. Будет указан в личном кабинете, когда клиент подключит интеграцию |

##### Пример запроса
```curl
curl --location --request POST 'https://api.wazzup24.com/v3/connect' \
--header 'Content-Type: application/json' \
--data-raw '{
"state": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJ1c2Vy....",
"secret": "61e5a375-1760-452f-ad73-5318844ffc4f",
"crmKey": "e0629e11-0f67-4567-92a9-2237e91ec1b9",
"name": "Any integration name"
}'
```
```

--------------------------------

### Wazzup24 API: Fetch Single Contact with cURL

Source: https://wazzup24.ru/help/api/rabota-s-kontaktami

This example demonstrates how to fetch information for a single contact using the cURL command-line tool. It includes the necessary GET request to the contacts endpoint with a specific contact ID and an Authorization header for authentication.

```shell
 curl --location --request GET 'https://api.wazzup24.com/v3/contacts/111-2e0df379-0e3c-470f-9b36' \
--header 'Authorization: Bearer c8cf904467023482f909520d454368d27'
```

--------------------------------

### Example Webhook Configuration Request (cURL)

Source: https://wazzup24.ru/help/api-ru/webhooks-2

This example demonstrates how to configure webhooks using `curl`. It includes the necessary headers (Authorization and Content-Type) and the JSON data payload for setting the webhook URI and subscription preferences. This request should return a 200 OK status if successful.

```bash
curl --location --request PATCH 'https://api.wazzup24.com/v3/webhooks' \
--header 'Authorization: Bearer w11cf3444405648267f900520d454368d27' \
--header 'Content-Type: application/json' \
--data-raw '{
"webhooksUri": "https://example.com/webhooks",
"subscriptions": {
"messagesAndStatuses": true,
"contactsAndDealsCreation": true
}
}'
```

--------------------------------

### HTTP 200 OK Response Example with Template Data (JSON)

Source: https://wazzup24.ru/help/api/shablony-whatsapp-business-api

This JSON object represents a successful HTTP response (200 OK) containing detailed information about a template. It includes fields like template GUID, account ID, title, channels, components (with text, type, and examples), WABA details, name, namespace, creation and update timestamps, and a template code. This structure is common for retrieving or confirming template configurations.

```json
HTTP/1.1 200 OK
[
 {
  "templateGuid": "8d255e5d-aefd-44dc-8131-c3ad6c3ab28c",
  "accountId": 70789196,
  "title": "Название шаблона",
  "channels": ["e9a268e4-44af-41cd-9b63-2524a4ad653e"],
  "order": 0,
  "category": "MARKETING",
  "language": "ru",
  "components": [
    {
     "text": "Привет, !",
     "type": "HEADER",
     "format": "TEXT",
     "example": {
     "header_text": ["header-example-1"]
      }
    },
    {
     "text": "Обновление сервиса.",
     "type": "BODY",
     "example": {
      "body_text": [["body-example-1"]]
     }
 }
 ],
  "waba": {
   "wabaId": "194388939529290",
   "wabaName": "Wazzup LLC"
 },
 "name": "Имя шаблона, которое отправляется в Facebook",
 "namespace": "c8ae5f90_307a_ca4c-b8f6-d1e2a2573574",
 "publishedAt": null,
 "isTrickyTemplate": false,
 "trickyTemplatesPriority": null,
 "createdAt": "2023-12-31T23:55:42.504Z",
 "updatedAt": "2023-12-31T23:55:08.857Z",
 "componentsDefaults": {},
 "tags": null,
 "templateCode": "@template: fe03cddf-dec1-4c19-aede-e16190abca46 { [[headerVar1]]; [[bodyVar1]] }"
}
]
```

--------------------------------

### WZ_CREATE_ENTITY Event Example

Source: https://wazzup24.ru/help/api/okno-chatov-iframe

This example shows the structure of the WZ_CREATE_ENTITY event, which is triggered when a user initiates the creation of a new deal. It includes details about the chat, user, and integration.

```javascript
{
  type: 'WZ_CREATE_ENTITY',
  data: {
    chatType: 'whatsapp',
    chatId: 79998887766,
    channelId: 'c16tc1c-9f20-4rda-46jd-q92ty4j6s36888',
    userId: 'test_id',
    integrationId: '608df5ye-45hj-j6k7-l77k-qe5t88j4h1222'
  }
}
```

--------------------------------

### Example: Bulk Delete Deals (JavaScript Fetch)

Source: https://wazzup24.ru/help/api/rabota-so-spiskom-sdelok

A JavaScript example using the Fetch API to perform a bulk deletion of deals. It shows how to configure the request method, headers, and the JSON body containing an array of deal IDs.

```javascript
fetch("https://api.wazzup24.com/v3/deals/bulk_delete", {
  method: "PATCH",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer {apiKey}",
  },
  body: [
    "deal-id-123",
    "deal-id-456",
  ]
});
```

--------------------------------

### Connect to Notification Service and Get Unanswered Message Count (WebSocket)

Source: https://wazzup24.ru/help/api/schetchik-neotvechennyh

This section details how to establish a connection to the Wazzup24 notification service using WebSockets and Socket.IO to receive real-time updates on unanswered messages. It includes setup for the WebSocket client and event listeners for connection status and message updates.

```APIDOC
## Connect to Notification Service and Get Unanswered Message Count (WebSocket)

### Description
Connects to the Wazzup24 notification service via WebSockets to receive real-time counters for unanswered messages. This involves obtaining integration details, setting up connection options, and listening for events like 'connect', 'counterConnected', and 'counterUpdate'.

### Method
WebSocket (using Socket.IO)

### Endpoint
`https://integrations.wazzup24.com/counters/ws_host/api_v3/{apiKey}` (to get host), then connect to `wss://{host}`

### Parameters
#### Path Parameters
- **apiKey** (string) - Required - Integration key obtained from the Wazzup24 personal account.

#### Query Parameters
None

#### Request Body
None (for initial host retrieval)

### Request Example (JavaScript)
```javascript
// apiKey integration obtained from Wazzup personal account
const apiKey = 'YOUR_API_KEY';
// userId from your CRM
const userId = 'YOUR_USER_ID';
// Connection options for the notification service
const connectOptions = {
  path: '/ws-counters/',
  transports: ['websocket', 'polling']
};

// Get the URL for connecting to the notification service
fetch(`https://integrations.wazzup24.com/counters/ws_host/api_v3/${apiKey}`)
  .then((response) => response.json())
  .then((data) => {
    const { host } = data;
    // Connect using socket.io
    const client = io(`https://${host}`, connectOptions);

    // Listen for the 'connect' event
    client.on('connect', () => {
      // Initiate connection: emit 'counterConnecting' event with client data
      client.emit('counterConnecting', {
        type: 'api_v3',
        apiKey,
        userId
      });
    });

    // Connection confirmation
    client.on('counterConnected', () => console.log('Connected to Wazzup notifications!'));

    // Update unanswered counter
    client.on('counterUpdate', (data) => {
      const { counter, counterV2, type } = data;
      // Update UI element with counter value
      document.getElementById('counter').innerHTML = counter;
    });
  })
  .catch((error) => {
    console.log('Connection error', error);
  });
```

### Response
#### Success Response (Connection Host)
- **host** (string) - The host address for the WebSocket connection.

#### Success Response (counterUpdate Event Data)
- **counter** (integer) - Total count of unanswered messages.
- **counterV2** (integer) - New mechanism count for unanswered messages.
- **type** (string) - Type of counter: 'red' or 'grey'.

#### Response Example (counterUpdate Event)
```json
{
  "counterV2": 7,
  "type": "red",
  "lastMsgDateTime": "2023-05-25T12:30:46.000Z"
}
```

#### Error Response
- **Error**: Logs connection errors to the console.
```
Tokens:
Raw