The Call Loop API is a powerful tool that allows you to access and manipulate your data and add Call Loop to your custom automations. Our API is built using Postman and offers improved response times and a wide range of endpoints. You can use our API to add contacts, apply tags, send messages, and more.
How to Access the API
Authentication
Our API covers multiple authentication methods:
PAT (Personal Access Token) authorization type is to go for in case you want to integrate your personal existing account with Call Loop in order to extend your app’s functionality. PAT are managed by the user, which means that they are tied to a user account. This makes Personal Access Tokens a good choice for development, as well as automation purposes, when an application does only require a single Salesmessage account to manage organizations.
Personal Access Token
From your Settings page, click Personal Access Tokens, then click Create Token to generate your unique API token.
When creating a token, you will be asked to select scopes - these define exactly what the token is allowed to do. Only select the scopes your integration actually needs. See the API Scopes section for the full list.
Once your token is generated, you can start testing using our Live API Portal.
API Scopes
All API tokens require scopes. Scopes control exactly which endpoints your token can access. There is no longer a catch-all permission - every integration must declare exactly what it needs.
If a token tries to call an endpoint it doesn't have permission for, the API will return HTTP 403 insufficient_scope.
Scopes
Endpoints
The Call Loop API covers all functionality of Call Loop, including the following:
Contacts
Conversations
Broadcasts
Campaigns
And More.
All endpoints are covered in API 1.0 documentation.
API Documentation
Postman: View the API Documentation
Swagger: Test Your API
Call Loop Public API Usage with PAT and Swagger
This is step-by-step walkthrough of how to use the Call Loop Public API with a personal access token and Swagger. Follow these instructions to authenticate and perform basic API operations such as retrieving conversations, messages, and sending replies.
1. Generate a Personal Access Token
Login to Call Loop:
Access your Call Loop account.
Navigate to Token Settings:
Go to Settings > Personal Access Token.
Create a Token:
Click on Create Token.
Provide a name for the token (e.g., API Access Token).
Select desired scopes
Click Create.
Copy the Token:
Once the token is generated, copy it for later use.
2. Access Swagger and Authorize
Open Swagger:
Navigate to the Swagger UI page (ensure you're using version 1.0).
Authorize with Token:
Scroll down to the Authorize button at the top of the page.
Paste your personal access token into the provided field.
Click Authorize to complete authentication.
3. Perform API Operations
a. Retrieve Conversations
Find the Endpoint:
Locate the
GET /conversationsendpoint in Swagger.
Test the Request:
Click Try it out.
Specify any filters (e.g., date range for messages sent/received).
Click Execute.
View Results:
Review the returned data, which includes a list of conversations and their details.
b. Retrieve Messages in a Conversation
Get a Conversation ID:
From the retrieved conversations, copy the Conversation ID.
Find the Endpoint:
Locate the
GET /conversations/{id}/messagesendpoint in Swagger.
Test the Request:
Click Try it out.
Paste the Conversation ID and specify parameters (e.g., the number of messages to retrieve).
Click Execute.
View Results:
Review the retrieved messages, including details such as status and timestamps.
c. Send a Message
Find the Endpoint:
Locate the
POST /conversations/{id}/sendendpoint in Swagger.
Test the Request:
Click Try it out.
Paste the Conversation ID.
Enter the message content (e.g., Hello, my name is Den).
Click Execute.
Confirm Message Sent:
Review the response to ensure the message was successfully sent.
d. Verify Messages Sent
Retrieve Recent Messages:
Use the
GET /conversations/{id}/messagesendpoint to confirm the message appears in the conversation timeline.
Execute the Request:
Specify the Conversation ID and click Execute.
Review the response to confirm the new message is listed.
4. Additional Notes
Use filters like date or message count to refine your requests.
Always test endpoints in Swagger to verify data before integrating into your application.
Store your personal access token securely, as it grants access to your account data.