messenger

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.

api-key

Sua chave de API

xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

Gerar chave API

API do Usuário

API do usuário, criar, atualizar, listar...

API do Usuário : My Information

Minhas informações

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/user/myInfo
  1. apiToken
    Sua chave de API
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/user/myInfo?apiToken=API-KEY
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/user/myInfo' \ 
-d 'apiToken=API-KEY'
Exemplo de Resposta
{"status": "1", "message": { "user_id": 114, "user_type": "Member", "name": "Member", "email": "[email protected]", "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": "Wizebot" }] }}

API do Usuário : Usage Log

Registro de uso

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/user/usage/log
  1. apiToken
    Sua chave de API
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/user/usage/log?apiToken=API-KEY
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/user/usage/log' \ 
-d 'apiToken=API-KEY'
Exemplo de Resposta
{"status": "1", "message": { "modules": [ { "module_name": "End-user", "limit": 500, "used": 1 }, { "module_name": "Connect Account", "limit": 0, "used": 0 }, { "module_name": "Message Credit", "limit": 1458, "used": 0 }, { "module_name": "Subscribers", "limit": 0, "used": 0 }, { "module_name": "Bot Message Insight", "limit": 0, "used": 0 }, { "module_name": "Bot Conditional Reply", "limit": 0, "used": 0 }, { "module_name": "Bot AI Token", "limit": 0, "used": 0 }, { "module_name": "Input Flow Campaign", "limit": 0, "used": 0 }, { "module_name": "Live Chat", "limit": 0, "used": 0 }, { "module_name": "Live Chat - Advanced", "limit": 0, "used": 0 }, { "module_name": "Live Chat - Translator", "limit": 0, "used": 0 }, { "module_name": "Sequence Campaign", "limit": 0, "used": 0 }, { "module_name": "WhatsApp - Flows", "limit": 0, "used": 0 }, { "module_name": "WhatsApp - eCommerce Catalog", "limit": 0, "used": 0 }, { "module_name": "WhatsApp - Webhook Workflow", "limit": 0, "used": 0 }, { "module_name": "Webchat Bot", "limit": 0, "used": 0 }, { "module_name": "WhatsApp - WordPress/Shopify Integration", "limit": 0, "used": 0 }, { "module_name": "Team Member", "limit": 0, "used": 0 }, { "module_name": "API Developer", "limit": 0, "used": 0 }, { "module_name": "Live Chat Restriction", "limit": 0, "used": 0 } ], "package_name": "Premium1", "total_modules": 20 }}

API do Usuário : User List

Lista de Usuários

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/user/list
  1. apiToken
    Sua chave de API
    String|Required
  2. id
    Single User data can be fetched using both User ID or Email
    Integer|Optional
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/user/list?apiToken=API-KEY&id=USER-ID-OR-EMAIL
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/user/list' \ 
-d 'apiToken=API-KEY' \
-d 'id=USER-ID-OR-EMAIL'
Resposta de amostra (todas as listas)
{"status":"1","message":[{"user_id":114,"name":"Member","email":"[email protected]","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"}]}
Exemplo de Resposta (Usuário Único)
{"status": "1", "message": { "user_id": 114, "user_type": "Member", "name": "Member", "email": "[email protected]", "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": "Wizebot" }] }}

API do Usuário : User Create

Criar um novo usuário

Ponto de Extremidade da API : POST
https://app.wizebot.com.br/api/v1/user/create
  1. apiToken
    Sua chave de API
    String|Required
  2. name
    Nome do seu usuário
    String|Required
  3. email
    E-mail do seu usuário
    Email|Required
  4. mobile
    Número de telefone do usuário
    String|Optional
  5. password
    Senha do usuário
    String|Required
  6. package_id
    ID do pacote
    Integer|Required
  7. expired_date
    Pcakage Expired date like (2023-09-12)
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/user/create?apiToken=API-KEY&name=NAME&email=EMAIL&mobile=MOBILE&password=PASSWORD&package_id=NAME&expired_date=EXPIRED-DATE
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/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'
Exemplo de Resposta
{"status":"1","mesasge":"User Created Successfully.","id":192}

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}

API do Usuário : User Update

Atualizar um Usuário Existente

Ponto de Extremidade da API : POST
https://app.wizebot.com.br/api/v1/user/update
  1. apiToken
    Sua chave de API
    String|Required
  2. id
    O usuário pode ser atualizado usando tanto o ID do Usuário quanto o E-mail.
    Integer|Required
  3. name
    Nome do seu usuário
    String|Optional
  4. email
    E-mail do seu usuário
    Email|Optional
  5. mobile
    Número de telefone do usuário
    String|Optional
  6. password
    Senha do usuário
    String|Optional
  7. package_id
    ID do pacote
    Integer|Optional
  8. expired_date
    Data de expiração do pacote como (2023-09-12)
    String|Optional
  9. status
    Status do usuário ativo(1) inativo(0)
    String|Optional
  10. reset_monthly_usage
    Redefinir o registro de uso do mês atual do usuário reset(1) manter(0)
    String|Optional
