Get a campaign

GET

/api/v1/campaigns/{campaign_id}

curl --request GET \
  --url https://external-api.moja-ai.com/api/v1/campaigns/example \
  --header 'X-API-Key: <X-API-Key>'

Authorizations

• MojaApiKeyHeader
• MojaApiBearer

Parameters

Path Parameters

campaign_id

required

Campaign Id

string

Header Parameters

X-API-Key

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

CampaignResponse

object

id

required

Id

string

created_at

Any of:

string

string format: date-time

null

null

updated_at

Any of:

string

string format: date-time

null

null

name

required

Name

string

org_id

required

Org Id

string

routing_plan_id

Any of:

string

string

null

null

call_flow_id

Any of:

string

string

null

null

execution_mode

required

Execution Mode

string

is_active

required

Is Active

boolean

payout

Any of:

number

number

null

null

timezone

Any of:

string

string

null

null

conversion_scope

required

Conversion Scope

integer

qai_category_id

Any of:

integer

integer

null

null

tcpa_scrubbing

Any of:

string

string

null

null

tcpa_scrubbing_config

Any of:

CampaignTCPAScrubbingConfig

CampaignTCPAScrubbingConfig

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

object

id

Any of:

string

string

>= 1 characters <= 36 characters

null

null

api_key

Any of:

string

string

<= 255 characters

null

null

api_version

Any of:

string

string

Allowed values: v1 v2 v3

null

null

api_url

Any of:

string

string

null

null

allow_calls_on_failure

Allow Calls On Failure

boolean

default: true

null

null

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

id

Any of:

string

string

>= 1 characters <= 36 characters

null

null

number_id

required

Number Id

string

publisher_id

Any of:

string

string

null

null

type

Type

string

default: static

Allowed values: static dynamic

payout

Any of:

number

number

null

null

payout_condition

Any of:

string

string

null

null

payout_condition_duration

Any of:

integer

integer

null

null

payout_percentage

Any of:

number

number

null

null

external_id

Any of:

string

string

>= 1 characters <= 64 characters

null

null

is_active

Is Active

boolean

default: true

number

Any of:

string

string

null

null

publisher_name

Any of:

string

string

null

null

paused_until

Any of:

string

string format: date-time

null

null

paused_at

Any of:

string

string format: date-time

null

null

paused_by

Any of:

string

string

null

null

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

id

Any of:

string

string

>= 1 characters <= 36 characters

null

null

legacy_rule_id

Any of:

string

string

null

null

combinator

Combinator

string

default: and

Allowed values: and or

payout

Payout

number

0

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

string

null

null

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

string

null

null

routing_plan

Any of:

ResourceRef

ResourceRef

object

id

required

Id

string

name

Any of:

string

string

null

null

null

null

advanced_caps

Advanced Caps

Array<object>

object

key

additional properties

any

Example

{
  "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

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

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

401

Unauthorized

Media typeapplication/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

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

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

409

Conflict

Media typeapplication/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

Media typeapplication/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

Media typeapplication/json

ErrorResponse

object

detail

required

ErrorBody

object

code

required

Code

string

message

required

Message

string

Example^generated

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