Получение входящих событий

Существует два варианта получения входящих событий api:

• Через webhooks - подписка на webhooks
• Через websockets, используя протокол pusher-api

Для работы через pusher-api доступно множество готовых библиотек на разных языках программирования. Мы же с вами рассмотрим пример получения событий, с использованием библиотеки pusher-js.

1. Подключаем pusher-js

<script src="https://js.pusher.com/7.0/pusher.min.js"></script>

2. Задаем настройки подключения

Примечание: В настройках подключения необходимо указать только ваш accessToken, полученный методом v1.tokens.make (другие переменные менять не нужно).

let pusher = new Pusher('ChatsAppApiProdKey', {
    wsHost: 'socket.chatapp.online',
    wssPort: 6001,
    disableStats: true,
    authEndpoint: 'https://api.chatapp.online/broadcasting/auth',
    auth: {
        headers: {
            'Authorization': '$2y$10$l.SQOBOaqz3ZU65JAlEK4ughTCzIbcVGpJIUNTVnGpaKOYOd4M' // accessToken, полученный методом v1.tokens.make
        }
    },
    enabledTransports: ['ws'],
    forceTLS: true
});

3. Подключаемся к приватному каналу

Всего существует 3 типа приватных каналов:

• private-v1.licenses.1229.messengers.grWhatsApp - канал мессенджера в лицензии
• private-v1.companies.2224 - канал компании
• private-v1.users.685 - канал пользователя

let channel = pusher.subscribe('private-v1.licenses.1229.messengers.grWhatsApp');
// или
let channel = pusher.subscribe('private-v1.licenses.1229.messengers.telegram');

Примечание: Один мессенджер в одной лицензии - это один канал. 1229 - это номер вашей лицензии. grWhatsApp - это тип мессенджера в лицензии.

let channelCompany = pusher.subscribe('private-v1.companies.2224');

Примечание: Одна компания - это один канал. 2224 - это номер вашей компании.

let channelUser = pusher.subscribe('private-v1.users.685');

Примечание: Один пользователь - это один канал. 685 - это id пользователя.

4. Слушаем входящие события

// входящее/исходящее сообщение
channel.bind('message', (data) => {
    console.log(data);
});

// статус отправленного сообщения
channel.bind('messageStatus', (data) => {
    console.log(data);
});

// добавлена/удалена метка для чата
channel.bind('chatTag', (data) => {
    console.log(data);
});

// статус сотрудника
channelCompany.bind('employeeStatus', (data) => {
    console.log(data);
});

// добавлен/изменен/удален быстрый ответ
channelUser.bind('quickResponse', (data) => {
    console.log(data);
});

Доступные события для канала - лицензия-мессенджер:

• message (входящее/исходящее сообщение)
• messageStatus (статус отправленного сообщения)
• messageDestroy (событие удаления сообщения)
• chatTag (добавлена/удалена метка для чата)
• chatStatus (установлен статус для чата)
• chatResponsible (установлен ответственный для чата)
• chatResponsiblePin (закреплен/откреплен ответственный для чата)
• chatProducer (установлен постановщик для чата)
• chatAccomplice (добавлен/удален соисполнитель для чата)
• chatAuditor (добавлен/удален наблюдатель для чата)
• chatLevel (установлен уровень для чата)
• chatConversation (открыто 24-х часовое окно (доступно только для WhatsApp))
• chatRead (чат прочитан)
• chatProcess (установлен процесс для чата)

Доступные события для канала - компания:

• employeeStatus (статус сотрудника)
• employeeWorkday (рабочий день сотрудника)

Доступные события для канала - пользователь:

• quickResponseList (добавлен/изменен/удален список быстрых ответов)
• quickResponse (добавлен/изменен/удален быстрый ответ)

Полный код примера:

<script src="https://js.pusher.com/7.0/pusher.min.js"></script>