Exemplo de Solicitação GET
https://app.wizebot.com.br/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-USAGE
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/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'
Exemplo de Resposta
{"status":"1","message":"User Updated Successfully."}

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}

API do Usuário : Package List

Lista de Pacotes

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/user/package/list
  1. apiToken
    Sua chave de API
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/user/package/list?apiToken=API-KEY
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/user/package/list' \ 
-d 'apiToken=API-KEY'
Resposta de amostra (todas as listas)
{"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\"}"}}

API do Usuário : Module List

Lista de Módulos

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/user/module/list
  1. apiToken
    Sua chave de API
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/user/module/list?apiToken=API-KEY
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/user/module/list' \ 
-d 'apiToken=API-KEY'
Resposta de amostra (todas as listas)
{"status":"1","message":{"id":1,"module_name":"Connect Account","extra_text":"","limit_enabled":"1","status":"1"}}

API do Usuário : Addon List

List of Addon

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/user/addon/list
  1. apiToken
    Sua chave de API
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/user/addon/list?apiToken=API-KEY
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/user/addon/list' \ 
-d 'apiToken=API-KEY'
Resposta de amostra (todas as listas)
{"status":"1","message":{"id":2,"addon_name":"Unlimited Team Member","addon_description":"Description of addon","addon_type":"recurring","access_type":"extend","price":25,"validity":30,"product_data":"{\"fastspring\":{\"product_id\":\"\",\"coupon\":\"\"},\"paypro\":{\"product_id\":\"101357\",\"coupon\":\"ADDONDEFAULT\"},\"paypal\":{\"plan_id\":\"\"},\"razorpay\":{\"plan_id\":\"\"}}","variation_data":null,"discount_data":"{\"percent\":\"\",\"terms\":\"\",\"start_date\":\"\",\"end_date\":\"2024-11-24 13:35:12\",\"timezone\":\"Asia\\/Dhaka\",\"status\":\"1\"}","visible":"1"}}

API do Usuário : Addon Create

Create Addon

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/user/addon/create
Available Modules
SLModule IDModule Name
11Connect Account
119Message Credit
240Bot Typing On Display
29Subscribers
210Bot Message Insight
211Bot Conditional Reply
218Bot AI Token
32Input Flow Campaign
344Incoming Message to Webhook URL
326Instagram Bot
430Livechat - Restriction
43Live Chat
420Live Chat - Advanced
424Live Chat - Translator
54Broadcast
87Sequence Campaign
943Social Posting
928Comment Automation
929WhatsApp Embedded Signup
1123WhatsApp - Flows
1121WhatsApp - Catalog
1147WhatsApp - Appointment System
1116WhatsApp - Webhook Workflow
1142WhatsApp - Click Ads
1137WhatsApp - Carousel Template
1227Whatsapp About Field Brand Name
1238Webchat Bot
1217WhatsApp - WordPress/Shopify Integration
1335Integration - HTTP API
1436Google - Google Sheet
1422Telegram - Group Manager
1445Google - Google Contacts
1446Google - Connect Account
1448Google - Google Calendar
1513Team Member
1515API Developer
3939Bot AI Agent
3949Bot AI Assistant
  1. apiToken
    Sua chave de API
    String|Required
  2. addon_name
    Name of your addon
    String|Required
  3. module_id
    Your Module ID
    Int|Required
  4. addon_description
    Description of your addon
    String|Required
  5. price
    Price of your addon
    Float|Required
  6. validity
    Validity of your addon
    Int|Required
  7. validity_type
    validity type can be day,week, month, year. For Day use `D`, For Week use `W`, For Month use `M`, For Year use `Y`
    String|Required
  8. addon_type
    Você pode usar dois tipos de complementos: Recorrente e Único. Para Recorrente, use `recurring` e para Único, use `one-time`.
    String|Required
  9. access_type
    Você pode usar dois tipos de acesso: estender e permitir. Para estender, use `extend` e para permitir, use `allow`.
    String|Required
  10. extend_value
    This is Module Limit
    Int|Required
  11. visible
    Addon visibility 1 for visible and 0 for hidden
    Int|Optional
  12. variation_name
    Variation name and value in json format.
    Json|Optional
  13. variation_validity
    Variation validity and value in json format.
    Json|Optional
  14. variation_validity_type
    validity type can be day,week, month, year. For Day use `D`, For Week use `W`, For Month use `M`, For Year use `Y`
    Json|Optional
  15. variation_extend_value
    This is Module Limit For Variation
    Json|Obrigatório
  16. variation_price
    Variation price and value in json format.
    Json|Obrigatório
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/user/addon/create' \ 
-d 'apiToken=API-KEY' \
-d 'addon_name=NAME' \
-d 'module_id=MODULE-ID' \
-d 'addon_description=DESCRIPTION' \
-d 'price=PRICE' \
-d 'validity=VALIDITY' \
-d 'validity_type=D' \
-d 'addon_type=one-time' \
-d 'access_type=allow' \
-d 'extend_value=extend_value' \
-d 'visible=1' \
-d 'variation_name=["variation_name1","variation_name2"]' \
-d 'variation_validity=["30","60"]' \
-d 'variation_validity_type=["D","M"]' \
-d 'variation_extend_value=["extend_value1","extend_value2"]' \
-d 'variation_price=["price1","price2"]'
Resposta de amostra (todas as listas)
{"status":"1","message":"Addon has been saved successfully.."}

