Unifonic

https://docs.unifonic.com
Admin
Unifonic is an AI platform for streamlining conversations and engagement across communication...
Tokens:22,575
Snippets:59
Trust Score:9.5
Update:1 year ago
Show doc for...
Tokens:
Raw
### Unifonic Getting Started Guide

Source: https://docs.unifonic.com/articles/products-documentation/ecommerce-how-to

A guide to help new users get started with the Unifonic platform, covering initial setup and basic functionalities.

```APIDOC
Getting Started with Unifonic:

1. Sign Up:
   - Visit unifonic.com and create an account.

2. Obtain API Key:
   - Navigate to your account settings or dashboard to find your API key.

3. Explore Products:
   - Familiarize yourself with the available products like SMS Messaging, WhatsApp, etc.

4. Send Your First Message:
   - Use the API documentation to send a test SMS or WhatsApp message.
   - Refer to the 'SMS Messaging' or 'WhatsApp Messaging' sections in the API Reference.

5. Integrations:
   - Explore integration options with your existing systems.

Key Concepts:
  - Sender ID: The identifier displayed as the sender of your messages.
  - Callback URL: Used to receive real-time updates on message delivery status.
  - Use Cases: Discover how Unifonic can be applied to various business needs.
```

--------------------------------

### Unifonic Getting Started

Source: https://docs.unifonic.com/articles/api-documentation/overview

This guide provides an introduction to Unifonic and its services, helping new users get started with the platform. It likely covers account setup, basic concepts, and initial steps for using the APIs.

```APIDOC
Getting Started:
  - An introductory guide for new users of Unifonic.
  - Covers account creation, platform overview, and initial steps for API integration.
  - May include links to essential resources and tutorials.
```

--------------------------------

### Unifonic Getting Started Guide

Source: https://docs.unifonic.com/articles/products-documentation/government-use-cases

This guide provides an introduction to the Unifonic platform, covering initial setup, account configuration, and basic functionalities for new users.

```APIDOC
Getting Started with Unifonic:

1. Sign Up:
   - Visit unifonic.com and create an account.

2. Dashboard Overview:
   - Familiarize yourself with the main sections: Dashboard, Products, Use Cases, API Documentation, Settings.

3. API Key Generation:
   - Navigate to Settings > API Keys to generate or retrieve your API key.

4. Sending Your First SMS:
   - Use the 'Send SMS' API endpoint (POST /sms) with your API key and message details.
   - Example:
     curl -X POST https://api.unifonic.com/rest/sms \
     -H "Authorization: Key YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{"to": "+1234567890", "from": "Unifonic", "text": "Welcome to Unifonic!"}'

5. Explore Use Cases:
   - Browse the Use Cases Library for examples of how Unifonic can be applied to different industries (e.g., Ecommerce, Government, BFSI).
```

--------------------------------

### Agent Console Setup Guide

Source: https://docs.unifonic.com/smart/project-products-documentation/contact-center

This guide details the steps required to set up and configure the Unifonic Agent Console. It covers initial setup, user management, and integration with other Unifonic services.

```APIDOC
Agent Console Setup:

1. Initial Login:
   - Access the Agent Console URL provided by Unifonic.
   - Log in using your administrator credentials.

2. User Management:
   - Navigate to the 'Users' section.
   - Add new agents by providing their details (name, email, role).
   - Assign roles (e.g., Agent, Supervisor, Admin) to control access levels.

3. Channel Configuration:
   - Go to 'Settings' > 'Channels'.
   - Configure incoming and outgoing communication channels (e.g., SMS, WhatsApp, Voice).
   - Link channels to specific queues or routing rules.

4. Routing Rules:
   - Define rules for routing incoming interactions to agents or queues.
   - Configure based on channel, customer data, or time of day.

5. Integrations:
   - Set up integrations with external systems like CRMs or helpdesk software.
   - Follow specific integration guides for each third-party service.
```

--------------------------------

### Unifonic Products Documentation

Source: https://docs.unifonic.com/smart/project-products-documentation/flow-studio-overview

General documentation for Unifonic's products, including getting started guides and platform overviews.

```APIDOC
Products Documentation:
  - Getting Started: Initial steps for using Unifonic products.
  - Platform: Overview of the Unifonic platform.
  - Channels: Information on available communication channels.
  - Multichannel Campaigns: Creating and managing multichannel campaigns.
  - Integrations: Information on integrating with other services.
  - Audience: Managing customer audience data.
  - Agent Console: Using the agent console interface.
  - Chatbot Builder: Building and deploying chatbots.
  - Authenticate: Authentication methods for Unifonic services.
  - Compliance: Information on compliance standards.
  - Mobile SDKs: Using Unifonic's SDKs for mobile applications.
  - Use Cases Library: Examples and use cases for Unifonic products.
```

--------------------------------

### Unifonic Flow Studio Documentation

Source: https://docs.unifonic.com/smart/project-products-documentation/flow-studio-overview

Details on using the Flow Studio, a visual tool for building conversational flows. Covers overview, usage, glossary, getting started, access, dashboard, managing flows, widget library, variables, and execution logs.

```APIDOC
Flow Studio Documentation:
  - Overview: Introduction to the Flow Studio.
  - Usage Guide: How to use the Flow Studio effectively.
  - Glossary Flow Studio: Definitions of terms used in Flow Studio.
  - Getting Started with Flow Studio: Initial steps to begin using Flow Studio.
  - Accessing Flow Studio: How to access the Flow Studio interface.
  - Dashboard: Overview of the Flow Studio dashboard.
  - My Flows: Managing your created flows.
  - Widget Library: Available widgets for building flows.
  - Variables Management: Managing variables within flows.
  - Execution Logs (Reports): Viewing and analyzing flow execution.
```

--------------------------------

### Chatbot Builder - User Guide

Source: https://docs.unifonic.com/smart/project-products-documentation/chatbot-builder

A comprehensive guide for users on how to utilize the Chatbot Builder, including creating, managing, and deploying chatbots.

```APIDOC
Chatbot User Guide:
  - Step-by-step instructions for using the Chatbot Builder.
  - Covers creating new chatbots, managing subflows, and utilizing the widget library.
  - Includes information on testing, deployment, and analytics.
```

--------------------------------

### Unifonic Platform & Applications Overview

Source: https://docs.unifonic.com/home/en-us

Guides on setting up accounts, communication channels, access control, and real-time reporting within the Unifonic Platform.

```APIDOC
Unifonic Platform:
  Setup accounts, communication channels, and access control as well as real time reporting.
  Related: Authenticate and Verify, Chatbot Builder, Flow Studio, Multichannel Campaigns, Agent Console
```

```APIDOC
Authenticate and Verify:
  Prevent fraud with Authenticate and Verify applications featuring 2FA and OTP.
  Related: Unifonic Platform, Chatbot Builder, Flow Studio, Multichannel Campaigns, Agent Console
```

```APIDOC
Chatbot Builder:
  Build a chatbot to simplify business workstreams and automate customer support in seconds.
  Related: Unifonic Platform, Authenticate and Verify, Flow Studio, Multichannel Campaigns, Agent Console
```

```APIDOC
Flow Studio:
  Design and deploy omnichannel communication workflows without a single line of code.
  Related: Unifonic Platform, Authenticate and Verify, Chatbot Builder, Multichannel Campaigns, Agent Console
```

```APIDOC
Multichannel Campaigns:
  Reach your entire customer or prospect base in just a few clicks on many channels.
  Related: Unifonic Platform, Authenticate and Verify, Chatbot Builder, Flow Studio, Agent Console
```

```APIDOC
Agent Console:
  Scale customer communications across multiple channels, routes, agents, workflows, and more.
  Related: Unifonic Platform, Authenticate and Verify, Chatbot Builder, Flow Studio, Multichannel Campaigns
```

--------------------------------

### Unifonic Use Case Library

Source: https://docs.unifonic.com/index

Examples of how to use Unifonic's solutions for various industries.

```APIDOC
E-commerce Use Cases:
  Enhance customer experience, boost efficiency, and drive sales through practical use cases across the entire order lifecycle.
  Examples: Order confirmations, shipping notifications, customer support.
  Channels: SMS, WhatsApp, Email.
```

```APIDOC
Government Use Cases:
  Improve citizen engagement, optimize operational processes, and facilitate better outcomes through real-world examples spanning various stages of government operations.
  Examples: Public service announcements, appointment reminders, emergency alerts.
  Channels: SMS, Voice, Email.
```

```APIDOC
Banking & Finance Use Cases:
  Boost customer engagement, streamline processes, and drive better outcomes through real-world examples across various facets of financial operations.
  Examples: Transaction alerts, OTP verification, loan application updates.
  Channels: SMS, WhatsApp, Voice.
```

--------------------------------

### Agent Console Agents Guide

Source: https://docs.unifonic.com/smart/project-products-documentation/contact-center

This guide is for agents using the Unifonic Agent Console, detailing how to manage interactions, use features, and understand performance metrics.

```APIDOC
Agent Console Agents Guide:

Handling Interactions:
- Accept or reject incoming interactions from the dashboard.
- Use pre-defined responses or templates for common queries.
- Transfer interactions to other agents or departments.
- Access customer history and context during an interaction.

Agent Features:
- Status Management: Set your availability status (Online, Away, Offline).
- Wrap-up Time: Log notes and categorize interactions after completion.
- Knowledge Base: Access internal documentation and FAQs to assist customers.

Performance Metrics:
- View your personal performance metrics, such as average handling time, first contact resolution rate, and customer satisfaction scores.
```

--------------------------------

### Unifonic API Documentation Overview

Source: https://docs.unifonic.com/articles/api-documentation

This section provides an overview of the Unifonic API documentation, linking to various key areas such as Getting Started, SMS API, HTTP Status Codes, Voice, Unifonic Authenticate, Unifonic Push, Ulink, and Conversation.

