Check Only Login API Documentation
Introduction
It will get group info first than after getting group ids we can collect participants
Endpoint
Method: POST
URL: /audience-by-messages
\ pass list of chat or channel ids to get users
Request Body for url: /audience-by-messages
-
folder
(String, required): The folder containing the accounts to be used for data. -
phones
(List, required): The list of phones to be checked that were returned from url: /joined-groups-users -
chats_ids
(list, Required): these ids will help to get particepents from groups -
limit
(int, required): it defines that how much previous messages has to itertate for participants -
photo
(Bool, required): if its true it will get only participants who has photos -
premium
(Bool, required): if its true it will get only participants who are premium -
stories
(Bool, required): if its true it will get only participants who has stories -
start_hour
(int, optional): it helps to get participants by giving start hours for example: if we want to start scrap participants who messaged 4 hours ago than we will set 4 to start scrap from there. -
end_hour
(int, optional): it helps to get participants by giving end hours for example: if we want to end scrap participants who messaged 90 hours ago than we will set 90 to end scrap there. -
start_day
(int, optional): it helps to get participants by giving start days for example: if we want to start scrap participants who messaged 4 days ago than we will set 4 to start scrap from there. -
end_day
(int, optional): it helps to get participants by giving end days for example: if we want to end scrap participants who messaged 90 days ago than we will set 90 to end scrap there. -
hours
(Bool, optional): it will allow to use start and end hours. -
end_day
(Bool, optional): it will allow to use start and end days. -
save_dialogues
(Bool, optional): it will work with days or hours or by setting limit -
specific_words
(list, optional): pass list of words seperated by comma to get users who used specific words in messages -
left_chat
(Bool, optional): it helps to left chat at the end.
Example Request (1) Body for url: /audience-by-messages
{
"folder": "active",
"phones": ["84523786659"],
"chats_ids": [1109500936],
"start_hour": 4,
"end_hour": 90,
"hours": true | false,
"specific_words": ["hello", "are", "there"],
"left_chat": true | false,
"save_dialogues": true/false,
"stories": true/false,
"photo": true/false,
"premium": true/false,
}
Example Request (2) Body for url: /audience-by-messages
{
"folder": "active",
"phones": ["84523786659"],
"chats_ids": [1109500936],
"start_day": 4,
"end_day": 90,
"days": true | false,
"specific_words": ["hello", "are", "there"],
"left_chat": true | false,
"save_dialogues": true/false,
"stories": true/false,
"photo": true/false,
"premium": true/false,
}
Example Request (3) Body for url: /audience-by-messages
{
"folder": "active",
"phones": ["84523786659"],
"chats_ids": [1109500936],
"limit": 100,
"specific_words": ["hello", "are", "there"],
"save_dialogues": true/false,
"left_chat": true | false,
"stories": true/false,
"photo": true/false,
"premium": true/false,
}
Example Response for /audience-by-messages
- Stream Text
[{'name': 'Silvia', 'username': 'TelethonianBot'}, {'name': 'Vitalik 🪶', 'username': 'pirog_y'}, {' name': 'Aryan BadBoy Controlled By Fire And Adarsh', 'username': 'Aryan_BadBoy'}]