Maytapi WhatsApp
This API deals with a chatting platform based on WhatsApp. With the endpoints that are created for the user, the user can send and receive text and media messages through WhatsApp in private chats. Moreover, the current status and the screen of the session can be retrieved using these endpoints. With the account specific endpoints, user can get the product or registered phones information, edit…
50 subscribers
9.5/10 popularity
302 ms avg latency
99% success rate
22 endpoints
The in-depth APIMemo review for this API hasn't been published yet —
the data below comes straight from the public marketplace listing.
Maytapi WhatsApp endpoints
| Method | Endpoint | Description |
|---|---|---|
| Session Controlling Operations | ||
| POST |
restart /{phone_id}/restart |
Restarts the session by refreshing the page. |
| POST |
backup /{phone_id}/backup |
Backups the material needed for opening the same chat screen for the current phone number. This call is useful when the session is active and also the status of the session is… |
| POST |
logout /{phone_id}/logout |
Logouts the number from the current session and converts the screen to qr-code screen. |
| POST |
clear /{phone_id}/clear |
Only reset browser information. After you must scan qr code. |
| POST |
restore /{phone_id}/restore |
Reloads the current session based on the reload data. |
| GET |
redeploy /{phone_id}/redeploy |
Redeploys docker instance of your phone. If your phone having any unexpected problems you can use this endpoint to reboot the instance. |
| Session Information Getters | ||
| GET |
getStatus /{phone_id}/status |
Returns the status of the current session. |
| GET |
getQRCode /{phone_id}/qrCode |
Gets the image of QR-Code. |
| GET |
getScreen /{phone_id}/screen |
Returns the screenshot of the screen in the current session |
| GET |
checkNumberStatus /{phone_id}/checkNumberStatus |
Check phone number status. |
| GET |
logs /logs |
Gets logs. |
| GET |
contacts /{phone_id}/contacts |
Returns the contacts in the current whatsapp instance. |
| Message Sending Operations | ||
| POST |
sendMessage /{phone_id}/sendMessage |
Sends both text and media (image, video, sound, document) to the user, whose number is taken at the body of the request. |
| Account Information Retrieval & Edit | ||
| GET |
getProduct /product |
Gets the product id and webhook url of the account. |
| GET |
getListPhones /listPhones |
Gets the list of phones with their id's and numbers that are registered to the given product id. |
| POST |
setWebhook /setWebhook |
Sets the webhook url. Webhook is used for directing the incoming messages and some changes in the session. |
| POST |
setAckPreference /setAckPreference |
Sets the acknowledge notification preference to true or false. If it is set to true, then every acknowledge message of the delivered messages are sent to the webhook address if a… |
| POST |
addPhone /addPhone |
Adds a new phone object to the database for the product determined by the taken product id. A number can also be specified in that step but if not, the phone number in the active… |
| Group Chat Operations | ||
| POST |
createGroup /{phone_id}/createGroup |
Sets the option for getting the acknowledge messages from the webhook to true or false. |
| GET |
getGroups /{phone_id}/getGroups |
Sets the option for getting the acknowledge messages from the webhook to true or false. |
| Queue Operations | ||
| GET |
queue /{phone_id}/queue |
Returns the queue info of the phone. |
| GET |
purgeQueue /{phone_id}/purgeQueue |
Clears phone's send message queue. |
Maytapi WhatsApp pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| PRO | $29 / month | — |
|