```APIDOC
API Documentation:
  - Getting Started: https://docs.unifonic.com/articles/#!api-documentation/getting-started
  - SMS API: https://docs.unifonic.com/articles/#!api-documentation/sms-api
  - HTTP Status Codes: https://docs.unifonic.com/articles/#!api-documentation/http-status-codes
  - Voice: https://docs.unifonic.com/articles/#!api-documentation/voice
  - Unifonic Authenticate: https://docs.unifonic.com/articles/#!api-documentation/unifonic-authenticate-1
  - Unifonic Push: https://docs.unifonic.com/articles/#!api-documentation/unifonic-push-2
  - Ulink: https://docs.unifonic.com/articles/#!api-documentation/ulink-2
  - Conversation: https://docs.unifonic.com/articles/#!api-documentation/conversation
```

--------------------------------

### Unifonic Use Cases

Source: https://docs.unifonic.com/articles/products-documentation/ecommerce-how-to

Examples of how Unifonic can be utilized across different industries, including E-commerce, Government, and BFSI.

```APIDOC
Unifonic Use Cases Library:

E-commerce:
  - Order notifications (shipping, delivery).
  - Promotional campaigns and offers.
  - Customer support and feedback.
  - OTP verification for login and transactions.

Government:
  - Public service announcements.
  - Citizen alerts and emergency notifications.
  - Information dissemination.
  - Feedback collection.

BFSI (Banking, Financial Services, and Insurance):
  - Transaction alerts (debit, credit).
  - OTP for secure logins and payments.
  - Account balance notifications.
  - Marketing and promotional messages.
  - Customer service inquiries.
```

--------------------------------

### Unifonic Use Case Library

Source: https://docs.unifonic.com/home/en-us

Examples of how to use Unifonic's omnichannel communication solutions for different industries.

```APIDOC
E-commerce Use Cases:
  Learn how to enhance customer experience, boost efficiency, and drive sales through practical use cases across the entire order lifecycle.
  Related: Government Use Cases, Banking & Finance Use Cases
```

```APIDOC
Government Use Cases:
  Explore methods to improve citizen engagement, optimize operational processes, and facilitate better outcomes through real-world examples spanning various stages of government operations.
  Related: E-commerce Use Cases, Banking & Finance Use Cases
```

```APIDOC
Banking & Finance Use Cases:
  Discover strategies to boost customer engagement, streamline processes, and drive better outcomes through real-world examples across various facets of financial operations.
  Related: E-commerce Use Cases, Government Use Cases
```

--------------------------------

### Unifonic API Documentation Overview

Source: https://docs.unifonic.com/articles/api-documentation/sms-api

This section provides an overview of the Unifonic API documentation, including links to various sections such as Getting Started, SMS API, HTTP Status Codes, Voice, Unifonic Authenticate, Unifonic Push, Ulink, and Conversation.

```APIDOC
Getting Started: https://docs.unifonic.com/articles/#!api-documentation/getting-started
SMS API: https://docs.unifonic.com/articles/#!api-documentation/sms-api
HTTP Status Codes: https://docs.unifonic.com/articles/#!api-documentation/http-status-codes
Voice: https://docs.unifonic.com/articles/#!api-documentation/voice
Unifonic Authenticate: https://docs.unifonic.com/articles/#!api-documentation/unifonic-authenticate-1
Unifonic Push: https://docs.unifonic.com/articles/#!api-documentation/unifonic-push-2
Ulink: https://docs.unifonic.com/articles/#!api-documentation/ulink-2
Conversation: https://docs.unifonic.com/articles/#!api-documentation/conversation
```

--------------------------------

### Unifonic Documentation Navigation

Source: https://docs.unifonic.com/articles/products-documentation/channels-whatsapp

Provides an overview of the documentation structure, including sections for Getting Started, Platform features, Channels (SMS, Voice, WhatsApp, etc.), Multichannel Campaigns, Flow Studio, Integrations, and more.

```APIDOC
Documentation Structure:

- Getting Started: Initial setup and basic usage.
- Platform:
  - Overview: General platform features.
  - Channels:
    - Instagram Onboarding
    - SMS
    - Voice
    - WhatsApp
    - Facebook Messenger
    - Mobile Push Notifications
    - Email
    - Web Widget
- Multichannel Campaigns
- Flow Studio
- Integrations
- Audience
- Agent Console
- Chatbot Builder
- Authenticate
- Compliance
- Mobile SDKs
- Use Cases Library

Related Topics:
- Overview
- Instagram Onboarding
- SMS
- Voice
- Facebook Messenger
- Mobile Push Notifications
- Email
- Web Widget
```

--------------------------------

### Chatbot Builder - Sample Code

Source: https://docs.unifonic.com/smart/project-products-documentation/chatbot-builder

Sample code snippets and examples for building and integrating chatbots with Unifonic's platform.

```APIDOC
Chatbot Builder Sample Code:
  - Provides examples for chatbot development.
  - Covers integration with campaigns and customer satisfaction surveys.
  - Includes guidance on testing and deploying bots.
```

--------------------------------

### Multichannel Campaigns Overview

Source: https://docs.unifonic.com/smart/project-products-documentation/multichannel-campaigns

Guides users on streamlining campaigns across multiple communication channels through a single, intuitive interface.

```Markdown
## Multichannel Campaigns

Streamline Campaigns on Multiple Communication Channels Managed from a Single and Intuitive User Interface.

**Related topics:**
* Validations and Checks you Should Know
* SMS Campaigns (User guide)
* SMS Campaigns (User Guide)
* WhatsApp Campaigns (User Guide)
* Voice Campaigns (User Guide)
* Retargeting a Campaign
```