<script>
window.onload = function() {
    let pusher = new Pusher('ChatsAppApiProdKey', {
        wsHost: 'socket.chatapp.online',
        wssPort: 6001,
        disableStats: true,
        authEndpoint: 'https://api.chatapp.online/broadcasting/auth',
        auth: {
            headers: {
                'Authorization': '$2y$10$l.SQOBOaqz3ZU65JAlEK4ughTCzIbcVGpJIUNTVnGpaKOYOd4M' // accessToken, полученный методом v1.tokens.make
            }
        },
        enabledTransports: ['ws'],
        forceTLS: true
    });

    let channel = pusher.subscribe('private-v1.licenses.1229.messengers.grWhatsApp');

    channel.bind('message', (data) => {
        console.log(data);
    });

    channel.bind('messageStatus', (data) => {
        console.log(data);
    });

    channel.bind('chatTag', (data) => {
        console.log(data);
    });


    let channel2 = pusher.subscribe('private-v1.licenses.1229.messengers.telegram');

    channel2.bind('message', (data) => {
        console.log(data);
    });

    channel2.bind('messageStatus', (data) => {
        console.log(data);
    });

    channel2.bind('chatTag', (data) => {
        console.log(data);
    });
    
    
    let channelCompany = pusher.subscribe('private-v1.companies.2224');

    channelCompany.bind('employeeStatus', (data) => {
        console.log(data);
    });
    
    
    let channelUser = pusher.subscribe('private-v1.users.685');
    
    channelUser.bind('quickResponseList', (data) => {
        console.log(data);
    });
    
    channelUser.bind('quickResponse', (data) => {
        console.log(data);
    });
};
</script>

Пример объекта message (входящее/исходящее сообщение):

{
  "payload": {
    "data": [
      {
        "id": 696,
        "fromApi": false,
        "fromMe": false,
        "side": "in",
        "time": 1637319282,
        "isForwarded": false,
        "type": "text",
        "subtype": null,
        "message": {
          "text": "Test",
          "caption": "",
          "file": null
        },
        "quotedMessage": null,
        "fromUser": {
          "id": 1480675234,
          "username": "username_test",
          "name": "Test Test",
          "phone": "7000000000"
        },
        "chat": {
          "id": "private-1480005234h1360003129730259258",
          "hash": "h1360003129730259258",
          "type": "private",
          "phone": "7000000000",
          "username": "username_test",
          "name": "Test Test",
          "image": "https://telegramclientapi.app24.online/GetDialogPhoto/3bf70000-941b-4e19-bc31-56e150a0e900"
        },
        "fromApp": null,
        "utm": null,
        "created": null
      }
    ],
    "meta": {
      "type": "message",
      "licenseId": 1229,
      "messengerType": "telegram"
    }
  }
}

Пример объекта messageStatus (статус отправленного сообщения):

{
  "payload": {
    "data": [
      {
        "id": 42213,
        "type": "delivered", // delivered|viewed|failed|sent
        "chat": {
          "id": "private-1480000234h1367520000730259258",
          "hash": "h1367520000730259258",
          "type": "private",
          "phone": "70000000000",
          "username": "username_test"
        },
        "fromApp": {
          "id": "app_123_1",
          "tracking": null
        },
        "error": null
      }
    ],
    "meta": {
      "type": "messageStatus",
      "licenseId": 1229,
      "messengerType": "telegram"
    }
  }
}

Пример объекта messageDestroy (событие удаления сообщения):

{
  "data": [
    {
      "id": "1252",
      "chat": {
        "id": "private-243232294h-5444116472189911315"
      }
    }
  ],
  "meta": {
    "type": "messageDestroy",
    "licenseId": 16402,
    "messengerType": "telegram"
  }
}

Пример объекта chatTag (добавлена/удалена метка для чата):

