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.
xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
User API, create,update,list...
My Information
https://botsailor.com/api/v1/user/myInfohttps://botsailor.com/api/v1/user/myInfo?apiToken=API-KEYcurl -X POST \
'https://botsailor.com/api/v1/user/myInfo' \
-d 'apiToken=API-KEY' {"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" }] }}List of Users
https://botsailor.com/api/v1/user/listhttps://botsailor.com/api/v1/user/list?apiToken=API-KEY&id=USER-ID-OR-EMAILcurl -X POST \
'https://botsailor.com/api/v1/user/list' \
-d 'apiToken=API-KEY' \
-d 'id=USER-ID-OR-EMAIL' {"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"}]}{"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" }] }}Create an new User
https://botsailor.com/api/v1/user/createhttps://botsailor.com/api/v1/user/create?apiToken=API-KEY&name=NAME&email=EMAIL&mobile=MOBILE&password=PASSWORD&package_id=NAME&expired_date=EXPIRED-DATEcurl -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' {"status":"1","mesasge":"User Created Successfully.","id":192}
{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}Update a Existing User
https://botsailor.com/api/v1/user/updatehttps://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-USAGEcurl -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' {"status":"1","message":"User Updated Successfully."}
{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}List of Packages
https://botsailor.com/api/v1/user/package/listhttps://botsailor.com/api/v1/user/package/list?apiToken=API-KEYcurl -X POST \
'https://botsailor.com/api/v1/user/package/list' \
-d 'apiToken=API-KEY' {"status":"1","message":{"id":1,"package_name":"Basic","package_type":"subscription","price":"Trial","validity":730,"module_ids":"1,19,18,9,10,11,2,26,24,3,4,7,22,13,15","monthly_limit":"{\"1\":\"1\",\"19\":\"3000\",\"18\":\"0\",\"9\":\"2000\",\"10\":\"0\",\"11\":\"0\",\"2\":\"0\",\"26\":\"0\",\"24\":\"0\",\"3\":\"0\",\"4\":\"0\",\"7\":\"3\",\"22\":\"0\",\"13\":\"0\",\"15\":\"0\"}"}}List of Module
https://botsailor.com/api/v1/user/module/listhttps://botsailor.com/api/v1/user/module/list?apiToken=API-KEYcurl -X POST \
'https://botsailor.com/api/v1/user/module/list' \
-d 'apiToken=API-KEY' {"status":"1","message":{"id":1,"module_name":"Connect Account","extra_text":"","limit_enabled":"1","status":"1"}}An Unique and Secure One-time Login URL
https://botsailor.com/api/v1/user/get/direct-login-urlhttps://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=STATUScurl -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' {"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 send api, add contact...
Connect WhatsApp Business Account
https://botsailor.com/api/v1/whatsapp/account/connecthttps://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-TOKENcurl -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' {"status":"1","message":"Whatsapp account has been connect successfully."}Send WhatsApp message to any mobile number
When a user writes you on your chat service using your business number, you can reply to them through text message within 24 hours. This is known as a customer-initiated text message or session message. A WhatsApp template message, on the other hand, uses a pre-approved template for communication and is an outbound message launched by a business. You can get in touch with a user using template messages if you accidentally don`t respond to their message within 24 hours.
https://botsailor.com/api/v1/whatsapp/sendhttps://botsailor.com/api/v1/whatsapp/send?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&message=TEXT-MESSAGE&phone_number=PHONE-NUMBERcurl -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' {"status":"1","message":"Message sent successfully."}
{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}{"status":"1","message":"Template message sent successfully."}
{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}Get Conversation of particular subscriber
https://botsailor.com/api/v1/whatsapp/get/conversationhttps://botsailor.com/api/v1/whatsapp/get/conversation?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&limit=10&offset=1curl -X POST \
'https://botsailor.com/api/v1/whatsapp/get/conversation' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'limit=10' \
-d 'offset=1' {"status":"1","message":[{"id":8XX3,"whatsapp_bot_subscriber_subscriber_id":"88017XXXXX-23","whatsapp_bot_id":23,"sender":"bot","agent_name":null,"message_content":"{\"delay_in_reply\":0,\"messaging_product\":\"whatsapp\",\"recipient_type\":\"individual\",\"to\":\"88017XXXX9003\",\"type\":\"interactive\",\"interactive\":{\"header\":{\"type\":\"text\",\"text\":\"Order gateway\"},\"body\":{\"text\":\"How would you like to purchase it?\"},\"type\":\"button\",\"action\":{\"buttons\":[{\"type\":\"reply\",\"reply\":{\"id\":\"5lvomLOuENXIe6D::gPeAiDDmVQR_jTR\",\"title\":\"Paypal pay\"}},{\"type\":\"reply\",\"reply\":{\"id\":\"YES_START_CHAT_WITH_HUMAN::CBaLoC4yTMyIljZ\",\"title\":\"COD\"}}]}}}","conversation_time":"2024-07-28 13:21:03","wa_message_id":"wamid.HBgNODgwMTcyMzMwOTAwMxUCABEYEjlGQkY3MEFEMEVGODhCNDkxNQA=","reaction_data":null,"message_status":null,"delivery_status_updated_at":"2024-07-28 13:21:03","failed_reason":""}]}
Get Whatsapp Bot template
https://botsailor.com/api/v1/whatsapp/template/listhttps://botsailor.com/api/v1/whatsapp/template/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-IDcurl -X POST \
'https://botsailor.com/api/v1/whatsapp/template/list' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' {"status":"1","message":{"id":48,"template_id":"437509121867805","whatsapp_business_id":11,"template_name":"ada","template_type":"single","locale":"en_US","header_type":"media","header_subtype":"image","header_content":"","body_content":"To send an interactive message template, make a POST call to \/PHONE_NUMBER_ID\/","footer_content":"","button_content":"[]","template_json":"{\"name\":\"template_23_1666095188\",\"language\":\"en_US\",\"category\":\"transactional\",\"components\":[{\"type\":\"header\",\"format\":\"image\",\"example\":{\"header_handle\":[\"http:\\\/\\\/telegram.test\\\/assets\\\/images\\\/template\\\/image.jpg\"]}},{\"type\":\"body\",\"text\":\"To send an interactive message template, make a POST call to \\\/PHONE_NUMBER_ID\\\/\"}],\"access_token\":\"EAAHFAlhZBSyEBAIRZCsHKZA5ZAdOWMRL7AwuuCBKd3tZChAQQ1PHojPUS5k76aMVyzzxG9bYp2JQ57aLMfQBCZCpvXKac4KLDZAhejOuw1zkNCxGjvK7J5YwNmZBwTTd8Iig2YDq0vGZBoS20ipsLB4scbOOh0WmQrj7oLI9ZC5rFlsFC9mYctgQKIyJCvZBfgn5pGE1YPiBllrqwZDZD\"}","button_type":"none","variable_map":"{\"header\":[],\"body\":[]}","updated_at":"2022-10-18 12:13:09","user_id":1,"status":"Rejected","system_template":"0","map_needed":"0","check_wp_type":"general"}}{"status":"1","message":"Template message sent successfully."}
{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}Get Whatsapp Broadcast Template
https://botsailor.com/api/v1/whatsapp/broadcast/template/sendhttps://botsailor.com/api/v1/whatsapp/broadcast/template/send?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-IDcurl -X POST \
'https://botsailor.com/api/v1/whatsapp/broadcast/template/send' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' {"status":"1","visual_flow_campaign_id":1727,"message":"Data has been saved successfully.","redirect_on_success_url":""}{"status":"1","message":"Template message sent successfully."}
{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}Get Subscriber Using Chat ID (Phone Number
https://botsailor.com/api/v1/whatsapp/subscriber/gethttps://botsailor.com/api/v1/whatsapp/subscriber/get?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBERcurl -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' {"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"}]}List of Subscribers
https://botsailor.com/api/v1/whatsapp/subscriber/listhttps://botsailor.com/api/v1/whatsapp/subscriber/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&limit=10&offset=1curl -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' {"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"}]}
Create a Subscriber/Contact
https://botsailor.com/api/v1/whatsapp/subscriber/createhttps://botsailor.com/api/v1/whatsapp/subscriber/create?apiToken=API-KEY&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILEcurl -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' {"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."}Update an Existing Subscriber
https://botsailor.com/api/v1/whatsapp/subscriber/updatehttps://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-IDScurl -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' {"status":"1","message":"Subscriber Updated Successfully."}
Reset User Input Flow
https://botsailor.com/api/v1/whatsapp/subscriber/reset/user-input-flowhttps://botsailor.com/api/v1/whatsapp/subscriber/reset/user-input-flow?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBERcurl -X POST \
'https://botsailor.com/api/v1/whatsapp/subscriber/reset/user-input-flow' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' {"status":"1","message":"Reset User Input Flow successfully."}
Assign a Subscriber`s Chat to a Team Member
https://botsailor.com/api/v1/whatsapp/subscriber/chat/assign-to-team-memberhttps://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-IDcurl -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' {"status":"1","message":"Successfully Assign Agent to Conversation."}
Assign Custom Field To Subscriber
https://botsailor.com/api/v1/whatsapp/subscriber/chat/assign-custom-fieldscurl -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"}' {"status":"1","message":"Subscriber changes have been saved successfully."}
List of Labels
https://botsailor.com/api/v1/whatsapp/label/listhttps://botsailor.com/api/v1/whatsapp/label/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-IDcurl -X POST \
'https://botsailor.com/api/v1/whatsapp/label/list' \
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' {"status":"1","message":[{"id":1,"label_name":"Your label name","status":"1"}]}
Create a Label
https://botsailor.com/api/v1/whatsapp/label/createhttps://botsailor.com/api/v1/whatsapp/label/create?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&label_name=LABEL-NAMEcurl -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' {"status":"1","message":"Label has been created successfully."}
Catalog List
https://botsailor.com/api/v1/whatsapp/catalog/listhttps://botsailor.com/api/v1/whatsapp/catalog/list?apiToken=API-KEYcurl -X POST \
'https://botsailor.com/api/v1/whatsapp/catalog/list' \
-d 'apiToken=API-KEY' {"status":true,"message":[{"catalog_id":"1429267xxxx5095","catalog_name":"The White","catalog_url":"https:xxxxx","checkout_settings":"{"tax_percentage":"5.5","shipping_charge":"20"}"}]}
Catalog List
https://botsailor.com/api/v1/whatsapp/catalog/order/listhttps://botsailor.com/api/v1/whatsapp/catalog/order/list?apiToken=API-KEY&whatsapp_catalog_id=WHATSAPP-CATALOG-IDcurl -X POST \
'https://botsailor.com/api/v1/whatsapp/catalog/order/list' \
-d 'apiToken=API-KEY' \
-d 'whatsapp_catalog_id=WHATSAPP-CATALOG-ID' {"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"}]}
Change Catalog Order Status
https://botsailor.com/api/v1/whatsapp/catalog/order/status-changehttps://botsailor.com/api/v1/whatsapp/catalog/order/status-change?apiToken=API-KEY&order_unique_id=ORDER-UNIQUE-ID&cart_status=CART-STATUScurl -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' {"status":true,"message":"Cart status has been updated successfully"}