API Documentation

WhatsApp API

API endpoints for whatsapp api management

POST https://app.botbee.io/api/v1/whatsapp/account/connect

Connect Account

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
user_id	Integer	Required	User ID of WhatsApp account owner
whatsapp_business_account_id	String	Required	WhatsApp Business Account ID
access_token	String	Required	Access Token

Examples

GET Request

https://app.botbee.io/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

curl -X POST 'https://app.botbee.io/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'

Response

{"status":"1","message":"Whatsapp account has been connect successfully."}

POST/GET https://app.botbee.io/api/v1/whatsapp/send

Send Message

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
phone_number_id	String	Required	WhatsApp account phone number ID
message	String	Required	Text message content (need url encoded value for GET request)
phone_number	String	Required	Must start with country code and only numeric characters are allowed

Examples

GET Request

https://app.botbee.io/api/v1/whatsapp/send?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&message=TEXT-MESSAGE&phone_number=PHONE-NUMBER

POST Request

curl -X POST 'https://app.botbee.io/api/v1/whatsapp/send' -d 'apiToken=API-KEY' -d 'phone_number_id=PHONE-NUMBER-ID' -d 'message=TEXT-MESSAGE' -d 'phone_number=PHONE-NUMBER'

Response

{"status":"1","message":"Message sent successfully."}

Generate API Endpoint: Send Template Message (GET/POST)

GET/POST https://app.botbee.io/api/v1/whatsapp/get/conversation

Get Conversation

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
phone_number_id	String	Required	Your whatsapp phone number id
phone_number	String	Required	Subscriber phone number
limit	Number	Required	Fetch number of conversation message
offset	Number	Optional	Offset of pagination

Examples

GET Request

https://app.botbee.io/api/v1/whatsapp/get/conversation?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&limit=10&offset=1

POST Request

curl -X POST 'https://app.botbee.io/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'

Response

{"status":"1","message":[{"id":8XX3,"whatsapp_bot_subscriber_subscriber_id":"91017XXXXX-23","whatsapp_bot_id":23,"sender":"bot","agent_name":null,"message_content":"{\"delay_in_reply\":0,\"messaging_product\":\"whatsapp\",\"recipient_type\":\"individual\",\"to\":\"91017XXXX9003\",\"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/POST https://app.botbee.io/api/v1/whatsapp/template/list

Get Bot Template

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
phone_number_id	String	Required	WhatsApp account phone number ID

Examples

GET Request

https://app.botbee.io/api/v1/whatsapp/template/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID

POST Request

curl -X POST 'https://app.botbee.io/api/v1/whatsapp/template/list' -d 'apiToken=API-KEY' -d 'phone_number_id=PHONE-NUMBER-ID'

Response

{"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\":[\"https:\\/\\/example.com\\/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"}}

GET/POST https://app.botbee.io/api/v1/whatsapp/broadcast/template/send

Send Broadcast Template

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
phone_number_id	String	Required	WhatsApp account phone number ID
flow_data	Json	Required	Pass Flow data as json format

Examples

GET Request

https://app.botbee.io/api/v1/whatsapp/broadcast/template/send?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID

POST Request

curl -X POST 'https://app.botbee.io/api/v1/whatsapp/broadcast/template/send' -d 'apiToken=API-KEY' -d 'phone_number_id=PHONE-NUMBER-ID'

Response

{"status":"1","visual_flow_campaign_id":1727,"message":"Data has been saved successfully.","redirect_on_success_url":""}

GET/POST https://app.botbee.io/api/v1/whatsapp/trigger-bot

Trigger Bot Flow

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
phone_number_id	String	Required	WhatsApp account phone number ID
bot_flow_unique_id	String	Required	Bot Flow Unique ID
phone_number	String	Required	Must start with country code and only numeric characters are allowed

Examples

GET Request

https://app.botbee.io/api/v1/whatsapp/trigger-bot?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&bot_flow_unique_id=BOT-FLOW-UNIQUE-ID&phone_number=PHONE-NUMBER

POST Request

curl -X POST 'https://app.botbee.io/api/v1/whatsapp/trigger-bot' -d 'apiToken=API-KEY' -d 'phone_number_id=PHONE-NUMBER-ID' -d 'bot_flow_unique_id=BOT-FLOW-UNIQUE-ID' -d 'phone_number=PHONE-NUMBER'

Response

{"status":"1","message":"Bot ha been trigger successfully."}

Subscriber API

API endpoints for subscriber api management

POST https://app.botbee.io/api/v1/whatsapp/subscriber/get

Get Subscriber

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
phone_number_id	String	Required	WhatsApp account phone number ID
phone_number	String	Required	Subscriber phone number

Examples

GET Request

https://app.botbee.io/api/v1/whatsapp/subscriber/get?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER

POST Request

curl -X POST 'https://app.botbee.io/api/v1/whatsapp/subscriber/get' -d 'apiToken=API-KEY' -d 'phone_number_id=PHONE-NUMBER-ID' -d 'phone_number=PHONE-NUMBER'

Response

{"status":"1","message":[{"subscriber_id":144,"chat_id":"9101521455XXX","first_name":"S Akash","last_name":"Kumar","email":"test@gmail.com","gender":"Male","label_names":"Label1,Label2"}]}

GET/POST https://app.botbee.io/api/v1/whatsapp/subscriber/list

Subscribers List

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
phone_number_id	String	Required	Your whatsapp phone number id
limit	Number	Required	Fetch number of subscribers
offset	Number	Optional	Offset of pagination

Examples

GET Request

https://app.botbee.io/api/v1/whatsapp/subscriber/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&limit=10&offset=1

POST Request

curl -X POST 'https://app.botbee.io/api/v1/whatsapp/subscriber/list' -d 'apiToken=API-KEY' -d 'phone_number_id=PHONE-NUMBER-ID' -d 'limit=10' -d 'offset=1'

Response

{"status":"1","message":[{"subscriber_id":144,"chat_id":"910152145XXX","first_name":"Akash","last_name":"Akash","email":"test@gmail.com","gender":"male","label_names":"One ,two"},{"subscriber_id":157,"chat_id":"9101518951XXX","first_name":"Rahim","last_name":"Karim","email":"null","gender":"Male","label_names":"ChatTest,remove tag,One"}]}

POST https://app.botbee.io/api/v1/whatsapp/subscriber/create

Create Subscriber

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
phoneNumberID	String	Required	WhatsApp account phone number ID
name	String	Required	Name of your subscriber
phoneNumber	String	Required	Subscriber phone number with country code (without + sign)

Examples

GET Request

https://app.botbee.io/api/v1/whatsapp/subscriber/create?apiToken=API-KEY&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILE

POST Request

curl -X POST 'https://app.botbee.io/api/v1/whatsapp/subscriber/create' -d 'apiToken=API-KEY' -d 'phoneNumberID=PHONE-NUMBER-ID' -d 'name=NAME' -d 'phoneNumber=MOBILE'

Response

{"status":"1","mesasge":"WhatsApp subscriber has been created."}

POST https://app.botbee.io/api/v1/whatsapp/subscriber/update

Update Subscriber

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
phone_number_id	String	Required	WhatsApp account phone number ID
phone_number	String	Required	Subscriber phone number
first_name	String	Optional	First name of your subscriber
last_name	String	Optional	Last name of your subscriber
gender	String	Optional	Gender of your subscriber
label_ids	String	Optional	Label ids with comma separated like (1,4,5)

Examples

GET Request

https://app.botbee.io/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

curl -X POST 'https://app.botbee.io/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'

Response

{"status":"1","message":"Subscriber Updated Successfully."}

POST https://app.botbee.io/api/v1/whatsapp/subscriber/reset/user-input-flow

Reset User Input Flow

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
phone_number_id	String	Required	WhatsApp account phone number ID
phone_number	String	Required	Subscriber phone number

Examples

GET Request

https://app.botbee.io/api/v1/whatsapp/subscriber/reset/user-input-flow?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER

POST Request

curl -X POST 'https://app.botbee.io/api/v1/whatsapp/subscriber/reset/user-input-flow' -d 'apiToken=API-KEY' -d 'phone_number_id=PHONE-NUMBER-ID' -d 'phone_number=PHONE-NUMBER'

Response

{"status":"1","message":"Reset User Input Flow successfully."}

POST https://app.botbee.io/api/v1/whatsapp/subscriber/chat/assign-to-team-member

Assign Subscriber Chat to Team Member

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
phone_number_id	String	Required	Your whatsapp phone number id
phone_number	String	Required	Subscriber phone number
team_member_id	Integer	Required	Team Member ID

Examples

GET Request

https://app.botbee.io/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

curl -X POST 'https://app.botbee.io/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'

Response

{"status":"1","message":"Successfully Assign Agent to Conversation."}

POST https://app.botbee.io/api/v1/whatsapp/subscriber/chat/assign-custom-fields

Assign Subscriber Custom Fields

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
phone_number_id	String	Required	Your whatsapp phone number id
phone_number	String	Required	Subscriber phone number
custom_fields	JSON	Required	Custom fileds name and value in json format

Examples

POST Request

curl -X POST 'https://app.botbee.io/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"}'

Response

{"status":"1","message":"Subscriber changes have been saved successfully."}

Label API

API endpoints for label api management

GET/POST https://app.botbee.io/api/v1/whatsapp/label/list

Label List

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
phone_number_id	String	Required	Your whatsapp phone number id

Examples

GET Request

https://app.botbee.io/api/v1/whatsapp/label/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID

POST Request

curl -X POST 'https://app.botbee.io/api/v1/whatsapp/label/list' -d 'apiToken=API-KEY' -d 'phone_number_id=PHONE-NUMBER-ID'

Response

{"status":"1","message":[{"id":1,"label_name":"Your label name","status":"1"}]}

GET/POST https://app.botbee.io/api/v1/whatsapp/label/create

Label Create

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
phone_number_id	String	Required	Your whatsapp phone number id
label_name	String	Required	Label Name

Examples

GET Request

https://app.botbee.io/api/v1/whatsapp/label/create?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&label_name=LABEL-NAME

POST Request

curl -X POST 'https://app.botbee.io/api/v1/whatsapp/label/create' -d 'apiToken=API-KEY' -d 'phone_number_id=PHONE-NUMBER-ID' -d 'label_name=LABEL-NAME'

Response

{"status":"1","message":"Label has been created successfully."}

Catalog API

API endpoints for catalog api management

GET/POST https://app.botbee.io/api/v1/whatsapp/catalog/list

Catalog List

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key

Examples

GET Request

https://app.botbee.io/api/v1/whatsapp/catalog/list?apiToken=API-KEY

POST Request

curl -X POST 'https://app.botbee.io/api/v1/whatsapp/catalog/list' -d 'apiToken=API-KEY'

Response

{"status":true,"message":[{"catalog_id":"1429267xxxx5095","catalog_name":"The White","catalog_url":"https:xxxxx","checkout_settings":"{"tax_percentage":"5.5","shipping_charge":"20"}"}]}

GET/POST https://app.botbee.io/api/v1/whatsapp/catalog/order/list

Catalog Order List

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
whatsapp_catalog_id	String	Optional	Your whatsapp catalog id

Examples

GET Request

https://app.botbee.io/api/v1/whatsapp/catalog/order/list?apiToken=API-KEY&whatsapp_catalog_id=WHATSAPP-CATALOG-ID

POST Request

curl -X POST 'https://app.botbee.io/api/v1/whatsapp/catalog/order/list' -d 'apiToken=API-KEY' -d 'whatsapp_catalog_id=WHATSAPP-CATALOG-ID'

Response

{"status":"1","message":[{"order_unique_id":"17231046738801724816054","catalog_id":"762561142206860","chat_id":"9101724816XXX","catalog_name":"Ez soci Chat","first_name":"S Akash","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\":\"Akash Kumar\",\"phone_number\":\"015XXXXXXXXX\",\"email\":\"akash@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"}]}

GET/POST https://app.botbee.io/api/v1/whatsapp/catalog/order/status-change

Catalog Order Status Change

Parameters

Parameter	Type	Required	Description
apiToken	String	Required	Your api key
order_unique_id	String	Required	Your Catalog Order ID
cart_status	String	Required	Status value should be Approved\|Completed\|Shipped\|Delivered\|Refunded

Examples

GET Request

https://app.botbee.io/api/v1/whatsapp/catalog/order/status-change?apiToken=API-KEY&order_unique_id=ORDER-UNIQUE-ID&cart_status=CART-STATUS

POST Request

curl -X POST 'https://app.botbee.io/api/v1/whatsapp/catalog/order/status-change' -d 'apiToken=API-KEY' -d 'order_unique_id=ORDER-UNIQUE-ID' -d 'cart_status=CART-STATUS'

Response

{"status":true,"message":"Cart status has been updated successfully"}