Send SMS
Wysłanie wiadomości do wybranych numerów.
POST /send_sms
Body
{
"from_number": "123###123",
"text": "Przykładowa wiadomość marketingowa.",
"number_list": ["123###123", "123###123", "123###123"],
"project_id": 5
}
Nazwa | Rodzaj | Opcjonalne | Przykład | Opis |
---|---|---|---|---|
from_number | <STRING> |
NIE | 123###123 | Numer z którego zostanie wysłana wiadomość. Numer musi być przypisany do jakiegoś projektu bądź konsultanta w projekcie |
text | <STRING> |
NIE | Lorem ipsum | Tekst wiadomości |
number_list | <LIST<STRING>> |
NIE | [123###123, 123###123, 123###123] | Lista numerów na które zostanie wysłana wiadomość |
manual_close_conversation | <BOOLEAN> |
TAK | 1 | Jeżeli parametr ustawiony jest na 1, po wysłaniu wiadomości konwersacja automatycznie zostanie zamknięta |
ResponseBody
{
"success": <BOOLEAN>,
"message_list": <LIST<OBJECT>>
}
Nazwa | Rodzaj | Przykład | Opis |
---|---|---|---|
success | <BOOLEAN> |
true | Czy zapytanie było skuteczne |
message_list | <LIST<OBJECT>> |
[{"message_id": "66993c8a6044fb0001e29268", "conversation_id": "66993c8a6044fb0001e29268"}] | Identyfikatory wiadomości |
Response Code
Status | Opis |
---|---|
202 | Zlecenie przyjęte do realizacji |
400 | Niepoprawne dane |
503 | Serwis niedostępny |
Example
curl -X POST \
$CONPEEK_URL/send_sms \
-H 'Authorization: $CONPEEK_KEY' \
-H 'Content-Type: application/json' \
-d '{
"from_number": "123###123",
"text": "Wiadomość marketingowa.",
"number_list": ["123###123", "123###123", "123###123"]
}'
import requests
import json
import os
from urllib import parse
url = parse.urljoin(os.environ["CONPEEK_URL"], "/send_sms"
payload = {
"from_number": "123###123",
"text": "Wiadomość marketingowa.",
"number_list": ["123###123", "123###123", "123###123"]
}
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();
$payload = array(
"from_number" => "123###123",
"text" => "Wiadomość marketingowa.",
"number_list" => array("123###123", "123###123", "123###123")
);
curl_setopt_array($curl, array(
CURLOPT_URL => getenv("CONPEEK_URL")."/send_sms",
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;
}
Response
202 Accepted
{
"success": true
}