--------------------------------

### Agent Console Admin Guide

Source: https://docs.unifonic.com/smart/project-products-documentation/contact-center

This documentation provides an administrative overview of the Unifonic Agent Console, covering system settings, user roles, and operational management.

```APIDOC
Agent Console Admin Guide:

Roles and Permissions:
- Admin: Full access to all settings, user management, and reporting.
- Supervisor: Can monitor agent performance, manage queues, and access reports.
- Agent: Can handle customer interactions and view their own performance metrics.

System Settings:
- General Settings: Configure company name, timezone, and branding.
- Notification Settings: Set up email or in-app notifications for events like new messages or escalations.
- Security Settings: Manage password policies and two-factor authentication.

Reporting and Analytics:
- Access pre-built reports on agent performance, queue statistics, and customer interactions.
- Customize reports by selecting metrics, date ranges, and filters.
- Export reports in various formats (CSV, PDF).
```

--------------------------------

### External Bot Integration Guide

Source: https://docs.unifonic.com/smart/project-products-documentation/contact-center

This documentation outlines the process for integrating external bots with the Unifonic platform, enabling automated responses and enhanced customer service workflows.

```APIDOC
External Bot Integration:

Overview:
Integrate your custom or third-party bots to automate conversations and provide instant support.

Integration Steps:
1. Bot Configuration:
   - Ensure your bot supports a webhook or API interface for receiving and sending messages.
   - Configure your bot to communicate using the Unifonic message format.

2. Unifonic Setup:
   - In the Unifonic platform, navigate to 'Integrations' or 'Bots'.
   - Create a new bot integration.
   - Provide the webhook URL or API endpoint for your bot.
   - Configure authentication details if required by your bot.

3. Routing:
   - Set up routing rules to direct specific incoming messages or channels to your integrated bot.
   - Define fallback mechanisms to transfer conversations to human agents if the bot cannot handle a request.

4. Testing:
   - Thoroughly test the integration by sending various messages to your bot.
   - Monitor bot responses and Unifonic logs for any errors or unexpected behavior.
```

--------------------------------

### Unifonic API Documentation

Source: https://docs.unifonic.com/smart/project-products-documentation/contact-center

This section provides comprehensive API documentation for Unifonic services. It includes details on authentication, endpoints, request/response formats, and usage examples for integrating Unifonic's capabilities into your applications.

```APIDOC
Unifonic API Reference:

Base URL: https://api.unifonic.com/rest

Authentication:
API Key authentication is required. Include your API key in the 'Authorization' header as 'Key YOUR_API_KEY'.

Endpoints:

1. Send SMS:
   - Method: POST
   - Path: /sms
   - Description: Sends an SMS message to a specified recipient.
   - Request Body:
     {
       "to": "+1234567890",
       "from": "Unifonic",
       "text": "Hello from Unifonic!"
     }
   - Response:
     {
       "messageId": "msg_abc123",
       "status": "sent"
     }

2. Get SMS Status:
   - Method: GET
   - Path: /sms/{messageId}
   - Description: Retrieves the delivery status of a specific SMS message.
   - Parameters:
     - messageId (path): The ID of the message to query.
   - Response:
     {
       "messageId": "msg_abc123",
       "status": "delivered"
     }

3. List Messages:
   - Method: GET
   - Path: /sms
   - Description: Retrieves a list of sent SMS messages, with optional filtering.
   - Query Parameters:
     - to (optional): Filter by recipient number.
     - from (optional): Filter by sender ID.
     - status (optional): Filter by message status (e.g., 'sent', 'delivered', 'failed').
     - limit (optional): Number of results to return.
     - offset (optional): Number of results to skip.
   - Response:
     [
       {
         "messageId": "msg_abc123",
         "to": "+1234567890",
         "from": "Unifonic",
         "text": "Hello from Unifonic!",
         "status": "sent",
         "createdAt": "2023-10-27T10:00:00Z"
       }
     ]

Error Handling:
- 400 Bad Request: Invalid input parameters.
- 401 Unauthorized: Invalid API key.
- 404 Not Found: Resource not found.
- 500 Internal Server Error: Server-side error.
```

--------------------------------

### Unifonic Platform & Applications Overview

Source: https://docs.unifonic.com/index

Details on setting up accounts, communication channels, access control, and real-time reporting within the Unifonic Platform.

```APIDOC
Unifonic Platform:
  Setup accounts, communication channels, and access control as well as real time reporting.
  Dependencies: None
  Inputs: None
  Outputs: Configured Unifonic account with channels and access control.
  Limitations: None specified.
```

```APIDOC
Authenticate and Verify:
  Prevent fraud with Authenticate and Verify applications featuring 2FA and OTP.
  Dependencies: None
  Inputs: User details for verification.
  Outputs: Verified user status.
  Limitations: None specified.
```

```APIDOC
Chatbot Builder:
  Build a chatbot to simplify business workstreams and automate customer support in seconds.
  Dependencies: None
  Inputs: Chatbot logic and conversation flows.
  Outputs: Functional chatbot.
  Limitations: None specified.
```

