Intro
Welcome to Officely's API Documentation
Endpoint: https://api.officely.ai
Embark on a journey to transform your business's conversational capabilities with Officely's API. Our comprehensive guide provides detailed insights into integrating our API seamlessly with your CRM system. No coding skills? No problem! Officely's API is designed for ease of use, enabling you to create custom AI chat flows effortlessly.
Headers:
Authorization: Bearer [Your_API_Key]Content-Type: application/json
Start here to elevate your online presence with AI-driven interactions that are both efficient and engaging. Explore, learn, and innovate with Officely!
POST /sendMessage
ID | Required / Optional | Type | Description |
|---|---|---|---|
customer_phone | Required | string | Whatsapp Phone Number |
channel | Required | string | Choose your Channel provider: mayTapi or meta |
node_name | Required | string | Choose the API node from Officely chat builder - usually start with @api |
node_text | (Optional) | string | Add or Replace text to message flow |
data | (Optional) | object | Send variable to chatbot flow |
replace_text | (Optional) | bool | The default false (active only when “node_text” is not null) |
answers | (Optional) | array[string] | Replaces exists Predefined answers |
POST /humanState
ID | Required / Optional | Type | Description |
|---|---|---|---|
customer_phone | Required | string | Whatsapp Phone Number |
channel | Required | string | Choose your Channel provider: mayTapi or meta |
human_state | Required | bool | Choose the API node from Officely chat builder - usually start with @api |
message | (Optional) | string | Add message after Change mode Human/Chatbot |
POST /CreateUserCalls
ID | Required / Optional | Type | Description |
|---|---|---|---|
phone | Required | string | Whatsapp Phone Number |
time_zone | Required | string | For example : "israel" |
time | Required | string | YYYY-MM-DD HH:mm Format |
channel | Required | string | mayTapi, meta |
data | (Optional) | object | Send variables to chatbot flow |
node_text | (Optional) | string | Add or Replace text |
replace_text | (Optional) | bool | default false (active when “node_text” is not null) |
node_name | (Optional) | string | (api node) |
GET /getUserCalls
ID | Required / Optional | Type | Description |
|---|---|---|---|
phone | (Optional) | string | query string |
id | (Optional) | string | query string |
POST /deleteUserCalls
ID | Required / Optional | Type | Description |
|---|---|---|---|
phone | Required | string | Phone number for delete schedule |
id | Required | string | The ID from Get schedule |