Check large campaign balance (Beta)

POST

campaign

check-balance

{bulk_list_id}

Check Campaign Balance (Beta)

curl --request POST \
  --url https://prod-api.ringg.ai/ca/api/v0/campaign/check-balance/{bulk_list_id} \
  --header 'X-API-KEY: <x-api-key>'

import requests

url = "https://prod-api.ringg.ai/ca/api/v0/campaign/check-balance/{bulk_list_id}"

headers = {"X-API-KEY": "<x-api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'X-API-KEY': '<x-api-key>'}};

fetch('https://prod-api.ringg.ai/ca/api/v0/campaign/check-balance/{bulk_list_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod-api.ringg.ai/ca/api/v0/campaign/check-balance/{bulk_list_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://prod-api.ringg.ai/ca/api/v0/campaign/check-balance/{bulk_list_id}"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-API-KEY", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://prod-api.ringg.ai/ca/api/v0/campaign/check-balance/{bulk_list_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

{
  "status": "draft",
  "bulk_list_id": "<string>",
  "message": "<string>"
}

This endpoint is beta. Use it only after upload processing is complete for a beta large campaign.

POST /campaign/check-balance/{bulk_list_id} checks whether the workspace has enough balance to start calls for the validated rows in a large campaign.

Endpoint

POST /campaign/check-balance/{bulk_list_id}

Path parameters

Parameter	Required	Description
`bulk_list_id`	Yes	Large campaign list ID returned by `POST /campaign/upload-csv`

Request

curl --request POST "https://prod-api.ringg.ai/ca/api/v0/campaign/check-balance/your-bulk-list-id" \
  --header "X-API-KEY: $RINGG_API_KEY"

Response guidance

A successful response confirms whether the current balance can cover the validated campaign rows.

{
  "bulk_list_id": "123e4567-e89b-12d3-a456-426614174000",
  "required_credits": 6200,
  "available_credits": 8500,
  "sufficient_balance": true
}

If sufficient_balance is false, add balance, reduce the campaign size, or contact Ringg support before starting calls.

Next step

When balance is sufficient, call Make large campaign calls async.

Headers

X-API-KEY

string

required

(Required) Your Ringg AI API key.

Example:

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

Path Parameters

bulk_list_id

string

required

Bulk list ID to re-check.

Response

Balance check completed.

status

string

Example:

"draft"

bulk_list_id

string

message

string

Check Campaign Balance (Beta)

curl --request POST \
  --url https://prod-api.ringg.ai/ca/api/v0/campaign/check-balance/{bulk_list_id} \
  --header 'X-API-KEY: <x-api-key>'

import requests

url = "https://prod-api.ringg.ai/ca/api/v0/campaign/check-balance/{bulk_list_id}"

headers = {"X-API-KEY": "<x-api-key>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {'X-API-KEY': '<x-api-key>'}};

fetch('https://prod-api.ringg.ai/ca/api/v0/campaign/check-balance/{bulk_list_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod-api.ringg.ai/ca/api/v0/campaign/check-balance/{bulk_list_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "X-API-KEY: <x-api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://prod-api.ringg.ai/ca/api/v0/campaign/check-balance/{bulk_list_id}"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("X-API-KEY", "<x-api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://prod-api.ringg.ai/ca/api/v0/campaign/check-balance/{bulk_list_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<x-api-key>'

response = http.request(request)
puts response.read_body

{
  "status": "draft",
  "bulk_list_id": "<string>",
  "message": "<string>"
}

Get Started

API Reference

Webhooks Setup

Telephony Integration

MCP Server

External Integrations

Privacy and Compliance

Check large campaign balance (Beta)

Endpoint

Path parameters

Request

Response guidance

Next step

Headers

Path Parameters

Response

​Endpoint

​Path parameters

​Request

​Response guidance

​Next step

Headers

Path Parameters

Response

Endpoint

Path parameters

Request

Response guidance

Next step