```APIDOC
Flow Studio:
  Design and deploy omnichannel communication workflows without a single line of code.
  Dependencies: None
  Inputs: Workflow design elements.
  Outputs: Deployed communication workflows.
  Limitations: None specified.
```

```APIDOC
Multichannel Campaigns:
  Reach your entire customer or prospect base in just a few clicks on many channels.
  Dependencies: None
  Inputs: Campaign content and target audience.
  Outputs: Sent campaigns across multiple channels.
  Limitations: None specified.
```

```APIDOC
Agent Console:
  Scale customer communications across multiple channels, routes, agents, workflows, and more.
  Dependencies: None
  Inputs: Customer communication data.
  Outputs: Managed customer interactions.
  Limitations: None specified.
```

--------------------------------

### Unifonic API Documentation - Authentication

Source: https://docs.unifonic.com/smart/project-products-documentation/authenticate-overview

Provides details on Unifonic's authentication APIs, including how to set up authentication apps, obtain authentication tokens, and application IDs. This section covers the core aspects of securing access to Unifonic services.

```APIDOC
Authenticate APIs:
  - Overview: Provides a general understanding of the authentication process.
  - How to Setup Authentication App: Step-by-step guide to setting up an authentication application.
  - Getting Authentication Token and Apps IDs: Instructions on how to retrieve necessary credentials for API access.

Example Usage:
  // Pseudocode for obtaining a token
  POST /auth/token
  Body: {
    "appId": "YOUR_APP_ID",
    "appSecret": "YOUR_APP_SECRET"
  }
  Response: {
    "token": "YOUR_AUTH_TOKEN",
    "expiresIn": 3600
  }
```

--------------------------------

### API Documentation Navigation

Source: https://docs.unifonic.com/articles

Provides links to Unifonic's API Documentation, Products Beats, and Products Documentation sections.

```APIDOC
API Documentation: https://docs.unifonic.com/articles/api-documentation
Products Beats: https://docs.unifonic.com/articles/products-beats
Products Documentation: https://docs.unifonic.com/articles/products-documentation
```

--------------------------------

### Unifonic API Documentation

Source: https://docs.unifonic.com/smart/project-products-documentation/getting-started-with-unifonic

This section provides API documentation for Unifonic's services. It includes details on authentication, endpoints, request parameters, and response formats for various communication and platform management functionalities.

```APIDOC
API Documentation:
  - Base URL: https://api.unifonic.com/rest

  Authentication:
    - API Key: Provided by Unifonic upon account creation.
    - Header: Authorization: Bearer YOUR_API_KEY

  Endpoints:
    - SMS Messaging:
      - Send SMS:
        - Method: POST
        - Path: /sms
        - Parameters:
          - to: (string, required) Recipient's phone number.
          - body: (string, required) Message content.
          - senderid: (string, optional) Sender ID.
          - callbackurl: (string, optional) URL for delivery reports.
        - Example:
          POST /sms
          Authorization: Bearer YOUR_API_KEY
          Content-Type: application/json
          {
            "to": "+1234567890",
            "body": "Hello from Unifonic!"
          }
        - Response:
          {
            "messageid": "msg_12345",
            "status": "queued"
          }
      - Get SMS Status:
        - Method: GET
        - Path: /sms/{messageid}
        - Parameters:
          - messageid: (string, required) The ID of the message.
        - Response:
          {
            "messageid": "msg_12345",
            "status": "delivered"
          }

    - WhatsApp Messaging:
      - Send WhatsApp Message:
        - Method: POST
        - Path: /whatsapp/messages
        - Parameters:
          - to: (string, required) Recipient's WhatsApp number.
          - from: (string, required) Unifonic WhatsApp number.
          - message_type: (string, required) Type of message (e.g., 'text', 'template').
          - text: (object, required if message_type is 'text')
            - body: (string, required) Message content.
          - template: (object, required if message_type is 'template')
            - name: (string, required) Template name.
            - language: (object, required)
              - code: (string, required) Language code (e.g., 'en').
            - components: (array, required) Template components.
        - Example:
          POST /whatsapp/messages
          Authorization: Bearer YOUR_API_KEY
          Content-Type: application/json
          {
            "to": "+1234567890",
            "from": "whatsapp:+14155238886",
            "message_type": "text",
            "text": {
              "body": "Hello from Unifonic WhatsApp!"
            }
          }
        - Response:
          {
            "messageid": "wa_msg_67890",
            "status": "sent"
          }

  Error Handling:
    - Common error codes include 400 (Bad Request), 401 (Unauthorized), 404 (Not Found), 500 (Internal Server Error).
    - Error responses typically include an error code and a descriptive message.
```

--------------------------------

### Unifonic API Documentation

Source: https://docs.unifonic.com/articles/products-beats

Provides access to Unifonic's Application Programming Interfaces for integrating messaging and communication services. This section details endpoints, request/response formats, authentication, and usage examples.

