JustCall API Essential Guide

What type of API does JustCall provide?

Based on the search results provided, JustCall has a REST API. Here are the key points:

Type of API

JustCall uses a REST API. The documentation explicitly states "The REST APIs provide programmatic access to read and write JustCall data."

Key Features of JustCall's REST API

• Allows creating new contacts, reading contact data, adding notes, and more
• Provides endpoints for searching calls, listing calls, and updating call information
• Offers endpoints for managing phone numbers, including listing numbers and checking availability
• Enables creating, deleting, getting, listing, updating and querying contacts
• Allows querying for text messages

API Structure

The API follows typical REST conventions:

• Uses HTTP methods (GET, POST, etc.) to perform operations
• Returns data in JSON format
• Organizes data around resources like calls, contacts, phone numbers

Authentication

The API uses api_key and api_secret for authentication.

Best Practices

• JustCall's REST API aligns with common REST best practices like using standard HTTP methods and returning JSON responses
• The API is organized around key resources, making it intuitive to use

In summary, JustCall provides a REST API that allows developers to programmatically interact with core JustCall functionality like managing calls, contacts, and phone numbers. The API follows REST conventions, making it relatively straightforward for developers familiar with REST APIs to work with.

Does the JustCall API have webhooks?

Yes, the official JustCall API does have webhooks. Here are the key points about JustCall's webhook functionality:

Webhook Availability

• Webhook access is available starting from the JustCall Team plan and above.

Types of Events You Can Subscribe To

JustCall provides various call and SMS events that you can subscribe to, including:

1. Call Events:

   • New incoming call in JustCall
   • Call answered in JustCall
   • Incoming caller enters queue
   • Incoming caller exits queue
   • Call initiated from JustCall
   • Call completed in JustCall
   • Call updated in JustCall
   • Call AI report generated in JustCall
   • Call completed in Sales Dialer
   • Call updated in Sales Dialer

2. SMS Events:

   • SMS sent/received
   • SMS Delivery Status Updated

3. Other Events:

   • Contact added to Blacklist/DND/DNM

Webhook Management

• You can add, view, and manage webhook subscriptions through the JustCall app interface or via API.
• JustCall allows adding multiple webhook URLs (up to 5) for a particular event.
• You can use the Webhooks API module to manage your webhooks programmatically.

Webhook Payload and Security

• Webhook payloads include detailed information about the event, such as call/SMS details, agent information, and more.
• JustCall uses dynamic webhook signatures to secure the webhook requests, allowing you to validate that the requests originated from JustCall.

Best Practices

• JustCall doesn't guarantee the delivery of events in the order they are generated, so your endpoint should be designed to handle events in any order.
• To guard against duplicate events, you can log the combination of object ID and event type you've processed.

In summary, JustCall offers a comprehensive webhook system that allows you to subscribe to a wide range of events related to calls, SMS, and other account activities. This enables real-time integration with your own systems and applications.

Rate Limits and other limitations

Here are the key points about the API Rate Limits of the JustCall API:

Hourly Rate Limits

• Business/Business+ plan: 5400 requests per hour
• Pro/Pro+ plan: 3600 requests per hour
• Team/Team+ plan: 1800 requests per hour

Burst Rate Limits (Per Minute)

• Business/Business+ plan: 90 requests per minute
• Pro/Pro+ plan: 60 requests per minute
• Team/Team+ plan: 30 requests per minute

Key Points to Consider

• Rate limits are implemented across different plan types to ensure fair usage and maintain API stability [1].

• User interface actions are not counted towards the rate limit [2].

• Webhooks are not subject to rate limiting [2].

• The current rate limits are visible in the developer's section of your JustCall account [1][2].

HTTP Headers and Response Codes

JustCall API requests include the following rate limit response headers [2]:

• X-Rate-Limit-Limit: The hourly rate limit for your account
• X-Rate-Limit-Remaining: The number of requests left for the 1-hour window
• X-Rate-Limit-Reset: The remaining time before the rate limit resets (in UTC epoch seconds)
• X-Rate-Limit-Burst-Limit: The minutely rate limit for your account
• X-Rate-Limit-Burst-Remaining: The number of requests left for the 1-minute window
• X-Rate-Limit-Burst-Reset: The remaining time before the burst rate limit resets (in UTC epoch seconds)

When an account exceeds either the burst or hourly limits, the API returns an HTTP 429 "Too Many Requests" response code, along with a detailed error message in the response body [2].

Best Practices