API do Usuário : Addon Update

Update Addon

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/user/addon/update
  1. apiToken
    Sua chave de API
    String|Required
  2. id
    ID do complemento
    Integer|Required
  3. addon_name
    Name of your addon
    String|Required
  4. addon_description
    Description of your addon
    String|Optional
  5. price
    Price of your addon
    Float|Optional
  6. validity
    Validity of your addon
    Int|Optional
  7. validity_type
    validity type can be day,week, month, year. For Day use `D`, For Week use `W`, For Month use `M`, For Year use `Y`
    String|Optional
  8. addon_type
    Você pode usar dois tipos de complementos: Recorrente e Único. Para Recorrente, use `recurring` e para Único, use `one-time`.
    String|Optional
  9. access_type
    Você pode usar dois tipos de acesso: estender e permitir. Para estender, use `extend` e para permitir, use `allow`.
    String|Optional
  10. extend_value
    This is Module Limit
    Int|Optional
  11. visible
    Addon visibility 1 for visible and 0 for hidden
    Int|Optional
  12. variation_name
    Variation name and value in json format.
    Json|Optional
  13. variation_validity
    Variation validity and value in json format.
    Json|Optional
  14. variation_validity_type
    validity type can be day,week, month, year. For Day use `D`, For Week use `W`, For Month use `M`, For Year use `Y`
    Json|Optional
  15. variation_extend_value
    This is Module Limit For Variation
    Json|Obrigatório
  16. variation_price
    Variation price and value in json format.
    Json|Obrigatório
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/user/addon/update' \ 
-d 'apiToken=API-KEY' \
-d 'id=ADDON-ID' \
-d 'addon_name=NAME' \
-d 'addon_description=DESCRIPTION' \
-d 'price=PRICE' \
-d 'validity=VALIDITY' \
-d 'validity_type=D' \
-d 'addon_type=one-time' \
-d 'access_type=allow' \
-d 'extend_value=extend_value' \
-d 'visible=1' \
-d 'variation_name=["variation_name1","variation_name2"]' \
-d 'variation_validity=["30","60"]' \
-d 'variation_validity_type=["D","M"]' \
-d 'variation_extend_value=["extend_value1","extend_value2"]' \
-d 'variation_price=["price1","price2"]'
Resposta de amostra (todas as listas)
{"status":"1","message":"Addon has been saved successfully."}

API do Usuário : Assign Addon

Assign Addon

Ponto de Extremidade da API :POST
https://app.wizebot.com.br/api/v1/user/addon/assign
  1. apiToken
    Sua chave de API
    String|Required
  2. user_id
    User ID
    Integer|Required
  3. addon_id
    Addon ID. For the main addon, use only the Addon ID (e.g., 5). For variations, use the format AddonID-Variation ID (e.g., 5-1 ), where 5 is the Addon ID and 1 is the Variation ID.
    String|Required
  4. expired_date
    Data de expiração do complemento (12/09/2023)
    String|Required
  5. status
    Status of addon active(1) inactive(0)
    Boolean|Optional
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/user/addon/assign' \ 
-d 'apiToken=API-KEY' \
-d 'user_id=USER-ID' \
-d 'addon_id=ADDON-ID' \
-d 'expired_date=EXPIRED-DATE' \
-d 'status=STATUS'
Resposta de amostra (todas as listas)
{"status":"1","message":"Addon has been assign successfully."}

API do Usuário : Get Direct Login Url

