NAV
bash javascript

Info

Welcome to the generated API reference. Get Postman Collection

Api management

APIs for managing user's chats

Websocket

[Example wss://api.app24.online:2233?instance=112233&token=k8jd78sd78jj33l598a64ee7510c]

Example request:

curl -X GET \
    -G "https://api.app24.online/websocket?instance=voluptatibus&token=vel" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/websocket"
);

let params = {
    "instance": "voluptatibus",
    "token": "vel",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

HTTP Request

GET websocket

Query Parameters

Parameter Status Description
instance required The instance of the websocket.
token required The token of the websocket.

getTokens

[Method for getting token in API service]

Example request:

curl -X PUT \
    "https://api.app24.online/tokens?email=ratione&password=illum&app_id=ad" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/tokens"
);

let params = {
    "email": "ratione",
    "password": "illum",
    "app_id": "ad",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "cabinet_user_id": 912,
    "access_token": "$2y$10$qeCKubxG.yPanuONchMMUe7M\/iQos6GcLXFk8gmmUfLzwPobQTP1C",
    "access_token_end_time": 1616071276,
    "refresh_token": "$2y$10$x8UgIewq3ckLrQi79z\/A7.OuwobUOw3jT.yQ7lqzIt6R0gbVlhqeO",
    "refresh_token_end_time": 1623760876
}

HTTP Request

PUT tokens

Query Parameters

Parameter Status Description
email required The email of the user. Example client@domain.com
password required The password of the user. Example Kioh7GHt6yg
app_id required If you user your application you have to send an application ID(app_id) of the created in Cabinet before by user handle. Example app_1234_1

refreshTokens


Requires authentication [Method for refreshing tokens for next applications App24 Service: current application, Web Chat Application and Mobile Application]

[Headers]

[Refresh: 2y$10$qeCKubxG.yPanuONchMMUe7M/iQos6GcLXFk8gmmUfLzwPobQTP1C4]

Example request:

curl -X PUT \
    "https://api.app24.online/refresh-tokens/user/1/type/1?userId=autem&type=fuga" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/refresh-tokens/user/1/type/1"
);

let params = {
    "userId": "autem",
    "type": "fuga",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "cabinet_user_id": 912,
    "access_token": "$2y$10$qeCKubxG.yPanuONchMMUe7M\/iQos6GcLXFk8gmmUfLzwPobQTP1C",
    "access_token_end_time": 1616071276,
    "refresh_token": "$2y$10$x8UgIewq3ckLrQi79z\/A7.OuwobUOw3jT.yQ7lqzIt6R0gbVlhqeO",
    "refresh_token_end_time": 1623760876
}

HTTP Request

PUT refresh-tokens/user/{userId}/type/{app_id}

Query Parameters

Parameter Status Description
userId required The ID of the cabinet user. Example 2331
type required If you user your application you have to send an application ID(app_id) of the created in Cabinet before by user handle. Example app_1234_1

checkToken


Requires authentication [The method returns actually information about both current tokens]

[Headers]

[Authorization: 2y$10$qeCKubxG.yPanuONchMMUe7M/iQos6GcLXFk8gmmUfLzwPobQTP1C4]

[Refresh: 2y$10$qeCKubxG.yPanuONchMMUe7M/iQos6GcLXFk8gmmUfLzwPobQTP1C4]

Example request:

curl -X GET \
    -G "https://api.app24.online/me" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/me"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "cabinet_user_id": 912,
    "access_token": "$2y$10$qeCKubxG.yPanuONchMMUe7M\/iQos6GcLXFk8gmmUfLzwPobQTP1C",
    "access_token_end_time": 1616071276,
    "refresh_token": "$2y$10$x8UgIewq3ckLrQi79z\/A7.OuwobUOw3jT.yQ7lqzIt6R0gbVlhqeO",
    "refresh_token_end_time": 1623760876
}

Example response (403):

{
    "error": "Got an empty token"
}

HTTP Request

GET me

clientInstances


Requires authentication [The method shows a list of user instances]

[Headers]

[Authorization: 2y$10$qeCKubxG.yPanuONchMMUe7M/iQos6GcLXFk8gmmUfLzwPobQTP1C4]

Example request:

curl -X GET \
    -G "https://api.app24.online/instances/1?userId=ut" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/instances/1"
);

let params = {
    "userId": "ut",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "instances": [
        "4433",
        "112233"
    ]
}

HTTP Request

GET instances/{userId}

Query Parameters

Parameter Status Description
userId required The ID of the cabinet user. Example 2331

checkPhone