{
  "payload": {
    "data": [
      {
        "type": "add", // add|destroy
        "tag": {
          "id": 29,
          "name": "test 1",
          "color": "#123df55",
          "sort": 100,
          "category": {
            "id": 9,
            "name": "test 1",
            "sort": 100
          }
        },
        "chat": {
          "id": "group-54911000655"
        }
      }
    ],
    "meta": {
      "type": "chatTag",
      "licenseId": 1229,
      "messengerType": "telegram"
    }
  }
}

Пример объекта chatConversation (открыто 24-х часовое окно (доступно только для WhatsApp)):

{
  "payload": {
    "data": [
      {
        "conversation": {
          "id": "ccb637d17ba3aced8051abc263bd72e4",
          "type": "BIC",
          "startTime": 1644500500,
          "endTime": 1644586900
        },
        "chat": {
          "id": "70000000000"
        }
      }
    ],
    "meta": {
      "type": "chatConversation",
      "licenseId": 1229,
      "messengerType": "WhatsApp"
    }
  }
}

Пример объекта chatStatus (установлен статус для чата):

{
  "payload": {
    "data": [
      {
        "type": "close",
        "chat": {
          "id": "70000000000@c.us"
        }
      }
    ],
    "meta": {
      "type": "chatStatus",
      "licenseId": 1229,
      "messengerType": "grWhatsApp"
    }
  }
}

Пример объекта chatResponsible (установлен ответственный для чата):

{
  "payload": {
    "data": [
      {
        "responsible": {
          "id": 685
        },
        "chat": {
          "id": "70000000000@c.us"
        },
        "fromApp": {
          "id": "app_123_1"
        },
        "edited": {
          "id": 685
        }
      }
    ],
    "meta": {
      "type": "chatResponsible",
      "licenseId": 1229,
      "messengerType": "grWhatsApp"
    }
  }
}

Пример объекта chatResponsiblePin (закреплен/откреплен ответственный для чата):

{
  "payload": {
    "data": [
      {
        "type": "pin", // pin|unpin
        "chat": {
          "id": "70000000000@c.us"
        }
      }
    ],
    "meta": {
      "type": "chatResponsiblePin",
      "licenseId": 1229,
      "messengerType": "grWhatsApp"
    }
  }
}

Пример объекта chatProducer (установлен постановщик для чата):

{
  "payload": {
    "data": [
      {
        "producer": {
          "id": 685
        },
        "chat": {
          "id": "70000000000@c.us"
        },
        "fromApp": {
          "id": "app_123_1"
        },
        "edited": {
          "id": 685
        }
      }
    ],
    "meta": {
      "type": "chatProducer",
      "licenseId": 1229,
      "messengerType": "grWhatsApp"
    }
  }
}

Пример объекта chatAccomplice (добавлен/удален соисполнитель для чата):

{
  "payload": {
    "data": [
      {
        "type": "add", // add|destroy
        "accomplice": {
          "id": 685
        },
        "chat": {
          "id": "70000000000@c.us"
        },
        "fromApp": {
          "id": "app_123_1"
        },
        "edited": {
          "id": 685
        }
      }
    ],
    "meta": {
      "type": "chatAccomplice",
      "licenseId": 1229,
      "messengerType": "grWhatsApp"
    }
  }
}

Пример объекта chatAuditor (добавлен/удален наблюдатель для чата):

{
  "payload": {
    "data": [
      {
        "type": "add", // add|destroy
        "auditor": {
          "id": 685
        },
        "chat": {
          "id": "70000000000@c.us"
        },
        "fromApp": {
          "id": "app_123_1"
        },
        "edited": {
          "id": 685
        }
      }
    ],
    "meta": {
      "type": "chatAuditor",
      "licenseId": 1229,
      "messengerType": "grWhatsApp"
    }
  }
}

Пример объекта chatLevel (установлен уровень для чата):

