Тело передавать в JSON, ответ также будет JSON-объект.
Тело запроса обязательно должно содержать поле:
{"source":"whatsapp"}
Если в ответе есть поле "error", значит произошла какая то ошибка, и в этом поле содержится ее текстовое описание. Так же будет возвращен uuid, который необходимо указать при обращении в техническую поддержку.
{"uuid":3928420,"error":"Some error text goes here"}
Перед вызовом данного метода аккаунт должен находит в выклюенном состоянии ( state : false ), после успешного выполнения необходимо выполнить /setState со значением state : true .
UPD: С 04.12.2023 нет необходимости устанавливать setState: TRUE || FALSE для обновления вебхуков
Чтобы удалить вебхуки - передайте пустой массив в параметре webhooksUrls
Полученный QR код нужно отсканировать приложением WhatsApp в телефоне
Настройки -> WhatsApp Web
Если сервер не отвечает после setState, возможно есть проблема с вашим прокси. Пожалуйста, обратитесь для проверки в техническую поддержку.
Если скриншот не грузит и ваши сервера расположены в России, можно ко всем GET запросам передать дополнительный параметр useAlternativeAddress=1, который решит эту проблему
Получении информации об аккаунтах, приязанных к токену
Request Body
Name
Type
Description
token*
String
Токен для аутентификации
skipDetails
boolean
если true, будет опрошен каждый аккаунт на статус подключения, если у Вас большое кол-во аккаунтов, рекомендуется использовать false, в таком случае актальным будет только defualtState , а далее опросить каждый аккаунт методом /getInfo
Если аккаунт находится в степе 2.2, то это актуальная ссылка. Если в степе 2.3, то ссылка не актуальна - нужно перезапускать
После получения ответа из значения value необходимо сформировать QR и отсканировать его через приложение WhatsApp
Код обновлеяется каждые 10 секунд, если пользователь не успел подключиться необходимо сформировать код заново
Request Body
Name
Type
Description
token*
String
Токен для аутентификации
login*
String
Номер телефона
Описание авторизации по коду для ввода в приложении вместо сканирования QR
На данный момент функция получения кода может занимать больше времени чем получения QR кода в связи со спецификой установки соединения с WhatsApp и получения кода авторизации, ниже список действий для авторизации по коду.
На данный момент этот способ не рекомендуется использовать как основной, только если пользователь не может авторизиваться по QR
Установить setState: false методом /setState
Очистить текущую сессию /сlearSession
Получить новый проки /getNewProxy
Переключить аккаунт в режим входа по коду /enablePhoneAuth
Установить setState: true методом /setState
Дождаться окончания загрузки и получить код /getAuthCode
Ввести полученный код на телефоне в приложении WhatsApp, в разделе Linked Diveces
{
"status": "error",
"error": { "message": "Such user is not exist" }
// if there isn't whatsapp registered with this phonen
}
// OR
{
"status": "error",
"error": { "message": "Such user is not in contact list" }
// someone with this phone has whatsapp, but he isn't in your contacts
}
{
"source": "whatsapp",
"login": "String",
"owner": "String",
"activated": true // or false,
"addedTime": "timestamp",
"webhookUrl": "String",
"proxyString": "String",
"defaultState": true // or false,
"APIv": "String",
"state": true // or false,
"step": {
"message": "String",
"value": 1 // number
}
}
{
"to": "String",
"text": "String" // or null. required if content is empty
"content": [ // required if text is empty
{
"type": "String",
"src": "String", // media url
}
]
}