Requires authentication [The method check user's phone on existing]

[Headers]

[Authorization: 2y$10$qeCKubxG.yPanuONchMMUe7M/iQos6GcLXFk8gmmUfLzwPobQTP1C4]

Example request:

curl -X GET \
    -G "https://api.app24.online/user/1/instance/1/phone/1?userId=et&phone=dolore" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/user/1/instance/1/phone/1"
);

let params = {
    "userId": "et",
    "phone": "dolore",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "status": true
}

Example response (200):

{
    "status": false
}

HTTP Request

GET user/{userId}/instance/{instance}/phone/{phone}

Query Parameters

Parameter Status Description
userId required The ID of the cabinet user. Example 2331
phone required Phone for checking. Example 79220000001

Service settings

APIs for managing service settings

setLocale

[Method for setting a new application language]

Example request:

curl -X PUT \
    "https://api.app24.online/set-locale?locale=et" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/set-locale"
);

let params = {
    "locale": "et",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "locale": "ru"
}

HTTP Request

PUT set-locale

Query Parameters

Parameter Status Description
locale required A language for answers [en, ru] Default set en. Example ru

getLocale

[Method for getting current an application language]

Example request:

curl -X GET \
    -G "https://api.app24.online/get-locale" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/get-locale"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "locale": "en"
}

HTTP Request

GET get-locale

WhatsApp API

getDialogs


Requires authentication [The method shows a list of user dialogs]

[Headers]

[Authorization: 2y$10$qeCKubxG.yPanuONchMMUe7M/iQos6GcLXFk8gmmUfLzwPobQTP1C4]

Example request:

curl -X GET \
    -G "https://api.app24.online/user/1/dialogs/1/limit/1/page/1?userId=esse&instance=quis&limit=sunt&page=15" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/user/1/dialogs/1/limit/1/page/1"
);

let params = {
    "userId": "esse",
    "instance": "quis",
    "limit": "sunt",
    "page": "15",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "dialogs": [
        {
            "id": "79220000001@c.us",
            "name": "+7 922 000-00-01",
            "image": "https:\/\/pps.whatsapp.net\/v\/t61.2000-24\/1.jpg",
            "metadata": {
                "isGroup": false,
                "participants": [],
                "groupInviteLink": null
            },
            "last_time": 1615455053,
            "unread_messages": 0
        },
        {
            "id": "79220000002@c.us",
            "name": "+7 922 000-00-02",
            "image": "https:\/\/pps.whatsapp.net\/v\/t61.24345\/3.jpg",
            "metadata": {
                "isGroup": false,
                "participants": [],
                "groupInviteLink": null
            },
            "last_time": 1615385847,
            "unread_messages": 0
        }
    ]
}

HTTP Request

GET user/{userId}/dialogs/{instance}/limit/{limit}/page/{page}

Query Parameters

Parameter Status Description
userId required The ID of a user of the cabinet ID user Example 2331
instance required The instance of a user. Example 334456
limit required The length of dialog's list. Example 1 (Default: 0 - returns all)
page required The number of current dialog' page. Example 1 (Default: 0)

getDialog


Requires authentication [This method shows the user dialog]

[Headers]

[Authorization: 2y$10$qeCKubxG.yPanuONchMMUe7M/iQos6GcLXFk8gmmUfLzwPobQTP1C4]

Example request:

curl -X GET \
    -G "https://api.app24.online/user/1/dialog/1/1?userId=voluptatem&instance=eos&chatId=praesentium" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/user/1/dialog/1/1"
);

let params = {
    "userId": "voluptatem",
    "instance": "eos",
    "chatId": "praesentium",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "id": "79220000001@c.us",
    "name": "+7 922 000-00-01",
    "metadata": {
        "isGroup": false,
        "participants": [],
        "admins": [],
        "participantsInfo": [],
        "groupInviteLink": null
    },
    "last_time": 1620746639,
    "image": "https:\/\/pps.whatsapp.net\/v\/t61.2000-24\/1.jpg"
}

HTTP Request

GET user/{userId}/dialog/{instance}/{chatId}

Query Parameters

Parameter Status Description
userId required The ID of a user of the cabinet ID user Example 2331
instance required The instance of a user. Example 334456
chatId required The ID of a chat (phone@c.us). Example 79220000002@c.us

getMessages


Requires authentication [The method shows a list of user messages]

[Headers]

[Authorization: 2y$10$qeCKubxG.yPanuONchMMUe7M/iQos6GcLXFk8gmmUfLzwPobQTP1C4]

Example request:

