Read Voice Campaign Request Summary
Pobranie podsumowań spraw z kampanii głosowych.
GET /voice_campaign_request_summary
Query Parameters
Możliwe parametry w URL:
Parameter | Default | Przykład | Opis |
---|---|---|---|
limit | 100 | 100 | Limit pobranych rekordów |
offset | 0 | 0 | Od którego rekordu |
filter | NULL | [{"property": "contact_number", "value": "452442123"}] |
Filtrowanie po parametrach, każdy obiekt musi posiadać klucz property i value . Opcjonalnie może posiadać klucz operator |
Dostępne parametry dla filter
:
- contact_number_list:
<LIST<STRING>>
— lista numerów rozmówców - created_date/closed_date:
<STRING>
— data w UTC w formacieYYYY-MM-DD HH:mm:ss
, dostępny parametroperator
, który przyjmuje wartości:- gt: połączenia rozpoczęte później niż
- gte: połączenia rozpoczęte później niż lub równe dacie
- lt: połączenia rozpoczęte wcześniej niż
- lte: połączenia rozpoczęte wcześniej niż lub równe dacie
- voice_campaign_id_list:
<LIST<STRING>>
— lista identyfikatorów kampanii - project_id_list:
<LIST<INTEGER>>
— lista identyfikator pojektów - call_request_id_list:
<LIST<STRING>>
— lista identyfikatorów spraw
Opis pól znajdziesz w Voice Campaign Request Summary
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": "452442123"}]))
Przekształcona wartość:
%5B%7B%22property%22:%22contact_number%22,%22value%22:%22452442123%22%7D%5D
Response Body
{
"data": <LIST<VoiceCampaignRequestSummary>>
}
Nazwa | Rodzaj | Opis | Zasób |
---|---|---|---|
data | <LIST<VoiceCampaignRequestSummary>> |
Lista obiektów | Voice Campaign Request Summary |
Response Code
Status | Opis |
---|---|
200 | Rekordy zostały pobrane pomyślnie |
400 | Błędne dane |
Example
curl -X GET \
$CONPEEK_URL/voice_campaign_request_summary \
-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_request_summary")
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_request_summary",
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;
}