List campaigns

GET

/api/v1/campaigns

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Get,
    RequestUri = new Uri("https://external-api.moja-ai.com/api/v1/campaigns?limit=20&offset=0"),
    Headers =
    {
        { "X-API-Key", "<X-API-Key>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

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

func main() {

  url := "https://external-api.moja-ai.com/api/v1/campaigns?limit=20&offset=0"

  req, _ := http.NewRequest("GET", 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(res)
  fmt.Println(string(body))

}

const url = 'https://external-api.moja-ai.com/api/v1/campaigns?limit=20&offset=0';
const options = {method: 'GET', headers: {'X-API-Key': '<X-API-Key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://external-api.moja-ai.com/api/v1/campaigns?limit=20&offset=0' \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

MojaApiKeyHeader
MojaApiBearer

Parameters

Query Parameters

limit

Limit

integer

default: 20 >= 1 <= 200

offset

Offset

integer

Header Parameters

X-API-Key

Any of:

string
null

string

Responses

200

Successful Response

application/json

CampaignListResponse

object

data

required

Data

Array<object>

CampaignResponse

object

required

string

created_at

Any of:

string
null

string format: date-time

updated_at

Any of:

string
null

string format: date-time

name

required

Name

string

org_id

required

Org Id

string

routing_plan_id

Any of:

string
null

string

call_flow_id

Any of:

string
null

string

execution_mode

required

Execution Mode

string

is_active

required

Is Active

boolean

payout

Any of:

number
null

number

timezone

Any of:

string
null

string

conversion_scope

required

Conversion Scope

integer

qai_category_id

Any of:

integer
null

integer

tcpa_scrubbing

Any of:

string
null

string

tcpa_scrubbing_config

Any of:

CampaignTCPAScrubbingConfig
null

CampaignTCPAScrubbingConfig

id is the DB row uuid (campaign_tcpa_scrubbing_configs.uuid) for stable PATCH round-trips.

object

Any of:

string
null

string

>= 1 characters <= 36 characters

api_key

Any of:

string
null

string

<= 255 characters

api_version

Any of:

string
null

string

Allowed values: v1 v2 v3

api_url

Any of:

string
null

string

allow_calls_on_failure

Allow Calls On Failure

boolean

default: true

number_group_items

Number Group Items

Array<object>

CampaignNumberGroupItem

id is campaign_number_group_items.uuid (stable row id). Includes pause state on reads.

object

Any of:

string
null

string

>= 1 characters <= 36 characters

number_id

required

Number Id

string

publisher_id

Any of:

string
null

string

type

Type

string

default: static

Allowed values: static dynamic

payout

Any of:

number
null

number

payout_condition

Any of:

string
null

string

payout_condition_duration

Any of:

integer
null

integer

payout_percentage

Any of:

number
null

number

external_id

Any of:

string
null

string

>= 1 characters <= 64 characters

is_active

Is Active

boolean

default: true

number

Any of:

string
null

string

publisher_name

Any of:

string
null

string

paused_until

Any of:

string
null

string format: date-time

paused_at

Any of:

string
null

string format: date-time

paused_by

Any of:

string
null

string

is_paused

Is Paused

boolean

ivr_payout_rules

Ivr Payout Rules

Array<object>

CampaignIVRPayoutRule

id is campaign_ivr_payout_rules.uuid; legacy_rule_id is the legacy JSON rule key when distinct.

object

Any of:

string
null

string

>= 1 characters <= 36 characters

legacy_rule_id

Any of:

string
null

string

combinator

Combinator

string

default: and

Allowed values: and or

payout

Payout

number

filters

Filters

Array<object>

object

key

additional properties

any

outgoing_webhooks

Outgoing Webhooks

Array<string>

incoming_webhooks

Incoming Webhooks

Array<string>

preconverted_caller

Preconverted Caller

boolean

preconverted_destination

Preconverted Destination

boolean

preconverted_publisher

Preconverted Publisher

boolean

preconverted_campaign

Preconverted Campaign

boolean

external_id

Any of:

string
null

string

disable_recordings

Disable Recordings

boolean

access_to_call_recordings

required

Access To Call Recordings

boolean

expose_ineligible_routes

Expose Ineligible Routes

boolean

ineligible_routes_fields

Any of:

string
null

string

routing_plan

Any of:

ResourceRef
null

ResourceRef

object

required

string

name

Any of:

string
null

string

advanced_caps

Advanced Caps

Array<object>

object

key

additional properties

any

meta

required

PaginatedResponseMeta

object

limit

required

Limit

integer

offset

required

Offset

integer

count

required

Count

integer

total

required

Total

integer

has_more

required

Has More

boolean

next_offset

Any of:

integer
null

integer

previous_offset

Any of:

integer
null

integer

Example

{
  "data": [
    {
      "tcpa_scrubbing_config": {
        "api_version": "v1",
        "api_url": "https://api.blacklistalliance.net/lookup?key=abc123&ver=v1&resp=raw&phone=",
        "allow_calls_on_failure": true
      },
      "number_group_items": [
        {
          "type": "static",
          "is_active": true,
          "is_paused": false
        }
      ],
      "ivr_payout_rules": [
        {
          "combinator": "and",
          "payout": 0,
          "filters": [
            {
              "field": "keypress",
              "operator": "equals",
              "value": "1"
            }
          ]
        }
      ],
      "preconverted_caller": false,
      "preconverted_destination": false,
      "preconverted_publisher": false,
      "preconverted_campaign": false,
      "disable_recordings": false,
      "expose_ineligible_routes": false
    }
  ]
}

400

Bad Request

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

401

Unauthorized

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

404

Not Found

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

409

Conflict

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

422

Validation Error

application/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}

429

Too Many Requests

application/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

{
  "detail": {
    "code": "example",
    "message": "example"
  }
}

List campaigns

Authorizations

Parameters

Query Parameters

Header Parameters

Responses

200

Example

400

Examplegenerated

401

Examplegenerated

404

Examplegenerated

409

Examplegenerated

422

Examplegenerated

429

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated