API Reference
Last updated
Vietnamese
Last updated
To use Botcake API, you need to generate a token. Navigate to Settings -> API and click Generate your Token button.
Please note: Refreshing and Deleting your token will disable all connected API methods!
After a successful token generation, you can use API.
GET https://botcake.io/api/public_api/v1/pages/[:page_id]/flows
access-token*
String
Chuỗi token của page(Khách hàng có thể tạo ở mục Cấu hình/ API Access Token)
GET https://botcake.io/api/public_api/v1/pages/[:page_id]/flows/[:path]
path
Array
Thư mục muốn lấy ra(ví dụ: lấy dữ liệu trong thư mục id 2, thư mục id 2 nằm trong thư mục id 1, thư mục id 1 không có thư mục nào trên nữa thì path = [1,2])
access-token*
String
Chuỗi token của page(Khách hàng có thể tạo ở mục Cấu hình/ API Access Token)
GET https://botcake.io/api/public_api/v1/pages/[:page_id]/flows/:flow_id/statistics
access-token*
String
Chuỗi token của page(Khách hàng có thể tạo ở mục Cấu hình/ API Access Token)
GET https://botcake.io/api/public_api/v1/pages/[:page_id]/keywords
access-token*
String
Chuỗi token của page(Khách hàng có thể tạo ở mục Cấu hình/ API Access Token)
GET https://botcake.io/api/public_api/v1/pages/[:page_id]/ice_breaker
access-token*
String
Chuỗi token của page(Khách hàng có thể tạo ở mục Cấu hình/ API Access Token)
GET https://botcake.io/api/public_api/v1/pages/[:page_id]/main_menu
access-token*
String
Chuỗi token của page(Khách hàng có thể tạo ở mục Cấu hình/ API Access Token)
GET https://botcake.io/api/public_api/v1/pages/[:page_id]/tools
access-token*
String
Chuỗi token của page(Khách hàng có thể tạo ở mục Cấu hình/ API Access Token)
POST https://botcake.io/api/public_api/v1/pages/[:page_id]/ketwords/create
access-token*
String
Chuỗi token của page(Khách hàng có thể tạo ở mục Cấu hình/ API Access Token)
POST https://botcake.io/api/public_api/v1/pages/[:page_id]/ketwords/update
access-token*
String
Chuỗi token của page(Khách hàng có thể tạo ở mục Cấu hình/ API Access Token)
keyword_id*
Integer
Id của keyword được trả về trong api get keywords
update*
Object
Các trường bạn muốn update
Hiện tại hỗ trợ:
{
flow_id(Integer): id của flow sẽ được chạy khi keyword được kích hoạt
}
POST https://botcake.io/api/public_api/v1/pages/[:page_id]/flows/send_flow
access-token*
String
Chuỗi token của page(Khách hàng có thể tạo ở mục Cấu hình/ API Access Token)
psid*
String
Chuỗi id của khách hàng trên page Facebook trả về
flow_id*
Integer
Id của flow mà bạn muốn gửi cho khách hàng
payload
Object
In the Dynamic Block request body, you can use the Full Contact Data variable which contains all contact’s information:
{
"user_first_name": "Firstname", "user_last_name": "Lastname", "user_full_name": "Subscriber", "#GENDER{{MALE|FEMALE|UNKNOWN}}": "MALE",
"psid": "123456xxxxxx", "ad_id": "123456xxxxx", "page_name": "Botcake",
"{{SPIN_1|SPIN_2}}": "SPIN_1",
"email": "abc@gmail.com", "phone": "+8438409xxxx", "address": "Ha Noi", "current_date": "2018-07-02T00:00:00+00:00", "CONVERSATION_LINK": "https://pages.fm/323087334762615?c_id=323087334762615_xxxxxxxxxx",
...
}
POST https://botcake.io/api/public_api/v1/pages/[:page_id]/flows/send_content
access-token*
String
Chuỗi token của page(Khách hàng có thể tạo ở mục Cấu hình/ API Access Token)
psid*
String
Chuỗi id của khách hàng trên page Facebook trả về
payload
Object
In the Dynamic Block request body, you can use the Full Contact Data variable which contains all contact’s information:
{
"user_first_name": "Firstname", "user_last_name": "Lastname", "user_full_name": "Subscriber", "#GENDER{{MALE|FEMALE|UNKNOWN}}": "MALE",
"psid": "123456xxxxxx", "ad_id": "123456xxxxx", "page_name": "Botcake",
"{{SPIN_1|SPIN_2}}": "SPIN_1",
"email": "abc@gmail.com", "phone": "+8438409xxxx", "address": "Ha Noi", "current_date": "2018-07-02T00:00:00+00:00", "CONVERSATION_LINK": "https://pages.fm/323087334762615?c_id=323087334762615_xxxxxxxxxx",
...
}
message_tag
String
