Read Message Template
Pobranie szablonów wiadomości
GET /message_template
Query Parameters
Możliwe parametry w URL:
Parametr | Domyślnie | Przykład | Opis |
---|---|---|---|
limit | 100 | 1000 | Limit pobranych rekordów |
offset | 0 | 2 | Rekod, od którego zwrócone mają zostać dane |
sort | NULL | name | Parametr, według którego posortowane mają zostać dane |
dir | NULL | asc | Kierunek sortowania |
filter | NULL | [{"property": "project_id", "value": 36}] |
Parametry do filtrowania |
Dostępne opcje dla parametru sort
:
- name
Dostępne opcje dla parametru dir
:
- asc: sortowanie rosnące
- desc: sortowanie malejące
Dostępne property
dla parametru filter
:
- name
- active
- project_id
- use_in_all_projects
- use_by_consultants
- use_by_notification
- use_by_invitation
- sms_enabled
- fb_messenger_enabled
- email_enabled
- fax_enabled
- whatsapp_enabled
- booking_com_enabled
- airbnb_enabled
- email_bookingsync_enabled
- bookingsync_enabled
- instagram_enabled
- chat_enabled
Opis wszystkich pól znajdziesz w Message Template
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": "project_id", "value": 36}]))
Przekształcona wartość:
%5B%7B%22property%22:%project_id%22,%22value%22:36%7D%5D
Response Body
{
"data": <MessageTemplate>
}
Nazwa | Rodzaj | Opis | Zasób |
---|---|---|---|
data | <MessageTemplate> |
Obiekt | Message Template |
Response Code
Status | Opis |
---|---|
200 | Rekordy zostały pobrane pomyślnie |
400 | Nieprawidłowe dane |
Example
curl -X GET \
$CONPEEK_URL/message_template \
-H 'Authorization: '$CONPEEK_KEY \
-H 'Content-Type: application/json'
import requests
import os
from urllib import parse
url = parse.urljoin(os.environ["CONPEEK_URL"], "/message_template")
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")."/message_template",
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;
}