Add Voice SMS Campaign Requests

Dodanie listy spraw do kampanii głosowej sms

POST /voice_sms_campaign/{voice_sms_campaign_id}/request_list

URL Parameters

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

Body

{
    "data": [{"contact_number": "48987654321"}],
    "type": "announcement",
    "announcement_id": "5b7c78389fe80f7b60af688989"
}

Nazwa	Rodzaj	Opcjonalne	Opis
data	<LIST<OBJECT>>	NIE	[{"contact_number": "48987654321"}]
type	<STRING>	announcement	Rodzaj. Dostępne parametry: announcement - Odegranie zapowiedzi tts - Tekst na mowię none - Żadna akcja
announcement_id	<STRING>	5b7c78389fe80f7b60af688989	Identyfikator zapowiedzi, dostępne dla type o wartości announcement

Data

Parametr	Rodzaj	Przykład	Opis
contact_number	<STRING>	48123123123	Numer kontaktowy
text	<STRING>	Witaj	Tekst, dostępne dla type o wartości tts
ssml	<STRING>	Here are <say-as interpret-as="characters">SSML</say-as> samples	Tekst w formacie SSML, dostępne dla type o wartości tts
voice_definition_id	<STRING>	5b3c78874fe80o7c60af632189	Identyfikator definicji głosu, dostępne dla type o wartości tts
custom	<OBJECT>	{"issue_id":"XYZ-ABC-01"}	Niestandardowe parametry przekazane do sprawy. Dostępne z kontekstu {{ voice_sms }}

Response Body

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

Response Code

Status	Opis
200	Żądanie przyjęte do realizacji
403	Nie można wykonać takiej akcji
404	Nie znaleziono zasobu

Example

CURLPYTHONPHP

curl -X POST \
$CONPEEK_URL/voice_sms_campaign/5b7c389fe8df7b60af688989/request_list \
-H 'Authorization: '$CONPEEK_KEY \
-H 'Content-Type: application/json' \
-d '{"type": "announcement",
    "announcement_id": "5b7c78389fe80f7b60af688989",
    "data": [{"contact_number": "48987654321"}]
}'

import requests
import json
import os
from urllib import parse

url = parse.urljoin(os.environ["CONPEEK_URL"], "/voice_sms_campaign/%(voice_sms_campaign_id)s/request_list" % {
    "voice_sms_campaign_id": "5b7c389fe8df7b60af688989"
})

payload = {
    "type": "announcement",
    "announcement_id": "5b7c78389fe80f7b60af688989",
    "data": [{
        "contact_number": "48987654321"
    }]
}

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

response = requests.request("POST", url, data=json.dumps(payload), headers=headers)
print(response.text)

<?php
$curl = curl_init();

$voice_sms_campaign_id = "5b7c389fe8df7b60af688989";

$payload = array(
    "type" => "announcement",
    "announcement_id" => "5b7c78389fe80f7b60af688989",
    "data" => array(
        array(
            "contact_number"=>"48987654321"
        )
    )
);

curl_setopt_array($curl, array(
    CURLOPT_URL => getenv("CONPEEK_URL")."/voice_sms_campaign/$voice_sms_campaign_id/request_list",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_ENCODING => "",
    CURLOPT_MAXREDIRS => 10,
    CURLOPT_TIMEOUT => 30,
    CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_POSTFIELDS => json_encode($payload),
    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;
}