Create an inbound RTB

POST

/api/v1/inbound-rtb

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://external-api.moja-ai.com/api/v1/inbound-rtb"),
    Headers =
    {
        { "X-API-Key", "<X-API-Key>" },
    },
    Content = new StringContent("{ \"inbound_rtb_id\": \"example\", \"campaign_id\": \"example\", \"publisher_id\": \"example\", \"payout_mode\": \"dynamic\", \"payout_percentage\": 80, \"duration_add_seconds\": 0, \"payout\": 1, \"payout_condition\": \"call_length_connected\", \"payout_condition_duration\": 1, \"allocation_time_seconds\": 60, \"rate_limit\": 100, \"rate_period\": \"min\", \"is_active\": true, \"receive_mode\": \"dynamic\", \"receive_number_id\": \"example\", \"external_id\": \"example\" }")
    {
        Headers =
        {
            ContentType = new MediaTypeHeaderValue("application/json")
        }
    }
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

package main

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

func main() {

  url := "https://external-api.moja-ai.com/api/v1/inbound-rtb"

  payload := strings.NewReader("{ \"inbound_rtb_id\": \"example\", \"campaign_id\": \"example\", \"publisher_id\": \"example\", \"payout_mode\": \"dynamic\", \"payout_percentage\": 80, \"duration_add_seconds\": 0, \"payout\": 1, \"payout_condition\": \"call_length_connected\", \"payout_condition_duration\": 1, \"allocation_time_seconds\": 60, \"rate_limit\": 100, \"rate_period\": \"min\", \"is_active\": true, \"receive_mode\": \"dynamic\", \"receive_number_id\": \"example\", \"external_id\": \"example\" }")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("X-API-Key", "<X-API-Key>")
  req.Header.Add("Content-Type", "application/json")

  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/inbound-rtb';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'},
  body: '{"inbound_rtb_id":"example","campaign_id":"example","publisher_id":"example","payout_mode":"dynamic","payout_percentage":80,"duration_add_seconds":0,"payout":1,"payout_condition":"call_length_connected","payout_condition_duration":1,"allocation_time_seconds":60,"rate_limit":100,"rate_period":"min","is_active":true,"receive_mode":"dynamic","receive_number_id":"example","external_id":"example"}'
};

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

curl --request POST \
  --url https://external-api.moja-ai.com/api/v1/inbound-rtb \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "inbound_rtb_id": "example", "campaign_id": "example", "publisher_id": "example", "payout_mode": "dynamic", "payout_percentage": 80, "duration_add_seconds": 0, "payout": 1, "payout_condition": "call_length_connected", "payout_condition_duration": 1, "allocation_time_seconds": 60, "rate_limit": 100, "rate_period": "min", "is_active": true, "receive_mode": "dynamic", "receive_number_id": "example", "external_id": "example" }'

Authorizations

MojaApiKeyHeader
MojaApiBearer

Parameters

Header Parameters

X-API-Key

Any of:

string
null

string

Request Body^required

application/json

InboundRtbCreate

object

inbound_rtb_id

required

Inbound Rtb Id

string

>= 1 characters <= 255 characters

campaign_id

required

Campaign Id

string

>= 1 characters <= 255 characters

publisher_id

required

Publisher Id

string

>= 1 characters <= 255 characters

payout_mode

Payout Mode

string

default: dynamic

Allowed values: dynamic static

payout_percentage

Any of:

number
null

number

duration_add_seconds

Any of:

integer
null

integer

payout

Any of:

number
null

number

payout_condition

Any of:

string
null

string

Allowed values: call_length_connected call_length_incoming call_successfully_connected call_converted

payout_condition_duration

Any of:

integer
null

integer

>= 1

allocation_time_seconds

Allocation Time Seconds

integer

default: 60 >= 1 <= 60

rate_limit

Rate Limit

integer

default: 100 >= 1

rate_period

Rate Period

string

default: min

Allowed values: min hour day

is_active

Is Active

boolean

default: true

receive_mode

Receive Mode

string

default: dynamic

Allowed values: dynamic static_standard static_multi_bid

receive_number_id

Any of:

string
null

string

<= 255 characters

external_id

Any of:

string
null

string

>= 1 characters <= 64 characters

Responses

201

Successful Response

application/json

InboundRtbResponse

object

required

integer

inbound_rtb_id

required

Inbound Rtb Id

string

campaign_id

required

Campaign Id

string

campaign_name

Any of:

string
null

string

publisher_id

required

Publisher Id

string

publisher_name

Any of:

string
null

string

payout_mode

required

Payout Mode

string

payout_percentage

Any of:

number
null

number

duration_add_seconds

Any of:

integer
null

integer

payout

Any of:

number
null

number

payout_condition

Any of:

string
null

string

payout_condition_duration

Any of:

integer
null

integer

allocation_time_seconds

required

Allocation Time Seconds

integer

rate_limit

required

Rate Limit

integer

rate_period

required

Rate Period

string

is_active

required

Is Active

boolean

receive_mode

Receive Mode

string

default: dynamic

receive_number_id

Any of:

string
null

string

external_id

Any of:

string
null

string

created_at

Any of:

string
null

string format: date-time

updated_at

Any of:

string
null

string format: date-time

Example

{
  "receive_mode": "dynamic"
}

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

Create an inbound RTB

Authorizations

Parameters

Header Parameters

Request Bodyrequired

Responses

201

Example

400

Examplegenerated

401

Examplegenerated

404

Examplegenerated

409

Examplegenerated

422

Examplegenerated

429

Examplegenerated

Request Body^required

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated