Ringg AI APIs for Developers

GET

campaign

all

Get All Campaigns

curl --request GET \
  --url https://prod-api.ringg.ai/ca/api/v0/campaign/all \
  --header 'X-API-KEY: <x-api-key>'

{
  "campaigns": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Q4 Sales Campaign",
      "campaign_status": "completed",
      "created_at": "2024-01-15T14:30:00Z",
      "updated_at": "2024-01-15T16:45:00Z",
      "campaign_start_time": "2024-01-16T09:00:00Z",
      "campaign_end_time": "2024-01-16T17:00:00Z",
      "total_count": 150,
      "registered_count": 120,
      "completed_count": 85
    }
  ],
  "pagination": {
    "total": 25,
    "limit": 10,
    "offset": 0
  }
}

Headers

X-API-KEY

string

required

(Required) Your Ringg AI API key.

Example:

"7251cb4b-3373-43a4-844c-b27a1d45e0c9"

Query Parameters

call_count

boolean

default:true

Whether to include call count for each campaign (default: true).

limit

integer

default:10

Maximum number of campaigns to return (default: 10).

Required range: 1 <= x <= 1000

offset

integer

default:0

Number of campaigns to skip for pagination (default: 0).

Required range: x >= 0

Response

List of campaigns retrieved successfully.

campaigns

object[]

Show child attributes

campaigns.id

string

Campaign unique identifier

Example:

"550e8400-e29b-41d4-a716-446655440000"

campaigns.name

string

Campaign name

Example:

"Q4 Sales Campaign"

campaigns.campaign_status

enum<string>

Current status of the campaign

Available options:

pending,

registered,

running,

completed,

paused

Example:

"completed"

campaigns.created_at

string<date-time>

Campaign creation timestamp

Example:

"2024-01-15T14:30:00Z"

campaigns.updated_at

string<date-time>

Campaign last update timestamp

Example:

"2024-01-15T16:45:00Z"

campaigns.campaign_start_time

string<date-time>

Scheduled start time for the campaign

Example:

"2024-01-16T09:00:00Z"

campaigns.campaign_end_time

string<date-time>

Scheduled end time for the campaign

Example:

"2024-01-16T17:00:00Z"

campaigns.total_count

integer

Total number of calls in campaign (only included when call_count=true)

Example:

150

campaigns.registered_count

integer

Number of registered calls (only included when call_count=true)

Example:

120

campaigns.completed_count

integer

Number of completed calls (only included when call_count=true)

Example:

85

pagination

object

Show child attributes

pagination.total

integer

Total number of campaigns available

Example:

25

pagination.limit

integer

Number of campaigns requested per page

Example:

10

pagination.offset

integer

Number of campaigns skipped

Example:

0

Get Call HistoryRetrieves the history of calls made through the Ringg AI platform with optional filtering and pagination.

⌘I

Get All Campaigns

curl --request GET \
  --url https://prod-api.ringg.ai/ca/api/v0/campaign/all \
  --header 'X-API-KEY: <x-api-key>'

{
  "campaigns": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Q4 Sales Campaign",
      "campaign_status": "completed",
      "created_at": "2024-01-15T14:30:00Z",
      "updated_at": "2024-01-15T16:45:00Z",
      "campaign_start_time": "2024-01-16T09:00:00Z",
      "campaign_end_time": "2024-01-16T17:00:00Z",
      "total_count": 150,
      "registered_count": 120,
      "completed_count": 85
    }
  ],
  "pagination": {
    "total": 25,
    "limit": 10,
    "offset": 0
  }
}

Get Started

Webhooks Setup

API Reference

Get All Campaigns

Headers

Query Parameters

Response