Um URL de Login Único e Seguro de Uso Único

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/user/get/direct-login-url
  1. apiToken
    Sua chave de API
    String|Required
  2. email
    E-mail do seu usuário
    Email|Required
  3. name
    Nome do seu usuário
    String|Optional
  4. mobile
    Número de telefone do usuário
    String|Optional
  5. package_id
    ID do pacote
    Integer|Required for new user
  6. expired_date
    Data de expiração do pacote como (2023-09-12)
    String|Required for new user
  7. status
    Status do usuário ativo(1) inativo(0)
    String|Optional
  8. create_on_fail
    Set Value 1 for If user not found, create new user with this data or Set(0) it will return User not found error
    Boolean|Optional
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/user/get/direct-login-url?apiToken=API-KEY&email=EMAIL&name=NAME&mobile=MOBILE&package_id=NAME&expired_date=EXPIRED-DATE&status=STATUS&create_on_fail=1
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/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' \
-d 'create_on_fail=1'
Exemplo de Resposta
{"status":"1","message":{"email":"[email protected]","password":"xxxxxxxxxx","login_url":"https://app.wizebot.com.br/login","direct_login_url":"https://app.wizebot.com.br/direct-login/xxxxxxxxxx"}}

API do Usuário : Logout User

Sair do sistema

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/user/logout
  1. apiToken
    Sua chave de API
    String|Required
  2. user_id
    ID do usuário do proprietário da conta do WhatsApp
    Integer|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/user/logout?apiToken=API-KEY&user_id=USER-ID
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/user/logout' \ 
-d 'apiToken=API-KEY' \
-d 'user_id=USER-ID'
Resposta de amostra (todas as listas)
{"status":"1","message":"User logout from the system successfully."}

API do Usuário : Transaction List

Transaction list from the system

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/user/transaction/list
  1. apiToken
    Sua chave de API
    String|Required
  2. limit
    Fetch number of transactions.
    Integer|Optional
  3. offset
    Deslocamento de paginação.
    Integer|Optional
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/user/transaction/list?apiToken=API-KEY&limit=10&offset=0
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/user/transaction/list' \ 
-d 'apiToken=API-KEY' \
-d 'limit=10' \
-d 'offset=0'
Resposta de amostra (todas as listas)
{"status":"1","message":[{"id":1,"user_id":1,"buyer_user_id":249,"verify_status":"Processed","first_name":"john doe","last_name":"","buyer_email":"[email protected]","country":"","paid_currency":"USD","paid_at":"2025-10-13 09:20:53","payment_method":"Paypal","transaction_id":"AD1760347253249","paid_amount":0,"cycle_start_date":"2025-10-13","cycle_expired_date":null,"package_id":null,"addon_id":4,"variation_index":2,"variation_data_copy":"{\"name\":\"Webchat : unlimited website\/user\",\"validity\":\"30\",\"validity_type\":\"D\",\"extend_value\":\"0\",\"price\":\"149\",\"paypro_product_id\":\"103395\",\"fastspring_product_id\":\"\",\"paypal_plan_id\":\"\",\"razorpay_plan_id\":\"\",\"status\":\"1\"}","package_name":"Monthly Package","response_source":"","paypal_txn_type":"","invoice_url":null,"subscription_unique_id":null,"email":"[email protected]"}],"total_result":1}

WhatsApp API

API de envio do WhatsApp, adicionar contato...

WhatsApp API : Account Connect

Conectar conta do WhatsApp Business

Ponto de Extremidade da API : POST
https://app.wizebot.com.br/api/v1/whatsapp/account/connect
  1. apiToken
    Sua chave de API
    String|Required
  2. user_id
    ID do usuário do proprietário da conta do WhatsApp
    Integer|Required
  3. whatsapp_business_account_id
    ID da Conta do WhatsApp Business
    String|Required
  4. access_token
    Token de Acesso
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/whatsapp/account/connect?apiToken=API-KEY&user_id=USER-ID&whatsapp_business_account_id=WHATSAPP-BUSINESS-ACCOUNT-ID&access_token=ACCESS-TOKEN
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/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'
Exemplo de Resposta
{"status":"1","message":"Whatsapp account has been connect successfully."}

WhatsApp API : Send Message

Enviar mensagem do WhatsApp para qualquer número de celular

