List campaign groups

curl --request GET \
  --url https://sandbox.voice.miraiminds.co/v2/campaign-groups \
  --header 'Authorization: Bearer <token>'

const url = 'https://sandbox.voice.miraiminds.co/v2/campaign-groups';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "object": "campaign_group_map",
  "groups": {
    "cmp_01K79Q4T6W8XZ2B5D7F9H3JKMN": {
      "members": [
        "cmp_01K7B0E3R5T7V9X1Z3B5D7F9GH"
      ],
      "display_name": "सर्विस रिमाइंडर — अक्टूबर + नवंबर"
    }
  },
  "member_of": {
    "cmp_01K7B0E3R5T7V9X1Z3B5D7F9GH": "cmp_01K79Q4T6W8XZ2B5D7F9H3JKMN"
  }
}

Campaigns

List campaign groups

Some work runs as more than one campaign, say a first round and a follow-up round to the same list. A group ties those campaigns together so the insights and the CSV of the first one cover all of them, one row per person. Our team sets groups up for you on request; this route tells you which ones exist.

groups is keyed by the campaign the report lives on, and member_of maps each other campaign back to it. Most workspaces have none, and get empty maps.

GET

campaign-groups

curl --request GET \
  --url https://sandbox.voice.miraiminds.co/v2/campaign-groups \
  --header 'Authorization: Bearer <token>'

const url = 'https://sandbox.voice.miraiminds.co/v2/campaign-groups';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "object": "campaign_group_map",
  "groups": {
    "cmp_01K79Q4T6W8XZ2B5D7F9H3JKMN": {
      "members": [
        "cmp_01K7B0E3R5T7V9X1Z3B5D7F9GH"
      ],
      "display_name": "सर्विस रिमाइंडर — अक्टूबर + नवंबर"
    }
  },
  "member_of": {
    "cmp_01K7B0E3R5T7V9X1Z3B5D7F9GH": "cmp_01K79Q4T6W8XZ2B5D7F9H3JKMN"
  }
}

Authorizations

Authorization

string

header

required

Your workspace secret key, sk_live_ followed by 32 hex characters. Create one in the console under Developers.

Response

200 - application/json

One group

Get started

Agents

Calls

Flows

Tools and secrets

Campaigns

Do-not-call list

Phone numbers

Phone pools

Telephony

Transcriptions

Speech to text

Text to speech

Wallet

Reference

List campaign groups

Authorizations

Response