Telma API documentation

Welcome to the Telma API documentation. Telma is a powerful telecommunications platform designed to help you automate and streamline your telephony campaigns. This API provides REST endpoints that enable programmatic interaction with the Telma platform, allowing you to create, manage, and track your campaigns more efficiently. To learn more about the available endpoints, please refer to our OpenAPI specification.

Getting Started

First step you need to do is to obtain login credential to Telma portal on the registration page of Telma. Once you are granted the login credentials, you can use those to obtain the API access token.

Authentication

This API uses OAuth2 with bearer token for authentication. To authenticate, send a POST request to /oauth2/token with your username and password as Basic Authentication header and receive an access token in response. This token is time limited so new token needs to be obtained with use of refresh token. To refresh an access token, send a POST request to /oauth2/refresh with a refresh token.

API Overview

The API uses Campaigns and Conversation Tasks as main concepts. The Campaigns correspond to the campaigns in the Telma portal. The Conversation Tasks are analogous to the Excel file uploaded to the portal. We are using JSON as the data exchange format for request and response payloads.

Campaigns

Campaigns are collections of related Conversation Tasks, allowing you to manage and track the progress of your telephony initiatives. You can customize the campaign in terms of number of retries if call was not connected and the delay between retries. The Telma API offers a variety of endpoints to help you work with campaigns:

• GET /v1/campaigns: Retrieves a list of all campaigns.
• POST /v1/campaigns: Creates a new campaign.
• GET /v1/campaigns/{campaign_id}: Retrieves details for a specific campaign.
• DELETE /v1/campaigns/{campaign_id}: Deletes a specific campaign.
• PATCH /v1/campaigns/{campaign_id}: Updates a specific campaign.

Conversation Tasks

Conversation Tasks are the building blocks of your Campaigns, consisting of phone numbers and customizable message parameters. The Telma API provides several endpoints to manage Conversation Tasks within a specific campaign:

• GET /v1/campaigns/{campaign_id}/conversation_tasks: Retrieves a list of all conversation tasks for a specific campaign.
• POST /v1/campaigns/{campaign_id}/conversation_tasks: Creates a new conversation task for a specific campaign.
• DELETE /v1/campaigns/{campaign_id}/conversation_tasks: Deletes all conversation tasks for a specific campaign.
• GET /v1/campaigns/{campaign_id}/conversation_tasks/{task_id}: Retrieves details for a specific conversation task related to a campaign.

Recordings

The Recordings API enables you to retrieve audio recordings of specific phone calls made during your campaigns. Please note that our retention policy is limited, so it's highly recommended to download and store the recordings as soon as possible. The Telma API provides the following endpoints for managing call recordings:

• GET /v1/recordings: Retrieves a list of all recordings.
• GET /v1/recordings/{session_id}: Retrieves audio file for a specific recording.

Contact Information

For any questions, concerns, or issues related to the Telma API, our support team is here to help. You can reach out to us through the following channels

• Email Support: For general inquiries, technical questions, or bug reports, please contact our support team via email at support@telma.ai. We will respond to your query as soon as possible.

• Social Media: Stay up to date with the latest news, updates, and announcements by following Telma AI on LinkedIn.

Please provide as much detail as possible when submitting a query or reporting an issue, including any relevant API request and response data, error codes, and steps to reproduce the problem. This will help our support team provide you with a faster and more accurate resolution. We appreciate your feedback and are committed to continuously improving the Telma API and supporting your needs.