Get a campaign

GET

campaigns

{id}

Get a campaign

curl --request GET \
  --url https://api-us.larynth.com/v1/campaigns/{id} \
  --cookie lx_session=

const options = {method: 'GET', headers: {cookie: 'lx_session='}};

fetch('https://api-us.larynth.com/v1/campaigns/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-us.larynth.com/v1/campaigns/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_COOKIE => "lx_session=",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api-us.larynth.com/v1/campaigns/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("cookie", "lx_session=")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-us.larynth.com/v1/campaigns/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["cookie"] = 'lx_session='

response = http.request(request)
puts response.read_body

{
  "amd_mode": "off",
  "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cps": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "max_attempts": 123,
  "max_concurrent": 123,
  "name": "<string>",
  "number_ids": [
    "<string>"
  ],
  "purpose": "informational",
  "retry_policy": {
    "busy": "<string>",
    "failed": "<string>",
    "no_answer": "<string>",
    "voicemail_left": "<string>"
  },
  "ring_timeout_s": 123,
  "status": "draft",
  "updated_at": "2023-11-07T05:31:56Z",
  "windows": [
    {
      "days": [
        123
      ],
      "end_minute": 720,
      "start_minute": 719
    }
  ],
  "amd_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "archived_at": "2023-11-07T05:31:56Z",
  "end_at": "2023-11-07T05:31:56Z",
  "informational_category": "<string>",
  "paused_reason": "user",
  "start_at": "2023-11-07T05:31:56Z",
  "voicemail_message": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

Authorizations

lx_session

string

required

Dashboard session cookie

Path Parameters

string<uuid>

required

Response

amd_mode

enum<string>

required

Available options:

off,

hangup_on_machine,

voicemail

assistant_id

string<uuid>

required

cps

number<double>

required

created_at

string<date-time>

required

created_by

string

required

string<uuid>

required

max_attempts

integer<int64>

required

max_concurrent

integer<int64>

required

name

string

required

number_ids

string[]

required

purpose

enum<string>

required

Available options:

informational,

telemarketing

retry_policy

object

required

Show child attributes

ring_timeout_s

integer<int64>

required

status

enum<string>

required

Available options:

draft,

running,

paused,

completed,

archived

updated_at

string<date-time>

required

windows

object[]

required

Show child attributes

amd_profile_id

string<uuid>

archived_at

string<date-time>

end_at

string<date-time>

informational_category

string

paused_reason

enum<string>

Available options:

user,

credits_exhausted,

window_closed,

no_caller_id,

compliance,

operator

start_at

string<date-time>

voicemail_message

string

⌘I

Get a campaign

curl --request GET \
  --url https://api-us.larynth.com/v1/campaigns/{id} \
  --cookie lx_session=

const options = {method: 'GET', headers: {cookie: 'lx_session='}};

fetch('https://api-us.larynth.com/v1/campaigns/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api-us.larynth.com/v1/campaigns/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_COOKIE => "lx_session=",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api-us.larynth.com/v1/campaigns/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("cookie", "lx_session=")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api-us.larynth.com/v1/campaigns/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["cookie"] = 'lx_session='

response = http.request(request)
puts response.read_body

{
  "amd_mode": "off",
  "assistant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "cps": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "max_attempts": 123,
  "max_concurrent": 123,
  "name": "<string>",
  "number_ids": [
    "<string>"
  ],
  "purpose": "informational",
  "retry_policy": {
    "busy": "<string>",
    "failed": "<string>",
    "no_answer": "<string>",
    "voicemail_left": "<string>"
  },
  "ring_timeout_s": 123,
  "status": "draft",
  "updated_at": "2023-11-07T05:31:56Z",
  "windows": [
    {
      "days": [
        123
      ],
      "end_minute": 720,
      "start_minute": 719
    }
  ],
  "amd_profile_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "archived_at": "2023-11-07T05:31:56Z",
  "end_at": "2023-11-07T05:31:56Z",
  "informational_category": "<string>",
  "paused_reason": "user",
  "start_at": "2023-11-07T05:31:56Z",
  "voicemail_message": "<string>"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

{
  "code": "<string>",
  "status": 123,
  "title": "<string>",
  "type": "<string>",
  "detail": "<string>",
  "errors": [
    {
      "location": "<string>",
      "message": "<string>",
      "value": "<unknown>"
    }
  ],
  "instance": "<string>",
  "retry_at": "2023-11-07T05:31:56Z"
}

Overview

Assistants

Calls

Recordings

Campaigns

Contacts

Compliance

Phone numbers

Knowledge bases

Billing

Catalog

Webhook endpoints

Authorizations

Path Parameters

Response