API Reference
How to generate and authorize your token
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 Flows
GET
https://botcake.io/api/public_api/v1/pages/[:page_id]/flows
Headers
Name | Type | Description |
---|---|---|
access-token* | String | Token of page(You can create it in Setting/ API) |
Get Flows by path
GET
https://botcake.io/api/public_api/v1/pages/[:page_id]/flows/[:path]
Query Parameters
Name | Type | Description |
---|---|---|
path* | Array | The directory you want to retrieve (for example, get data in folder id 2, folder id 2 is in folder id 1, folder id 1 has no other folders on it, then path = [1,2]) |
Headers
Name | Type | Description |
---|---|---|
access-token* | String | Token of page(You can create it in Setting/ API) |
Get Flow Statistics
GET
https://botcake.io/api/public_api/v1/pages/[:page_id]/flows/:flow_id/statistics
Headers
Name | Type | Description |
---|---|---|
access-token* | String | Token of page(You can create it in Setting/ API) |
Get Keywords
GET
https://botcake.io/api/public_api/v1/pages/[:page_id]/keywords
Headers
Name | Type | Description |
---|---|---|
access-token* | String | Token of page(You can create it in Setting/ API) |
Get Asked Question
GET
https://botcake.io/api/public_api/v1/pages/[:page_id]/ice_breaker
Headers
Name | Type | Description |
---|---|---|
access-token* | String | Token of page(You can create it in Setting/ API) |
Get Main Menu
GET
https://botcake.io/api/public_api/v1/pages/[:page_id]/main_menu
Headers
Name | Type | Description |
---|---|---|
access-token* | String | Token of page(You can create it in Setting/ API) |
Get Tools
GET
https://botcake.io/api/public_api/v1/pages/[:page_id]/tools
Headers
Name | Type | Description |
---|---|---|
access-token* | String | Token of page(You can create it in Setting/ API) |
Create Keyword
POST
https://botcake.io/api/public_api/v1/pages/[:page_id]/keywords/create
Headers
Name | Type | Description |
---|---|---|
access-token* | String | Token of page(You can create it in Setting/ API) |
Update Keyword
POST
https://botcake.io/api/public_api/v1/pages/[:page_id]/keywords/update
Headers
Name | Type | Description |
---|---|---|
access-token* | String | Token of page(You can create it in Setting/ API) |
Request Body
Name | Type | Description |
---|---|---|
keyword_id* | Integer | The id of the keyword returned in the api get keywords |
update* | Object | The fields you want to update. Currently supported:
|
Send Flow For Customer
POST
https://botcake.io/api/public_api/v1/pages/[:page_id]/flows/send_flow
Headers
Name | Type | Description |
---|---|---|
access-token* | String | Token of page(You can create it in Setting/ API) |
Request Body
Name | Type | Description |
---|---|---|
psid* | String | The returned id string of the customer on the Facebook page |
flow_id* | Integer | The id of the flow you want to send to the client |
payload | Object | In the Dynamic Block request body, you can use the
|
Send Content For Customer
POST
https://botcake.io/api/public_api/v1/pages/[:page_id]/flows/send_content
Headers
Name | Type | Description |
---|---|---|
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) |
Request Body
Name | Type | Description |
---|---|---|
psid* | String | Chuỗi id của khách hàng trên page Facebook trả về |
data* | Object | |
message_tag | String | |
payload | Object | In the Dynamic Block request body, you can use the
|
Last updated