RingCX Dialing Quick Start

Last updated: 2026-07-24

Contributors

This quick start creates a dial group, the top-level container for outbound campaigns. After the dial group exists, create campaigns under it and load leads into those campaigns.

Prerequisites

Before calling the Dialing APIs:

Create a RingCentral app with the ReadAccounts permission.
Complete the RingCentral token exchange flow and obtain a RingCX access token.
Get the RingCX sub-account ID from GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts.

SDK Setup

SDK examples in this quick start use JWT authentication and load credentials from environment variables.

JavaScript

npm install ringcentral-engage-voice-client dotenv

Python

pip3 install ringcentral_engage_voice python-dotenv

Create a .env file in the directory where you run the sample:

RC_CLIENT_ID=<clientId>
RC_CLIENT_SECRET=<clientSecret>
RC_JWT=<jwt>

The SDK wrapper reads these values, signs in with RingCentral, and exchanges the RingCentral access token for a RingCX access token before calling RingCX APIs.

Create a Dial Group

HTTP

POST https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/dialGroups
Authorization: Bearer <ringcxAccessToken>
Content-Type: application/json

{
  "dialGroupName": "Outbound Renewals",
  "dialGroupDesc": "Renewal outreach campaigns",
  "dialMode": "PREVIEW",
  "isActive": true
}

Python

import requests

account_id = "<accountId>"
access_token = "<ringcxAccessToken>"
payload = {
    "dialGroupName": "Outbound Renewals",
    "dialGroupDesc": "Renewal outreach campaigns",
    "dialMode": "PREVIEW",
    "isActive": True,
}

response = requests.post(
    f"https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{account_id}/dialGroups",
    headers={
        "Authorization": f"Bearer {access_token}",
        "Content-Type": "application/json",
    },
    json=payload,
)
response.raise_for_status()
print(response.json())

JavaScript

const accountId = "<accountId>";
const accessToken = "<ringcxAccessToken>";
const payload = {
  dialGroupName: "Outbound Renewals",
  dialGroupDesc: "Renewal outreach campaigns",
  dialMode: "PREVIEW",
  isActive: true
};

const response = await fetch(
  `https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/${accountId}/dialGroups`,
  {
    method: "POST",
    headers: {
      Authorization: `Bearer ${accessToken}`,
      "Content-Type": "application/json"
    },
    body: JSON.stringify(payload)
  }
);

if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

JavaScript SDK

const EngageVoice = require("ringcentral-engage-voice-client").default;
require("dotenv").config();

async function main() {
  const ev = new EngageVoice({
    clientId: process.env.RC_CLIENT_ID,
    clientSecret: process.env.RC_CLIENT_SECRET
  });

  await ev.authorize({ jwt: process.env.RC_JWT });

  const payload = {
    dialGroupName: "Outbound Renewals",
    dialGroupDesc: "Renewal outreach campaigns",
    dialMode: "PREVIEW",
    isActive: true
  };

  const response = await ev.post(
    "/api/v1/admin/accounts/{accountId}/dialGroups",
    payload
  );
  console.log(response.data);
}

main().catch(console.error);

Python SDK

import os
from dotenv import load_dotenv
from ringcentral_engage_voice import RingCentralEngageVoice

load_dotenv()

ev = RingCentralEngageVoice(
    os.environ["RC_CLIENT_ID"],
    os.environ["RC_CLIENT_SECRET"],
)
ev.authorize(jwt=os.environ["RC_JWT"])

payload = {
    "dialGroupName": "Outbound Renewals",
    "dialGroupDesc": "Renewal outreach campaigns",
    "dialMode": "PREVIEW",
    "isActive": True,
}

response = ev.post(
    "/api/v1/admin/accounts/{accountId}/dialGroups",
    payload,
).json()
print(response)

Verify the Dial Group

HTTP

GET https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{accountId}/dialGroups
Authorization: Bearer <ringcxAccessToken>
Accept: application/json

Python

import requests

account_id = "<accountId>"
access_token = "<ringcxAccessToken>"

response = requests.get(
    f"https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/{account_id}/dialGroups",
    headers={
        "Authorization": f"Bearer {access_token}",
        "Accept": "application/json",
    },
)
response.raise_for_status()
print(response.json())

JavaScript

const accountId = "<accountId>";
const accessToken = "<ringcxAccessToken>";

const response = await fetch(
  `https://ringcx.ringcentral.com/voice/api/v1/admin/accounts/${accountId}/dialGroups`,
  {
    headers: {
      Authorization: `Bearer ${accessToken}`,
      Accept: "application/json"
    }
  }
);

if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

JavaScript SDK

const EngageVoice = require("ringcentral-engage-voice-client").default;
require("dotenv").config();

async function main() {
  const ev = new EngageVoice({
    clientId: process.env.RC_CLIENT_ID,
    clientSecret: process.env.RC_CLIENT_SECRET
  });

  await ev.authorize({ jwt: process.env.RC_JWT });

  const response = await ev.get("/api/v1/admin/accounts/{accountId}/dialGroups");
  console.log(response.data);
}

main().catch(console.error);

Python SDK

import os
from dotenv import load_dotenv
from ringcentral_engage_voice import RingCentralEngageVoice

load_dotenv()

ev = RingCentralEngageVoice(
    os.environ["RC_CLIENT_ID"],
    os.environ["RC_CLIENT_SECRET"],
)
ev.authorize(jwt=os.environ["RC_JWT"])

response = ev.get("/api/v1/admin/accounts/{accountId}/dialGroups").json()
print(response)

Use the returned dialGroupId when creating campaigns.

Next Steps

After creating a dial group:

Create an outbound campaign.
Load leads into the campaign with bulk import.
Use lead search and lead actions to manage campaign leads.