curl -X GET \
    -G "https://api.app24.online/user/1/instance/1/messages/1?userId=explicabo&instance=incidunt&chatId=magnam" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/user/1/instance/1/messages/1"
);

let params = {
    "userId": "explicabo",
    "instance": "incidunt",
    "chatId": "magnam",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "messages": [
        {
            "id": "true_79220000001@c.us_3EB021A49CD62FE77E43",
            "body": "тестовое сообщение в ватсапп",
            "fromMe": true,
            "self": 1,
            "isForwarded": 0,
            "author": "79020004444@c.us",
            "time": 1614676130,
            "chatId": "79220000001@c.us",
            "messageNumber": 5571,
            "type": "chat",
            "senderName": "Аналогик",
            "quotedMsgBody": null,
            "quotedMsgId": null,
            "quotedMsgType": null,
            "chatName": "+7 922 000-00-01",
            "status": {
                "delivered": 1,
                "viewed": 1
            }
        },
        {
            "id": "true_79220000001@c.us_3EB024F5E103C57BBF0B",
            "body": "обратка связи",
            "fromMe": true,
            "self": 1,
            "isForwarded": 0,
            "author": "79020004444@c.us",
            "time": 1614677724,
            "chatId": "79220000001@c.us",
            "messageNumber": 5574,
            "type": "chat",
            "senderName": "Аналогик",
            "quotedMsgBody": null,
            "quotedMsgId": null,
            "quotedMsgType": null,
            "chatName": "+7 922 000-00-01",
            "status": {
                "delivered": 1,
                "viewed": 1
            }
        }
    ],
    "lastMessageNumber": 5753
}

HTTP Request

GET user/{userId}/instance/{instance}/messages/{chatId}

Query Parameters

Parameter Status Description
userId required The ID of a user of the cabinet ID user Example 2331
instance required The instance of a user. Example 334456
chatId required The ID of a chat (phone@c.us). Example 79220000002@c.us"

getMessagesHistory


Requires authentication [The method shows a list of user messages with sorting and page's pagination]

[Headers]

[Authorization: 2y$10$qeCKubxG.yPanuONchMMUe7M/iQos6GcLXFk8gmmUfLzwPobQTP1C4]

Example request:

curl -X GET \
    -G "https://api.app24.online/user/1/instance/1/messages/1/page/1/count/1?userId=autem&instance=id&chatId=mollitia&%24page=5&%24count=9" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/user/1/instance/1/messages/1/page/1/count/1"
);

let params = {
    "userId": "autem",
    "instance": "id",
    "chatId": "mollitia",
    "$page": "5",
    "$count": "9",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "messages": [
        {
            "id": "true_79220000001@c.us_3EB021A49CD62FE77E43",
            "body": "тестовое сообщение в ватсапп",
            "fromMe": true,
            "self": 1,
            "isForwarded": 0,
            "author": "79020004444@c.us",
            "time": 1614676130,
            "chatId": "79220000001@c.us",
            "messageNumber": 5571,
            "type": "chat",
            "senderName": "Аналогик",
            "quotedMsgBody": null,
            "quotedMsgId": null,
            "quotedMsgType": null,
            "chatName": "+7 922 000-00-01",
            "status": {
                "delivered": 1,
                "viewed": 1
            }
        },
        {
            "id": "true_79220000001@c.us_3EB024F5E103C57BBF0B",
            "body": "обратка связи",
            "fromMe": true,
            "self": 1,
            "isForwarded": 0,
            "author": "79020004444@c.us",
            "time": 1614677724,
            "chatId": "79220000001@c.us",
            "messageNumber": 5574,
            "type": "chat",
            "senderName": "Аналогик",
            "quotedMsgBody": null,
            "quotedMsgId": null,
            "quotedMsgType": null,
            "chatName": "+7 922 000-00-01",
            "status": {
                "delivered": 1,
                "viewed": 1
            }
        }
    ],
    "lastMessageNumber": 5753
}

HTTP Request

GET user/{userId}/instance/{instance}/messages/{chatId}/page/{page}/count/{count}

Query Parameters

Parameter Status Description
userId required The ID of a user of the cabinet ID user Example 2331
instance required The instance of a user. Example 334456
chatId required The ID of a chat (phone@c.us). Example 79220000002@c.us"
$page required The number of current messages' page. Example 1 (Default: 0)
$count required The count of messages in array. Example 200. (Default: 100)

sendMessages


Requires authentication [Message sending function]

[Headers]

[Authorization: 2y$10$qeCKubxG.yPanuONchMMUe7M/iQos6GcLXFk8gmmUfLzwPobQTP1C4]

Example request:

