image

The BotSailor API offers powerful tools to integrate and automate various aspects of your business communication and management. With a wide range of endpoints designed for managing users, WhatsApp accounts, and subscribers, you can significantly streamline operations, enhance customer engagement, and improve overall efficiency. By leveraging the capabilities of the BotSailor API, businesses can automate routine tasks, reduce manual effort, and ensure consistent communication across multiple channels. This not only saves valuable time and resources but also enables businesses to focus on strategic growth and customer satisfaction. Moreover, the API's robust features provide deeper insights into user behavior, allowing for more personalized interactions and data-driven decision-making. Whether you are looking to scale your operations or optimize customer interactions, the BotSailor API is the perfect solution to help you achieve your business goals with ease and efficiency.

This API is ideal for developers looking to build custom solutions that leverage the full potential of BotSailor's features, enabling you to create tailored experiences for your users and customers.

User Management : Create, update, and manage user accounts with detailed control over their subscription status and access rights.

WhatsApp Integration : Seamlessly connect WhatsApp Business Accounts, send messages, and manage subscriber data to optimize communication with your customers.

Subscriber Management : Automate the process of adding, updating, and segmenting subscribers, ensuring personalized and targeted interactions.

Advanced Integrations : Utilize APIs to connect with third-party applications like WooCommerce, Shopify, and Zapier, expanding the capabilities of your business automation.

Your API key

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Generate API key

User API

User API, create,update,list...

User API : User List

List of Users

API End-point : GET/POST
https://botsailor.com/api/v1/user/list
  1. apiToken
    Your api key
    String|Required
  2. id
    Single User data can be fetched using both User ID or Email
    Integer|Optional
GET Request Example
https://botsailor.com/api/v1/user/list?apiToken=API-KEY&id=USER-ID-OR-EMAIL
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/user/list' \ 
-d 'apiToken=API-KEY' \
-d 'id=USER-ID-OR-EMAIL'
Sample Response(All list)
{"status":"1","message":[{"user_id":114,"name":"Member","email":"member@gmail.com","mobile":"017XXXXXXXX","package_name":"Premium2","expired_date":"2023-08-05 00:00:00","created_at":"2022-03-26 10:55:29","last_login_at":"2023-08-06 08:55:13","last_login_ip":"127.0.0.1"}]}
Sample Response(Single User)
{"status": "1", "message": { "user_id": 114, "user_type": "Member", "name": "Member", "email": "member@gmail.com", "mobile": "3555757", "package_name": "Premium1", "expired_date": "2025-07-02 00:00:00", "created_at": "2022-03-26 10:55:29", "status": "1", "last_login_at": "2024-07-24 11:59:58", "last_login_ip": "127.0.0.1", "agent_has_ppu": "0", "agent_ppu_remaining": -1, "bot_subscriber_data": { "limit": "5000", "count": "1" }, "message_credit_data": { "limit": "unlimited", "used": 0 }, "whatsapp_bots_details": [ { "display_phone_number": "+91 97031 XXXX", "phone_number_id": "11906XXXXX40020", "whatsapp_business_account_id": "10039XXXX785XX", "whatsapp_business_name": "BotSailor" }] }}

User API : User Create

Create an new User

API End-point : POST
https://botsailor.com/api/v1/user/create
  1. apiToken
    Your api key
    String|Required
  2. name
    Name of your user
    String|Required
  3. email
    Email of your user
    Email|Required
  4. mobile
    User phone number
    String|Optional
  5. password
    User password
    String|Required
  6. package_id
    Package Id
    Integer|Required
  7. expired_date
    Pcakage Expired date like (2023-09-12)
    String|Required
GET Request Example
https://botsailor.com/api/v1/user/create?apiToken=API-KEY&name=NAME&email=EMAIL&mobile=MOBILE&password=PASSWORD&package_id=NAME&expired_date=EXPIRED-DATE
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/user/create' \ 
-d 'apiToken=API-KEY' \
-d 'name=NAME' \
-d 'email=EMAIL' \
-d 'mobile=MOBILE' \
-d 'password=PASSWORD' \
-d 'package_id=NAME' \
-d 'expired_date=EXPIRED-DATE'
Sample Response
{"status":"1","mesasge":"User Created Successfully.","id":192}

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}

User API : User Update

Update a Existing User

