Informacje

Uwierzytelnianie wymagane
Format odpowiedzi json
Metoda HTTP POST

POST agents

Ostatnia modyfikacja 2024-11-20 13:20:36
Dodanie agenta.

URL

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

Parametry

name

wymagany

Imię agenta. Przykładowa wartość: Jan
surname

wymagany

Nazwisko agenta. Przykładowa wartość: Kowalski
login

wymagany

Login agenta. Przykładowa wartość: jkowalski
password

wymagany

Hasło do autoryzacji podczas logowania. Przykładowa wartość: somepass123!QAZ
number

wymagany

Numer agenta. Przykładowa wartość: 5634
email

opcjonalny

Adres e-mail agenta. Przykładowa wartość: jkowalski@example.com
change_password

opcjonalny

Wymuszenie zmiany hasła podczas pierwszego logowania.
Domyślna wartość: false Przykładowa wartość: true|false
callerid

opcjonalny

Identyfikator dzwoniącego.
Domyślna wartość: pierwsza litera imienia i nazwisko (J.Kowalski). Przykładowa wartość: J.Kowalski
language

opcjonalny

Język panelu.
Domyślna wartość: pl Przykładowa wartość: pl|en
active

opcjonalny

Ustawienie czy konto jest aktywne.
Domyślna wartość: true Przykładowa wartość: true|false
outbound_mode

opcjonalny

Tryb rozmów wychodzących.
Domyślna wartość: manual Przykładowa wartość: manual|auto
roles

opcjonalny

Identyfikatory ról. Przykładowa wartość: [1, 2]

Przykładowy request

POST https://your-system-name.thulium.com/api/agents
Dane {"name":"Jan","surname":"Kowalski","login":"jkowalski","email":"jk@foo.bar","password":"pass","number":"345","roles":[1,2]}

Przykładowy response

{
    "agent_id": "11",
    "agent_login": "jkowalski"
}

Przykładowe wywołanie


PHP

<?php
$data 
'{"name":"Jan","surname":"Kowalski","login":"jkowalski","email":"jk@foo.bar","password":"pass","number":"345","roles":[1,2]}';

$request curl_init('https://your-system-name.thulium.com/api/agents');
curl_setopt($requestCURLOPT_HTTPHEADER, array(
    
'Content-Type: application/json; charset=utf-8',
    
'Content-Length: ' mb_strlen($data)
));
curl_setopt($requestCURLOPT_USERPWD'api_user:api_pass');
curl_setopt($requestCURLOPT_TIMEOUT30);
curl_setopt($requestCURLOPT_RETURNTRANSFERtrue);
curl_setopt($requestCURLOPT_CUSTOMREQUEST'POST');
curl_setopt($requestCURLOPT_POSTFIELDS$data);

$response curl_exec($request);
if (
$response) {
    
$httpCode curl_getinfo($requestCURLINFO_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/agents", "{\"name\":\"Jan\",\"surname\":\"Kowalski\",\"login\":\"jkowalski\",\"email\":\"jk@foo.bar\",\"password\":\"pass\",\"number\":\"345\",\"roles\":[1,2]}");
        System.out.println(response);
    }
}

CURL

curl -u api_user:api_pass -k -X POST -H "Content-type: application/json" -d '{"name":"Jan","surname":"Kowalski","login":"jkowalski","email":"jk@foo.bar","password":"pass","number":"345","roles":[1,2]}' "https://your-system-name.thulium.com/api/agents"

HTTPie

echo '{"name":"Jan","surname":"Kowalski","login":"jkowalski","email":"jk@foo.bar","password":"pass","number":"345","roles":[1,2]}' | http -a api_user:api_pass POST https://your-system-name.thulium.com/api/agents