Ponto de Extremidade da API : Enviar mensagem (GET/POST)
https://app.wizebot.com.br/api/v1/whatsapp/send
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Número de telefone da conta do WhatsApp ID
    String|Required
  3. message
    Conteúdo da mensagem de texto (necessário valor codificado em URL para solicitação GET)
    String|Required
  4. phone_number
    Deve começar com o código do país e apenas caracteres numéricos são permitidos
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/whatsapp/send?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&message=TEXT-MESSAGE&phone_number=PHONE-NUMBER
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/send' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'message=TEXT-MESSAGE' \
-d 'phone_number=PHONE-NUMBER'
Exemplo de Resposta
{"status":"1", "wa_message_id":"wamid.HBgNODgwMTcyMzMwOTAwMxUCABEYEjlGQkY3MEFEMEVGODhCNDkxNQA=", "message":"Message sent successfully."}

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}
Gerar Ponto de Extremidade de API : Enviar Mensagem de Modelo (GET/POST)

Por favor, faça login para carregar todos os modelos

login
Exemplo de Resposta
{"status":"1","message":"Template message sent successfully."}

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}

WhatsApp API : Get Conversation

Obter conversa de assinante específico

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/whatsapp/get/conversation
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Seu número de telefone do WhatsApp
    String|Required
  3. phone_number
    Número de telefone do assinante
    String|Required
  4. limit
    Buscar número da mensagem da conversa.
    Number|Required
  5. offset
    Deslocamento de paginação.
    Number|Optional
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/whatsapp/get/conversation?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER&limit=10&offset=1
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/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'
Exemplo de Resposta
{"status":"1","message":[{"id":8XX3,"whatsapp_bot_subscriber_subscriber_id":"0123456789-23","whatsapp_bot_id":23,"sender":"bot","agent_name":null,"message_content":"{\"delay_in_reply\":0,\"messaging_product\":\"whatsapp\",\"recipient_type\":\"individual\",\"to\":\"0123456789\",\"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":""}]}

WhatsApp API : Get Delivery Message Status

Get message statuses from API

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/whatsapp/get/message-status
  1. apiToken
    Sua chave de API
    String|Required
  2. wa_message_id
    WhatsApp message ID to check status
    String|Required
  3. whatsapp_bot_id
    WhatsApp bot ID
    Number|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/whatsapp/get/message-status?apiToken=API-KEY&wa_message_id=WAMID.XXXXX&whatsapp_bot_id=123
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/get/message-status' \ 
-d 'apiToken=API-KEY' \
-d 'wa_message_id=WAMID.XXXXX' \
-d 'whatsapp_bot_id=123'
Exemplo de Resposta
{"status":"1","message":{"message_status":"delivered","delivery_status_updated_at":"2024-07-28 13:21:03","read_time":null,"failed_time":null,"failed_reason":""}}

WhatsApp API : Bot Template Get

Obter modelo de bot do Whatsapp

Ponto de Extremidade da API : Obter modelo (GET/POST)
https://app.wizebot.com.br/api/v1/whatsapp/template/list
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Número de telefone da conta do WhatsApp ID
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/whatsapp/template/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/template/list' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID'
Exemplo de Resposta
{"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"}}
Exemplo de Resposta
{"status":"1","message":"Template message sent successfully."}

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}

WhatsApp API : Send Broadcast Template

Obter modelo de transmissão do Whatsapp

Ponto de Extremidade da API : Enviar modelo de transmissão (GET/POST)
https://app.wizebot.com.br/api/v1/whatsapp/broadcast/template/send
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Número de telefone da conta do WhatsApp ID
    String|Required
  3. fluxo_de_dados
    Passar dados de fluxo como formato json
    Json|Obrigatório
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/whatsapp/broadcast/template/send?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/broadcast/template/send' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID'
Exemplo de Resposta
{"status":"1","visual_flow_campaign_id":1727,"message":"Data has been saved successfully.","redirect_on_success_url":""}
Exemplo de Resposta
{"status":"1","message":"Template message sent successfully."}

{"status":"0","message":"Subscriber limit has been exceeded. You cannot have more subscribers."}

WhatsApp API : Trigger Bot Flow

Acione seu bot para qualquer número de celular

Ponto de Extremidade da API : Fluxo do Bot de Acionamento (GET/POST)
https://app.wizebot.com.br/api/v1/whatsapp/trigger-bot
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Número de telefone da conta do WhatsApp ID
    String|Required
  3. bot_flow_unique_id
    ID exclusivo do fluxo do bot
    String|Required
  4. phone_number
    Deve começar com o código do país e apenas caracteres numéricos são permitidos
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/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
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/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'
Exemplo de Resposta
{"status":"1","message":"Bot has been trigger successfully."}

WhatsApp API : Subscriber Get

Obter Assinante Usando ID do Chat (Número de Telefone)