```APIDOC
API Documentation:
  - Base URL: https://api.unifonic.com/rest
  - Authentication: API Key (provided by Unifonic)
  - Endpoints:
    - SMS Messaging:
      - Send SMS:
        - Method: POST
        - Path: /sms
        - Parameters:
          - "to": (string, required) Recipient's phone number.
          - "from": (string, required) Sender ID or shortcode.
          - "body": (string, required) The message content.
          - "sender_id": (string, optional) Alternative sender ID.
          - "callback_url": (string, optional) URL for delivery status notifications.
        - Example:
          POST /sms
          {
            "to": "+1234567890",
            "from": "MySenderID",
            "body": "Hello from Unifonic!"
          }
      - Get SMS Status:
        - Method: GET
        - Path: /sms/{messageId}
        - Parameters:
          - messageId: (string, required) The ID of the message to check.
        - Returns: Status of the message (e.g., 'sent', 'delivered', 'failed').
    - Voice Calls:
      - Make Call:
        - Method: POST
        - Path: /calls
        - Parameters:
          - "to": (string, required) Recipient's phone number.
          - "from": (string, required) Caller ID.
          - "url": (string, required) URL to fetch TwiML instructions.
        - Example:
          POST /calls
          {
            "to": "+1234567890",
            "from": "MyCallerID",
            "url": "http://example.com/twiml"
          }
    - Other Services:
      - WhatsApp Messaging
      - Email Services
      - Authentication Endpoints
  - Error Handling:
    - Standard HTTP status codes (4xx for client errors, 5xx for server errors).
    - Error responses include a JSON body with an error code and message.
```

--------------------------------

### Chatbot Builder - How to Create a Chatbot

Source: https://docs.unifonic.com/smart/project-products-documentation/chatbot-builder

Detailed instructions on the process of creating a chatbot using Unifonic's Chatbot Builder.

```APIDOC
How to Create a Chatbot:
  - A guide on the chatbot creation process.
  - Covers defining intents, building conversation flows, and configuring responses.
  - Includes best practices for chatbot design.
```

--------------------------------

### Chatbot Builder - Test and Deploy Bot

Source: https://docs.unifonic.com/smart/project-products-documentation/chatbot-builder

Instructions for testing and deploying chatbots created with Unifonic's Chatbot Builder.

```APIDOC
Test and Deploy Bot:
  - Steps for thoroughly testing chatbot functionality.
  - Guidance on deploying chatbots to various channels.
  - Covers pre-launch checks and deployment strategies.
```

--------------------------------

### Unifonic Ulink

Source: https://docs.unifonic.com/articles/api-documentation/overview

This documentation pertains to Unifonic Ulink, which could be a service for creating and managing links, possibly for tracking or directing users. It might include details on link generation, customization, and analytics.

```APIDOC
Ulink:
  - Documentation for the Ulink service.
  - Likely covers creating, managing, and tracking custom links.
  - May include features for analytics, deep linking, or campaign management.
```

--------------------------------

### Unifonic API Documentation

Source: https://docs.unifonic.com/smart/project-products-documentation/multichannel-campaigns

Provides access to Unifonic's API for programmatic interaction with their services. This includes endpoints for managing campaigns, users, and other platform features.

```APIDOC
API Documentation:
  - Access to Unifonic's API for managing communication campaigns and platform features.
  - Endpoints for SMS, WhatsApp, and Voice campaigns.
  - Authentication methods and user management.
  - Related topics include Products Documentation and Products Beats.
```

--------------------------------

### Unifonic Integrations

Source: https://docs.unifonic.com/smart/project-products-documentation/chatbot-builder

Information on integrating Unifonic services with other platforms and applications.

```APIDOC
Integrations:
  - Details on connecting Unifonic with third-party services.
  - Covers API integrations, SDKs, and pre-built connectors.
  - Facilitates seamless workflows.
```

--------------------------------

### Unifonic API Documentation

Source: https://docs.unifonic.com/articles/api-documentation/unifonic-push-1

Provides comprehensive details on Unifonic's API, including endpoints, methods, parameters, and response formats. This documentation is essential for integrating Unifonic services into applications.

```APIDOC
Unifonic API Documentation:

This section details the Unifonic API for programmatic access to its services.

Key Features:
- SMS Messaging API
- Voice API
- Contact Management
- Reporting and Analytics

Authentication:
API requests must be authenticated using an API key.

Example Request:
```
POST /restapi/v1/Accounts/{AccountSid}/Messages.json
Host: api.unifonic.com
Content-Type: application/x-www-form-urlencoded

To=+1234567890&From=+1098765432&Body=Hello+from+Unifonic
```

Endpoints:
- /restapi/v1/Accounts/{AccountSid}/Messages.json: For sending SMS messages.
- /restapi/v1/Accounts/{AccountSid}/Calls.json: For initiating voice calls.

Schemas:
- Message: Represents an SMS message with properties like To, From, Body, Status, etc.
- Call: Represents a voice call with properties like To, From, Status, etc.

Error Handling:
API responses include status codes and error messages to help diagnose issues.

Related Documentation:
- Products Documentation: For details on Unifonic's product offerings.
- Products Beats: For information on specific product features or updates.
```

--------------------------------

### Unifonic Authentication

Source: https://docs.unifonic.com/articles/api-documentation/overview

This documentation explains how to authenticate with Unifonic services. It likely covers API key management, authentication tokens, and security best practices for accessing Unifonic APIs.

