Get a routing plan

GET

/api/v1/routing-plans/{routing_plan_id}

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

Authorizations

• MojaApiKeyHeader
• MojaApiBearer

Parameters

Path Parameters

routing_plan_id

required

Routing Plan Id

string

Header Parameters

X-API-Key

Any of:

string

string

null

null

Responses

200

Successful Response

Media typeapplication/json

RoutingPlanResponse

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

org_id

required

Org Id

string

name

required

Name

string

description

Any of:

string

string

null

null

is_active

required

Is Active

boolean

allowed_publishers

Allowed Publishers

Array<string>

allowed_buyers

Allowed Buyers

Array<string>

prefix

Prefix

string

""

predictive_routing_plan_id

Any of:

string

string

null

null

external_id

Any of:

string

string

null

null

routes

Routes

Array<object>

RoutingPlanRouteResponse

object

id

Any of:

string

string

>= 1 characters <= 36 characters

null

null

action

required

Action

string

Allowed values: route-to-target route-to-sip-target route-to-ivr route-to-rtb route-to-rtb-group

target_id

Any of:

string

string

null

null

rtb_formula_id

Any of:

string

string

null

null

ivr_id

Any of:

string

string

null

null

rtb_group_id

Any of:

string

string

null

null

predictive_routing_plan_id

Any of:

string

string

null

null

priority

Priority

integer

0

weight

Weight

integer

0

target

Any of:

ResourceRef

ResourceRef

object

id

required

Id

string

name

Any of:

string

string

null

null

null

null

rtb_formula

Any of:

ResourceRef

ResourceRef

object

id

required

Id

string

name

Any of:

string

string

null

null

null

null

ivr

Any of:

ResourceRef

ResourceRef

object

id

required

Id

string

name

Any of:

string

string

null

null

null

null

rtb_group

Any of:

ResourceRef

ResourceRef

object

id

required

Id

string

name

Any of:

string

string

null

null

null

null

Example

{
  "prefix": "",
  "routes": [
    {
      "action": "route-to-target",
      "priority": 0,
      "weight": 0
    }
  ]
}

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