Ponto de Extremidade da API : POST
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/get
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Número de telefone da conta do WhatsApp ID
    String|Required
  3. phone_number
    Número de telefone do assinante
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/get?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/get' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER'
Exemplo de Resposta
{"status":"1","message":[{"subscriber_id":144,"chat_id":"0123456789","first_name":"john","last_name":"Doe","email":"[email protected]","gender":"Male","label_names":"Label1,Label2"}]}

WhatsApp API : Subscriber List

Lista de Assinantes

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/list
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Seu número de telefone do WhatsApp
    String|Required
  3. limit
    Obter número de assinantes.
    Number|Required
  4. offset
    Deslocamento de paginação.
    Number|Optional
  5. orderBy
    Set this to 1 to sort the subscriber list by their most recent message (latest first). Set to 0 to keep the default order.
    Number|Optional
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&limit=10&offset=1&orderBy=0
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/list' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'limit=10' \
-d 'offset=1' \
-d 'orderBy=0'
Exemplo de Resposta
{"status":"1","message":[{"subscriber_id":144,"chat_id":"0123456789","first_name":"John","last_name":"Doe","email":"[email protected]","gender":"male","label_names":"One ,two"},{"subscriber_id":157,"chat_id":"0123456789","first_name":"john","last_name":"Doe","email":"null","gender":"Male","label_names":"ChatTest,remove tag,One"}]}

WhatsApp API : Subscriber Create

Criar um Assinante/Contato

Ponto de Extremidade da API : POST
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/create
  1. apiToken
    Sua chave de API
    String|Required
  2. phoneNumberID
    Número de telefone da conta do WhatsApp ID
    String|Required
  3. name
    Nome do seu assinante
    String|Required
  4. phoneNumber
    Número de telefone do assinante com código do país (sem o sinal de +)
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/create?apiToken=API-KEY&phoneNumberID=PHONE-NUMBER-ID&name=NAME&phoneNumber=MOBILE
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/create' \ 
-d 'apiToken=API-KEY' \
-d 'phoneNumberID=PHONE-NUMBER-ID' \
-d 'name=NAME' \
-d 'phoneNumber=MOBILE'
Exemplo de Resposta
{"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."}

WhatsApp API : Subscriber Update

Atualizar um Assinante Existente

Ponto de Extremidade da API : POST
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/update
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Número de telefone da conta do WhatsApp ID
    String|Required
  3. phone_number
    Número de telefone do assinante
    String|Required
  4. first_name
    Primeiro nome do seu assinante
    String|Optional
  5. last_name
    Sobrenome do seu assinante
    String|Optional
  6. gender
    Gênero do seu assinante
    String|Optional
  7. label_ids
    Identificar IDs separados por vírgula, como (1,4,5).
    String|Optional
Exemplo de Solicitação GET
https://app.wizebot.com.br/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
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/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'
Exemplo de Resposta
{"status":"1","message":"Subscriber Updated Successfully."}

WhatsApp API : Delete Subscriber

Delete Whatsapp Subscriber

Ponto de Extremidade da API : Excluir assinante (GET/POST)
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/delete
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Número de telefone da conta do WhatsApp ID
    String|Required
  3. phone_number
    Deve começar com o código do país e apenas caracteres numéricos são permitidos
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/delete?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/delete' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER'
Exemplo de Resposta
{"status":"1","message":"Subscriber has been deleted successfully."}

WhatsApp API : Reset User Input Flow

Redefinir fluxo de entrada do usuário

Ponto de Extremidade da API : POST
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/reset/user-input-flow
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Número de telefone da conta do WhatsApp ID
    String|Required
  3. phone_number
    Número de telefone do assinante
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/reset/user-input-flow?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&phone_number=PHONE-NUMBER
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/reset/user-input-flow' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER'
Exemplo de Resposta
{"status":"1","message":"Reset User Input Flow successfully."}

WhatsApp API : Subscriber Assign Chat to Team

Atribuir o Chat de um Assinante a um Membro da Equipe

Ponto de Extremidade da API : POST
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/assign-to-team-member
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Seu número de telefone do WhatsApp
    String|Required
  3. phone_number
    Número de telefone do assinante
    String|Required
  4. team_member_id
    ID do Membro da Equipe
    Integer|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/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
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/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'
Exemplo de Resposta
{"status":"1","message":"Successfully Assign Agent to Conversation."}

WhatsApp API : Subscriber Assign Custom Fields

Atribuir Campo Personalizado ao Assinante

Ponto de Extremidade da API : POST
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/assign-custom-fields
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Seu número de telefone do WhatsApp
    String|Required
  3. phone_number
    Número de telefone do assinante
    String|Required
  4. custom_fields
    Nome e valor de campos personalizados no formato JSON.
    JSON|Required
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/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"}'
Exemplo de Resposta
{"status":"1","message":"Subscriber changes have been saved successfully."}