```APIDOC
Unifonic Authenticate:
  - Details the authentication mechanisms for Unifonic APIs.
  - Covers obtaining and using API keys or tokens for secure access.
  - May include information on different authentication flows or methods.
```

--------------------------------

### Unifonic API Documentation

Source: https://docs.unifonic.com/articles/products-documentation/channels-whatsapp

Provides comprehensive API references for Unifonic services. This section details available endpoints, methods, parameters, and response structures for integrating Unifonic's communication capabilities into applications.

```APIDOC
Unifonic API Reference:

Base URL: https://api.unifonic.com/rest

Authentication:
API Key: Provided by Unifonic, passed in the 'Authorization' header as 'Key YOUR_API_KEY'.

Endpoints:

1. SMS Messaging:
   - Send SMS:
     Method: POST
     Path: /sms
     Parameters:
       - to: (string, required) Recipient's phone number in international format (e.g., +1234567890).
       - message: (string, required) The message content.
       - senderid: (string, optional) Sender ID (alphanumeric or numeric).
       - callbackurl: (string, optional) URL to receive delivery reports.
     Response:
       - status: (string) 'queued', 'sent', 'failed', etc.
       - messageid: (string) Unique ID for the message.
       - cost: (number) Cost of the message.
     Example:
       POST /sms
       Authorization: Key YOUR_API_KEY
       Content-Type: application/json
       {
         "to": "+1234567890",
         "message": "Hello from Unifonic!"
       }

   - Get Delivery Status:
     Method: GET
     Path: /sms/{messageid}
     Parameters:
       - messageid: (string, required) The ID of the message to check.
     Response:
       - status: (string) Delivery status.

2. WhatsApp Messaging:
   - Send WhatsApp Message:
     Method: POST
     Path: /whatsapp/messages
     Parameters:
       - to: (string, required) Recipient's WhatsApp number (e.g., 1234567890@c.us).
       - message: (string, required) The message content.
       - from_phone: (string, required) Your Unifonic WhatsApp number.
       - type: (string, required) 'text', 'image', 'document', 'audio', 'video', 'sticker', 'location', 'contacts', 'ptt'.
       - media_url: (string, optional) URL for media messages.
     Response:
       - status: (string) 'queued', 'sent', 'failed'.
       - messageid: (string) Unique ID for the message.

3. Voice Calls:
   - Make Voice Call:
     Method: POST
     Path: /voice/calls
     Parameters:
       - to: (string, required) Recipient's phone number.
       - from_number: (string, required) Your Unifonic voice number.
       - audio_url: (string, required) URL to the audio file or text-to-speech configuration.
     Response:
       - status: (string) 'queued', 'ringing', 'answered', 'completed', 'failed'.
       - callid: (string) Unique ID for the call.

Error Handling:
- Common error codes include 400 (Bad Request), 401 (Unauthorized), 404 (Not Found), 500 (Internal Server Error).
- Detailed error messages are provided in the response body.
```

--------------------------------

### Unifonic API Documentation

Source: https://docs.unifonic.com/articles/products-documentation/ecommerce-how-to

Provides comprehensive API documentation for Unifonic services, including authentication, endpoints, request/response formats, and error handling.

```APIDOC
Unifonic API Reference:

Authentication:
  - API Key: Obtain your API key from the Unifonic dashboard.
  - Header: Include 'Authorization: Key YOUR_API_KEY' in your requests.

Endpoints:
  - SMS Messaging:
    - Send SMS:
      - POST /sms
      - Parameters:
        - to: (string, required) Recipient's phone number (e.g., "+1234567890").
        - from: (string, required) Sender ID or shortcode.
        - body: (string, required) The message content.
        - callback_url: (string, optional) URL to receive delivery reports.
      - Returns:
        - message_id: (string) Unique identifier for the sent message.
        - status: (string) Status of the message (e.g., "queued", "sent").
      - Example:
        POST /sms
        {
          "to": "+1234567890",
          "from": "Unifonic",
          "body": "Hello from Unifonic!"
        }
    - Get Message Status:
      - GET /sms/{message_id}
      - Parameters:
        - message_id: (string, required) The ID of the message to query.
      - Returns:
        - status: (string) Current status of the message.
        - delivered_at: (string, optional) Timestamp when the message was delivered.

  - WhatsApp Messaging:
    - Send WhatsApp Message:
      - POST /whatsapp/messages
      - Parameters:
        - to: (string, required) Recipient's WhatsApp number (e.g., "+1234567890").
        - from: (string, required) Your WhatsApp Business Number.
        - type: (string, required) Type of message ('text', 'template', 'image', 'document', etc.).
        - text: (object, required if type is 'text')
          - body: (string, required) The text message content.
        - template: (object, required if type is 'template')
          - name: (string, required) The name of the template.
          - language: (object, required)
            - code: (string, required) Language code (e.g., "en").
          - components: (array, optional) Template components.
      - Returns:
        - message_id: (string) Unique identifier for the sent message.
        - status: (string) Status of the message.
      - Example:
        POST /whatsapp/messages
        {
          "to": "+1234567890",
          "from": "+11234567890",
          "type": "text",
          "text": {
            "body": "Hello from Unifonic WhatsApp!"
          }
        }

Error Handling:
  - Common error codes:
    - 400: Bad Request (e.g., missing parameters, invalid format).
    - 401: Unauthorized (e.g., invalid API key).
    - 404: Not Found (e.g., invalid endpoint).
    - 500: Internal Server Error.
  - Error Response Format:
    {
      "error": {
        "code": "INVALID_PARAMETER",
        "message": "The 'to' parameter is missing."
      }
    }
```

