Common errors#
HTTP errors#
| HTTP code | Error ID | Description |
|---|---|---|
| 204 | No Content | OPTIONS request method used, change the request method to GET |
| 400 | instance in starting process try later | The instance is in starting/restarting process. Please try again in a few seconds |
| 400 | instance is starting or not authorized | The instance is not authorized. To authorize your instance, go to console and scan the QR code from the WhatsApp Business application on your phone |
| 400 | Instance account is expired. Renew your instance from personal area | The instance has expired, to continue working you need to make a payment through the console |
| 400 | bad request data | The request data are not valid. Correct the error in the request parameters and try again |
| 400 | Instance is deleted | The instance has been deleted |
| 400 | Bad Request Validation failed | Validation error, more details in table |
| 400 | Unexpected token _ in JSON at position ХХ | Error in JSON structure |
| 401 | Unauthorized | Problem with authorization, check the correctness of the apiTokenInstance, partnerToken |
| 403 | Forbidden | Problem with authentication, check the correctness of the idInstance and request URL |
| 404 | Not Found | Invalid request method used, change the request method to GET |
| 429 | Too Many Requests | The user has been rate limited. Please decrease the frequency requests. Request frequency guidelines |
| 466 | correspondentsStatus | The limit is used up, more details in the error body. Error body example |
| 499 | Client Closed Request | The user closed the connection while the server was processing the request. It is necessary to increase the waiting time for a response from the server and repeat the request with a delay. If the error persists, inform the operator and provide an opportunity to retry the submission |
| 500 | File from url exceeded max upload size. Size: XXXXmb Limit: 100mb Url: | An attempt to send a file larger than 100 MB |
| 502 | Bad Gateway | The server is unable to receive a response from the target server. It is necessary to repeat the request 3 times with a delay. If the error persists, inform the operator and provide an opportunity to retry the submission |
Errors in the webhooks body and journals#
| Error code | Parameter | Description | Solution |
|---|---|---|---|
| {{SWE001}} | textMessage | Error of receiving the first incoming message in the chat when sent to additional devices from the WhatsApp side. It is also observed in the native web and desktop versions. In fact, all additional devices get an empty message. Webhook body example | To capture the text-marker {{SWE001}} in the message body and configure the bot to re-request the message from the sender with the following text:"Please send your message again, I couldn't see your reply". |
| {{SWE002}} | downloadUrl | Error of getting a large file over 100 MB. Webhook body example | To capture the text-marker {{SWE002}} in the message body and check the message in the phone. |
| {{SWE003}} | textMessage | Error of decrypting messages caused by the loss of the authorization keys relevance. Webhook body example | To capture the text-marker {{SWE003}}. When such messages come, it is necessary to delete all authorizations in the phone and scan the QR code again. |
| {{SWE004}} | textMessage | Error working with group chats caused by exceeding the membership of 100 contacts in the group. Webhook body example | To capture the text-marker {{SWE004}}. When such messages appear, it is necessary to delete groups in which the number of participants exceeds 100 contacts or to delete contacts from groups. |
| {{SWE999}} | textMessage | Error receiving incoming message without encryption keys in chat from WhatsApp. In fact, the message comes empty to all additional devices. Example notification body | Catch the marker text {{SWE999}} in the message body and configure the bot to re-request the message from the sender with the text: "Please send the message again, I could not see your response" |
Validation errors (400: Validation failed)#
| Error ID | Description |
|---|---|
'chatId' must be one of the next formats: 'phone_number@c.us' or 'group_id@g.us | Invalid format of field chatId, the field is specified in the format phone_number@c.us or group_id@g.us |
'message' length must be less than or equal to 20000 characters long | The message text must be less than or equal to 20 000 characters |
'message id' must be at least 16 symbols | The message's iD must be at least 16 characters long, check that the specified idmessage is correct. |
'wrongFieldName' is not allowed | Extra field in request |
'{{field}}' is not allowed | Extra field in request |
'{{field}}' is required | A required field is missing |
'{{field}}' is not allowed to be empty | A required field cannot be empty |
'XXX' must be a string | Invalid data type for field XXX - field must be of type string. Fields of this type: message, idMessage,quotedMessageId, groupId, groupName, participantChatId, options[X].optionName, urlFile |
'XXX' must be a boolean | Invalid data type for field XXX - field must be of type boolean. Fields of this type: linkPreview, multipleAnswers |
'XXX' must be an array | Invalid data type for field XXX - field must be of type array. Fields of this type: chatIds, options, messages |