API End-point : POST
https://botsailor.com/api/v1/user/update
  1. apiToken
    Your api key
    String|Required
  2. id
    User can be updated using both User ID or Email
    Integer|Required
  3. name
    Name of your user
    String|Optional
  4. email
    Email of your user
    Email|Optional
  5. mobile
    User phone number
    String|Optional
  6. password
    User password
    String|Optional
  7. package_id
    Package Id
    Integer|Optional
  8. expired_date
    Package Expired date like (2023-09-12)
    String|Optional
  9. status
    Status of user active(1) inactive(0)
    String|Optional
  10. reset_monthly_usage
    Reset current month`s usage log of user reset(1) keep(0)
    String|Optional
GET Request Example
https://botsailor.com/api/v1/user/update?apiToken=API-KEY&id=USER-ID-OR-EMAIL&name=NAME&email=EMAIL&mobile=MOBILE&password=PASSWORD&package_id=NAME&expired_date=EXPIRED-DATE&status=STATUS&reset_monthly_usage=RESET-MONTHLY-USAGE
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/user/update' \ 
-d 'apiToken=API-KEY' \
-d 'id=USER-ID-OR-EMAIL' \
-d 'name=NAME' \
-d 'email=EMAIL' \
-d 'mobile=MOBILE' \
-d 'password=PASSWORD' \
-d 'package_id=NAME' \
-d 'expired_date=EXPIRED-DATE' \
-d 'status=STATUS' \
-d 'reset_monthly_usage=RESET-MONTHLY-USAGE'
Sample Response
{"status":"1","message":"User Updated Successfully."}

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}

User API : Get Direct Login Url

An Unique and Secure One-time Login URL

API End-point : GET/POST
https://botsailor.com/api/v1/user/get/direct-login-url
  1. apiToken
    Your api key
    String|Required
  2. email
    Email of your user
    Email|Required
  3. name
    Name of your user
    String|Optional
  4. mobile
    User phone number
    String|Optional
  5. package_id
    Package Id
    Integer|Required for new user
  6. expired_date
    Package Expired date like (2023-09-12)
    String|Required for new user
  7. status
    Status of user active(1) inactive(0)
    String|Optional
GET Request Example
https://botsailor.com/api/v1/user/get/direct-login-url?apiToken=API-KEY&email=EMAIL&name=NAME&mobile=MOBILE&package_id=NAME&expired_date=EXPIRED-DATE&status=STATUS
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/user/get/direct-login-url' \ 
-d 'apiToken=API-KEY' \
-d 'email=EMAIL' \
-d 'name=NAME' \
-d 'mobile=MOBILE' \
-d 'package_id=NAME' \
-d 'expired_date=EXPIRED-DATE' \
-d 'status=STATUS'
Sample Response
{"status":"1","message":{"email":"user@domain.com","password":"xxxxxxxxxx","login_url":"https://botsailor.com/login","direct_login_url":"https://botsailor.com/direct-login/xxxxxxxxxx"}}

WhatsApp API

WhatsApp send api, add contact...

WhatsApp API : Account Connect

Connect WhatsApp Business Account

API End-point : POST
https://botsailor.com/api/v1/whatsapp/account/connect
  1. apiToken
    Your api key
    String|Required
  2. user_id
    User ID of WhatsApp account owner
    Integer|Required
  3. whatsapp_business_account_id
    WhatsApp Business Account ID
    String|Required
  4. access_token
    Access Token
    String|Required
GET Request Example
https://botsailor.com/api/v1/whatsapp/account/connect?apiToken=API-KEY&user_id=USER-ID&whatsapp_business_account_id=WHATSAPP-BUSINESS-ACCOUNT-ID&access_token=ACCESS-TOKEN
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/whatsapp/account/connect' \ 
-d 'apiToken=API-KEY' \
-d 'user_id=USER-ID' \
-d 'whatsapp_business_account_id=WHATSAPP-BUSINESS-ACCOUNT-ID' \
-d 'access_token=ACCESS-TOKEN'
Sample Response
{"status":"1","message":"Whatsapp account has been connect successfully."}

WhatsApp API : Send Message

Send WhatsApp message to any mobile number

API End-point : Send Message (GET/POST)
https://botsailor.com/api/v1/whatsapp/send
  1. apiToken
    Your api key
    String|Required
  2. phone_number_id
    WhatsApp account phone number ID
    String|Required
  3. message
    Text message content (need url encoded value for GET request)
    String|Required
  4. phone_number
    Must start with country code and only numeric characters are allowed
    String|Required
GET Request Example
https://botsailor.com/api/v1/whatsapp/send?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&message=TEXT-MESSAGE&phone_number=PHONE-NUMBER
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/whatsapp/send' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'message=TEXT-MESSAGE' \
-d 'phone_number=PHONE-NUMBER'
Sample Response
{"status":"1","message":"Message sent successfully."}

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}
Generate API End-point : Send Template Message (GET/POST)

Please Login to load all the templates

login
Sample Response
{"status":"1","message":"Template message sent successfully."}

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}

WhatsApp API : Subscriber Get

Get Subscriber Using Chat ID (Phone Number

API End-point : POST
https://botsailor.com/api/v1/whatsapp/subscriber/get
  1. apiToken
    Your api key
    String|Required
  2. phone_number_id
    WhatsApp account phone number ID
    String|Required
  3. phone_number
    Subscriber phone number
    String|Required
GET Request Example
https://botsailor.com/api/v1/whatsapp/subscriber/get?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/whatsapp/subscriber/get' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER'
Sample Response
{"status":"1","message":[{"subscriber_id":144,"chat_id":"8801521455XXX","first_name":"Md Ronok","last_name":"Ronok","email":"test@gmail.com","gender":"Male","label_names":"Label1,Label2"}]}

WhatsApp API : Subscriber List

List of Subscribers

API End-point : GET/POST
https://botsailor.com/api/v1/whatsapp/subscriber/list
  1. apiToken
    Your api key
    String|Required
  2. phone_number_id
    Your whatsapp phone number id
    String|Required
  3. limit
    Fetch number of subscribers.
    Number|Required
  4. offset
    Offset of paginatio.
    Number|Optional
GET Request Example
https://botsailor.com/api/v1/whatsapp/subscriber/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&limit=10&offset=1
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/whatsapp/subscriber/list' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'limit=10' \
-d 'offset=1'
Sample Response
{"status":"1","message":[{"subscriber_id":144,"chat_id":"880152145XXX","first_name":"Mamuduzzaman","last_name":"Ronok","email":"test@gmail.com","gender":"male","label_names":"One ,two"},{"subscriber_id":157,"chat_id":"8801518951XXX","first_name":"Rahim","last_name":"Karim","email":"null","gender":"Male","label_names":"ChatTest,remove tag,One"}]}

WhatsApp API : Subscriber Create

Create a Subscriber/Contact

API End-point : POST
https://botsailor.com/api/v1/whatsapp/subscriber/create
  1. apiToken
    Your api key
    String|Required
  2. phoneNumberID
    WhatsApp account phone number ID
    String|Required
  3. name
    Name of your subscriber
    String|Required
  4. phoneNumber
    Subscriber phone number with country code (without + sign)
    String|Required
GET Request Example
https://botsailor.com/api/v1/whatsapp/subscriber/create?apiToken=API-KEY&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILE
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/whatsapp/subscriber/create' \ 
-d 'apiToken=API-KEY' \
-d 'phoneNumberID=PHONE-NUMBER-ID' \
-d 'name=NAME' \
-d 'phoneNumber=MOBILE'
Sample Response
{"status":"1","mesasge":"WhatsApp subscriber has been created."}

{"status":"0","message":"WhatsApp account not found."}

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}

{"status":"0","message":"Something went wrong or subscriber already exist."}

WhatsApp API : Subscriber Update

Update an Existing Subscriber

API End-point : POST
https://botsailor.com/api/v1/whatsapp/subscriber/update
  1. apiToken
    Your api key
    String|Required
  2. phone_number_id
    WhatsApp account phone number ID
    String|Required
  3. phone_number
    Subscriber phone number
    String|Required
  4. first_name
    First name of your subscriber
    String|Optional
  5. last_name
    Last name of your subscriber
    String|Optional
  6. gender
    Gender of your subscriber
    String|Optional
  7. label_ids
    Label ids with comma separated like (1,4,5)
    String|Optional
GET Request Example
https://botsailor.com/api/v1/whatsapp/subscriber/update?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&first_name=FIRST-NAME&last_name=LAST-NAME&gender=GENDER&label_ids=LABEL-IDS
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/whatsapp/subscriber/update' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'first_name=FIRST-NAME' \
-d 'last_name=LAST-NAME' \
-d 'gender=GENDER' \
-d 'label_ids=LABEL-IDS'
Sample Response
{"status":"1","message":"Subscriber Updated Successfully."}

WhatsApp API : Subscriber Assign Chat to Team

Assign a Subscriber`s Chat to a Team Member