curl -X PUT \
    "https://api.app24.online/user/1/instance/1/messages/1/1?userId=modi&instance=rem&chatId=et&typeMessage=error" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"body":"et","filename":"necessitatibus","caption":"architecto"}'
const url = new URL(
    "https://api.app24.online/user/1/instance/1/messages/1/1"
);

let params = {
    "userId": "modi",
    "instance": "rem",
    "chatId": "et",
    "typeMessage": "error",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "body": "et",
    "filename": "necessitatibus",
    "caption": "architecto"
}

fetch(url, {
    method: "PUT",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "sent": true,
    "message": "Sent to 79220000001@c.us",
    "id": "true_79220000001@c.us_3EB0A79D45C44643F165",
    "queueNumber": 1089
}

HTTP Request

PUT user/{userId}/instance/{instance}/messages/{chatId}/{type}

POST user/{userId}/instance/{instance}/messages/{chatId}/{type}

Query Parameters

Parameter Status Description
userId required The ID of a user of the cabinet ID user Example 2331
instance required The instance of a user. Example 334456
chatId required The ID of a chat (phone). Example 79220000002
typeMessage required Request Type [text, file, image, ptt, link, location, contact, read, typing, record]

Body Parameters

Parameter Type Status Description
body string required Text Message support emoji. Required for types [text, file, image, link]. [x-www-form-urlencoded]
filename string required File name. Required for type [file]. [x-www-form-urlencoded]
caption string optional Text under the file. Available only for types [file, image]. [x-www-form-urlencoded]

readMessages


Requires authentication [Function to set status READ for messages]

[Headers]

[Authorization: 2y$10$qeCKubxG.yPanuONchMMUe7M/iQos6GcLXFk8gmmUfLzwPobQTP1C4]

Example request:

curl -X PUT \
    "https://api.app24.online/user/1/instance/1/read/1?userId=aperiam&instance=natus&chatId=animi" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/user/1/instance/1/read/1"
);

let params = {
    "userId": "aperiam",
    "instance": "natus",
    "chatId": "animi",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "read": true,
    "message": null,
    "chatId": "79220000002@c.us"
}

HTTP Request

PUT user/{userId}/instance/{instance}/read/{chatId}

Query Parameters

Parameter Status Description
userId required The ID of a user of the cabinet ID user Example 2331
instance required The instance of a user. Example 334456
chatId required The ID of a chat (phone). Example 79220000002

deleteMessages


Requires authentication [Delete message function (only works 2 hours after sending message for deleted message)]

[Headers]

[Authorization: 2y$10$qeCKubxG.yPanuONchMMUe7M/iQos6GcLXFk8gmmUfLzwPobQTP1C4]

Example request:

curl -X DELETE \
    "https://api.app24.online/user/1/instance/1/messages/1/1?userId=sunt&instance=id&chatId=quibusdam&messageId=maxime" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/user/1/instance/1/messages/1/1"
);

let params = {
    "userId": "sunt",
    "instance": "id",
    "chatId": "quibusdam",
    "messageId": "maxime",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "sent": true,
    "message": "message deleted"
}

HTTP Request

DELETE user/{userId}/instance/{instance}/messages/{chatId}/{messageId}

Query Parameters

Parameter Status Description
userId required The ID of a user of the cabinet ID user Example 2331
instance required The instance of a user. Example 334456
chatId required The ID of a chat (phone). Example 79220000002
messageId required The ID of a message. Example true_79220000002@c.us_3EB0A79D45C44643F165

addGroup


Requires authentication [Group creation]

[Headers]

[Authorization: 2y$10$qeCKubxG.yPanuONchMMUe7M/iQos6GcLXFk8gmmUfLzwPobQTP1C4]

Example request:

curl -X POST \
    "https://api.app24.online/user/1/instance/1/group?userId=a&instance=facere" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json" \
    -d '{"groupName":"molestiae","chatIds":[],"phones":[],"messageText":"minima","preview96":"molestiae","avatar640":"sed"}'
const url = new URL(
    "https://api.app24.online/user/1/instance/1/group"
);

let params = {
    "userId": "a",
    "instance": "facere",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "groupName": "molestiae",
    "chatIds": [],
    "phones": [],
    "messageText": "minima",
    "preview96": "molestiae",
    "avatar640": "sed"
}