--------------------------------

### Unifonic Products Beats Documentation

Source: https://docs.unifonic.com/articles/products-beats

Provides updates and details on Unifonic's Products Beats, covering release notes, feature enhancements, and important announcements for various product versions.

```APIDOC
Products Beats Documentation:
  - Getting Started: Information on how to begin using Unifonic products.
  - Release Notes:
    - Jan 2024 Products Beats: Details on January 2024 updates.
    - Aug-Sep-Oct 2023 Products Beats: Information on updates from August to October 2023.
    - June-July 2023 Products Beats: Details on June-July 2023 updates.
    - Apr-May 2023 Products Beats: Information on April-May 2023 updates.
    - Jan-Mar 2023 Products Beats: Details on January-March 2023 updates.
    - December 2022 Product Beats: Information on December 2022 updates.
  - Feedback Mechanism:
    - Users can provide feedback on page helpfulness.
    - Option to add comments and submit feedback via email.
```

--------------------------------

### Chatbot Builder - Cloning Chatbot

Source: https://docs.unifonic.com/smart/project-products-documentation/chatbot-builder

Information on how to clone existing chatbots within the Unifonic platform.

```APIDOC
Cloning Chatbot:
  - Instructions for duplicating existing chatbots.
  - Useful for creating variations or backups of chatbot configurations.
  - Details the process and any limitations.
```

--------------------------------

### Unifonic API Documentation Overview

Source: https://docs.unifonic.com/articles/api-documentation/overview

This section provides links to various Unifonic API documentation topics. It covers security, authentication, data formats, voice parameters, call status checking, caller ID usage, making outgoing calls with audio or for response collection, sending OTPs, text-to-speech messages, random caller ID, managing incoming calls, conference bridges, IVR objects, webhooks for call statuses, and general Unifonic Voice APIs.

```APIDOC
Security & Authentication: https://docs.unifonic.com/articles/#!api-documentation/security-authentication
Data Format: https://docs.unifonic.com/articles/#!api-documentation/data-format
Different Voice Parameters that are Available: https://docs.unifonic.com/articles/#!api-documentation/different-voice-parameters-that-are-available
Checking my call status via APIs: https://docs.unifonic.com/articles/#!api-documentation/new-topic-1
Understanding the use of Secondary Caller ID: https://docs.unifonic.com/articles/#!api-documentation/understanding-the-use-of-secondary-caller-id
Making an Outgoing Call that Plays an Audio: https://docs.unifonic.com/articles/#!api-documentation/making-an-outgoing-call-that-plays-an-audio
Making an Outgoing Call to Collect Response: https://docs.unifonic.com/articles/#!api-documentation/making-an-outgoing-call-to-collect-response
Making an Outgoing Voice Call to Send an OTP: https://docs.unifonic.com/articles/#!api-documentation/making-an-outgoing-voice-call-to-send-an-otp
Making an Outgoing Voice Call to Send a Simple Text-to-Speech message: https://docs.unifonic.com/articles/#!api-documentation/making-an-outgoing-voice-call-to-send-a-simple-text-to-speech-message
How to use Random Caller ID feature: https://docs.unifonic.com/articles/#!api-documentation/how-to-use-random-caller-id-feature
Managing your Incoming Calls: https://docs.unifonic.com/articles/#!api-documentation/managing-your-incoming-calls
How to create a Conference Bridge: https://docs.unifonic.com/articles/#!api-documentation/how-to-create-a-conference-bridge
Sending Multiple IVR Objects in a single request: https://docs.unifonic.com/articles/#!api-documentation/sending-multiple-ivr-objects-in-a-single-request
Setting up a Webhook to Receive Call Statuses: https://docs.unifonic.com/articles/#!api-documentation/setting-up-a-webhook-to-receive-call-statuses
Unifonic Voice APIs: https://docs.unifonic.com/articles/#!api-documentation/unifonic-voice-apis-1
```

--------------------------------

### Unifonic API Documentation

Source: https://docs.unifonic.com/smart/project-products-documentation/chatbot-builder

Provides access to Unifonic's API documentation, covering various services and functionalities for developers.

```APIDOC
API Documentation:
  - Access point for all Unifonic API-related information.
  - Covers services like SMS, Chatbots, and more.
  - Includes guides for authentication, endpoints, and data formats.
```

--------------------------------

### Chatbot Builder - Campaign Integration

Source: https://docs.unifonic.com/smart/project-products-documentation/chatbot-builder

Guidance on integrating chatbots with Unifonic's campaign management tools.

```APIDOC
Campaign Integration:
  - How to connect chatbots with marketing or communication campaigns.
  - Enables automated interactions within campaigns.
  - Covers setup and configuration for seamless integration.
```
Tokens:
Raw