Informacje

Uwierzytelnianie wymagane
Format odpowiedzi json
Metoda HTTP POST

POST sms_messages

Ostatnia modyfikacja 2024-11-20 13:20:36

Wysłanie SMS-a.

URL

https://your-system-name.thulium.com/api/sms_messages

Parametry

phone_number

wymagany

Numer telefonu odbiorcy. Przykładowa wartość: 48666777888
body

wymagany

Treść SMS-a. Przykładowa wartość: Hello, world!
customer_id

opcjonalny

Identyfikator klienta zapisanego w CRM (SMS zostanie zapisany w jego historii kontaktu). Przykładowa wartość: 41
sms_mailbox_id

opcjonalny

Identyfikator skrzynki SMS, którą zostanie wysłana wiadomość (jeśli puste, to wysyła nastąpi z konta domyślnego). Przykładowa wartość: 2
user_login

opcjonalny

Login użytkownika, w imieniu którego wysyłamy wiadomość (jak puste, to wyśle się z konta Automat). Przykładowa wartość: jan.kowalski

Przykładowy request

POST https://your-system-name.thulium.com/api/sms_messages
Dane {"phone_number":"48666777888","body":"Hello, world!","customer_id":1,"sms_mailbox_id":2,"user_login":"jan.kowalski"}

Przykładowy response

{
    sms_message_id: 1234
}

Przykładowe wywołanie


PHP 

<?php
$data = '{"phone_number":"48666777888","body":"Hello, world!","customer_id":1,"sms_mailbox_id":2,"user_login":"jan.kowalski"}';

$request = curl_init('https://your-system-name.thulium.com/api/sms_messages');
curl_setopt($request, CURLOPT_HTTPHEADER, array(
    'Content-Type: application/json; charset=utf-8',
    'Content-Length: ' . mb_strlen($data)
));
curl_setopt($request, CURLOPT_USERPWD, 'api_user:api_pass');
curl_setopt($request, CURLOPT_TIMEOUT, 30);
curl_setopt($request, CURLOPT_RETURNTRANSFER, true);
curl_setopt($request, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($request, CURLOPT_POSTFIELDS, $data);

$response = curl_exec($request);
if ($response) {
    $httpCode = curl_getinfo($request, CURLINFO_HTTP_CODE);
    if ($httpCode == 200){
        print_r(json_decode($response));
    } else {
        echo $response;
    }
} else {
    trigger_error(curl_error($request), E_USER_WARNING);
}

curl_close($request);
JAVA 

public class Example {
    public static void main(String[] args) throws Exception {
        ThuliumRestClient restClient = new ThuliumRestClient("api_user", "api_pass", true);

        ThuliumRestClient.ThuliumRestResponse response = restClient.post("https://your-system-name.thulium.com/api/sms_messages", "{\"phone_number\":\"48666777888\",\"body\":\"Hello, world!\",\"customer_id\":1,\"sms_mailbox_id\":2,\"user_login\":\"jan.kowalski\"}");
        System.out.println(response);
    }
}

CURL 

curl -u api_user:api_pass -k -X POST -H "Content-type: application/json" -d '{"phone_number":"48666777888","body":"Hello, world!","customer_id":1,"sms_mailbox_id":2,"user_login":"jan.kowalski"}' "https://your-system-name.thulium.com/api/sms_messages"

HTTPie 

echo '{"phone_number":"48666777888","body":"Hello, world!","customer_id":1,"sms_mailbox_id":2,"user_login":"jan.kowalski"}' | http -a api_user:api_pass POST https://your-system-name.thulium.com/api/sms_messages