Przejdź do treści

Read Voice SMS Campaign Requests

Pobranie danych wszystkich spraw z kampanii głosowej sms

GET /voice_sms_campaign/{voice_sms_campaign_id}/request

URL Parameters

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

Query Parameters

Możliwe parametry w URL:

Parametr Domyślnie Przykład Opis
limit 500 500 Limit pobranych rekordów
offset 0 0 Od którego rekordu
filter NULL [{"property": "contact_number_list", "value": ["123456789"]}] Filtrowanie po parametrach, każdy obiekt musi posiadać klucz property i value. Możliwy parametr "operator"

Dostępne parametry dla filter:

  • contact_number_list - <LIST<STRING>
  • result_list - <LIST<STRING>

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_list", "value": ["123456789"]}]))

Przekształcona wartość:

%5B%7B%22property%22:%22contact_number_list%22,%22value%22:%5B%22123456789%22%5D%7D%5D

Response Body

{
    "data": <LIST<VoiceSMSCampaignRequest>>,
    "count": <INTEGER>
}
Nazwa Rodzaj Opis Zasób
data <VoiceSMSCampaignRequest> Obiekt VoiceSMSCampaignRequest

Response Code

Status Opis
200 Żądanie zrealizowane poprawnie
403 Nie można wykonać takiej akcji
404 Nie znaleziono zasobu

Example

curl -X GET \
$CONPEEK_URL/voice_sms_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_sms_campaign/%(voice_campaign_id)s/request" % {
    "voice_sms_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();

$voice_sms_campaign_id = "5b7c389fe8df7b60af688989";

curl_setopt_array($curl, array(
    CURLOPT_URL => getenv("CONPEEK_URL")."/voice_sms_campaign/$voice_sms_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;
}