API End-point : POST
https://botsailor.com/api/v1/whatsapp/subscriber/chat/assign-to-team-member
  1. apiToken
    Your api key
    String|Required
  2. phone_number_id
    Your whatsapp phone number id
    String|Required
  3. phone_number
    Subscriber phone number
    String|Required
  4. team_member_id
    Team Member ID
    Integer|Required
GET Request Example
https://botsailor.com/api/v1/whatsapp/subscriber/chat/assign-to-team-member?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&team_member_id=TEAM-MEMBER-ID
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/whatsapp/subscriber/chat/assign-to-team-member' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'team_member_id=TEAM-MEMBER-ID'
Sample Response
{"status":"1","message":"Successfully Assign Agent to Conversation."}

WhatsApp API : Subscriber Assign Custom Fields

Assign Custom Field To Subscriber

API End-point : POST
https://botsailor.com/api/v1/whatsapp/subscriber/chat/assign-custom-fields
  1. apiToken
    Your api key
    String|Required
  2. phone_number_id
    Your whatsapp phone number id
    String|Required
  3. phone_number
    Subscriber phone number
    String|Required
  4. custom_fields
    Custom fileds name and value in json format.
    JSON|Required
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/whatsapp/subscriber/chat/assign-custom-fields' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'custom_fields={"custom_filed_name1": "custom_field_value1","custom_filed_name2": "custom_field_value2"}'
Sample Response
{"status":"1","message":"Subscriber changes have been saved successfully."}