WhatsApp API : Custom Fields List

Get List of Custom Fields

Ponto de Extremidade da API : POST
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/custom-fields/list
  1. apiToken
    Sua chave de API
    String|Required
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/custom-fields/list' \ 
-d 'apiToken=API-KEY'
Exemplo de Resposta
{"status":"1","message":"Custom fields retrieved successfully","data":[{"id":1,"name":"customer_name","reply_type":"text"},{"id":2,"name":"customer_email","reply_type":"email"}]}

WhatsApp API : Subscriber Assign Labels

Atribuir rótulos ao assinante

Ponto de Extremidade da API : POST
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/assign-labels
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Seu número de telefone do WhatsApp
    String|Required
  3. phone_number
    Número de telefone do assinante
    String|Required
  4. label_ids
    Identificar IDs separados por vírgula, como (1,4,5).
    String|Required
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/assign-labels' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'label_ids=LABEL-IDS'
Exemplo de Resposta
{"status":"1","message":"Labels have been assigned successfully."}

WhatsApp API : Subscriber Remove Labels

Remover rótulos para assinante

Ponto de Extremidade da API : POST
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/remove-labels
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Seu número de telefone do WhatsApp
    String|Required
  3. phone_number
    Número de telefone do assinante
    String|Required
  4. label_ids
    Identificar IDs separados por vírgula, como (1,4,5).
    String|Required
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/remove-labels' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'label_ids=LABEL-IDS'
Exemplo de Resposta
{"status":"1","message":"Labels have been assigned successfully."}

WhatsApp API : Subscriber Assign Sequences

Assign Sequences To Subscriber

Ponto de Extremidade da API : POST
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/assign-sequence
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Seu número de telefone do WhatsApp
    String|Required
  3. phone_number
    Número de telefone do assinante
    String|Required
  4. sequence_ids
    Identificar IDs separados por vírgula, como (1,4,5).
    String|Required
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/assign-sequence' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'sequence_ids=SEQUENCE-IDS'
Exemplo de Resposta
{"status":"1","message":"Sequences have been assigned successfully."}

WhatsApp API : Subscriber Remove Sequences

Remove Sequence To Subscriber

Ponto de Extremidade da API : POST
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/remove-sequence
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Seu número de telefone do WhatsApp
    String|Required
  3. phone_number
    Número de telefone do assinante
    String|Required
  4. sequence_ids
    Sequence ids with comma separated like (1,4,5)
    String|Required
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/remove-sequence' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'sequence_ids=SEQUENCE-IDS'
Exemplo de Resposta
{"status":"1","message":"Sequences have been removed successfully."}

WhatsApp API : Add Notes To Subscriber

Add Notes To Subscriber

Ponto de Extremidade da API : POST
https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/add-notes
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Seu número de telefone do WhatsApp
    String|Required
  3. phone_number
    Número de telefone do assinante
    String|Required
  4. note_text
    Note text
    String|Required
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/subscriber/chat/add-notes' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'phone_number=PHONE-NUMBER' \
-d 'note_text=NOTE-TEXT'
Exemplo de Resposta
{"status":"1","message":"Notes have been added successfully."}

WhatsApp API : Label List

Lista de Etiquetas

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/whatsapp/label/list
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Seu número de telefone do WhatsApp
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/whatsapp/label/list?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/label/list' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID'
Exemplo de Resposta
{"status":"1","message":[{"id":1,"label_name":"Your label name","status":"1"}]}

WhatsApp API : Label Create

Criar uma Etiqueta

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/whatsapp/label/create
  1. apiToken
    Sua chave de API
    String|Required
  2. phone_number_id
    Seu número de telefone do WhatsApp
    String|Required
  3. label_name
    Nome da etiqueta
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/whatsapp/label/create?apiToken=API-KEY&phone_number_id=PHONE-NUMBER-ID&label_name=LABEL-NAME
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/label/create' \ 
-d 'apiToken=API-KEY' \
-d 'phone_number_id=PHONE-NUMBER-ID' \
-d 'label_name=LABEL-NAME'
Exemplo de Resposta
{"status":"1","message":"Label has been created successfully."}

WhatsApp API : Catalog List

Lista de catálogos

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/whatsapp/catalog/list
  1. apiToken
    Sua chave de API
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/whatsapp/catalog/list?apiToken=API-KEY
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/catalog/list' \ 
-d 'apiToken=API-KEY'
Exemplo de Resposta
{"status":true,"message":[{"catalog_id":"1429267xxxx5095","catalog_name":"The White","catalog_url":"https:xxxxx","checkout_settings":"{"tax_percentage":"5.5","shipping_charge":"20"}"}]}

