Available Campaigns (Token authentication)

This API is used to retrieve all the campaign information. The information that can be retrieved is the CampaignId, Campaign name, Username, Position (whether in a ready state or not), DID, and Campaign type (Inbound, Preview, Chat, IVR, Progressive, and Predictive).

To use this API with the help of a token, follow these steps:

  1. Generate the Token: Use the 'Generate Token' API to obtain an authentication token.
  2. Enter the Token ID: Navigate to the right section of this page, under the 'AUTHORIZATION' tab. Here, input the generated token ID.
  3. With the token entered, pass the below header and body parameters:

Header parameters

ParameterDescription
Content-Typeapplication/json

Body Params

{
"userName":"Test"
}

Possible responses

Success response"status": "success",
"message": [
{"CampaignID": "XXXXX",
"Campaign": "campaignname", "XXXXXX",
"UserName": "username", "XXXXXX",
"Position": "state",
"DID": "9140XXXXX",
"CampaignType": "campaignType"
Invalid apikey/username"campaign": {}, "code": "401",
"message": "User Does not Exists.",
"status": "Error"
Language
Authorization
Bearer
URL
Click Try It! to start a request and see the response here!