Create a target

POST

/api/v1/targets

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/targets"),
    Headers =
    {
        { "X-API-Key", "<X-API-Key>" },
    },
    Content = new StringContent("{ \"name\": \"example\", \"buyer_id\": \"example\", \"type\": \"number\", \"number\": \"example\", \"sip_endpoint\": \"example\", \"sip_username\": \"example\", \"sip_password\": \"example\", \"sip_headers\": { \"X-Campaign\": \"sales\", \"X-Trace-Id\": \"trace-123\" }, \"connection_timeout\": 1, \"timezone\": \"America/New_York\", \"is_active\": false, \"max_concurrency\": 1, \"revenue\": 1, \"payout\": 1, \"payout_condition\": \"call_successfully_connected\", \"payout_condition_duration\": 1, \"conversion_scope\": 10, \"duplicate_conversion_action\": \"decline\", \"consider_duplicate\": false, \"consider_duplicate_on\": \"example\", \"consider_duplicate_length\": 1, \"consider_duplicate_interval\": 30, \"disable_recordings\": false, \"access_to_call_recordings\": true, \"filters\": { \"enabled\": true, \"groups\": [ { \"conditions\": [ { \"field\": \"state\", \"operator\": \"in\", \"values\": [ \"CA\", \"TX\" ] } ] } ] }, \"hours_of_operation\": { \"always_open\": false, \"days\": [ { \"day\": \"monday\", \"hours\": \"custom\", \"isOpen\": true, \"timeRanges\": [ { \"end\": \"17:00\", \"start\": \"09:00\" } ] } ] }, \"external_id\": \"example\", \"advanced_caps\": [ {} ] }")
    {
        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/targets"

  payload := strings.NewReader("{ \"name\": \"example\", \"buyer_id\": \"example\", \"type\": \"number\", \"number\": \"example\", \"sip_endpoint\": \"example\", \"sip_username\": \"example\", \"sip_password\": \"example\", \"sip_headers\": { \"X-Campaign\": \"sales\", \"X-Trace-Id\": \"trace-123\" }, \"connection_timeout\": 1, \"timezone\": \"America/New_York\", \"is_active\": false, \"max_concurrency\": 1, \"revenue\": 1, \"payout\": 1, \"payout_condition\": \"call_successfully_connected\", \"payout_condition_duration\": 1, \"conversion_scope\": 10, \"duplicate_conversion_action\": \"decline\", \"consider_duplicate\": false, \"consider_duplicate_on\": \"example\", \"consider_duplicate_length\": 1, \"consider_duplicate_interval\": 30, \"disable_recordings\": false, \"access_to_call_recordings\": true, \"filters\": { \"enabled\": true, \"groups\": [ { \"conditions\": [ { \"field\": \"state\", \"operator\": \"in\", \"values\": [ \"CA\", \"TX\" ] } ] } ] }, \"hours_of_operation\": { \"always_open\": false, \"days\": [ { \"day\": \"monday\", \"hours\": \"custom\", \"isOpen\": true, \"timeRanges\": [ { \"end\": \"17:00\", \"start\": \"09:00\" } ] } ] }, \"external_id\": \"example\", \"advanced_caps\": [ {} ] }")

  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/targets';
const options = {
  method: 'POST',
  headers: {'X-API-Key': '<X-API-Key>', 'Content-Type': 'application/json'},
  body: '{"name":"example","buyer_id":"example","type":"number","number":"example","sip_endpoint":"example","sip_username":"example","sip_password":"example","sip_headers":{"X-Campaign":"sales","X-Trace-Id":"trace-123"},"connection_timeout":1,"timezone":"America/New_York","is_active":false,"max_concurrency":1,"revenue":1,"payout":1,"payout_condition":"call_successfully_connected","payout_condition_duration":1,"conversion_scope":10,"duplicate_conversion_action":"decline","consider_duplicate":false,"consider_duplicate_on":"example","consider_duplicate_length":1,"consider_duplicate_interval":30,"disable_recordings":false,"access_to_call_recordings":true,"filters":{"enabled":true,"groups":[{"conditions":[{"field":"state","operator":"in","values":["CA","TX"]}]}]},"hours_of_operation":{"always_open":false,"days":[{"day":"monday","hours":"custom","isOpen":true,"timeRanges":[{"end":"17:00","start":"09:00"}]}]},"external_id":"example","advanced_caps":[{}]}'
};

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/targets \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "name": "example", "buyer_id": "example", "type": "number", "number": "example", "sip_endpoint": "example", "sip_username": "example", "sip_password": "example", "sip_headers": { "X-Campaign": "sales", "X-Trace-Id": "trace-123" }, "connection_timeout": 1, "timezone": "America/New_York", "is_active": false, "max_concurrency": 1, "revenue": 1, "payout": 1, "payout_condition": "call_successfully_connected", "payout_condition_duration": 1, "conversion_scope": 10, "duplicate_conversion_action": "decline", "consider_duplicate": false, "consider_duplicate_on": "example", "consider_duplicate_length": 1, "consider_duplicate_interval": 30, "disable_recordings": false, "access_to_call_recordings": true, "filters": { "enabled": true, "groups": [ { "conditions": [ { "field": "state", "operator": "in", "values": [ "CA", "TX" ] } ] } ] }, "hours_of_operation": { "always_open": false, "days": [ { "day": "monday", "hours": "custom", "isOpen": true, "timeRanges": [ { "end": "17:00", "start": "09:00" } ] } ] }, "external_id": "example", "advanced_caps": [ {} ] }'

