documenter.getpostman.com Open in urlscan Pro
2606:4700:4400::ac40:9a6a  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Public


Documentation Settings

ENVIRONMENT
No Environment

LAYOUT
Single Column

LANGUAGE
cURL - cURL



Lets bot Documentation
Introduction
Responses
Success Message
Single Error Message
Versioning
Change Log
Webhooks
Rate Limiting
Sales
Support
Messages
Groups Control
Chat
Users
Instances
Sessions
Live Chat


LETS BOT DOCUMENTATION

Welcome to the Lets bot API

🚀 Enjoy taking your business messaging to the next level. With Lets bot API,
you can take advantage of the world's most popular messaging platform and create
powerful applications that help you enhance customer service & communication
needs. Get up and running quickly with our tutorials, reference guides, and
examples, and start building unique solutions today. Unlock the potential of
WhatsApp Business with Lets bot API and prepare for a whole new world of
business opportunities!

WhatsApp has completely transformed the communication landscape - it's used by
an astounding 2 billion people, with 60 billion messages flying around daily!
Businesses also realize this as a secure and reliable way to deliver
notifications quickly and provide premium customer service.

Relatively easy to use and integrate, the RESTful API of this tool opens up a
world of possibilities. You can now connect your WhatsApp number to third-party
systems, programming languages, CMS, CRMs & CLI tools.

We don't require you to hassle with SDKs or complex software dependencies - you
can use the API right away with ease by sending HTTPS requests to the relevant
endpoint.

NOTE

To access our API, you will need a Lets bot account. Already have an account?
Log in now. Otherwise, create your account quickly and easily with only a few
clicks - Create an Account.

Send your first message today! 😍

> This documentation is regularly updated, so check back often! In addition, if
> you need more help or spot any mistakes while developing an application, feel
> free to reach out, and we'll be happy to provide assistance.


RESPONSES


RESPONSES AND ERROR HANDLING

Lets bot has applied all the technical standards placed by the RESTFull API
codes. So, developers can always receive, read, decode, or understand the errors
in responses based on the following form:

RESPONSE STATUS MEANING 200 Success The request has succeeded. 201 Created The
request has been accepted for processing and successfully inserted/updated in
our database. 202 Accepted The request has been accepted for processing and
successfully deleted from our database. 422 Unprocessable Entity Used if the
server cannot process the entity, e.g., mandatory fields are missing in the
payload. 500 Internal Server Error We might be updating our services; please
wait a while before trying again.
503 Service Unavailable We could not handle the HTTP request due to a temporary
overloading or maintenance of the server; please wait a while before trying
again.


SUCCESS MESSAGE

View More
json


{
    "success": true,
    "message": "The message has been successfully sent.",
    "data": {
        "key": {
        },
        "message": {
        },
        "messageTimestamp": "1677650400", // Unix timestamp
        "status": "SUCCESS" // SUCCESS OR PENDING
    }
}


SINGLE ERROR MESSAGE

json


{
    "Status": 0,
    "Message": "Phone is Required"
}


VERSIONING


INEVITABLE CHANGE

Change in an API is unavoidable as your knowledge and experience of a system
improve. To manage the impact of this change, we have decided to use URI
versioning.


URI VERSIONING

One way to version a REST API is to include the version number in the URI path.
When we introduce the version in the URI space, the Representations of Resources
are considered immutable. So when changes need to be introduced in the API, a
new URI space must be created.

For example, say an API publishes the following resources – users, and
privileges:

Plain Text


https://letsbot.net/api/v1/send
https://letsbot.net/api/v1/message


CHANGE LOG

This page will cover Lets bot APIs' hotfixes, frequent updates, bug fixes, speed
improvement, and deprecated endpoints and requests.
We will display both the unreleased and released updates on Lets bot API, but
now, we are made a standard API v1 with no more changes.


WEBHOOKS

Lets bot Webhooks allows you to set up fully automated notifications easily. As
long as your WhatsApp is connected to our system, you will get notified whenever
your WhatsApp Account receives payload/data.

The Webhooks are triggered when:

   
 * New Chats.
   
 * New Contact.
   
 * New Ack
   

You can then use the payload sent via webhooks to trigger other actions or
integrate with external systems.

This makes it simple to customize your solution and keep track of all changes
occurring within your WhatsApp account.


RATE LIMITING

All APIs are rate-limited to ensure our platform remains stable and fair for
everyone. We use a combination of techniques to implement rate limits. For
example, responsibly limit calls, caching results, and re-retry requests.
Rate limits apply based on the plan you are subscribed to; this table clarifies
how it works.

PLAN MAX REQUESTS TIMEOUT DURATION LEAK LIMIT Basic 60 1 minute One request per
second Flex 120 1 minute One request per second Extra 180 1 minute One request
per second

According to your plan, you have x Max requests per 1 minute (Timeout duration).
However, you consumed all the submissions before the minute ended. In that case,
you can have one request per second (the leak limit) until the minute ends and
another minute begins.

Limits are calculated using the leaky bucket algorithm. All requests made after
exceeding rate limits are throttled, and an HTTP 429 Too Many Requests error is
returned.

Requests succeed again after enough requests have emptied the bucket. You can
see the state of the throttle for a store using the rate limits header.

Rate limits will be returned with every request in the following headers:

X-RATELIMIT-LIMIT

> This header, x-rate limit-remaining, will contain the number of calls per
> minute to be made to the API before rate limiting takes effect. Depending on
> the subscription plan, this can have a value of 60, 120, or 180.

X-RATELIMIT-REMAINING

> This header, x-rate limit-remaining, will contain the number of calls the API
> has left in the current rate limit window.

RETRY-AFTER

> This header will contain the number of seconds the API will become available
> after its exceeded rate limit.

X-RATELIMIT-RESET

> This header will contain when an API's current rate limit window resets in UTC
> epoch seconds.

If the bucket size exceeds, an HTTP 429 Too Many Requests error is returned. The
bucket empties at a leak rate of one request per second. You can make your
integration average one bid per second to avoid being throttled. The throttle is
a pass-or-fail operation.


FACING A PROBLEM?

We've got your back! Get quick and expert help with a call at +201099455783 or
drop us an email at sales@letsbot.net


SALES

Our sales team is here to assist - get in touch now at +201099455783 or
sales@letsbot.net


SUPPORT

Struggling with something? Let us lend you a hand! Our friendly & knowledgeable
support team is just a message away. Message us at +201099455783 for quick help.

AUTHORIZATIONBearer Token
Token

Bearer Token