1. Monitor your API usage to stay within the limits of your plan.
2. Implement proper error handling for rate limit responses (HTTP 429).
3. Consider upgrading your plan if you consistently approach or exceed the rate limits.
4. Optimize your API calls to make efficient use of the available requests.
5. Use the provided response headers to track your remaining requests and plan accordingly.

By adhering to these rate limits and best practices, you can ensure smooth integration with the JustCall API while maintaining a reliable and consistent experience for your users.

Latest API Version

Based on the search results provided, I can answer your question about the most recent version of the JustCall API. Here are the key points:

Most Recent API Updates

The most recent version of the JustCall API includes updates from December 2023. These updates include:

1. Enhanced response objects for JustCall Calls and Texts APIs.
2. Introduction of new endpoints for Sales Dialer Calls and Campaigns.
3. Addition of enriched data points in the latest version.

Key Additions and Enhancements

1. Sales Dialer:

   • New endpoints for fetching Sales Dialer Calls and Campaigns.
   • More endpoints from v1 are planned to be added in future releases.

2. JustCall Calls:

   • Added new parameters to the Call response object: contact_email, public_recording, and voicemail_transcription.

3. JustCall SMS:

   • Added new parameters to the Texts response object: contact_email, agent_email, and medium.

Previous Updates

It's worth noting that there were also API updates in October 2023, which introduced new parameters for both Calls and SMS response objects. These updates included:

• For Calls: Detailed IVR, Queue callback, and JustCall IQ data.
• For SMS: Data around the cost incurred in sending a text.

Best Practices

When working with the JustCall API, keep the following in mind:

1. Always refer to the latest documentation for the most up-to-date information on endpoints and response objects.
2. Be aware of rate limiting for API requests, which depends on your plan.
3. Use webhook events for real-time notifications about important events in your JustCall account.

In conclusion, the most recent version of the JustCall API includes updates from December 2023, with enhancements to existing endpoints and the introduction of new ones, particularly for Sales Dialer functionality. Always check the official documentation for the most current information when integrating with the API.

How to get a JustCall developer account and API Keys?

To get a developer account for JustCall and create an API integration, you need to follow these steps:

1. Sign up for a JustCall account if you don't already have one.

2. Once logged in, navigate to the Settings page in your JustCall account.

3. In the Settings page, look for the "Developers" section.

4. Click on the "Manage APIs and Webhooks" button in the Developers section.

5. This will take you to a page where you can access your API credentials.

6. Under "API Credentials", you will find your API key and API secret. These are essential for authenticating your API requests.

Key points to consider:

• You must have Admin permissions to access the Developer settings on JustCall.
• JustCall offers REST APIs that provide programmatic access to read and write JustCall data.
• The API allows you to perform various actions such as creating contacts, adding notes, getting call information, and more.

Best practices:

1. Keep your API key and secret secure. Do not share them publicly or commit them to version control systems.

2. Familiarize yourself with the rate limiting policies to ensure your integration doesn't exceed the allowed request limits.

3. Use webhooks to get notified about important events in your JustCall account.

4. Always test your integration thoroughly before deploying it to production.

5. Refer to the JustCall developer documentation for detailed information on available endpoints and their usage.

By following these steps and best practices, you'll be able to set up a developer account and create an API integration with JustCall. Remember to review the documentation thoroughly for specific endpoints and functionalities you need for your integration.

What can you do with the JustCall API?

Based on the search results, here are the key data models you can interact with using the JustCall API, along with what is possible for each:

Contacts

• Create new contacts
• Delete existing contacts
• Get details of specific contacts
• List all contacts
• Update contact information
• Query/search contacts
• Access contact fields like name, phone, email, company, notes, etc.

Calls

• List all calls
• Search/query calls
• Update call notes and disposition codes
• Download call recordings
• Get details of specific calls
• Access call data like duration, status, agent info, recording link, etc.

Phone Numbers

• Get list of JustCall phone numbers
• Check availability status of numbers
• Detect number type (landline, mobile, VOIP)
• Access number details like ID, capabilities (SMS, voice, etc.)

Users

• List users/agents
• Get user details

SMS/MMS

• Send and receive text messages
• Access SMS inbox
• Build SMS workflows

WhatsApp

• Connect to shared WhatsApp inbox

Analytics

• Access call center analytics and performance metrics
• Monitor real-time call activity
• Get insights into team and number performance

Other Features

• Automated call distribution
• Sales dialer functionality
• Call recording capabilities
• Integrations with CRMs and other business tools

The API allows programmatic access to create, read, update and delete data across these core JustCall objects, enabling automation and integration with other systems. The comprehensive set of endpoints provides flexibility to build custom workflows leveraging JustCall's communication capabilities.