WhatsApp API : Label List

List of Labels

API End-point : GET/POST
https://botsailor.com/api/v1/whatsapp/label/list
  1. apiToken
    Your api key
    String|Required
  2. phone_number_id
    Your whatsapp phone number id
    String|Required
GET Request Example
https://botsailor.com/api/v1/whatsapp/label/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/whatsapp/label/list' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID'
Sample Response
{"status":"1","message":[{"id":1,"label_name":"Your label name","status":"1"}]}

WhatsApp API : Label Create

Create a Label

API End-point : GET/POST
https://botsailor.com/api/v1/whatsapp/label/create
  1. apiToken
    Your api key
    String|Required
  2. phone_number_id
    Your whatsapp phone number id
    String|Required
  3. label_name
    Label Name
    String|Required
GET Request Example
https://botsailor.com/api/v1/whatsapp/label/create?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&label_name=LABEL-NAME
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/whatsapp/label/create' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'label_name=LABEL-NAME'
Sample Response
{"status":"1","message":"Label has been created successfully."}

WhatsApp API : Catalog List

Catalog List

API End-point : GET/POST
https://botsailor.com/api/v1/whatsapp/catalog/list
  1. apiToken
    Your api key
    String|Required
GET Request Example
https://botsailor.com/api/v1/whatsapp/catalog/list?apiToken=API-KEY
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/whatsapp/catalog/list' \ 
-d 'apiToken=API-KEY'
Sample Response
{"status":true,"message":[{"catalog_id":"1429267xxxx5095","catalog_name":"The White","catalog_url":"https:xxxxx","checkout_settings":"{"tax_percentage":"5.5","shipping_charge":"20"}"}]}

WhatsApp API : Catalog Order List

Catalog List

API End-point : GET/POST
https://botsailor.com/api/v1/whatsapp/catalog/order/list
  1. apiToken
    Your api key
    String|Required
  2. whatsapp_catalog_id
    Your whatsapp catalog id
    String|Optional
GET Request Example
https://botsailor.com/api/v1/whatsapp/catalog/order/list?apiToken=API-KEY&whatsapp_catalog_id=WHATSAPP-CATALOG-ID
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/whatsapp/catalog/order/list' \ 
-d 'apiToken=API-KEY' \
-d 'whatsapp_catalog_id=WHATSAPP-CATALOG-ID'
Sample Response
{"status":"1","message":[{"order_unique_id":"17231046738801724816054","catalog_id":"762561142206860","chat_id":"8801724816XXX","catalog_name":"Ez soci Chat","first_name":"Md Ronok","cart_total":4300,"cart_currency":"USD","cart_status_raw":"Submitted","ordered_at":"2024-08-08 08:11:13","updated_at":"2024-08-08 08:30:40","payment_amount":4300,"payment_method":"Cash on Delivery","shipping_address":"{\"name\":\"Mamuduzzaman Ronok\",\"phone_number\":\"015XXXXXXXXX\",\"email\":\"ronok@gmail.com\",\"address\":\"pti road\"}","checkout_account_email":null,"checkout_amount":"0","checkout_timestamp":null,"transaction_id":"PD1723104673880172481605433FAD1","paid_at":"2024-08-08 08:30:40","status_changed_at":"2024-08-08 08:30:40"}]}

WhatsApp API : Catalog Order Status Change

Change Catalog Order Status

API End-point : GET/POST
https://botsailor.com/api/v1/whatsapp/catalog/order/status-change
  1. apiToken
    Your api key
    String|Required
  2. order_unique_id
    Your Catalog Order ID
    String|Required
  3. cart_status
    Status value should be Approved|Completed|Shipped|Delivered|Refunded
    String|Required
GET Request Example
https://botsailor.com/api/v1/whatsapp/catalog/order/status-change?apiToken=API-KEY&order_unique_id=ORDER-UNIQUE-ID&cart_status=CART-STATUS
POST Request Example
curl -X POST \ 
'https://botsailor.com/api/v1/whatsapp/catalog/order/status-change' \ 
-d 'apiToken=API-KEY' \
-d 'order_unique_id=ORDER-UNIQUE-ID' \
-d 'cart_status=CART-STATUS'
Sample Response
{"status":true,"message":"Cart status has been updated successfully"}