{
  "payload": {
    "data": [
      {
        "level": {
          "id": 555
        },
        "chat": {
          "id": "70000000000@c.us"
        },
        "fromApp": {
          "id": "app_685_1"
        },
        "edited": {
          "id": 685
        }
      }
    ],
    "meta": {
      "type": "chatLevel",
      "licenseId": 1229,
      "messengerType": "grWhatsApp"
    }
  }
}

Пример объекта chatRead (чат прочитан):

{
  "payload": {
    "data": [
      {
        "chat": {
          "id": "7000000000@c.us"
        }
      }
    ],
    "meta": {
      "type": "chatRead",
      "licenseId": "1229",
      "messengerType": "grWhatsApp"
    }
  }
}

Пример объекта chatProcess (установлен процесс для чата):

{
  "payload": {
    "data": [
      {
        "process": "inWork", // null|inWork
        "chat": {
          "id": "70000000000@c.us"
        },
        "fromApp": {
          "id": "app_685_1"
        },
        "edited": {
          "id": 685
        }
      }
    ],
    "meta": {
      "type": "chatProcess",
      "licenseId": 1229,
      "messengerType": "grWhatsApp"
    }
  }
}

Пример объекта employeeStatus (статус сотрудника):

{
  "payload": {
    "data": [
      {
        "type": "online",
        "employee": {
          "id": 685
        }
      }
    ],
    "meta": {
      "type": "employeeStatus",
      "companyId": 2226
    }
  }
}

Пример объекта employeeWorkday (рабочий день сотрудника):

{
  "payload": {
    "data": [
      {
        "type": "start|end",
        "employee": {
          "id": 685
        }
      }
    ],
    "meta": {
      "type": "employeeWorkday",
      "companyId": 2226
    }
  }
}

Пример объекта quickResponseList (добавлен/изменен список быстрых ответов):

{
  "payload": {
    "data": [
      {
        "type": "create", // create|edit
        "quickResponseList": {
          "id": 1338,
          "name": "List name",
          "sort": 100,
          "access": [
            {
              "userId": "685",
              "email": "test@test.test",
              "permission": "w"
            },
            {
              "userId": "124",
              "email": "test2@test.test",
              "permission": "r"
            }
          ]
        }
      }
    ],
    "meta": {
      "type": "quickResponseList",
      "userId": "685"
    }
  }
}

Пример объекта quickResponseList (удален список быстрых ответов):

{
  "payload": {
    "data": [
      {
        "type": "destroy",
        "quickResponseList": {
          "id": 1338
        }
      }
    ],
    "meta": {
      "type": "quickResponseList",
      "userId": "685"
    }
  }
}

Пример объекта quickResponse (добавлен/изменен быстрый ответ):

{
  "payload": {
    "data": [
      {
        "type": "create", // create|edit
        "quickResponseList": {
          "id": 1339
        },
        "quickResponse": {
          "id": 1197,
          "name": "Response name",
          "sort": 300,
          "parent": null,
          "text": "Detail text",
          "keywords": "test test2 test4",
          "enableAI": true
        }
      }
    ],
    "meta": {
      "type": "quickResponse",
      "userId": "685"
    }
  }
}

Пример объекта quickResponse (удален быстрый ответ):

{
  "payload": {
    "data": [
      {
        "type": "destroy",
        "quickResponseList": {
          "id": 1339
        },
        "quickResponse": {
          "id": 1197
        }
      }
    ],
    "meta": {
      "type": "quickResponse",
      "userId": "685"
    }
  }
}

Пример объекта quickResponse (массовое удаление быстрых ответов):

{
  "payload": {
    "data": [
      {
        "type": "destroy",
        "quickResponseList": {
          "id": 1339
        },
        "quickResponse": {
          "id": 1197
        }
      },
      {
        "type": "destroy",
        "quickResponseList": {
          "id": 1339
        },
        "quickResponse": {
          "id": 1198
        }
      }
    ],
    "meta": {
      "type": "quickResponse",
      "userId": "685"
    }
  }
}