Authorizations

MojaApiKeyHeader
MojaApiBearer

Parameters

Header Parameters

X-API-Key

Any of:

string
null

string

Request Body^required

application/json

TargetCreate

object

name

required

Name

string

>= 1 characters <= 255 characters

buyer_id

required

Buyer Id

string

>= 1 characters

type

required

Type

string

Allowed values: number phone sip sip_target sip-target

number

Any of:

string
null

string

sip_endpoint

Any of:

string
null

string

sip_username

Any of:

string
null

string

sip_password

Any of:

string
null

string

sip_headers

Any of:

object
null

object

key

additional properties

any

connection_timeout

Any of:

integer
null

integer

timezone

Timezone

string

default: America/New_York

is_active

Is Active

boolean

max_concurrency

Any of:

integer
null

integer

revenue

Any of:

number
null

number

payout

Any of:

number
null

number

payout_condition

Payout Condition

string

default: call_successfully_connected

Allowed values: call_successfully_connected call_length_connected

payout_condition_duration

Any of:

integer
null

integer

conversion_scope

Conversion Scope

integer

default: 10

duplicate_conversion_action

Duplicate Conversion Action

string

default: decline

Allowed values: decline route_no_pay route_no_revenue route_no_revenue_no_pay

consider_duplicate

Consider Duplicate

boolean

consider_duplicate_on

Any of:

string
null

string

consider_duplicate_length

Any of:

integer
null

integer

consider_duplicate_interval

Consider Duplicate Interval

Lookback window in days for the consider-duplicate check

integer

default: 30 >= 1

disable_recordings

Disable Recordings

boolean

access_to_call_recordings

Any of:

boolean
null

boolean

filters

Any of:

object
null

object

key

additional properties

any

hours_of_operation

Any of:

object
null

object

key

additional properties

any

external_id

Any of:

string
null

string

>= 1 characters <= 64 characters

advanced_caps

Any of:

Array<object>
null

Array<object>

object

key

additional properties

any

Responses

201

Successful Response

application/json

TargetResponse

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

buyer_id

Any of:

string
null

string

buyer_name

Any of:

string
null

string

type

Any of:

string
null

string

number

Any of:

string
null

string

sip_endpoint

Any of:

string
null

string

sip_username

Any of:

string
null

string

sip_password

Any of:

string
null

string

sip_headers

Any of:

object
null

object

key

additional properties

any

connection_timeout

Any of:

integer
null

integer

timezone

Timezone

string

default: America/New_York

is_active

required

Is Active

boolean

max_concurrency

Any of:

integer
null

integer

revenue

Any of:

number
null

number

payout

Any of:

number
null

number

payout_condition

Any of:

string
null

string

payout_condition_duration

Any of:

integer
null

integer

conversion_scope

required

Conversion Scope

integer

duplicate_conversion_action

Duplicate Conversion Action

string

default: decline

Allowed values: decline route_no_pay route_no_revenue route_no_revenue_no_pay

consider_duplicate

Consider Duplicate

boolean

consider_duplicate_on

Any of:

string
null

string

consider_duplicate_length

Any of:

integer
null

integer

consider_duplicate_interval

Consider Duplicate Interval

integer

default: 30

disable_recordings

Disable Recordings

boolean

access_to_call_recordings

required

Access To Call Recordings

boolean

filters

Any of:

object
null

object

key

additional properties

any

hours_of_operation

Any of:

object
null

object

key

additional properties

any

external_id

Any of:

string
null

string

advanced_caps

Advanced Caps

Array<object>

object

key

additional properties

any

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

Example

{
  "sip_headers": {
    "X-Campaign": "sales",
    "X-Trace-Id": "trace-123"
  },
  "timezone": "America/New_York",
  "duplicate_conversion_action": "decline",
  "consider_duplicate": false,
  "consider_duplicate_interval": 30,
  "disable_recordings": false,
  "filters": {
    "enabled": true,
    "groups": [
      {
        "conditions": [
          {
            "field": "state",
            "operator": "in",
            "values": [
              "CA",
              "TX"
            ]
          }
        ]
      }
    ]
  },
  "hours_of_operation": {
    "always_open": false,
    "days": [
      {
        "day": "monday",
        "hours": "custom",
        "isOpen": true,
        "timeRanges": [
          {
            "end": "17:00",
            "start": "09:00"
          }
        ]
      }
    ]
  },
  "is_paused": 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"
  }
}

Create a target

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