WhatsApp Catalog : Sync

Catalog Sync

Ponto de Extremidade da API : POST
https://app.wizebot.com.br/api/v1/whatsapp/catalog/sync
  1. apiToken
    Sua chave de API
    String|Required
  2. whatsapp_catalog_id
    Seu ID de catálogo do WhatsApp
    String|Required
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/catalog/sync' \ 
-d 'apiToken=API-KEY' \
-d 'whatsapp_catalog_id=WHATSAPP-CATALOG-ID'
Exemplo de Resposta
{"status":"1","message":"Catalog products have been synced successfully."}

WhatsApp API : Catalog Order List

Lista de catálogos

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/whatsapp/catalog/order/list
  1. apiToken
    Sua chave de API
    String|Required
  2. whatsapp_catalog_id
    Seu ID de catálogo do WhatsApp
    String|Optional
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/whatsapp/catalog/order/list?apiToken=API-KEY&whatsapp_catalog_id=WHATSAPP-CATALOG-ID
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/catalog/order/list' \ 
-d 'apiToken=API-KEY' \
-d 'whatsapp_catalog_id=WHATSAPP-CATALOG-ID'
Exemplo de Resposta
{"status":"1","message":[{"order_unique_id":"172310467380123456789","catalog_id":"762561142206860","chat_id":"0123456789","catalog_name":"Catalog Name","first_name":"John","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\":\"John Doe\",\"phone_number\":\"0123456789\",\"email\":\"[email protected]\",\"address\":\"pti road\"}","checkout_account_email":null,"checkout_amount":"0","checkout_timestamp":null,"transaction_id":"PD1723104673012345678933FAD1","paid_at":"2024-08-08 08:30:40","status_changed_at":"2024-08-08 08:30:40"}]}

WhatsApp API : Catalog Order Status Change

Alterar status do pedido do catálogo

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/whatsapp/catalog/order/status-change
  1. apiToken
    Sua chave de API
    String|Required
  2. order_unique_id
    Seu ID de Pedido do Catálogo
    String|Required
  3. cart_status
    O valor do status deve ser Aprovado|Concluído|Enviado|Entregue|Reembolsado.
    String|Required
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/whatsapp/catalog/order/status-change?apiToken=API-KEY&order_unique_id=ORDER-UNIQUE-ID&cart_status=CART-STATUS
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/whatsapp/catalog/order/status-change' \ 
-d 'apiToken=API-KEY' \
-d 'order_unique_id=ORDER-UNIQUE-ID' \
-d 'cart_status=CART-STATUS'
Exemplo de Resposta
{"status":true,"message":"Cart status has been updated successfully"}

WizeBot AI : Get Response

Obter resposta

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/ai/get_response
  1. apiToken
    Sua chave de API
    String|Required
  2. param
    Seu prompt de dados
    Json|Obrigatório
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/ai/get_response?apiToken=API-KEY&param=PARAM
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/api/v1/ai/get_response' \ 
-d 'apiToken=API-KEY' \
-d 'param=PARAM'
Exemplo de Resposta
{"status":true,"message":"Cart status has been updated successfully"}

API do Usuário : Get Direct Login Url

Um URL de Login Único e Seguro de Uso Único

Ponto de Extremidade da API : GET/POST
https://app.wizebot.com.br/api/v1/user/get/direct-login-url
  1. apiToken
    Sua chave de API
    String|Required
  2. email
    E-mail do seu usuário
    Email|Required
  3. name
    Nome do seu usuário
    String|Optional
  4. mobile
    Número de telefone do usuário
    String|Optional
  5. package_id
    ID do pacote
    Integer|Required for new user
  6. expired_date
    Data de expiração do pacote como (2023-09-12)
    String|Required for new user
  7. status
    Status do usuário ativo(1) inativo(0)
    String|Optional
  8. create_on_fail
    Set Value 1 for If user not found, create new user with this data or Set(0) it will return User not found error
    Boolean|Optional
Exemplo de Solicitação GET
https://app.wizebot.com.br/api/v1/user/get/direct-login-url?apiToken=API-KEY&email=EMAIL&name=NAME&mobile=MOBILE&package_id=NAME&expired_date=EXPIRED-DATE&status=STATUS&create_on_fail=1
Exemplo de solicitação POST
curl -X POST \
'https://app.wizebot.com.br/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' \
-d 'create_on_fail=1'
Exemplo de Resposta
{"status":"1","message":{"email":"[email protected]","password":"xxxxxxxxxx","login_url":"https://app.wizebot.com.br/login","direct_login_url":"https://app.wizebot.com.br/direct-login/xxxxxxxxxx"}}