Read Voice Campaign Requests

Pobranie istniejących spraw w kampanii głosowej

GET /voice_campaign/{voice_campaign_id}/request

URL Parameters

Nazwa	Rodzaj	Opcjonalne	Opis
voice_campaign_id	<STRING>	5b7c389fe8df7b60af688989	Identyfikator systemowy Kampanii głosowej

Query Parameters

Możliwe parametry w URL:

Parameter	Default	Przykład	Opis
limit	1000	10000	Limit pobranych rekordów
offset	0	0	Od którego rekordu
filter	NULL	[{"property": "created_date", "operator": "gte", "value": "2021-08-10 00:00:00"}]	Filtrowanie po parametrach, kazdy obiekt musi posiadać kluczproperty i value. Możliwy parametr "operator", "key"
exclude	NULL	["history", "call_history", "dialogs"]	Wykluczenie pobierania konkretnych parametrów

Dostępne parametry dla filter:

• created_date - <STRING> - Data w UTC w formacie YYYY-MM-DD HH:mm:ss, dostępny parametr operator który przyjmuje wartości:
  • gte - więcej lub równo
  • lte - mniej lub równo
• closed_date - <STRING> - Data w UTC w formacie YYYY-MM-DD HH:mm:ss, dostępny parametr operator który przyjmuje wartości:
  • gte - więcej lub równo
  • lte - mniej lub równo
• process_not_before - <STRING> - Data w UTC w formacie YYYY-MM-DD HH:mm:ss, dostępny parametr operator który przyjmuje mieć wartości:
  • gte - więcej lub równo
  • lte - mniej lub równo
• state - <LIST<STRING>> - Dostępne wartości:
  • OPEN
  • PROCESSING
  • CLOSED
• application_state - <LIST<STRING>> - Dostępne wartości:
  • NEW
  • RECALL
  • RETRY
  • CLOSED
• contact_number - <STRING>
• dialing_method - <STRING>
• tenant_user_id - <LIST<INTEGER>>
• assigned_tenant_user_id - <LIST<INTEGER>>
• close_reason - <LIST<STRING>>
• custom_fields - <STRING> - dostępny parametr key, który oznacza nazwę niestandardowego pola
• priority - <INTEGER> - dostępny parametr operator który może mieć wartości:
  • gt - więcej niż
  • gte - więcej lub równo
  • lte - mniej lub równo
  • lt - mniej niż
  • eq - dokładnie
  • ne - różne od
• consultant_try - <INTEGER> - dostępny parametr operator który może mieć wartości:
  • gt - więcej niż
  • gte - więcej lub równo
  • lte - mniej lub równo
  • lt - mniej niż
  • eq - dokładnie
  • ne - różne od
• contact_try - <INTEGER> - dostępny parametr operator który może mieć wartości:
  • gt - więcej niż
  • gte - więcej lub równo
  • lte - mniej lub równo
  • lt - mniej niż
  • eq - dokładnie
  • ne - różne od

Parametr filter musi być Listą obiektów przekształconą w ciąg JSON zakodowany w UTF-8.

Przykład przekształcenia:

encodeURI(JSON.stringify([{"property": "contact_number", "value": [123123123]}]))

Przekształcona wartość:

%5B%7B%22property%22:%22contact_number%22,%22value%22:123123123%7D%5D

Response Body

{
    "data": <LIST<VoiceCampaignRequest>>
}

Nazwa	Rodzaj	Opis	Zasób
data	<LIST<VoiceCampaignRequest>>	Lista obiektów	VoiceCampaignRequest

Response Code

Status	Opis
200	Rekordy zostały pobrane pomyślnie
403	Nie można wykonać takiej akcji
404	Nie znaleziono zasobu

Example

CURLPYTHONPHP

curl -X GET \
$CONPEEK_URL/voice_campaign/5b7c389fe8df7b60af688989/request \
-H 'Authorization: '$CONPEEK_KEY \
-H 'Content-Type: application/json'

import requests
import os
from urllib import parse

url = parse.urljoin(os.environ["CONPEEK_URL"], "/voice_campaign/%(voice_campaign_id)s/request" % {
    "voice_campaign_id": "5b7c389fe8df7b60af688989",
})

headers = {
    'Content-Type': "application/json",
    'Authorization': os.environ["CONPEEK_KEY"]
}

response = requests.request("GET", url, headers=headers)
print(response.text)

<?php
$curl = curl_init();

curl_setopt_array($curl, array(
    CURLOPT_URL => getenv("CONPEEK_URL")."/voice_campaign/$voice_campaign_id/request",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "GET",
    CURLOPT_HTTPHEADER => array(
        "Authorization: ".getenv("CONPEEK_KEY"),
        "Content-Type: application/json"
    ),
));

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

curl_close($curl);

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