fetch(url, {
    method: "POST",
    headers: headers,
    body: body
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "created": true,
    "message": "ok",
    "chatId": "1493046918@g.us-13216468942@c.us",
    "groupInviteLink": "string"
}

HTTP Request

POST user/{userId}/instance/{instance}/group

Query Parameters

Parameter Status Description
userId required The ID of a user of the cabinet ID user Example 2331
instance required The instance of a user. Example 334456

Body Parameters

Parameter Type Status Description
groupName string required Group name.
chatIds array required Array of member ids for the group being created. Required if phones are not specified.
phones array required Array of member phones for the group being created. Required if chatIds is not specified.
messageText string optional The text of the message that will be sent to the group after its creation.
preview96 string optional Preview for the group 96x96px. Base64 file, example: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ...
avatar640 string optional Group avatar 640x640px. Base64 file, example: data:image/jpeg;base64,/9j/4AAQSkZJRgABAQ...

deleteGroup


Requires authentication [Deleting group]

[Headers]

[Authorization: 2y$10$qeCKubxG.yPanuONchMMUe7M/iQos6GcLXFk8gmmUfLzwPobQTP1C4]

Example request:

curl -X DELETE \
    "https://api.app24.online/user/1/instance/1/group/1?userId=quo&instance=repellat&groupId=minima" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/user/1/instance/1/group/1"
);

let params = {
    "userId": "quo",
    "instance": "repellat",
    "groupId": "minima",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "DELETE",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "result": {
        "message": "Exited group"
    }
}

Example response (200):

{
    "result": {
        "message": "Group deleted"
    }
}

HTTP Request

DELETE user/{userId}/instance/{instance}/group/{groupId}

Query Parameters

Parameter Status Description
userId required The ID of a user of the cabinet ID user. Example 2331
instance required The instance of a user. Example 334456
groupId required The group ID. Example 17680561234-1479621234@g.us

addGroupParticipant


Requires authentication [Adding a participant to a group]

[Headers]

[Authorization: 2y$10$qeCKubxG.yPanuONchMMUe7M/iQos6GcLXFk8gmmUfLzwPobQTP1C4]

Example request:

curl -X PUT \
    "https://api.app24.online/user/1/instance/1/group/1/add-participant/1?userId=eos&instance=error&groupId=aliquam&participantChatId=consequuntur" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/user/1/instance/1/group/1/add-participant/1"
);

let params = {
    "userId": "eos",
    "instance": "error",
    "groupId": "aliquam",
    "participantChatId": "consequuntur",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "PUT",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "add": true,
    "message": "Added to 1493046918@g.us",
    "groupId": "1493046918@g.us-13216468942@c.us"
}

HTTP Request

PUT user/{userId}/instance/{instance}/group/{groupId}/add-participant/{participantChatId}

Query Parameters

Parameter Status Description
userId required The ID of a user of the cabinet ID user. Example 2331
instance required The instance of a user. Example 334456
groupId required The group ID. Example 17680561234-1479621234@g.us
participantChatId required Participant Chat ID or Phone. Example 17633123456@c.us 79995253422

getInstanceStatus


Requires authentication [Get account status and QR code for authorization]

[Headers]

[Authorization: 2y$10$qeCKubxG.yPanuONchMMUe7M/iQos6GcLXFk8gmmUfLzwPobQTP1C4]

Example request:

curl -X GET \
    -G "https://api.app24.online/user/1/instance/1/status/1/1?userId=sint&instance=sequi&mode=recusandae&waking=19" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/user/1/instance/1/status/1/1"
);

let params = {
    "userId": "sint",
    "instance": "sequi",
    "mode": "recusandae",
    "waking": "19",
};
Object.keys(params)
    .forEach(key => url.searchParams.append(key, params[key]));

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (200):

{
    "accountStatus": "authenticated"
}

Example response (200):

{
    "accountStatus": "authenticated",
    "statusData": {
        "title": "string",
        "msg": "string",
        "substatus": "normal",
        "actions": {}
    }
}

HTTP Request

GET user/{userId}/instance/{instance}/status/{mode}/{waking}

Query Parameters

Parameter Status Description
userId required The ID of a user of the cabinet ID user. Example 2331
instance required The instance of a user. Example 334456
mode required Answer completeness mode. Available value options [full, short]
waking required Account awakening. Available value options [wakeup, no-wakeup]

general

api/monitor

Example request:

curl -X GET \
    -G "https://api.app24.online/api/monitor" \
    -H "Content-Type: application/json" \
    -H "Accept: application/json"
const url = new URL(
    "https://api.app24.online/api/monitor"
);

let headers = {
    "Content-Type": "application/json",
    "Accept": "application/json",
};

fetch(url, {
    method: "GET",
    headers: headers,
})
    .then(response => response.json())
    .then(json => console.log(json));

Example response (403):

{
    "status": 403
}

HTTP Request

GET api/monitor