Introduction

Welcome to the Teleduce API! You can use our API to access Teleduce API endpoints, which can get information on various campaigns in our database.

We have language bindings in Shell, Ruby, Python, and JavaScript! You can view code examples in the dark area to the right, and you can switch the programming language of the examples with the tabs in the top right.

Authentication

To authorize, use this code:

# With shell, you can just pass the correct header with each request
curl "api_endpoint_here"
-H "Authorization: t313duc3"

Make sure to replace t313duc3 with your API key.

Teleduce uses API keys to allow access to the API. You can register a new Teleduce API key at our developer portal.

Teleduce expects for the API key to be included in all API requests to the server in a header that looks like the following:

Authorization: t313duc3

Campaigns

Get All Campaigns

curl "https://www.corefactors.in/api/campaigns"
-H "Authorization: t313duc3"

The above command returns JSON structured like this:

[
{
"id": 1,
"name": "John",
"category": "sms",
"type": 6,
"months": 7
},
{
"id": 2,
"name": "Jack",
"category": "call",
"type": 5,
"months": 10
}
]

This endpoint retrieves all campaigns.

HTTP Request

GET https://www.corefactors.in/api/campaigns

Query Parameters

ParameterDefaultDescription
include_campaignsfalseIf set to true, the result will also include campaigns.
availabletrueIf set to false, the result will include campaigns that have already been recorded.

Get a Specific Campaign

curl "https://www.corefactors.in/api/campaigns/2"
-H "Authorization: t313duc3"

The above command returns JSON structured like this:

{
"id": 2,
"name": "Max",
"category": "email",
"type": 5,
"months": 10
}

This endpoint retrieves a specific campaign.

HTTP Request

GET https://www.corefactors.in/campaigns/<ID>

URL Parameters

ParameterDescription
IDThe ID of the campaign to retrieve

Delete a Specific Campaign

curl "https://www.corefactors.in/api/campaigns/2"
-X DELETE
-H "Authorization: t313duc3"

The above command returns JSON structured like this:

{
"id": 2,
"deleted" : "5"
}

This endpoint deletes a specific campaign.

HTTP Request

DELETE https://www.corefactors.in/campaigns/<ID>

URL Parameters

ParameterDescription
IDThe ID of the campaign to delete