Documentation | ARKK Labs

ARKK Labs system guides and API reference.

## Sections
• [Getting Started](https://app.theneo.io/arkk-labs/documentation/getting-started.md): Explore the ARKK Labs API reference with comprehensive guides, code examples, and endpoint documentation If you still haven't setup your credentials, you can refer to our Authentication docs on where to find them. Webhooks URLs Connect ARKK Labs to your existing integration(s) in order to receive real-time events or pass customer data to be used in communications like calls, SMS messages, or emails between a user and an agent. For more information, see our guides on Webhooks . To receive webhook events, you'll need to setup your Webhook URLs. Add them in the ARKK Portal by navigating to Settings → API & Integrations, or by clicking here . Connect your Email Connecting your Outlook email to ARKK allows your agent to send and receive emails from your existing inbox. Agents can send emails to customers in real time, before, after, and during calls. Multiple emails can be connected to your company (no limit.) ARKK uses Outlook emails to leverage Microsoft Graph APIs for email communication vs SMTP (older email protocol.) This allows you to use modern APIs, better security and authentication, and access more functionality compared to the alternative protocol. If you prefer to connect a Gmail account, see our guide on how to Connect Gmail to Outlook. To connect your email, go to the ARKK Portal and navigate to Settings → API & Integrations, or click here .
• [Authentication](https://app.theneo.io/arkk-labs/documentation/authentication.md): Learn how to authenticate your ARKK Labs API requests. We use Basic Authentication , a standard and secure method for an HTTP user to provide a username and password when making a request. HTTP Authorization: Basic <credentials> If sending the Authorization header is not possible, you may pass the token a query paramerer in the URL like this: ?token=<credentials> HTTP GET /open-api/v1/company/sources?token=<credentials> HTTP/1.1 Host: app.arkklabs.com You can find your API credentials in the ARKK Portal by navigating to Settings → API & Integrations, or by clicking here . Your API credentials must be included in every Open API request associated with your account. Keep your username and password secure. If you lose access to your credentials or believe they are compromised, you can always regenerate them in the ARKK Portal.
• [Webhooks](https://app.theneo.io/arkk-labs/documentation/resources/webhooks.md): To receive webhook events, you'll need to setup your Webhook URLs. Add them in the ARKK Portal by navigating to Settings → API & Integrations, or by clicking here . Get Call Details When “Get Call Details” is enabled for a company or a specific agent within a company, ARKK will make a POST request to your CRM (or preferred system) to retreive customer information for the call that is being initiated. ARKK sends the information below in the POST request: phone_number - Phone number of the external party state - Two-letter abbreviation of the state linked to phone_number. agent_id - ARKK Phone Agent initiating the call. direction - Can be inbound or outbound. You can use this information to retrieve curated and useful data from your integrations to be used in calls. The expected response structure is the same as the call_details object sent in the dispatch calls request. HTTP POST /api/arkk/call-details HTTP/1.1 Host: crm-integration.com Content-Type: application/json { "phone_number": "8885551234", "state": "FL", "agent_id": "apa-XqubNVXh", "diretion": "inbound" } HTTP HTTP/1.1 Content-Type: application/json { "first_name": "Alex" } Events Events keep your integration in sync with ongoing call events and actions by the agent. Call Events inititated - Call has been connected to the customer's phone number. Status: active . Outbound calls include a dispatch_id . hangup - Call has ended. Status: complete , no-answer , voicemail , or failed . Includes voicemail , marked_dnc , and transferred_to . timeout - Call timed out due to exceeding maximum duration allowed. Status: timeout. Includes marked_dnc and transferred_to . call-answered - Customer has answered the phone. Status: callback-scheduled - Customer requested a callback. ARKK creates and sends us a new id callback_dispatch for the upcoming call. transferred - Call was live-transferred to an agent/number. Status: active . Includes agent_id and transferred_to . Dispatch Events dispatch-rescheduled - ARKK deferred the dispatch to a later time for reasons such as calling outside timezone allowed hours. dispatch-failed - ARKK rejected the dispatch request for reasons such as pending calls capacity limit reached.
• [Dispatch](https://app.theneo.io/arkk-labs/documentation/resources/dispatch.md): The Dispatch section enables users to initiate and manage call dispatches efficiently within the ARKK Labs Open-API. It provides tools to create new dispatch calls and retrieve dispatch limits, helping streamline communication workflows and ensure operational control.
  • [Dispatch Calls](https://app.theneo.io/arkk-labs/documentation/resources/dispatch/calls.md): Use this section to initiate outbound calls through the ARKK Labs platform, enabling you to programmatically dispatch voice interactions to specified recipients. It provides a streamlined way to trigger and manage call dispatches as part of your communication workflows.
  • [Dispatch Limit](https://app.theneo.io/arkk-labs/documentation/resources/dispatch/limit.md): Retrieve the current dispatch limits applicable to your account, enabling you to monitor and manage usage thresholds effectively. This section helps ensure that your dispatch operations stay within allowed boundaries, supporting optimal resource allocation and preventing service interruptions.
• [Company](https://app.theneo.io/arkk-labs/documentation/resources/company.md): Manage and retrieve information related to your company’s funding sources within ARKK Labs Open-API. This section enables you to access detailed data about the financial channels linked to your organization, helping streamline payment management and reconciliation processes.
  • [Get Sources](https://app.theneo.io/arkk-labs/documentation/resources/company/get-sources.md): Retrieve a comprehensive list of all sources associated with your company to manage and review the origins of your data inputs. This section allows you to efficiently access detailed information about each source, enabling better tracking and integration within your workflows.
• [Internal Directory](https://app.theneo.io/arkk-labs/documentation/resources/internal-directory.md): Manage and explore your organization's internal contact information with ease. This section enables you to search, retrieve detailed profiles, and create or update contact records, ensuring your directory stays accurate and up-to-date.
  • [Search Contacts](https://app.theneo.io/arkk-labs/documentation/resources/internal-directory/search-contacts.md): Retrieve and filter contact records within your organization’s internal directory using flexible search criteria. This section enables precise querying of contacts to quickly find relevant individuals based on provided parameters.
  • [Search Directories](https://app.theneo.io/arkk-labs/documentation/resources/internal-directory/search-directories.md): Search Directories enables you to perform targeted queries across internal directories, allowing for efficient retrieval of relevant records based on custom search criteria. This section helps you quickly locate and filter directory entries to streamline access to essential information within ARKK Labs.
  • [Contact Details](https://app.theneo.io/arkk-labs/documentation/resources/internal-directory/contact-details.md): Retrieve detailed information about a specific contact within the internal directory, enabling users to access comprehensive profile data quickly. This section helps streamline communication and collaboration by providing accurate and up-to-date contact details.
  • [Create or Update Contact](https://app.theneo.io/arkk-labs/documentation/resources/internal-directory/create-or-update-contact.md): Use this section to add new contacts or modify existing ones within your internal directory seamlessly. It enables you to manage contact information efficiently by either creating a fresh entry or updating details for a specified contact.
• [Introduction](https://app.theneo.io/arkk-labs/documentation/introduction.md): Welcome to ARKK Labs. These guides walk you through the core concepts, setup, and best practices for integrating with the ARKK Labs platform. Dispatch your first outbound call or build automated call campaigns at scale — start here to understand how the platform works before diving into the API reference. Sign in to ARKK Labs at https://app.arkklabs.com . Need access? Complete the ARKK Labs Onboarding to register. Setup your Internal Departments Add company phone contacts (transfer options) and assign them to an agent directory to make them available to your agents. In this page, you can add company contacts and group them in agent directories for your ARKK Agents to transfer to during calls. Adding a Company Contact A company contact is any phone number that ARKK Phone Agents can transfers calls to, such as your Customer Service team, Help Desk, or yourself. A Company Contact requires a valid phone number, name / label, description, and optionally an Agent Script. The name and description of the contact should provide some information to the ARKK Agent on what this company contact is intended for. The optional field ‘Agent Script’ is the phrase the ARKK Agent says to the customer when transferring them, which by defaults is, "One moment while I transfer you to a licensed agent." Creating an Agent Directory An Agent Directory is a folder that groups one or more phone numbers for your ARKK Phone Agent to access during a call. These folders typically correspond to a specific area or department, avoiding the need to expose the agent to dozens or hundreds of company contacts. Agent Directories are assigned directly to ARKK Phone Agents via the agent's page. Associating Contacts to Agent Directories Once an agent directory is created, hover over the directory to delete, edit (name and description), or update the contacts associatewith the directory. When viewing directory contacts you can toggle between the list of contact that are already associated and available contacts to add. Purchase Phone Numbers Get phone numbers for your phone agent(s) to make and receive calls. Your company starts with a toll free number, but it is encouraged that your agent uses multiple phone numbers for features like local presence. Go to ‘Phone Numbers’ from the ARKK App navigation menu, or click here . See more information on Purchasing Phone Numbers . Create Phone Agent(s) Create inbound and outbound agents using ARKK's Agent Builder, or use an existing template to get started with your first agent. See more on how to create a Phone Agent .
• [Reports](https://app.theneo.io/arkk-labs/documentation/reports.md): This section walks you through all reporting-related features available to you. You can create a brand new report, manage existing ones, view ‘Today’s Report', and more. Reports page showing current reports, and user Mark Labs creating a report to filter by all transferred outbound calls (call status and direction). Today's Report View real time data from the beginning of the today to now Current Reports Lorem Ipsum
• [Call Campaigns](https://app.theneo.io/arkk-labs/documentation/call-campaigns.md): Call Campaigns let your Phone Agents automatically follow up with customers over multiple attempts — instead of calling once and stopping. Assign a call pattern to an agent with a start condition, and ARKK handles the cadence from there. Assign a reusable call pattern to a phone agent in Campaigns Overview Call Patterns A Call Pattern defines how many times an agent will attempt to contact a customer, and how long to wait between each attempt. Patterns are reusable and can be shared across campaigns. ARKK provides community patterns out of the box — pre-configured sequences you can use immediately without building your own. The 'Low Volume' pattern, for example, makes up to 3 attempts with increasing intervals between each call. You can also create a custom pattern if your outreach cadence has specific requirements. Creating a Campaign To create a campaign, click Create Campaign from the Call Campaigns overview. A form will slide open with the following fields: Name — A label for this campaign. Choose something that reflects the goal or audience, such as "Prospects Outreach." Pattern — The call pattern this campaign will follow. Select from community patterns or any custom patterns your company has created. Phone Agent — The outbound agent that will work this campaign. Only active outbound agents appear here. Start Condition — Controls when a customer gets enrolled in the campaign. See Start Conditions below. Description — A short note describing what this campaign does. Used for internal reference only. Once all fields are filled, click Create Campaign to save. The campaign will appear in your campaigns list immediately.