HTTPS API v2 / Pobranie listy agentów WhatsApp

Wywołanie adresu

Aby przy pomocy Zdalnej obsługi pobrać listę agentów WhatsApp należy przesłać określone żądanie protokołem HTTPS metodą POST. Agenta WhatsApp można dodać z poziomu Panelu Klienta -> Usługi dodatkowe -> WhatsApp. Jeśli nie utworzono żadnych agentów, API zwróci pustą tablicę items.

agents/whatsapp

Dostępne parametry

Parametr	Typ	Przykładowa wartość lub format	Opis
username	String	login	Login użytkownika API.
password	String	haslo	Hasło użytkownika API.

Parametry oznaczone pogrubieniem są obowiązkowe.

Zwrot odpowiedzi

W przypadku poprawnego żądania API zwróci dokument w formacie JSON lub XML zawierający listę skonfigurowanych agentów:

{
   "items":[{
      "name":"SerwerSMS",
      "phone":"+48100100100",
      "description":"Masowa wysyłka, powiadomienia i kampanie SMS",
      "whatsapp_id":"1dgd2bss-bee6-134f-8d56-2655f4047649",
      "webhook":"http://serwersms.pl",
      "online":1,
      "active":1
   }]
}

Objaśnienie parametrów zwrotnych

Znacznik	Opis
name	Nazwa agenta WhatsApp.
phone	Numer telefonu, który został przypisany do agenta WhatsApp.
description	Opis agenta WhatsApp.
whatsapp_id	Unikalny identyfikator agenta WhatsApp.
webhook	Adres URL skonfigurowany do obsługi zdarzeń związanych z agentem WhatsApp.
online	Stan agenta określający, czy reaguje on na odpowiedzi użytkownika zgodnie z ustawionym flow w panelu.
active	Status agenta określający jego gotowość do użycia. Wartość 1 oznacza, że agent jest gotowy do wysyłki wiadomości.